From 598653a467db09f318eb74d51847638b56c0ec9a Mon Sep 17 00:00:00 2001 From: Pete Shima Date: Fri, 3 Jun 2016 14:08:05 -0700 Subject: [PATCH 1/2] Add several more s3 examples to artifact docs --- website/source/docs/jobspec/index.html.md | 29 +++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/website/source/docs/jobspec/index.html.md b/website/source/docs/jobspec/index.html.md index 0a74caf9f..1382c4f26 100644 --- a/website/source/docs/jobspec/index.html.md +++ b/website/source/docs/jobspec/index.html.md @@ -471,6 +471,35 @@ artifact { } ``` +#### S3 examples + +S3 has several different types of addressing and more detail can be found +[here](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) + +S3 region specific endpoints can be found +[here](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) + +Path based style: +``` +artifact { + source = "https://s3-us-west-2.amazonaws.com/my-bucket-example/my_app.tar.gz" +} +``` + +or to override automatic detection in the url, use the s3 specific syntax +``` +artifact { + source = "s3::https://s3-eu-west-1.amazonaws.com/my-bucket-example/my_app.tar.gz" +} +``` + +Virtual hosted based style +``` +artifact { + source = "my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz" +} +``` + ## JSON Syntax Job files can also be specified in JSON. The conversion is straightforward From 478e0eae2d1a22b48961ed908f20356b7d253bc3 Mon Sep 17 00:00:00 2001 From: Pete Shima Date: Fri, 3 Jun 2016 14:35:43 -0700 Subject: [PATCH 2/2] Add s3 examples to json docs as well --- website/source/docs/jobspec/json.html.md | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/website/source/docs/jobspec/json.html.md b/website/source/docs/jobspec/json.html.md index d5c64f481..38d595f0b 100644 --- a/website/source/docs/jobspec/json.html.md +++ b/website/source/docs/jobspec/json.html.md @@ -529,3 +529,38 @@ An example of downloading and unzipping an archive is as simple as: } ] ``` + +#### S3 examples + +S3 has several different types of addressing and more detail can be found +[here](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) + +S3 region specific endpoints can be found +[here](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) + +Path based style: +``` +"Artifacts": [ + { + "GetterSource": "https://s3-us-west-2.amazonaws.com/my-bucket-example/my_app.tar.gz", + } +] +``` + +or to override automatic detection in the url, use the s3 specific syntax +``` +"Artifacts": [ + { + "GetterSource": "s3::https://s3-eu-west-1.amazonaws.com/my-bucket-example/my_app.tar.gz", + } +] +``` + +Virtual hosted based style +``` +"Artifacts": [ + { + "GetterSource": "my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz", + } +] +```