Added new documentation about using the CodeBuild agent in use-codebuild-agent.md plus minor periodic updates.

markiver · markiver · commit b745f2e2c4c5 · 2018-06-15T23:58:36.000Z
diff --git a/doc_source/create-project.md b/doc_source/create-project.md
@@ -242,7 +242,7 @@ For information about using the AWS CLI with AWS CodeBuild, see the [Command Lin
        + If you specified `NO_ARTIFACTS` for *artifacts\-type*, do not specify a `packaging` for `artifacts`\.
        + If you specified `S3` for *artifacts\-type*, valid values include `ZIP` and `NONE`\. To create a ZIP file that contains the build output, use `ZIP`\. To create a folder that contains the build output, use `NONE`\. The default value is `NONE`\.
    + For the required *cache* object, information about this build project's cache settings\. These settings include the following:
-     + *CacheType*: Required value\. Valid values are `S3` or `NONE`\.
+     + *CacheType*: Required value\. Valid values are `S3` or `NO_CACHE`\.
      + *CacheLocation*: Required value unless you set *CacheType* to `NONE`\. If you specified S3 for *CacheType*, then this is the ARN of the S3 bucket and the path prefix\. For example, if your Amazon S3 bucket name is `my-bucket`, and your path prefix is `build-cache`, then acceptable formats for your *CacheLocation* are `my-bucket/build-cache` or `aws:s3:::my-bucket/build-cache`\.
    + *serviceRole*: Required value\. The ARN of the service role AWS CodeBuild uses to interact with services on behalf of the IAM user \(for example, `arn:aws:iam::account-id:role/role-name`\)\.
    + For the optional *vpcConfig* object, information about your VPC configuration\. These settings include: 
@@ -266,7 +266,7 @@ If you are using a region other than us\-east\-1, be sure to use it when you run
 **Note**  
 If you are using a region other than us\-east\-1, be sure to use it when you run the command\.
    + For the required `environment` object, information about this project's build environment settings\. These settings include: 
-     + *environment\-type*: Required value\. The type of build environment\. The only allowed value is `LINUX_CONTAINER`\.
+     + *environment\-type*: Required value\. The type of build environment\. Valid values are `LINUX_CONTAINER` and `WINDOWS_CONTAINER`\.
      + *image*: Required value\. The Docker image identifier used by this build environment\. Typically, this identifier is expressed as *image\-name*:*tag*\. For example, in the Docker repository that AWS CodeBuild uses to manage its Docker images, this could be `aws/codebuild/java:openjdk-8`\. In Docker Hub, `maven:3.3.9-jdk-8`\. In Amazon ECR, `account-id.dkr.ecr.region-id.amazonaws.com/your-Amazon-ECR-repo-name:tag`\. For more information, see [Docker Images Provided by AWS CodeBuild](build-env-ref-available.md)\. 
      + *computeType*: Required value\. A category corresponding to the number of CPU cores and memory used by this build environment\. Allowed values include `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, and `BUILD_GENERAL1_LARGE`\.
      + *certificate*: Optional value\. The ARN of the AWS S3 bucket, path prefix and object key containing the PEM encoded certificate\. The object key can be either just the \.pem file or a \.zip file containing the pem encoded certificate\. For example, if your Amazon S3 bucket name is my\-bucket, your path prefix is cert, and your object key name is certificate\.pem, then acceptable formats for your *certificate* are my\-bucket/cert/certificate\.pem or arn:aws:s3:::my\-bucket/cert/certificate\.pem\.
diff --git a/doc_source/index.md b/doc_source/index.md
@@ -49,6 +49,7 @@ Amazon's trademarks and trade dress may not be used in
       + [Shells and Commands in Build Environments](build-env-ref-cmd.md)
       + [Environment Variables in Build Environments](build-env-ref-env-vars.md)
       + [Background Tasks in Build Environments](build-env-ref-background-tasks.md)
+   + [Test and Debug Locally with the AWS CodeBuild Agent](use-codebuild-agent.md)
 + [Run AWS CodeBuild Directly](how-to-run.md)
 + [Use AWS CodeBuild with Amazon Virtual Private Cloud](vpc-support.md)
    + [Use VPC Endpoints](use-vpc-endpoints-with-codebuild.md)
diff --git a/doc_source/sample-build-notifications.md b/doc_source/sample-build-notifications.md
@@ -258,7 +258,7 @@ To stop using a rule to send build notifications, in the CloudWatch console, cho
 
 To delete a rule altogether, in the CloudWatch console, choose the rule you want to delete, and then choose **Actions**, **Delete**\.
 
-### Related Resources<a name="w3ab1b9c51c23b9c12"></a>
+### Related Resources<a name="w3ab1b9c49c23b9c12"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-c-plus-plus-hw.md b/doc_source/sample-c-plus-plus-hw.md
@@ -9,7 +9,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-c-plus-plus-hw-running)
 + [Directory Structure](#sample-c-plus-plus-hw-dir)
 + [Files](#sample-c-plus-plus-hw-files)
-+ [Related Resources](#w3ab1b9c54c11c15)
++ [Related Resources](#w3ab1b9c52c11c15)
 
 ## Running the Sample<a name="sample-c-plus-plus-hw-running"></a>
 
@@ -99,7 +99,7 @@ int main()
 }
 ```
 
-## Related Resources<a name="w3ab1b9c54c11c15"></a>
+## Related Resources<a name="w3ab1b9c52c11c15"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-codedeploy.md b/doc_source/sample-codedeploy.md
@@ -163,7 +163,7 @@ Do not add `(root directory name)` or `(root directory name)/my-app` to the ZIP
 
 1. To find the build output artifact after the deployment is complete, sign in to the instance and look in the `/tmp` directory for the file named `my-app-1.0-SNAPSHOT.jar`\.
 
-## Related Resources<a name="w3ab1b9c51c31b9"></a>
+## Related Resources<a name="w3ab1b9c49c31b9"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-docker-custom-image.md b/doc_source/sample-docker-custom-image.md
@@ -11,7 +11,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-docker-custom-image-running)
 + [Directory Structure](#sample-docker-custom-image-dir)
 + [Files](#sample-docker-custom-image-files)
-+ [Related Resources](#w3ab1b9c51c25c17)
++ [Related Resources](#w3ab1b9c49c25c17)
 
 ## Running the Sample<a name="sample-docker-custom-image-running"></a>
 
@@ -97,7 +97,7 @@ FROM maven:3.3.9-jdk-8
 RUN echo "Hello World"
 ```
 
-## Related Resources<a name="w3ab1b9c51c25c17"></a>
+## Related Resources<a name="w3ab1b9c49c25c17"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-docker.md b/doc_source/sample-docker.md
@@ -16,7 +16,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Directory Structure](#sample-docker-dir)
 + [Files](#sample-docker-files)
 + [Adapting the Sample to Push the Image to Docker Hub](#sample-docker-docker-hub)
-+ [Related Resources](#w3ab1b9c51b9c23)
++ [Related Resources](#w3ab1b9c49b9c23)
 
 ## Running the Sample<a name="sample-docker-running"></a>
 
@@ -285,7 +285,7 @@ If you are using an Amazon S3 input bucket, be sure to create a ZIP file that co
 
 1. Confirm that AWS CodeBuild successfully pushed the Docker image to the repository\. Sign in to Docker Hub, go to the repository, and choose the **Tags** tab\. The `latest` tag should contain a very recent **Last Updated** value\.
 
-## Related Resources<a name="w3ab1b9c51b9c23"></a>
+## Related Resources<a name="w3ab1b9c49b9c23"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-ecr.md b/doc_source/sample-ecr.md
@@ -113,7 +113,7 @@ The IAM entity that modifies this policy must have permission in IAM to modify p
 
 1. Download the `GoOutputArtifact.zip` file to your local computer or instance, and then extract the contents of the `GoOutputArtifact.zip` file\. In the extracted contents, get the `hello` file\.
 
-## Related Resources<a name="w3ab1b9c51b7b9"></a>
+## Related Resources<a name="w3ab1b9c49b7b9"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-elastic-beanstalk.md b/doc_source/sample-elastic-beanstalk.md
@@ -304,7 +304,7 @@ In this step, you will add an Elastic Beanstalk configuration file and a build s
 
 If you want, you can make changes to the source code and then run the eb deploy command from the same directory\. The EB CLI performs the same steps as the eb create command, but it deploys the build output to the existing environment instead of creating a new environment\.
 
-## Related Resources<a name="w3ab1b9c51c35c15"></a>
+## Related Resources<a name="w3ab1b9c49c35c15"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-go-hw.md b/doc_source/sample-go-hw.md
@@ -12,7 +12,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-go-hw-running)
 + [Directory Structure](#sample-go-hw-dir)
 + [Files](#sample-go-hw-files)
-+ [Related Resources](#w3ab1b9c54c27c17)
++ [Related Resources](#w3ab1b9c52c27c17)
 
 ## Running the Sample<a name="sample-go-hw-running"></a>
 
@@ -103,7 +103,7 @@ func main() {
 }
 ```
 
-## Related Resources<a name="w3ab1b9c54c27c17"></a>
+## Related Resources<a name="w3ab1b9c52c27c17"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-lambda.md b/doc_source/sample-lambda.md
@@ -6,7 +6,7 @@ You can use AWS CodeBuild to package and deploy serverless applications that fol
 
 For more information, see [Deploying Lambda\-based Applications](http://docs.aws.amazon.com/lambda/latest/dg/deploying-lambda-apps.html) in the *AWS Lambda Developer Guide*\. To experiment with a serverless application sample that uses AWS CodeBuild along with Lambda, AWS CloudFormation, and AWS CodePipeline, see [Automating Deployment of Lambda\-based Applications](http://docs.aws.amazon.com/lambda/latest/dg/automating-deployment.html) in the *AWS Lambda Developer Guide*\.
 
-## Related Resources<a name="w3ab1b9c51c33b9"></a>
+## Related Resources<a name="w3ab1b9c49c33b9"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-maven-5m.md b/doc_source/sample-maven-5m.md
@@ -115,7 +115,7 @@ If you are using an Amazon S3 input bucket, be sure to create a ZIP file that co
 
 1. Download the `MavenIn5MinutesOutputArtifact.zip` file to your local computer or instance, and then extract the contents of the `MavenIn5MinutesOutputArtifact.zip` file\. In the extracted contents, open the `target` folder to get the `my-app-1.0-SNAPSHOT.jar` file\. 
 
-## Related Resources<a name="w3ab1b9c54c29b9"></a>
+## Related Resources<a name="w3ab1b9c52c29b9"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-net-core-linux.md b/doc_source/sample-net-core-linux.md
@@ -98,7 +98,7 @@ namespace HelloWorldSample {
 }
 ```
 
-## Related Resources<a name="w3ab1b9c54c41c13"></a>
+## Related Resources<a name="w3ab1b9c52c41c13"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-nodejs-hw.md b/doc_source/sample-nodejs-hw.md
@@ -12,7 +12,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-nodejs-hw-running)
 + [Directory Structure](#sample-nodejs-hw-dir)
 + [Files](#sample-nodejs-hw-files)
-+ [Related Resources](#w3ab1b9c54c31c17)
++ [Related Resources](#w3ab1b9c52c31c17)
 
 ## Running the Sample<a name="sample-nodejs-hw-running"></a>
 
@@ -108,7 +108,7 @@ if (test.string(str).startsWith('Hello')) {
 }
 ```
 
-## Related Resources<a name="w3ab1b9c54c31c17"></a>
+## Related Resources<a name="w3ab1b9c52c31c17"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-python-hw.md b/doc_source/sample-python-hw.md
@@ -12,7 +12,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-python-hw-running)
 + [Directory Structure](#sample-python-hw-dir)
 + [Files](#sample-python-hw-files)
-+ [Related Resources](#w3ab1b9c54c33c17)
++ [Related Resources](#w3ab1b9c52c33c17)
 
 ## Running the Sample<a name="sample-python-hw-running"></a>
 
@@ -111,7 +111,7 @@ if __name__ == '__main__':
   unittest.main()
 ```
 
-## Related Resources<a name="w3ab1b9c54c33c17"></a>
+## Related Resources<a name="w3ab1b9c52c33c17"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-ruby-hw.md b/doc_source/sample-ruby-hw.md
@@ -12,7 +12,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-ruby-hw-running)
 + [Directory Structure](#sample-ruby-hw-dir)
 + [Files](#sample-ruby-hw-files)
-+ [Related Resources](#w3ab1b9c54c35c17)
++ [Related Resources](#w3ab1b9c52c35c17)
 
 ## Running the Sample<a name="sample-ruby-hw-running"></a>
 
@@ -118,7 +118,7 @@ describe HelloWorld do
 end
 ```
 
-## Related Resources<a name="w3ab1b9c54c35c17"></a>
+## Related Resources<a name="w3ab1b9c52c35c17"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-scala-hw.md b/doc_source/sample-scala-hw.md
@@ -9,7 +9,7 @@ Running this sample may result in charges to your AWS account\. These include po
 + [Running the Sample](#sample-scala-hw-running)
 + [Directory Structure](#sample-scala-hw-dir)
 + [Files](#sample-scala-hw-files)
-+ [Related Resources](#w3ab1b9c54c37c15)
++ [Related Resources](#w3ab1b9c52c37c15)
 
 ## Running the Sample<a name="sample-scala-hw-running"></a>
 
@@ -185,7 +185,7 @@ object MyBuild extends Build {
 sbt.version=0.13.7
 ```
 
-## Related Resources<a name="w3ab1b9c54c37c15"></a>
+## Related Resources<a name="w3ab1b9c52c37c15"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/sample-war-hw.md b/doc_source/sample-war-hw.md
@@ -113,7 +113,7 @@ If you are using an Amazon S3 input bucket, be sure to create a ZIP file that co
 
 1. Download the `WebArchiveHelloWorldOutputArtifact.zip` file to your local computer or instance, and then extract the contents of the file\. In the extracted contents, open the `target` folder to get the `my-web-app.war` file\. 
 
-## Related Resources<a name="w3ab1b9c54c39b9"></a>
+## Related Resources<a name="w3ab1b9c52c39b9"></a>
 + For more information about getting started with AWS CodeBuild, see [Getting Started with AWS CodeBuild](getting-started.md)\.
 + For more information about troubleshooting problems with AWS CodeBuild, see [Troubleshooting AWS CodeBuild](troubleshooting.md)\.
 + For more information about limits in AWS CodeBuild, see [Limits for AWS CodeBuild](limits.md)\.
diff --git a/doc_source/samples.md b/doc_source/samples.md
@@ -1,18 +1,6 @@
 # AWS CodeBuild Samples<a name="samples"></a>
 
-These use case\-based samples can be used to experiment with AWS CodeBuild:
-
-**Note**  
- You can test and debug builds on a local machine with the AWS CodeBuild agent\. To use the agent:   
-
-```
-docker run -it -v /var/run/docker.sock:/var/run/docker.sock -e \
-        "IMAGE_NAME=amazon/aws-codebuild-local" -e \
-        "ARTIFACTS=absolute-path-to-your-artifact-output-directory" -e \
-        "SOURCE=absolute-path-to-your-source-directory" name-of-the-agent -e \
-        "BUILDSPEC=absolute-or-relative-path-to-your-buildspec-file"
-```
- The agent is available from [https://hub\.docker\.com/r/amazon/aws\-codebuild\-local/](https://hub.docker.com/r/amazon/aws-codebuild-local/) and its current SHA is `2fe3f77c8b580b82709e7f5f576313418eac2e5217a1da130ab1a8fb396f3ab2`\. You can use the SHA to identify the version of the agent\. 
+ These use case\-based samples can be used to experiment with AWS CodeBuild: 
 
 
 ****  
diff --git a/doc_source/use-codebuild-agent.md b/doc_source/use-codebuild-agent.md
