diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ac4b59..8e08b1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,13 +25,13 @@ We look forward to receiving your pull requests for: To contribute, send us a pull request. For small changes, such as fixing a typo or adding a link, you can use the [GitHub Edit Button](https://blog.github.com/2011-04-26-forking-with-the-edit-button/). For larger changes: 1. [Fork the repository](https://help.github.com/articles/fork-a-repo/). -2. In your fork, make your change in a branch that's based on this repo's **master** branch. +2. In your fork, make your change in a branch that's based on this repo's **main** branch. 3. Commit the change to your fork, using a clear and descriptive commit message. 4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/), answering any questions in the pull request form. Before you send us a pull request, please be sure that: -1. You're working from the latest source on the **master** branch. +1. You're working from the latest source on the **main** branch. 2. You check [existing open](https://github.com/awsdocs/aws-codebuild-user-guide/pulls), and [recently closed](https://github.com/awsdocs/aws-codebuild-user-guide/pulls?q=is%3Apr+is%3Aclosed), pull requests to be sure that someone else hasn't already addressed the problem. 3. You [create an issue](https://github.com/awsdocs/aws-codebuild-user-guide/issues/new) before working on a contribution that will take a significant amount of your time. @@ -53,4 +53,4 @@ If you discover a potential security issue, please notify AWS Security via our [ ## Licensing -See the [LICENSE](https://github.com/awsdocs/aws-codebuild-user-guide/blob/master/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. +See the [LICENSE](https://github.com/awsdocs/aws-codebuild-user-guide/blob/main/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. diff --git a/README.md b/README.md index 32fd39f..a02f592 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ -## AWS CodeBuild User Guide +# NOTICE -The open source version of the AWS CodeBuild docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request. +This repository is archived, read-only, and no longer updated. For more information, read [the announcement on the AWS News Blog](https://aws.amazon.com/blogs/aws/retiring-the-aws-documentation-on-github/). -## License Summary - -The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file. - -The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file. +You can find up-to-date AWS technical documentation on the [AWS Documentation website](https://docs.aws.amazon.com/), where you can also submit feedback and suggestions for improvement. diff --git a/doc_source/advanced-topics.md b/doc_source/advanced-topics.md deleted file mode 100644 index 69c0201..0000000 --- a/doc_source/advanced-topics.md +++ /dev/null @@ -1,9 +0,0 @@ -# Advanced Topics - -This section includes several advanced topics that are useful to more experienced AWS CodeBuild users\. - -**Topics** -+ [Advanced Setup](setting-up.md) -+ [Command Line Reference for CodeBuild](cmd-ref.md) -+ [AWS SDKs and Tools Reference for CodeBuild](sdk-ref.md) -+ [Specify the CodeBuild Endpoint](endpoint-specify.md) \ No newline at end of file diff --git a/doc_source/auth-and-access-control-iam-access-control-identity-based.md b/doc_source/auth-and-access-control-iam-access-control-identity-based.md deleted file mode 100644 index fbbc6a0..0000000 --- a/doc_source/auth-and-access-control-iam-access-control-identity-based.md +++ /dev/null @@ -1,108 +0,0 @@ -# Overview of Managing Access Permissions to Your CodeBuild Resources - -Every AWS resource is owned by an AWS account, and permissions to create or access a resource are governed by permissions policies\. An account administrator can attach permissions policies to IAM identities \(that is, users, groups, and roles\)\. - -**Note** -An account administrator \(or administrator user\) is a user with administrator privileges\. For more information, see [IAM Best Practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) in the *IAM User Guide Guide*\. - -When you grant permissions, you decide who is getting the permissions, the resources they can access, and the actions that can be performed on those resources\. - -**Topics** -+ [CodeBuild Resources and Operations](#arn-formats) -+ [Understanding Resource Ownership](#understanding-resource-ownership) -+ [Managing Access to Resources](#managing-access-resources) -+ [Specifying Policy Elements: Actions, Effects, and Principals](#actions-effects-principals) - -## CodeBuild Resources and Operations - -In AWS CodeBuild, the primary resource is a build project\. In a policy, you use an Amazon Resource Name \(ARN\) to identify the resource the policy applies to\. Builds are also resources and have ARNs associated with them\. For more information, see [Amazon Resource Names \(ARN\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *Amazon Web Services General Reference*\. - - -| Resource type | ARN format | -| --- | --- | -| Build project | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| Build | `arn:aws:codebuild:region-ID:account-ID:build/build-ID` | -| All CodeBuild resources | `arn:aws:codebuild:*` | -| All CodeBuild resources owned by the specified account in the specified region | `arn:aws:codebuild:region-ID:account-ID:*` | - -**Note** -Most AWS services treat a colon \(:\) or a forward slash \(/\) as the same character in ARNs\. However, CodeBuild uses an exact match in resource patterns and rules\. Be sure to use the correct characters when you create event patterns so that they match the ARN syntax in the resource\. - -For example, you can indicate a specific build project \(*myBuildProject*\) in your statement using its ARN as follows: - -``` -"Resource": "arn:aws:codebuild:us-east-2:123456789012:project/myBuildProject" -``` - -To specify all resources, or if an API action does not support ARNs, use the wildcard character \(\*\) in the `Resource` element as follows: - -``` -"Resource": "*" -``` - -Some CodeBuild API actions accept multiple resources \(for example, `BatchGetProjects`\)\. To specify multiple resources in a single statement, separate their ARNs with commas, as follows: - -``` -"Resource": [ - "arn:aws:codebuild:us-east-2:123456789012:project/myBuildProject", - "arn:aws:codebuild:us-east-2:123456789012:project/myOtherBuildProject" -] -``` - -CodeBuild provides a set of operations to work with the CodeBuild resources\. For a list, see [CodeBuild Permissions Reference](auth-and-access-control-permissions-reference.md)\. - -## Understanding Resource Ownership - -The AWS account owns the resources that are created in the account, regardless of who created the resources\. Specifically, the resource owner is the AWS account of the [principal entity](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) \(that is, the root account, an IAM user, or an IAM role\) that authenticates the resource creation request\. The following examples illustrate how this works: -+ If you use the root account credentials of your AWS account to create a rule, your AWS account is the owner of the CodeBuild resource\. -+ If you create an IAM user in your AWS account and grant permissions to create CodeBuild resources to that user, the user can create CodeBuild resources\. However, your AWS account, to which the user belongs, owns the CodeBuild resources\. -+ If you create an IAM role in your AWS account with permissions to create CodeBuild resources, anyone who can assume the role can create CodeBuild resources\. Your AWS account, to which the role belongs, owns the CodeBuild resources\. - -## Managing Access to Resources - -A permissions policy describes who has access to which resources\. - -**Note** -This section discusses the use of IAM in AWS CodeBuild\. It doesn't provide detailed information about the IAM service\. For complete IAM documentation, see [What Is IAM?](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html) in the *IAM User Guide Guide*\. For information about IAM policy syntax and descriptions, see [AWS IAM Policy Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in the *IAM User Guide Guide*\. - -Policies attached to an IAM identity are referred to as identity\-based policies \(IAM policies\)\. Policies attached to a resource are referred to as resource\-based policies\. CodeBuild supports identity\-based \(IAM policies\) only\. - -### Identity\-Based Policies - -You can attach policies to IAM identities\. -+ **Attach a permissions policy to a user or a group in your account** – To grant a user permissions to view build projects and other AWS CodeBuild resources in the CodeBuild console, you can attach a permissions policy to a user or group that the user belongs to\. -+ **Attach a permissions policy to a role \(grant cross\-account permissions\)** – You can attach an identity\-based permissions policy to an IAM role to grant cross\-account permissions\. For example, the administrator in Account A can create a role to grant cross\-account permissions to another AWS account \(for example, Account B\) or an AWS service as follows: - - 1. Account A administrator creates an IAM role and attaches a permissions policy to the role that grants permissions on resources in Account A\. - - 1. Account A administrator attaches a trust policy to the role identifying Account B as the principal who can assume the role\. - - 1. Account B administrator can then delegate permissions to assume the role to any users in Account B\. Doing this allows users in Account B to create or access resources in Account A\. The principal in the trust policy must also be an AWS service principal if you want to grant an AWS service permissions to assume the role\. - - For more information about using IAM to delegate permissions, see [Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide Guide*\. - -In CodeBuild, identity\-based policies are used to manage permissions to the resources related to the deployment process\. For example, you can control access to build projects\. - -You can create IAM policies to restrict the calls and resources that users in your account have access to, and then attach those policies to IAM users\. For more information about how to create IAM roles and to explore example IAM policy statements for CodeBuild, see [Overview of Managing Access Permissions to Your CodeBuild Resources](#auth-and-access-control-iam-access-control-identity-based)\. - -### Secure Access to Amazon S3 Buckets - -We strongly recommend that you include the following permissions in your IAM role to verify the Amazon S3 bucket associated with your CodeBuild project is owned by you or someone you trust\. These permissions are not included in AWS managed policies and roles\. You must be add them yourself\. -+ `s3:GetBucketACL` -+ `s3:GetBucketLocation` - -If the owner of an Amazon S3 bucket used by your project changes, you must verify you still own the bucket and update permissions in your IAM role if not\. For more information, see [Add CodeBuild Access Permissions to an IAM Group or IAM User](setting-up.md#setting-up-service-permissions-group) and [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - -## Specifying Policy Elements: Actions, Effects, and Principals - -For each AWS CodeBuild resource, the service defines a set of API operations\. To grant permissions for these API operations, CodeBuild defines a set of actions that you can specify in a policy\. Some API operations can require permissions for more than one action in order to perform the API operation\. For more information, see [CodeBuild Resources and Operations](#arn-formats) and [CodeBuild Permissions Reference](auth-and-access-control-permissions-reference.md)\. - -The following are the basic policy elements: -+ **Resource** – You use an Amazon Resource Name \(ARN\) to identify the resource that the policy applies to\. -+ **Action** – You use action keywords to identify resource operations you want to allow or deny\. For example, the `codebuild:CreateProject` permission gives the user permissions to perform the `CreateProject` operation\. -+ **Effect** – You specify the effect, either allow or deny, when the user requests the action\. If you don't explicitly grant access to \(allow\) a resource, access is implicitly denied\. You can also explicitly deny access to a resource\. You might do this to make sure a user cannot access a resource, even if a different policy grants access\. -+ **Principal** – In identity\-based policies \(IAM policies\), the user the policy is attached to is the implicit principal\. For resource\-based policies, you specify the user, account, service, or other entity that you want to receive permissions\. - -To learn more about IAM policy syntax and descriptions, see [AWS IAM Policy Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in the *IAM User Guide Guide*\. - -For a table showing all of the CodeBuild API actions and the resources they apply to, see the [CodeBuild Permissions Reference](auth-and-access-control-permissions-reference.md)\. \ No newline at end of file diff --git a/doc_source/auth-and-access-control-iam-identity-based-access-control.md b/doc_source/auth-and-access-control-iam-identity-based-access-control.md deleted file mode 100644 index e242db5..0000000 --- a/doc_source/auth-and-access-control-iam-identity-based-access-control.md +++ /dev/null @@ -1,368 +0,0 @@ -# Using Identity\-Based Policies for CodeBuild - -This topic provides examples of identity\-based policies that demonstrate how an account administrator can attach permissions policies to IAM identities \(that is, users, groups, and roles\) and thereby grant permissions to perform operations on AWS CodeBuild resources\. - -**Important** -We recommend that you first review the introductory topics that explain the basic concepts and options available to manage access to your CodeBuild resources\. For more information, see [Overview of Managing Access Permissions to Your CodeBuild Resources](auth-and-access-control-iam-access-control-identity-based.md)\. - -**Topics** -+ [Permissions Required to Use the CodeBuild Console](#console-permissions) -+ [Permissions Required for the CodeBuild Console to Connect to Source Providers](#console-policies) -+ [AWS Managed \(Predefined\) Policies for CodeBuild](#managed-policies) -+ [Customer\-Managed Policy Examples](#customer-managed-policies) - -The following shows an example of a permissions policy that allows a user to get information about build projects only in the `us-east-2` region for account `123456789012` for any build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:BatchGetProjects", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -## Permissions Required to Use the CodeBuild Console - -A user who uses the AWS CodeBuild console must have a minimum set of permissions that allows the user to describe other AWS resources for the AWS account\. You must have permissions from the following services: -+ AWS CodeBuild -+ Amazon CloudWatch -+ CodeCommit \(if you are storing your source code in an AWS CodeCommit repository\) -+ Amazon Elastic Container Registry \(Amazon ECR\) \(if you are using a build environment that relies on a Docker image in an Amazon ECR repository\) -+ Amazon Elastic Container Service \(Amazon ECS\) \(if you are using a build environment that relies on a Docker image in an Amazon ECR repository\) -+ AWS Identity and Access Management \(IAM\) -+ AWS Key Management Service \(AWS KMS\) -+ Amazon Simple Storage Service \(Amazon S3\) - -If you create an IAM policy that is more restrictive than the minimum required permissions, the console won't function as intended\. - -## Permissions Required for the CodeBuild Console to Connect to Source Providers - -The AWS CodeBuild console uses the following API actions to connect to source providers \(for example, GitHub repositories\)\. -+ `codebuild:ListConnectedOAuthAccounts` -+ `codebuild:ListRepositories` -+ `codebuild:PersistOAuthToken` -+ `codebuild:ImportSourceCredentials` - -You can associate source providers \(such as GitHub repositories\) with your build projects using the CodeBuild console\. To do this, you must first add the preceding API actions to IAM access policies associated with the IAM user you use to access the CodeBuild console\. - -The `ListConnectedOAuthAccounts`, `ListRepositories`, and `PersistOAuthToken` API actions are not intended to be called by your code\. Therefore, these API actions are not included in the AWS CLI and AWS SDKs\. - -## AWS Managed \(Predefined\) Policies for CodeBuild - -AWS addresses many common use cases by providing standalone IAM policies that are created and administered by AWS\. These AWS managed policies grant necessary permissions for common use cases so you can avoid having to investigate what permissions are needed\. For more information, see [AWS Managed Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) in the *IAM User Guide*\. - -The following AWS managed policies, which you can attach to users in your account, are specific to AWS CodeBuild\. -+ **AWSCodeBuildAdminAccess** – Provides full access to CodeBuild including permissions to administrate CodeBuild build projects\. -+ **AWSCodeBuildDeveloperAccess** – Provides access to CodeBuild but does not allow build project administration\. -+ **AWSCodeBuildReadOnlyAccess** – Provides read\-only access to CodeBuild\. - -To access build output artifacts that CodeBuild creates, you must also attach the AWS managed policy named **AmazonS3ReadOnlyAccess**\. - -To create and manage CodeBuild service roles, you must also attach the AWS managed policy named **IAMFullAccess**\. - -You can also create your own custom IAM policies to allow permissions for CodeBuild actions and resources\. You can attach these custom policies to the IAM users or groups that require those permissions\. - -## Customer\-Managed Policy Examples - -In this section, you can find example user policies that grant permissions for AWS CodeBuild actions\. These policies work when you are using the CodeBuild API, AWS SDKs, or AWS CLI\. When you are using the console, you must grant additional permissions specific to the console\. For information, see [Permissions Required to Use the CodeBuild Console](#console-permissions)\. - -You can use the following sample IAM policies to limit CodeBuild access for your IAM users and roles\. - -**Topics** -+ [Allow a User to Get Information About Build Projects](#customer-managed-policies-example-batch-get-projects) -+ [Allow a User to Create Build Projects](#customer-managed-policies-example-create-project) -+ [Allow a User to Delete Build Projects](#customer-managed-policies-example-delete-project) -+ [Allow a User to Get a List of Build Project Names](#customer-managed-policies-example-list-projects) -+ [Allow a User to Change Information About Build Projects](#customer-managed-policies-example-update-project) -+ [Allow a User to Get Information About Builds](#customer-managed-policies-example-batch-get-builds) -+ [Allow a User to Get a List of Build IDs for a Build Project](#customer-managed-policies-example-list-builds-for-project) -+ [Allow a User to Get a List of Build IDs](#customer-managed-policies-example-list-builds) -+ [Allow a User to Begin Running Builds](#customer-managed-policies-example-start-build) -+ [Allow a User to Attempt to Stop Builds](#customer-managed-policies-example-stop-build) -+ [Allow a User to Attempt to Delete Builds](#customer-managed-policies-example-delete-builds) -+ [Allow a User to Get Information About Docker Images That Are Managed by CodeBuild](#customer-managed-policies-example-list-curated-environment-images) -+ [Allow CodeBuild Access to AWS Services Required to Create a VPC Network Interface](#customer-managed-policies-example-create-vpc-network-interface) -+ [Use a Deny Statement to Prevent CodeBuild from Disconnecting from Source Providers](#customer-managed-policies-example-deny-disconnect) - -### Allow a User to Get Information About Build Projects - -The following example policy statement allows a user to get information about build projects only in the `us-east-2` region for account `123456789012` for any build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:BatchGetProjects", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -### Allow a User to Create Build Projects - -The following example policy statement allows a user to create build projects with any name but only in the `us-east-2` region for account `123456789012` and using only the specified CodeBuild service role: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:CreateProject", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/*" - }, - { - "Effect": "Allow", - "Action": "iam:PassRole", - "Resource": "arn:aws:iam:123456789012:role/CodeBuildServiceRole" - } - ] -} -``` - -### Allow a User to Delete Build Projects - -The following example policy statement allows a user to delete build projects only in the `us-east-2` region for account `123456789012` for any build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:DeleteProject", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -### Allow a User to Get a List of Build Project Names - -The following example policy statement allows a user to get a list of build project names for the same account: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:ListProjects", - "Resource": "*" - } - ] -} -``` - -### Allow a User to Change Information About Build Projects - -The following example policy statement allows a user to change information about build projects with any name but only in the `us-east-2` region for account `123456789012` and using only the specified AWS CodeBuild service role: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:UpdateProject", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/*" - }, - { - "Effect": "Allow", - "Action": "iam:PassRole", - "Resource": "arn:aws:iam:123456789012:role/CodeBuildServiceRole" - } - ] -} -``` - -### Allow a User to Get Information About Builds - -The following example policy statement allows a user to get information about builds only in the `us-east-2` region for account `123456789012` for the build projects named `my-build-project` and `my-other-build-project`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:BatchGetBuilds", - "Resource": [ - "arn:aws:codebuild:us-east-2:123456789012:project/my-build-project", - "arn:aws:codebuild:us-east-2:123456789012:project/my-other-build-project" - ] - } - ] -} -``` - -### Allow a User to Get a List of Build IDs for a Build Project - -The following example policy statement allows a user to get a list of build IDs only in the `us-east-2` region for account `123456789012` for the build projects named `my-build-project` and `my-other-build-project`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:ListBuildsForProject", - "Resource": [ - "arn:aws:codebuild:us-east-2:123456789012:project/my-build-project", - "arn:aws:codebuild:us-east-2:123456789012:project/my-other-build-project" - ] - } - ] -} -``` - -### Allow a User to Get a List of Build IDs - -The following example policy statement allows a user to get a list of all build IDs for the same account: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:ListBuilds", - "Resource": "*" - } - ] -} -``` - -### Allow a User to Begin Running Builds - -The following example policy statement allows a user to run builds only in the `us-east-2` region for account `123456789012` for build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:StartBuild", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -### Allow a User to Attempt to Stop Builds - -The following example policy statement allows a user to attempt to stop running builds only in the `us-east-2` region for account `123456789012` for any build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:StopBuild", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -### Allow a User to Attempt to Delete Builds - -The following example policy statement allows a user to attempt to delete builds only in the `us-east-2` region for account `123456789012` for any build project that starts with the name `my`: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:BatchDeleteBuilds", - "Resource": "arn:aws:codebuild:us-east-2:123456789012:project/my*" - } - ] -} -``` - -### Allow a User to Get Information About Docker Images That Are Managed by CodeBuild - -The following example policy statement allows a user to get information about all Docker images that are managed by CodeBuild: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": "codebuild:ListCuratedEnvironmentImages", - "Resource": "*" - } - ] -} -``` - -### Allow CodeBuild Access to AWS Services Required to Create a VPC Network Interface - -The following example policy statement grants AWS CodeBuild permission to create a network interface in an Amazon VPC with two subnets: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ec2:CreateNetworkInterface", - "ec2:DescribeDhcpOptions", - "ec2:DescribeNetworkInterfaces", - "ec2:DeleteNetworkInterface", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:DescribeVpcs" - ], - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "ec2:CreateNetworkInterfacePermission" - ], - "Resource": "arn:aws:ec2:region:account-id:network-interface/*", - "Condition": { - "StringEquals": { - "ec2:Subnet": [ - "arn:aws:ec2:region:account-id:subnet/subnet-id-1", - "arn:aws:ec2:region:account-id:subnet/subnet-id-2" - ], - "ec2:AuthorizedService": "codebuild.amazonaws.com" - } - } - } - ] -} -``` - -### Use a Deny Statement to Prevent CodeBuild from Disconnecting from Source Providers - - The following example policy statement uses a deny statement to prevent AWS CodeBuild from disconnecting from source providers\. It uses `codebuild:DeleteOAuthToken`, which is the inverse of `codebuild:PersistOAuthToken` and `codebuild:ImportSourceCredentials`, to connect with source providers\. For more information, see [Permissions Required for the CodeBuild Console to Connect to Source Providers](#console-policies)\. - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Deny", - "Action": "codebuild:DeleteOAuthToken", - "Resource": "*" - } - ] -} -``` \ No newline at end of file diff --git a/doc_source/auth-and-access-control-permissions-reference.md b/doc_source/auth-and-access-control-permissions-reference.md deleted file mode 100644 index ea18725..0000000 --- a/doc_source/auth-and-access-control-permissions-reference.md +++ /dev/null @@ -1,42 +0,0 @@ -# CodeBuild Permissions Reference - -You can use the following table as a reference when you are setting up [Access Control](auth-and-access-control.md#access-control) and writing permissions policies that you can attach to an IAM identity \(identity\-based policies\)\. - -You can use AWS\-wide condition keys in your AWS CodeBuild policies to express conditions\. For a list, see [Available Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#AvailableKeys) in the *IAM User Guide*\. - -You specify the actions in the policy's `Action` field\. To specify an action, use the `codebuild:` prefix followed by the API operation name \(for example, `codebuild:CreateProject` and `codebuild:StartBuild`\)\. To specify multiple actions in a single statement, separate them with commas \(for example, `"Action": [ "codebuild:CreateProject", "codebuild:StartBuild" ]`\)\. - -**Using Wildcard Characters** - -You specify an ARN, with or without a wildcard character \(\*\), as the resource value in the policy's `Resource` field\. You can use a wildcard to specify multiple actions or resources\. For example, `codebuild:*` specifies all CodeBuild actions and `codebuild:Batch*` specifies all CodeBuild actions that begin with the word `Batch`\. The following example grants access to all build project with names that begin with `my`: - -``` -arn:aws:codebuild:us-east-2:123456789012:project/my* -``` - -If you see an expand arrow \(**↗**\) in the upper\-right corner of the table, you can open the table in a new window\. To close the window, choose the close button \(**X**\) in the lower\-right corner\. - - -**CodeBuild API Operations and Required Permissions for Actions** - -| AWS CodeBuild API operations | Required permissions \(API actions\) | Resources | -| --- | --- | --- | -| BatchDeleteBuilds | `codebuild:BatchDeleteBuilds` Required to delete builds\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| BatchGetBuilds | `codebuild:BatchGetBuilds` Required to get information about builds\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| BatchGetProjects | `codebuild:BatchGetProjects` Required to get information about build projects\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| CreateProject | `codebuild:CreateProject` `iam:PassRole` Required to create build projects\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` `arn:aws:iam:account-ID:role/role-name` | -| CreateWebhook | `codebuild:CreateWebhook` Required to create a webhook\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| DeleteProject | `codebuild:DeleteProject` Required to delete build projects\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| DeleteSourceCredentials | `codebuild:DeleteSourceCredentials` Required to delete a set of `SourceCredentialsInfo` objects that contain information about credentials for a GitHub, GitHub Enterprise, or Bitbucket repository\. | `*` | -| DeleteWebhook | `codebuild:DeleteWebhook` Required to delete a webhook\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| ImportSourceCredentials | `codebuild:ImportSourceCredentials` Required to import a set of `SourceCredentialsInfo` objects that contain information about credentials for a GitHub, GitHub Enterprise, or Bitbucket repository\. | `*` | -| InvalidateProjectCache | `codebuild:InvalidateProjectCache` Required to reset the cache for a project\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| ListBuilds | codebuild:ListBuildsRequired to get a list of build IDs\. | `*` | -| ListBuildsForProject | `codebuild:ListBuildsForProject` Required to get a list of build IDs for a build project\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| ListCuratedEnvironmentImages | `codebuild:ListCuratedEnvironmentImages` Required to get information about all Docker images that are managed by CodeBuild\. | `*` \(required, but does not refer to an addressable AWS resource\) | -| ListSourceCredentials | `codebuild:ListSourceCredentials` Required to get a list of `SourceCredentialsInfo` objects that contain information about credentials for a GitHub, GitHub Enterprise, or Bitbucket repository\. | `*` | -| ListProjects | `codebuild:ListProjects` Required to get a list of build project names\. | `*` | -| StartBuild | `codebuild:StartBuild` Required to start running builds\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| StopBuild | `codebuild:StopBuild` Required to attempt to stop running builds\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | -| UpdateProject | `codebuild:UpdateProject` `iam:PassRole` Required to change information about builds\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` `arn:aws:iam:account-ID:role/role-name` | -| UpdateWebhook | `codebuild:UpdateWebhook` Required to update a webhook\. | `arn:aws:codebuild:region-ID:account-ID:project/project-name` | \ No newline at end of file diff --git a/doc_source/auth-and-access-control.md b/doc_source/auth-and-access-control.md deleted file mode 100644 index c34a0f8..0000000 --- a/doc_source/auth-and-access-control.md +++ /dev/null @@ -1,30 +0,0 @@ -# Identity and Access Management in CodeBuild - -Access to AWS CodeBuild requires credentials\. Those credentials must have permissions to access AWS resources, such as storing and retrieving build artifacts in Amazon S3 buckets and viewing Amazon CloudWatch Logs for builds\. The following sections describe how you can use [AWS Identity and Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html) \(IAM\) and CodeBuild to help secure access to your resources: -+ [Authentication](#authentication) -+ [Access Control](#access-control) - -## Authentication - -You can access AWS as any of the following types of identities: -+ **AWS account root user** – When you sign up for AWS, you provide an email address and password that is associated with your AWS account\. These are your *root credentials* and they provide complete access to all of your AWS resources\. -**Important** -For security reasons, we recommend that you use the root credentials only to create an administrator user, which is an IAM user with full permissions to your AWS account\. Then, you can use this administrator user to create other IAM users and roles with limited permissions\. For more information, see [IAM Best Practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users) and [Creating an Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide Guide*\. -+ **IAM user** – An [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) is simply an identity in your AWS account that has custom permissions \(for example, permission to create build projects in CodeBuild\)\. You can use an IAM user name and password to sign in to secure AWS webpages like the [AWS Management Console](https://console.aws.amazon.com/), [AWS Discussion Forums](https://forums.aws.amazon.com/), or the [AWS Support Center](https://console.aws.amazon.com/support/home#/)\. - - In addition to a user name and password, you can also generate [access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for each user\. You can use these keys when you access AWS services programmatically, either through [one of the AWS SDKs](https://aws.amazon.com/tools/) or by using the [AWS Command Line Interface \(AWS CLI\)](https://aws.amazon.com/cli/)\. The AWS SDKs and AWS CLI tools use the access keys to cryptographically sign your request\. If you don’t use the AWS tools, you must sign the request yourself\. CodeBuild supports Signature Version 4, a protocol for authenticating inbound API requests\. For more information about authenticating requests, see the [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*\. -+ **IAM role** – An [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) is similar to an IAM user, but it is not associated with a specific person\. An IAM role enables you to obtain temporary access keys that can be used to access AWS services and resources\. IAM roles with temporary credentials are useful in the following situations: - + **Federated user access** – Instead of creating an IAM user, you can use preexisting user identities from AWS Directory Service, your enterprise user directory, or a web identity provider\. These are known as federated users\. AWS assigns a role to a federated user when access is requested through an [identity provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers.html)\. For more information about federated users, see [Federated Users and Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_access-management.html#intro-access-roles) in the *IAM User Guide Guide*\. - + **Cross\-account access** – You can use an IAM role in your account to grant another AWS account permissions to access your account’s resources\. For an example, see [Tutorial: Delegate Access Across AWS Accounts Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the *IAM User Guide Guide*\. - + **AWS service access** – You can use an IAM role in your account to grant permissions to an AWS service to access your account’s resources\. For example, you can create a role that allows Amazon Redshift to access an Amazon S3 bucket on your behalf and then load data stored in the bucket into an Amazon Redshift cluster\. For more information, see [Creating a Role to Delegate Permissions to an AWS Service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide Guide*\. - + **Applications running on Amazon EC2** – Instead of storing access keys in the Amazon EC2 instance for use by applications running on the instance and making AWS API requests, you can use an IAM role to manage temporary credentials for these applications\. To assign an AWS role to an Amazon EC2 instance and make it available to all of its applications, you can create an instance profile that is attached to the instance\. An instance profile contains the role and enables programs running on the Amazon EC2 instance to get temporary credentials\. For more information, see [Using Roles for Applications on Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) in the *IAM User Guide Guide*\. - -## Access Control - -You can have valid credentials to authenticate your requests, but unless you have permissions, you cannot create or access AWS CodeBuild resources\. For example, you must have permissions to create, view, or delete build projects and to start, stop, or view builds\. - -The following sections describe how to manage permissions for CodeBuild\. We recommend that you read the overview first\. -+ [Overview of Managing Access Permissions to Your CodeBuild Resources](auth-and-access-control-iam-access-control-identity-based.md) -+ [Using Identity\-Based Policies for CodeBuild](auth-and-access-control-iam-identity-based-access-control.md) -+ [CodeBuild Permissions Reference](auth-and-access-control-permissions-reference.md) -+ [Viewing Resources in the Console](console-resources.md) \ No newline at end of file diff --git a/doc_source/build-caching.md b/doc_source/build-caching.md deleted file mode 100644 index 3142863..0000000 --- a/doc_source/build-caching.md +++ /dev/null @@ -1,104 +0,0 @@ -# Build Caching in CodeBuild - - You can save time when your project builds by using a cache\. A cache can store reusable pieces of your build environment and use them across multiple builds\. Your build project can use one of two types of caching: Amazon S3 or local\. If you use a local cache, you must choose one or more of three cache modes: source cache, Docker layer cache, and custom cache\. - -**Note** -Docker layer cache mode is available for the Linux environment only\. If you choose this mode, you must run your build in privileged mode\. - -**Topics** -+ [Amazon S3 Caching](#caching-s3) -+ [Local Caching](#caching-local) - -## Amazon S3 Caching - - Amazon S3 caching stores the cache in an Amazon S3 bucket that is available across multiple build hosts\. This is a good option for small intermediate build artifacts that are more expensive to build than to download\. This is not the best option for large build artifacts because they can take a long time to tranfer over your network, which can affect build performance\. - -## Local Caching - - Local caching stores a cache locally on a build host that is available to that build host only\. This is a good option for large intermediate build artifacts because the cache is immediately available on the build host\. This means that build performance is not impacted by network transfer time\. If you choose local caching, you must choose one or more of the following cache modes: -+ Source cache mode caches Git metadata for primary and secondary sources\. After the cache is created, subsequent builds pull only the change between commits\. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository\. If you choose this option and your project does not use a Git repository \(GitHub, GitHub Enterprise, or Bitbucket\), the option is ignored\. -+ Docker layer cache mode caches existing Docker layers\. This mode is a good choice for projects that build or pull large Docker images\. It can prevent the performance issues caused by pulling large Docker images down from the network\. -**Note** - You can use a Docker layer cache in the Linux environment only\. - The `privileged` flag must be set so that your project has the required Docker permissions\. - You should consider the security implications before you use a Docker layer cache\. -+ Custom cache mode caches directories you specify in the buildspec file\. This mode is a good choice if your build scenario is not suited to one of the other two local cache modes\. If you use a custom cache: - + Only directories can be specified for caching\. You cannot specify individual files\. - + Symlinks are used to reference cached directories\. - + Cached directories are linked to your build before it downloads its project sources\. Cached items are overriden if a source item has the same name\. Directories are specified using cache paths in the buildspec file\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -**Topics** -+ [Specify Local Caching \(CLI\)](#caching-local-cli) -+ [Specify Local Caching \(Console\)](#caching-local-console) -+ [Specify Local Caching \(AWS CloudFormation\)](#caching-local-cfn) - - You can use the AWS CLI, console, SDK, or AWS CloudFormation to specify a local cache\. - -### Specify Local Caching \(CLI\) - - You can use the the `--cache` parameter in the AWS CLI to specify each of the three local cache types\. -+ To specify a source cache: - - ``` - --cache type=Local,mode=[LOCAL_SOURCE_CACHE] - ``` -+ To specify a Docker layer cache: - - ``` - --cache type=Local,mode=[LOCAL_DOCKER_LAYER_CACHE] - ``` -+ To specify a custom cache: - - ``` - --cache type=Local,mode=[LOCAL_CUSTOM_CACHE] - ``` - -For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -### Specify Local Caching \(Console\) - -You specify a cache in the **Artifacts** section of the console\. For ** Cache type**, choose **Amazon S3** or **Local**\. If you choose **Local**, choose one or more of the three local cache options\. The following shows how to choose a local cache\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/local-cache.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - -### Specify Local Caching \(AWS CloudFormation\) - - If you use AWS CloudFormation to specify a local cache, on the `Cache` property, for `Type`, you specify `LOCAL`\. The following sample YAML\-formatted AWS CloudFormation code specifies all three local cache types\. You can specify any combination of the types\. If you use a Docker layer cache, under `Environment`, you must set `PrivilegedMode` to `true` and `Type` to `LINUX_CONTAINER`\. - -``` -CodeBuildProject: - Type: AWS::CodeBuild::Project - Properties: - Name: MyProject - ServiceRole: service-role - Artifacts: - Type: S3 - Location: myBucket - Name: myArtifact - EncryptionDisabled: true - OverrideArtifactName: true - Environment: - Type: LINUX_CONTAINER - ComputeType: BUILD_GENERAL1_SMALL - Image: aws/codebuild/standard:2.0 - Certificate: bucket/cert.zip - # PrivilegedMode must be true if you specify LOCAL_DOCKER_LAYER_CACHE - PrivilegedMode: true - Source: - Type: GITHUB - Location: github-location - InsecureSsl: true - GitCloneDepth: 1 - ReportBuildStatus: false - TimeoutInMinutes: 10 - Cache: - Type: LOCAL - Modes: # You can specify one or more cache mode, - - LOCAL_CUSTOM_CACHE - - LOCAL_DOCKER_LAYER_CACHE - - LOCAL_SOURCE_CACHE -``` - -For more information, see [Create a Build Project \(AWS CloudFormation\)](create-project.md#create-project-cloud-formation)\. \ No newline at end of file diff --git a/doc_source/build-env-ref-available.md b/doc_source/build-env-ref-available.md deleted file mode 100644 index 96fb3d7..0000000 --- a/doc_source/build-env-ref-available.md +++ /dev/null @@ -1,57 +0,0 @@ -# Docker Images Provided by CodeBuild - -AWS CodeBuild manages the following Docker images that are available in the CodeBuild and AWS CodePipeline consoles\. - - -**** - -| Platform | Image identifier | Definition | -| --- | --- | --- | -| Amazon Linux 2 | aws/codebuild/amazonlinux2\-x86\_64\-standard:1\.0 | [al2/standard/1\.0](https://github.com/aws/aws-codebuild-docker-images/tree/master/al2/x86_64/standard/1.0) | -| Ubuntu 18\.04 | aws/codebuild/standard:1\.0 | [ubuntu/standard/1\.0](https://github.com/aws/aws-codebuild-docker-images/tree/master/ubuntu/standard/1.0) | -| Ubuntu 18\.04 | aws/codebuild/standard:2\.0 | [ubuntu/standard/2\.0](https://github.com/aws/aws-codebuild-docker-images/tree/master/ubuntu/standard/2.0) | -| Windows Server Core 2016 | aws/codebuild/windows\-base:1\.0 | N/A | -| Windows Server Core 2016 | aws/codebuild/windows\-base:2\.0 | N/A | - - The standard image of the Ubuntu 18\.04 and Amazon Linux 2 platforms contain the following runtimes\. If you use the Amazon Linux 2 standard image 1\.0 or the Ubuntu standard image 2\.0, you must specify your runtime in the `runtime-versions` section of your buildspec file\. For more information, see [Specify Runtime Versions in the Buildspec File](build-spec-ref.md#runtime-versions-buildspec-file)\. - - -| Runtime name | Version/versions | How to specify in the buildspec file | -| --- | --- | --- | -| android | 28 | android: 28 | -| docker | 18 | docker: 18 | -| dotnet | 2\.2 | dotnet: 2\.2 | -| golang | 1\.12 | golang: 1\.12 | -| nodejs | 8, 10 | nodejs: 8, nodejs: 10 | -| java \(Ubuntu only\) | openjdk8, openjdk11 | java: openjdk8, java: openjdk11 | -| corretto \(Amazon Linux 2 only\) | corretto8, corretto11 | java: corretto8, java: corretto11 | -| php | 7\.3 | php: 7\.3 | -| python | 3\.7 | python: 3\.7 | -| ruby | 2\.6 | ruby: 2\.6 | - - The base image of the Windows Server Core 2016 contains the following runtimes\. - - -| Runtime name | Version in `windows-base:1.0` | Version in `windows-base:2.0` | -| --- | --- | --- | -| dotnet | 2\.1 | 2\.2 | -| golang | 1\.11 | 1\.12 | -| nodejs | 9\.16 | 10\.16 | -| java | openjdk8 | openjdk11 | -| php | 7\.2 | 7\.3 | -| python | 3\.6 | 3\.7 | -| ruby | 2\.4 | 2\.6 | - -**Note** - The base image of the Windows Server Core 2016 platform is available in the US East \(N\. Virginia\), US East \(Ohio\), US West \(Oregon\), and EU \(Ireland\) regions only\. - -You can use a build specification to install other components \(for example, the AWS CLI, Apache Maven, Apache Ant, Mocha, RSpec, or similar\) during the `install` build phase\. For more information, see [Build Spec Example](build-spec-ref.md#build-spec-ref-example)\. - -CodeBuild frequently updates the list of Docker images\. To get the most current list, do one of the following: -+ In the CodeBuild console, in the **Create build project** wizard or **Edit Build Project** page, for **Environment image**, choose **Managed image**\. Choose from the **Operating system**, **Runtime**, and **Runtime version** drop\-down lists\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) or [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. -+ For the AWS CLI, run the `list-curated-environment-images` command: - - ``` - aws codebuild list-curated-environment-images - ``` -+ For the AWS SDKs, call the `ListCuratedEnvironmentImages` operation for your target programming language\. For more information, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/build-env-ref-background-tasks.md b/doc_source/build-env-ref-background-tasks.md deleted file mode 100644 index 4eae49b..0000000 --- a/doc_source/build-env-ref-background-tasks.md +++ /dev/null @@ -1,24 +0,0 @@ -# Background Tasks in Build Environments - -You can run background tasks in build environments\. To do this, in your buildspec, use the `nohup` command to run a command as a task in the background, even if the build process exits the shell\. Use the disown command to forcibly stop a running background task\. - -**Examples:** -+ Start a background process and wait for it to complete later: - - ``` - nohup sleep 30 & echo $! > pidfile - … - wait $(cat pidfile) - ``` -+ Start a background process and do not wait for it to ever complete: - - ``` - nohup sleep 30 & disown $! - ``` -+ Start a background process and kill it later: - - ``` - nohup sleep 30 & echo $! > pidfile - … - kill $(cat pidfile) - ``` \ No newline at end of file diff --git a/doc_source/build-env-ref-cmd.md b/doc_source/build-env-ref-cmd.md deleted file mode 100644 index a9cc258..0000000 --- a/doc_source/build-env-ref-cmd.md +++ /dev/null @@ -1,14 +0,0 @@ -# Shells and Commands in Build Environments - -You provide a set of commands for AWS CodeBuild to run in a build environment during the lifecycle of a build \(for example, installing build dependencies and testing and compiling your source code\)\. There are several ways to specify these commands: -+ Create a build specification file and include it with your source code\. In this file, specify the commands you want to run in each phase of the build lifecycle\. For more information, see the [Build Specification Reference for CodeBuild](build-spec-ref.md)\. -+ Use the CodeBuild console to create a build project\. In **Insert build commands**, for **Build commands**, enter the commands you want to run in the `build` phase\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. -+ Use the CodeBuild console to change the settings of a build project\. In **Insert build commands**, for **Build commands**, enter the commands you want to run in the `build` phase\. For more information, see [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. -+ Use the AWS CLI or AWS SDKs to create a build project or change the settings of a build project\. Reference the source code that contains a build spec file with your commands, or specify a single string that includes the contents of an equivalent build spec file\. For more information, see [Create a Build Project](create-project.md) or [Change a Build Project's Settings](change-project.md)\. -+ Use the AWS CLI or AWS SDKs to start a build, specifying a build spec file or a single string that includes the contents of an equivalent build spec file\. For more information, see the description for the `buildspecOverride` value in [Run a Build](run-build.md)\. - -You can specify any Shell command\. In build spec version 0\.1, CodeBuild runs each Shell command in a separate instance in the build environment\. This means that each command runs in isolation from all other commands\. Therefore, by default, you cannot run a single command that relies on the state of any previous commands \(for example, changing directories or setting environment variables\)\. To get around this limitation, we recommend that you use version 0\.2, which solves this issue\. If you must use version 0\.1, we recommend the following approaches: -+ Include a shell script in your source code that contains the commands you want to run in a single instance of the default shell\. For example, you could include a file named `my-script.sh` in your source code that contains commands such as `cd MyDir; mkdir -p mySubDir; cd mySubDir; pwd;`\. Then, in your build spec file, specify the command `./my-script.sh`\. -+ In your build spec file or on the **Build commands** setting for the `build` phase only, enter a single command that includes all of the commands you want to run in a single instance of the default shell \(for example, `cd MyDir && mkdir -p mySubDir && cd mySubDir && pwd`\)\. - -If CodeBuild encounters an error, the error might be more difficult to troubleshoot compared to running a single command in its own instance of the default shell\. \ No newline at end of file diff --git a/doc_source/build-env-ref-compute-types.md b/doc_source/build-env-ref-compute-types.md deleted file mode 100644 index db2733f..0000000 --- a/doc_source/build-env-ref-compute-types.md +++ /dev/null @@ -1,22 +0,0 @@ -# Build Environment Compute Types - -AWS CodeBuild provides build environments with the following available memory, vCPUs, and disk space: - - -**** - -| Compute type | computeType value | Memory | vCPUs | Disk space | Operating system | -| --- | --- | --- | --- | --- | --- | -| build\.general1\.small | BUILD\_GENERAL1\_SMALL | 3 GB | 2 | 64 GB | Linux | -| build\.general1\.medium | BUILD\_GENERAL1\_MEDIUM | 7 GB | 4 | 128 GB | Linux, Windows | -| build\.general1\.large | BUILD\_GENERAL1\_LARGE | 15 GB | 8 | 128 GB | Linux, Windows | - -**Note** -For custom build environment images, CodeBuild supports Docker images up to 20 GB uncompressed in Linux and 50 GB uncompressed in Windows, regardless of the compute type\. To check your build image's size, use Docker to run the `docker images REPOSITORY:TAG` command\. - -To choose a compute type: -+ In the CodeBuild console, in the **Create build project** wizard or **Edit Build Project** page, in **Environment** expand **Additional configuration**, and then choose one of the options from **Compute type**\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) or [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. -+ For the AWS CLI, run the `create-project` or `update-project` command, specifying the `computeType` value of the `environment` object\. For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli) or [Change a Build Project's Settings \(AWS CLI\)](change-project.md#change-project-cli)\. -+ For the AWS SDKs, call the equivalent of the `CreateProject` or `UpdateProject` operation for your target programming language, specifying the equivalent of `computeType` value of the `environment` object\. For more information, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. - -You can use Amazon EFS to access more space in your build container\. For more information, see [Amazon Elastic File System Sample for CodeBuild](sample-efs.md)\. If you want to manipulate container disk space during a build, then the build must run in privileged mode\. \ No newline at end of file diff --git a/doc_source/build-env-ref-env-vars.md b/doc_source/build-env-ref-env-vars.md deleted file mode 100644 index 083ac29..0000000 --- a/doc_source/build-env-ref-env-vars.md +++ /dev/null @@ -1,49 +0,0 @@ -# Environment Variables in Build Environments - -AWS CodeBuild provides several environment variables that you can use in your build commands: -+ `AWS_DEFAULT_REGION`: The AWS Region where the build is running \(for example, `us-east-1`\)\. This environment variable is used primarily by the AWS CLI\. -+ `AWS_REGION`: The AWS Region where the build is running \(for example, `us-east-1`\)\. This environment variable is used primarily by the AWS SDKs\. -+ `CODEBUILD_BUILD_ARN`: The Amazon Resource Name \(ARN\) of the build \(for example, `arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE`\)\. -+ `CODEBUILD_BUILD_ID`: The CodeBuild ID of the build \(for example, `codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE`\)\. -+ `CODEBUILD_BUILD_IMAGE`: The CodeBuild build image identifier \(for example, `aws/codebuild/standard:2.0`\)\. -+ `CODEBUILD_BUILD_SUCCEEDING`: Whether the current build is succeeding\. Set to `0` if the build is failing, or `1` if the build is succeeding\. -+ `CODEBUILD_INITIATOR`: The entity that started the build\. If CodePipeline started the build, this is the pipeline's name \(for example, `codepipeline/my-demo-pipeline`\)\. If an IAM user started the build, this is the user's name \(for example, `MyUserName`\)\. If the Jenkins plugin for CodeBuild started the build, this is the string `CodeBuild-Jenkins-Plugin`\. -+ `CODEBUILD_KMS_KEY_ID`: The identifier of the AWS KMS key that CodeBuild is using to encrypt the build output artifact \(for example, `arn:aws:kms:region-ID:account-ID:key/key-ID` or `alias/key-alias`\)\. -+ `CODEBUILD_LOG_PATH`: The log stream name in CloudWatch Logs for the build\. -+ `CODEBUILD_RESOLVED_SOURCE_VERSION`: An identifier for the version of a build's source code\. Its format depends on the source code repository: - + For CodeCommit, GitHub, GitHub Enterprise, and Bitbucket, it is the commit ID\. For these repositories, `CODEBUILD_RESOLVED_SOURCE_VERSION` is only available after the `DOWNLOAD_SOURCE` phase\. - + For CodePipeline, it is the source revision is provided by CodePipeline\. For CodePipeline, the `CODEBUILD_RESOLVED_SOURCE_VERSION` environment variable may not always be available\. - + For Amazon S3, this does not apply\. -+ `CODEBUILD_SOURCE_REPO_URL`: The URL to the input artifact or source code repository\. For Amazon S3, this is `s3://` followed by the bucket name and path to the input artifact\. For CodeCommit and GitHub, this is the repository's clone URL\. If a build originates from CodePipeline, then this might be empty\. -+ `CODEBUILD_SOURCE_VERSION`: The value's format depends on the source repository\. - + For Amazon S3,it is the version ID associated with the input artifact\. - + For CodeCommit, it is the commit ID or branch name associated with the version of the source code to be built\. - + For GitHub, GitHub Enterprise, and Bitbucket it is the commit ID, branch name, or tag name associated with the version of the source code to be built\. -**Note** -For a GitHub or GitHub Enterprise build that is triggered by a webhook pull request event, it is `pr/pull-request-number`\. -+ `CODEBUILD_SRC_DIR`: The directory path that CodeBuild uses for the build \(for example, `/tmp/src123456789/src`\)\. -**Note** -If you use a secondary source, the environment variable for its directory path is `CODEBUILD_SRC_DIR_sourceIdentifier`, where `sourceIdentifier` is the source identifier you create\. For more information, see [Multiple Input Sources and Output Artifacts Sample](sample-multi-in-out.md)\. -+ `CODEBUILD_START_TIME`: The start time of the build\. -+ `CODEBUILD_WEBHOOK_ACTOR_ACCOUNT_ID`: The account ID of the user that triggered the webhook event\. -+ `CODEBUILD_WEBHOOK_BASE_REF`: The base reference name of the webhook event that triggers the current build\. For a pull request, this is the branch reference\. -+ `CODEBUILD_WEBHOOK_EVENT`: The webhook event that triggers the current build\. -+ `CODEBUILD_WEBHOOK_HEAD_REF`: The head reference name of the webhook event that triggers the current build\. It can be a branch reference or a tag reference\. -+ `CODEBUILD_WEBHOOK_TRIGGER`: Shows the webhook event that triggered the build\. This variable is available only for builds triggered by a webhook\. The value is parsed from the payload sent to CodeBuild by Github, Github Enterprise, or Bitbucket\. The value's format depends on what type of event triggered the build\. - + For builds triggered by a pull request, it is `pr/pull-request-number`\. - + For builds triggered by creating a new branch or pushing a commit to a branch, it is `branch/branch-name`\. - + For builds triggered by a pushing a tag to a repository, it is `tag/tag-name`\. -+ `HOME`: This environment variable is always set to `/root`\. - -You can also provide build environments with your own environment variables\. For more information, see the following topics: -+ [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md) -+ [Create a Build Project](create-project.md) -+ [Change a Build Project's Settings](change-project.md) -+ [Run a Build](run-build.md) -+ [Build Spec Reference](build-spec-ref.md) - -To list all of the available environment variables in a build environment, you can run the `printenv` command \(for Linux\-based build environment\) or `"Get-ChildItem Env:"` \(for Windows\-based build environments\) during a build\. Except for those previously listed, environment variables that start with `CODEBUILD_` are for CodeBuild internal use\. They should not be used in your build commands\. - -**Important** -We strongly discourage the use of environment variables to store sensitive values, especially AWS access key IDs and secret access keys\. Environment variables can be displayed in plain text using tools such as the CodeBuild console and the AWS CLI\. -We recommend you store sensitive values in the Amazon EC2 Systems Manager Parameter Store and then retrieve them from your build spec\. To store sensitive values, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. To retrieve them, see the `parameter-store` mapping in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. \ No newline at end of file diff --git a/doc_source/build-env-ref.md b/doc_source/build-env-ref.md deleted file mode 100644 index 3e3fa2e..0000000 --- a/doc_source/build-env-ref.md +++ /dev/null @@ -1,19 +0,0 @@ -# Build Environment Reference for CodeBuild - -When you call AWS CodeBuild to run a build, you must provide information about the build environment\. A *build environment* represents a combination of operating system, programming language runtime, and tools that CodeBuild uses to run a build\. For information about how a build environment works, see [How CodeBuild Works](concepts.md#concepts-how-it-works)\. - -A build environment contains a Docker image\. For information, see [the Docker glossary](https://docs.docker.com/glossary/?term=image) on the Docker Docs website\. - -When you provide information to CodeBuild about the build environment, you specify the identifier of a Docker image in a supported repository type\. These include the CodeBuild Docker image repository, publicly available images in Docker Hub, and Amazon Elastic Container Registry \(Amazon ECR\) repositories that your AWS account has permissions to access\. -+ We recommend that you use Docker images stored in the CodeBuild Docker image repository, because they are optimized for use with the service\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. -+ To get the identifier of a publicly available Docker image stored in Docker Hub, see [Searching for Images](https://docs.docker.com/docker-hub/repos/#searching-for-images) on the Docker Docs website\. -+ To learn how to work with Docker images stored in Amazon ECR repositories in your AWS account, see [Amazon ECR Sample](sample-ecr.md)\. - -In addition to a Docker image identifier, you also specify a set of computing resources that the build environment uses\. For more information, see [Build Environment Compute Types](build-env-ref-compute-types.md)\. - -**Topics** -+ [Docker Images Provided by CodeBuild](build-env-ref-available.md) -+ [Build Environment Compute Types](build-env-ref-compute-types.md) -+ [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) \ No newline at end of file diff --git a/doc_source/build-spec-ref.md b/doc_source/build-spec-ref.md deleted file mode 100644 index b7ee331..0000000 --- a/doc_source/build-spec-ref.md +++ /dev/null @@ -1,417 +0,0 @@ -# Build Specification Reference for CodeBuild - -This topic provides important reference information about build specification \(build spec\) files\. A *build spec* is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build\. You can include a build spec as part of the source code or you can define a build spec when you create a build project\. For information about how a build spec works, see [How CodeBuild Works](concepts.md#concepts-how-it-works)\. - -**Topics** -+ [Build Spec File Name and Storage Location](#build-spec-ref-name-storage) -+ [Build Spec Syntax](#build-spec-ref-syntax) -+ [Build Spec Example](#build-spec-ref-example) -+ [Build Spec Versions](#build-spec-ref-versions) - -## Build Spec File Name and Storage Location - -If you include a build spec as part of the source code, by default, the build spec file must be named `buildspec.yml` and placed in the root of your source directory\. - -You can override the default build spec file name and location\. For example, you can: -+ Use a different build spec file for different builds in the same repository, such as `buildspec_debug.yml` and `buildspec_release.yml`\. -+ Store a build spec file somewhere other than the root of your source directory, such as `config/buildspec.yml`\. - -You can specify only one build spec for a build project, regardless of the build spec file's name\. - -To override the default build spec file name, location, or both, do one of the following: -+ Run the AWS CLI `create-project` or `update-project` command, setting the `buildspec` value to the path to the alternate build spec file relative to the value of the built\-in environment variable `CODEBUILD_SRC_DIR`\. You can also do the equivalent with the `create project` operation in the AWS SDKs\. For more information, see [Create a Build Project](create-project.md) or [Change a Build Project's Settings](change-project.md)\. -+ Run the AWS CLI `start-build` command, setting the `buildspecOverride` value to the path to the alternate build spec file relative to the value of the built\-in environment variable `CODEBUILD_SRC_DIR`\. You can also do the equivalent with the `start build` operation in the AWS SDKs\. For more information, see [Run a Build](run-build.md)\. -+ In an AWS CloudFormation template, set the `BuildSpec` property of `Source` in a resource of type `AWS::CodeBuild::Project` to the path to the alternate build spec file relative to the value of the built\-in environment variable `CODEBUILD_SRC_DIR`\. For more information, see the BuildSpec property in [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) in the *AWS CloudFormation User Guide*\. - -## Build Spec Syntax - -Build spec files must be expressed in [YAML](http://yaml.org/) format\. - -**Important** -If you use the Ubuntu standard image 2\.0 or later, or the Amazon Linux 2 \(AL2\) standard image 1\.0 or later, you must specify `runtime-versions` in your buildspec file\. For more information, see [Specify Runtime Versions in the Buildspec File](#runtime-versions-buildspec-file)\. - -The build spec has the following syntax: - -``` -version: 0.2 - -run-as: Linux-user-name - -env: - variables: - key: "value" - key: "value" - parameter-store: - key: "value" - key: "value" - git-credential-helper: yes - -phases: - install: - run-as: Linux-user-name - runtime-versions: - runtime: version - runtime: version - commands: - - command - - command - finally: - - command - - command - pre_build: - run-as: Linux-user-name - commands: - - command - - command - finally: - - command - - command - build: - run-as: Linux-user-name - commands: - - command - - command - finally: - - command - - command - post_build: - run-as: Linux-user-name - commands: - - command - - command - finally: - - command - - command -artifacts: - files: - - location - - location - name: artifact-name - discard-paths: yes - base-directory: location - secondary-artifacts: - artifactIdentifier: - files: - - location - - location - name: secondary-artifact-name - discard-paths: yes - base-directory: location - artifactIdentifier: - files: - - location - - location - discard-paths: yes - base-directory: location -cache: - paths: - - path - - path -``` - -The build spec contains the following: -+ `version`: Required mapping\. Represents the build spec version\. We recommend that you use `0.2`\. -**Note** -Although version 0\.1 is still supported, we recommend that you use version 0\.2 whenever possible\. For more information, see [Build Spec Versions](#build-spec-ref-versions)\. -+ `run-as`: Optional sequence\. Available to Linux users only\. Specifies a Linux user that runs commands in this buildspec file\. `run-as` grants the specified user read and execute permissions\. When you specify `run-as` at the top of the buildspec file, it applies globally to all commands\. If you don't want to specify a user for all buildspec file commands, you can specify one for commands in a phase by using `run-as` in one of the `phases` blocks\. If `run-as` is not specified, then all commands run as the root\. -+ `env`: Optional sequence\. Represents information for one or more custom environment variables\. - + `variables`: Required if `env` is specified, and you want to define custom environment variables in plain text\. Contains a mapping of *key*/*value* scalars, where each mapping represents a single custom environment variable in plain text\. *key* is the name of the custom environment variable, and *value* is that variable's value\. -**Important** -We strongly discourage the storing of sensitive values, especially AWS access key IDs and secret access keys, in environment variables\. Environment variables can be displayed in plain text using tools such as the CodeBuild console and the AWS CLI\. For sensitive values, we recommend that you use the `parameter-store` mapping instead, as described later in this section\. -Any environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that starts with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, the value is determined as follows: -The value in the start build operation call takes highest precedence\. You can add or override environment variables when you create a build\. For more information, see [Run a Build in CodeBuild](run-build.md)\. -The value in the build project definition takes next precedence\. You can add environment variables at the project level when you create or edit a project\. For more information, see [Create a Build Project in CodeBuild](create-project.md) and [Change a Build Project's Settings in CodeBuild ](change-project.md)\. -The value in the build spec declaration takes lowest precedence\. - + `parameter-store`: Required if `env` is specified, and you want to retrieve custom environment variables stored in Amazon EC2 Systems Manager Parameter Store\. Contains a mapping of *key*/*value* scalars, where each mapping represents a single custom environment variable stored in Amazon EC2 Systems Manager Parameter Store\. *key* is the name you use later in your build commands to refer to this custom environment variable, and *value* is the name of the custom environment variable stored in Amazon EC2 Systems Manager Parameter Store\. To store sensitive values, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. -**Important** -To allow CodeBuild to retrieve custom environment variables stored in Amazon EC2 Systems Manager Parameter Store, you must add the `ssm:GetParameters` action to your CodeBuild service role\. For more information, see [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. -Any environment variables you retrieve from Amazon EC2 Systems Manager Parameter Store replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you retrieve an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you retrieve an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not store any environment variable with a name that starts with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, the value is determined as follows: -The value in the start build operation call takes highest precedence\. You can add or override environment variables when you create a build\. For more information, see [Run a Build in CodeBuild](run-build.md)\. -The value in the build project definition takes next precedence\. You can add environment variables at the project level when you create or edit a project\. For more information, see [Create a Build Project in CodeBuild](create-project.md) and [Change a Build Project's Settings in CodeBuild ](change-project.md)\. -The value in the build spec declaration takes lowest precedence\. - + `git-credential-helper`: Optional mapping\. Represents whether CodeBuild uses its Git credential helper to provide Git credentials\. `yes` if it is used; otherwise, `no` or not specified\. For more information, see [gitcredentials](https://git-scm.com/docs/gitcredentials) on the Git website\. -+ `phases`: Required sequence\. Represents the commands CodeBuild runs during each phase of the build\. -**Note** -In build spec version 0\.1, CodeBuild runs each command in a separate instance of the default shell in the build environment\. This means that each command runs in isolation from all other commands\. Therefore, by default, you cannot run a single command that relies on the state of any previous commands \(for example, changing directories or setting environment variables\)\. To get around this limitation, we recommend that you use version 0\.2, which solves this issue\. If you must use build spec version 0\.1, we recommend the approaches in [Shells and Commands in Build Environments](build-env-ref-cmd.md)\. - + `run-as`: Optional sequence\. Use in a build phase to specify a Linux user that runs its commands\. If `run-as` is also specified globally for all commands at the top of the buildspec file, then the phase\-level user takes precedence\. For example, if globally `run-as` specifies User\-1, and for the `install` phase only a `run-as` statement specifies User\-2, then all commands in then buildspec file are run as User\-1 *except* commands in the `install` phase, which are run as User\-2\. - - The allowed build phase names are: - + `install`: Optional sequence\. Represents the commands, if any, that CodeBuild runs during installation\. We recommend that you use the `install` phase only for installing packages in the build environment\. For example, you might use this phase to install a code testing framework such as Mocha or RSpec\. - + `runtime-versions`: Required if using the Ubuntu standard image 2\.0 or later, or the Amazon Linux \(AL2\) standard image 1\.0 or later\. A runtime version is not supported with a custom image or the Ubuntu standard image 1\.0\. If specified, at least one runtime must be included in this section\. Specify a runtime using a major version only, such as "java: openjdk11" or "ruby: 2\.6\." You can specify the runtime using a number or an environment variable\. For example, the following specifies that version 8 of `openjdk`, version 28 of `android`, and a version contained in an environment variable of `ruby` is installed\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. -**Note** - If you specify a `runtime-versions` section and use an image other than Ubuntu Standard Image 2\.0 or later, or the Amazon Linux 2 \(AL2\) standard image 1\.0 or later, the build issues the warning, "Skipping install of runtimes\. Runtime version selection is not supported by this build image\." - - ``` - phases: - install: - runtime-versions: - java: openjdk8 - android: 28 - ruby: "$MY_RUBY_VAR" - ``` - + Some runtimes must include specific versions of other runtimes\. If a required runtime is not specified, the build fails\. For example, `android` version 28 requires version 8 of `openjdk`\. If `android: 28` is specified, and `openjdk: 8` is not, the build fails\. - + If two specified runtimes conflict, the build fails\. For example, `android: 8` and `java: openjdk11` conflict, so if both are specified, the build fails\. - + The following runtimes can be specified\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) - + `commands`: Required sequence unless you specify `runtime-versions`\. Optional if you specify `runtime-versions`\. Contains a sequence of scalars, where each scalar represents a single command that CodeBuild runs during installation\. CodeBuild runs each command, one at a time, in the order listed, from beginning to end\. - + `pre_build`: Optional sequence\. Represents the commands, if any, that CodeBuild runs before the build\. For example, you might use this phase to sign in to Amazon ECR, or you might install npm dependencies\. - + `commands`: Required sequence if `pre_build` is specified\. Contains a sequence of scalars, where each scalar represents a single command that CodeBuild runs before the build\. CodeBuild runs each command, one at a time, in the order listed, from beginning to end\. - + `build`: Optional sequence\. Represents the commands, if any, that CodeBuild runs during the build\. For example, you might use this phase to run Mocha, RSpec, or sbt\. - + `commands`: Required if `build` is specified\. Contains a sequence of scalars, where each scalar represents a single command that CodeBuild runs during the build\. CodeBuild runs each command, one at a time, in the order listed, from beginning to end\. - + `post_build`: Optional sequence\. Represents the commands, if any, that CodeBuild runs after the build\. For example, you might use Maven to package the build artifacts into a JAR or WAR file, or you might push a Docker image into Amazon ECR\. Then you might send a build notification through Amazon SNS\. - + `commands`: Required if `post_build` is specified\. Contains a sequence of scalars, where each scalar represents a single command that CodeBuild runs after the build\. CodeBuild runs each command, one at a time, in the order listed, from beginning to end\. -**Important** -Commands in some build phases might not be run if commands in earlier build phases fail\. For example, if a command fails during the `install` phase, none of the commands in the `pre_build`, `build`, and `post_build` phases are run for that build's lifecycle\. For more information, see [Build Phase Transitions](view-build-details.md#view-build-details-phases)\. -+ `finally`: Optional block\. Commands specified in a `finally` block are executed after commands in the `commands` block\. The commands in a `finally` block are executed even if a command in the `commands` block fails\. For example, if the `commands` block contains three commands and the first fails, CodeBuild skips the remaining two commands and runs any commands in the `finally` block\. The phase is successful when all commands in the `commands` and the `finally` blocks run successfully\. If any command in a phase fails, the phase fails\. -+ `artifacts`: Optional sequence\. Represents information about where CodeBuild can find the build output and how CodeBuild prepares it for uploading to the Amazon S3 output bucket\. This sequence is not required if, for example, you are building and pushing a Docker image to Amazon ECR, or you are running unit tests on your source code, but not building it\. - + `files`: Required sequence\. Represents the locations that contain the build output artifacts in the build environment\. Contains a sequence of scalars, with each scalar representing a separate location where CodeBuild can find build output artifacts, relative to the original build location or, if set, the base directory\. Locations can include the following: - + A single file \(for example, `my-file.jar`\)\. - + A single file in a subdirectory \(for example, `my-subdirectory/my-file.jar` or `my-parent-subdirectory/my-subdirectory/my-file.jar`\)\. - + `'**/*'` represents all files recursively\. - + `my-subdirectory/*` represents all files in a subdirectory named *my\-subdirectory*\. - + `my-subdirectory/**/*` represents all files recursively starting from a subdirectory named *my\-subdirectory*\. - - When you specify build output artifact locations, CodeBuild can locate the original build location in the build environment\. You do not have to prepend your build artifact output locations with the path to the original build location or specify `./` or similar\. If you want to know the path to this location, you can run a command such as `echo $CODEBUILD_SRC_DIR` during a build\. The location for each build environment might be slightly different\. - + `name`: Optional name\. Specifies a name for your build artifact\. This name is used when one of the following is true\. - + You use the CodeBuild API to create your builds and the `overrideArtifactName` flag is set on the `ProjectArtifacts` object when a project is updated, a project is created, or a build is started\. - + You use the CodeBuild console to create your builds, a name is specified in the buildspec file, and you select **Use the name specified in the buildspec file** when you create or update a project\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - - You can specify a name in the build spec file that is calculated at build time\. The name specified in a build spec file uses the Shell command language\. For example, you can append a date and time to your artifact name so that it is always unique\. Unique artifact names prevent artifacts from being overwritten\. For more information, see [Shell Command Language](http://pubs.opengroup.org/onlinepubs/9699919799/)\. - - This is an example of an arifact name appended with the date the artifact is created\. - - ``` - version: 0.2 - phases: - build: - commands: - - rspec HelloWorld_spec.rb - artifacts: - files: - - '**/*' - name: myname-$(date +%Y-%m-%d) - ``` - - This is an example of an artifact name that uses a CodeBuild environment variable\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - - ``` - version: 0.2 - phases: - build: - commands: - - rspec HelloWorld_spec.rb - artifacts: - files: - - '**/*' - name: myname-$(AWS_REGION) - ``` - - This is an example of an artifact name that uses a CodeBuild environment variable with the artifact's creation date appended to it\. - - ``` - version: 0.2 - phases: - build: - commands: - - rspec HelloWorld_spec.rb - artifacts: - files: - - '**/*' - name: $(AWS_REGION)-$(date +%Y-%m-%d) - ``` - + `discard-paths`: Optional mapping\. Represents whether paths to files in the build output artifact are discarded\. `yes` if paths are discarded; otherwise, `no` or not specified \(the default\)\. For example, if a path to a file in the build output artifact would be `com/mycompany/app/HelloWorld.java`, then specifying `yes` would shorten this path to simply `HelloWorld.java`\. - + `base-directory`: Optional mapping\. Represents one or more top\-level directories, relative to the original build location, that CodeBuild uses to determine which files and subdirectories to include in the build output artifact\. Valid values include: - + A single top\-level directory \(for example, `my-directory`\)\. - + `'my-directory*'` represents all top\-level directories with names starting with `my-directory`\. - - Matching top\-level directories are not included in the build output artifact, only their files and subdirectories\. - - You can use `files` and `discard-paths` to further restrict which files and subdirectories are included\. For example, for the following directory structure: - - ``` - |-- my-build1 - | `-- my-file1.txt - `-- my-build2 - |-- my-file2.txt - `-- my-subdirectory - `-- my-file3.txt - ``` - - And for the following `artifacts` sequence: - - ``` - artifacts: - files: - - '*/my-file3.txt' - base-directory: my-build2 - ``` - - The following subdirectory and file would be included in the build output artifact: - - ``` - my-subdirectory - `-- my-file3.txt - ``` - - While for the following `artifacts` sequence: - - ``` - artifacts: - files: - - '**/*' - base-directory: 'my-build*' - discard-paths: yes - ``` - - The following files would be included in the build output artifact: - - ``` - |-- my-file1.txt - |-- my-file2.txt - `-- my-file3.txt - ``` - + `secondary-artifacts`: Optional sequence\. Represents one or more artifact definitions as a mapping between an artifact identifier and an artifact definition\. Each artifact identifiers in this block must match an artifact defined in the `secondaryArtifacts` attribute of your project\. Each separate definition has the same syntax as the `artifacts:` block above\. For example, if your project has the following structure: - - ``` - { - "name": "sample-project", - "secondaryArtifacts": [ - { - "type": "S3", - "location": "output-bucket1", - "artifactIdentifier": "artifact1", - "name": "secondary-artifact-name-1" - }, - { - "type": "S3", - "location": "output-bucket2", - "artifactIdentifier": "artifact2", - "name": "secondary-artifact-name-2" - } - ] - } - ``` - - Then your buildspec looks like the following: - - ``` - version: 0.2 - - phases: - build: - commands: - - echo Building... - artifacts: - secondary-artifacts: - artifact1: - files: - - directory/file - name: secondary-artifact-name-1 - artifact2: - files: - - directory/file2 - name: secondary-artifact-name-2 - ``` -+ `cache`: Optional sequence\. Represents information about where CodeBuild can prepare the files for uploading cache to an Amazon S3 cache bucket\. This sequence is not required if the cache type of the project is `No Cache`\. - + `paths`: Required sequence\. Represents the locations of the cache\. Contains a sequence of scalars, with each scalar representing a separate location where CodeBuild can find build output artifacts, relative to the original build location or, if set, the base directory\. Locations can include the following: - + A single file \(for example, `my-file.jar`\)\. - + A single file in a subdirectory \(for example, `my-subdirectory/my-file.jar` or `my-parent-subdirectory/my-subdirectory/my-file.jar`\)\. - + `'**/*'` represents all files recursively\. - + `my-subdirectory/*` represents all files in a subdirectory named *my\-subdirectory*\. - + `my-subdirectory/**/*` represents all files recursively starting from a subdirectory named *my\-subdirectory*\. - -**Important** -Because a build spec declaration must be valid YAML, the spacing in a build spec declaration is important\. If the number of spaces in your build spec declaration is invalid, builds might fail immediately\. You can use a YAML validator to test whether your build spec declarations are valid YAML\. -If you use the AWS CLI, or the AWS SDKs to declare a build spec when you create or update a build project, the build spec must be a single string expressed in YAML format, along with required whitespace and newline escape characters\. There is an example in the next section\. -If you use the CodeBuild or AWS CodePipeline consoles instead of a buildspec\.yml file, you can insert commands for the `build` phase only\. Instead of using the preceding syntax, you list, in a single line, all of the commands that you want to run during the build phase\. For multiple commands, separate each command by `&&` \(for example, `mvn test && mvn package`\)\. -You can use the CodeBuild or CodePipeline consoles instead of a buildspec\.yml file to specify the locations of the build output artifacts in the build environment\. Instead of using the preceding syntax, you list, in a single line, all of the locations\. For multiple locations, separate each location with a comma \(for example, `buildspec.yml, target/my-app.jar`\)\. - -## Build Spec Example - -Here is an example of a buildspec\.yml file\. - -``` -version: 0.2 - -env: - variables: - JAVA_HOME: "/usr/lib/jvm/java-8-openjdk-amd64" - parameter-store: - LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword - -phases: - install: - commands: - - echo Entered the install phase... - - apt-get update -y - - apt-get install -y maven - finally: - - echo This always runs even if the update or install command fails - pre_build: - commands: - - echo Entered the pre_build phase... - - docker login –u User –p $LOGIN_PASSWORD - finally: - - echo This always runs even if the login command fails - build: - commands: - - echo Entered the build phase... - - echo Build started on `date` - - mvn install - finally: - - echo This always runs even if the install command fails - post_build: - commands: - - echo Entered the post_build phase... - - echo Build completed on `date` -artifacts: - files: - - target/messageUtil-1.0.jar - discard-paths: yes - secondary-artifacts: - artifact1: - files: - - target/messageUtil-1.0.jar - discard-paths: yes - artifact2: - files: - - target/messageUtil-1.0.jar - discard-paths: yes -cache: - paths: - - '/root/.m2/**/*' -``` - -Here is an example of the preceding build spec, expressed as a single string, for use with the AWS CLI, or the AWS SDKs\. - -``` -"version: 0.2\n\nenv:\n variables:\n JAVA_HOME: \"/usr/lib/jvm/java-8-openjdk-amd64\"\n parameter-store:\n LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword\n\nphases:\n install:\n commands:\n - apt-get update -y\n - apt-get install -y maven\n pre_build:\n commands:\n - echo Entered the pre_build phase...\n build:\n commands:\n - echo Build started on `date`\n - mvn install\n post_build:\n commands:\n - echo Build completed on `date`\nartifacts:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes" -``` - -Here is an example of the commands in the `build` phase, for use with the CodeBuild or CodePipeline consoles\. - -``` -echo Build started on `date` && mvn install -``` - -In these examples: -+ A custom environment variable, in plain text, with the key of `JAVA_HOME` and the value of `/usr/lib/jvm/java-8-openjdk-amd64`, is set\. -+ A custom environment variable named `dockerLoginPassword` you stored in Amazon EC2 Systems Manager Parameter Store is referenced later in build commands by using the key `LOGIN_PASSWORD`\. -+ You cannot change these build phase names\. The commands that are run in this example are `apt-get update -y` and `apt-get install -y maven` \(to install Apache Maven\), `mvn install` \(to compile, test, and package the source code into a build output artifact and to install the build output artifact in its internal repository\), `docker login` \(to sign in to Docker with the password that corresponds to the value of the custom environment variable `dockerLoginPassword` you set in Amazon EC2 Systems Manager Parameter Store\), and several `echo` commands\. The `echo` commands are included here to show how CodeBuild runs commands and the order in which it runs them\. -+ `files` represents the files to upload to the build output location\. In this example, CodeBuild uploads the single file `messageUtil-1.0.jar`\. The `messageUtil-1.0.jar` file can be found in the relative directory named `target` in the build environment\. Because `discard-paths: yes` is specified, `messageUtil-1.0.jar` is uploaded directly \(and not to an intermediate `target` directory\)\. The file name `messageUtil-1.0.jar` and the relative directory name of `target` is based on the way Apache Maven creates and stores build output artifacts for this example only\. In your own scenarios, these file names and directories will be different\. - -## Build Spec Versions - -The following table lists the build spec versions and the changes between versions\. - - -**** - -| Version | Changes | -| --- | --- | -| 0\.2 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) | -| 0\.1 | This is the initial definition of the build specification format\. | \ No newline at end of file diff --git a/doc_source/builds-projects-and-builds.md b/doc_source/builds-projects-and-builds.md deleted file mode 100644 index 8079956..0000000 --- a/doc_source/builds-projects-and-builds.md +++ /dev/null @@ -1,7 +0,0 @@ -# Working with Build Projects and Builds in CodeBuild - - To get started, follow the steps in [Create a Build Project](create-project.md), and then follow the steps in [Run a Build](run-build.md)\. For more information about build projects and builds, see the following topics\. - -**Topics** -+ [Working with Build Projects](working-with-build-projects.md) -+ [Working with Builds in CodeBuild](builds-working.md) \ No newline at end of file diff --git a/doc_source/builds-working.md b/doc_source/builds-working.md deleted file mode 100644 index 0d0ac2d..0000000 --- a/doc_source/builds-working.md +++ /dev/null @@ -1,22 +0,0 @@ -# Working with Builds in CodeBuild - -A *build* represents a set of actions performed by AWS CodeBuild to create output artifacts \(for example, a JAR file\) based on a set of input artifacts \(for example, a collection of Java class files\)\. - -The following rules apply when you run multiple builds: -+ When possible, builds run concurrently\. The maximum number of concurrently running builds can vary\. For more information, see [Build Limits](limits.md#limits-builds)\. -+ Builds are queued if the number of concurrently running builds reaches its limit\. The maximum number of builds in a queue is five times the concurrent build limit\. For more information, see [Build Limits](limits.md#limits-builds)\. -+ A build in a queue that does not start after the number of minutes specified in its time out value is removed from the queue\. The default timeout value is eight hours\. You can override the build queue timeout with a value between five minutes and eight hours when you run your build\. For more information, see [Run a Build in CodeBuild](run-build.md)\. -+ It is not possible to predict the order in which queued builds start\. - -**Note** -You can access the history of a build for one year\. - -You can perform these tasks when working with builds: - -**Topics** -+ [Run a Build in CodeBuild](run-build.md) -+ [View Build Details in CodeBuild](view-build-details.md) -+ [View a List of Build IDs in CodeBuild](view-build-list.md) -+ [View a List of Build IDs for a Build Project in CodeBuild](view-builds-for-project.md) -+ [Stop a Build in CodeBuild](stop-build.md) -+ [Delete Builds in CodeBuild](delete-builds.md) \ No newline at end of file diff --git a/doc_source/change-project.md b/doc_source/change-project.md deleted file mode 100644 index b1df62e..0000000 --- a/doc_source/change-project.md +++ /dev/null @@ -1,137 +0,0 @@ -# Change a Build Project's Settings in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to change a build project's settings\. - -**Topics** -+ [Change a Build Project's Settings \(Console\)](#change-project-console) -+ [Change a Build Project's Settings \(AWS CLI\)](#change-project-cli) -+ [Change a Build Project's Settings \(AWS SDKs\)](#change-project-sdks) - -## Change a Build Project's Settings \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. Do one of the following: - + Choose the link for the build project you want to change, and then choose **Build details**\. - + Choose the button next to the build project you want to change, choose **View details**, and then choose **Build details**\. - -1. To change the project's description, in **Project configuration**, choose **Edit**, and then enter a description in **Description**\. - - Choose **Update configuration**\. - - For more information about settings referred to in this procedure, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - -1. To change information about the source code location, in **Source**, choose **Edit**\. Use the following table to make selections appropriate for your source provider, and then choose **Update source**\. -**Note** -CodeBuild does not support Bitbucket Server\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html) - - To change whether CodeBuild can modify the service role you use for this project, select or clear **Allow AWS CodeBuild to modify this service role so it can be used with this build project**\. If you clear it, you must use a service role with CodeBuild permissions attached to it\. For more information, see [Add CodeBuild Access Permissions to an IAM Group or IAM User](setting-up.md#setting-up-service-permissions-group) and [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - -1. To change information about the build environment, in **Environment**, choose **Edit**\. Make changes appropriate for the build environment type \(for example, **Environment image**, **Operating system**, **Runtime**, **Runtime version**, **Custom image**, **Other location**, **Amazon ECR repository**, or **Amazon ECR image**\)\. - -1. If you plan to use this build project to build Docker images and the specified build environment is not provided by CodeBuild with Docker support, select **Privileged**\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it as needed\. You can do this by by running the following build commands to initialize the Docker daemon in the `install` phase of your build spec\. \(Do not run the following build commands if the specified build environment image is provided by CodeBuild with Docker support\.\) - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - -1. To change information about the CodeBuild service role, in **Service role**, change the values for **New service role**, **Existing service role**, or **Role name**\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. To change information about the build timeout, in **Additional configuration**, for **Timeout**, change the values for **hours** and **minutes**\. If **hours** and **minutes** are left blank, the default value is 60 minutes\. - -1. To change information about the VPC, in **Additional configuration**, change the values for **VPC**, **Subnets**, and **Security groups**\. - -1. To change the amount of memory and vCPUs that are used to run builds, in **Additional configuration**, change the value for **Compute**\. - -1. To change information about environment variables you want builds to use, in **Additional configuration**, for **Environment variables**, change the values for **Name**, **Value**, and **Type**\. Use **Add row** to add an environment variable\. Choose the delete \(**X**\) button next to an environment variable you no longer want to use\. - - Others can see environment variables by using the CodeBuild console and the AWS CLI\. If you have no concerns about the visibility of your environment variable, set the **Name** and **Value** fields, and then set **Type** to **Plaintext**\. - - We recommend that you store an environment variable with a sensitive value, such as an AWS access key ID, an AWS secret access key, or a password as a parameter in Amazon EC2 Systems Manager Parameter Store\. For **Type**, choose **Parameter Store**\. For **Name**, enter an identifier for CodeBuild to reference\. For **Value**, enter the parameter's name as stored in Amazon EC2 Systems Manager Parameter Store\. Using a parameter named `/CodeBuild/dockerLoginPassword` as an example, for **Type** choose **Parameter Store**\. For **Name**, enter `LOGIN_PASSWORD`\. For **Value**, enter `/CodeBuild/dockerLoginPassword`\. -**Important** -We recommend that you store parameters in Amazon EC2 Systems Manager Parameter Store with parameter names that start with `/CodeBuild/` \(for example, `/CodeBuild/dockerLoginPassword`\)\. You can use the CodeBuild console to create a parameter in Amazon EC2 Systems Manager\. Choose **Create a parameter**, and then follow the instructions\. \(In that dialog box, for **KMS key**, you can optionally specify the ARN of an AWS KMS key in your account\. Amazon EC2 Systems Manager uses this key to encrypt the parameter's value during storage and decrypt during retrieval\.\) If you use the CodeBuild console to create a parameter, the console starts the parameter name with `/CodeBuild/` as it is being stored\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store, the build project's service role must allow the `ssm:GetParameters` action\. If you chose **Create a service role in your account** earlier, then CodeBuild includes this action in the default service role for your build project automatically\. However, if you chose **Choose an existing service role from your account**, then you must include this action to your service role separately\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store with parameter names that do not start with `/CodeBuild/`, and you chose **Create a service role in your account**, then you must update that service role to allow access to parameter names that do not start with `/CodeBuild/`\. This is because that service role allows access only to parameter names that start with `/CodeBuild/`\. -If you choose **Create a service role in your account**, the created service role includes permission to decrypt all parameters under the `/CodeBuild/` namespace in the Amazon EC2 Systems Manager Parameter Store\. -Environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that begins with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, its value is determined as follows: -The value in the start build operation call takes highest precedence\. -The value in the build project definition takes next precedence\. -The value in the build spec declaration takes lowest precedence\. - -1. To change information about tags for this build project, in **Additional configuration**, for **Tags**, change the values of **Name** and **Value**\. Use **Add row** to add a tag\. You can add up to 50 tags\. Choose the delete \(**X**\) icon next to a tag you no longer want to use\. - -1. Choose **Update environment**\. - -1. To change the project's build specifications, in **Buildspec**, choose **Edit**\. - + If your source code previously did not include a buildspec\.yml file but does now, choose **Use a buildspec file**\. - + If your source code previously included a buildspec\.yml file but does not now, choose **Insert build commands**, and in **Build commands**, enter the commands, - -1. Choose **Update buildspec**\. - -1. To change information about the build output artifact location and name, in **Artifacts**, choose **Edit**, and then change the values for **Type**, **Name**, **Path**, **Namespace type**, or **Bucket name**\. - -1. To change information about the AWS KMS customer master key \(CMK\), in **Additional configuration**, change the value for **Encryption key**\. -**Important** -If you leave **Encryption key** blank, CodeBuild uses the AWS\-managed CMK for Amazon S3 in your AWS account instead\. - -1. To change information about the cache, expand **Additional configuration**\. In **Cache type**, do one of the following: - + If you previously chose a cache, but do not want to use one now, choose **No cache**\. - + If you previously chose **No cache** but now want to use one, choose **Amazon S3**, and then do the following: - + For **Cache bucket**, choose the name of the Amazon S3 bucket where the cache is stored\. - + \(Optional\) For **Cache path prefix**, enter an Amazon S3 path prefix\. The **Cache path prefix** value is similar to a directory name that enables you to store the cache under the same directory in a bucket\. -**Important** -Do not append "/" to the end of **Path prefix**\. - - Using a cache saves considerable build time because reusable pieces of the build environment are stored in the cache and used across builds\. For information about specifying a cache in the build spec file, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -1. To change your log settings, in **Logs**, select or clear **CloudWatch logs** and **S3 logs**\. - - If you enable **CloudWatch logs**: - + In **Group name**, enter the name of your Amazon CloudWatch Logs group\. - + In **Stream name**, enter your Amazon CloudWatch Logs stream name\. - - If you enable **S3 logs**: - + From **Bucket**, choose the name of the S3 bucket for your logs\. - + In **Path prefix**, enter the prefix for your logs\. - + Select **Remove S3 log encryption** if you do not want your S3 logs encrypted\. - -1. To change information about the way build output artifacts are stored, in **Additional configuration**, change the value of **Artifacts packaging**\. - -1. To change whether build artifacts are encrypted, use **Disable artifacts encryption**\. - -1. Choose **Update artifacts**\. - -## Change a Build Project's Settings \(AWS CLI\) - -For more information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Run the `update-project` command as follows: - - ``` - aws codebuild update-project --generate-cli-skeleton - ``` - - JSON\-formatted data appears in the output\. Copy the data to a file \(for example, `update-project.json`\) in a location on the local computer or instance where the AWS CLI is installed\. Then modify the copied data as described in [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli), and save your results\. -**Note** -In the JSON\-formatted data, you must provide the name of the build project\. All other settings are optional\. You cannot change the build project's name, but you can change any of its other settings\. - -1. Switch to the directory that contains the file you just saved, and run the update\-projectcommand again\. - - ``` - aws codebuild update-project --cli-input-json file://update-project.json - ``` - -1. If successful, data similar to that as described in [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli) appears in the output\. - -## Change a Build Project's Settings \(AWS SDKs\) - -For information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/cloudformation-vpc-template.md b/doc_source/cloudformation-vpc-template.md deleted file mode 100644 index b54783e..0000000 --- a/doc_source/cloudformation-vpc-template.md +++ /dev/null @@ -1,245 +0,0 @@ -# AWS CloudFormation VPC Template - -AWS CloudFormation enables you to create and provision AWS infrastructure deployments predictably and repeatedly, by using template files to create and delete a collection of resources together as a single unit \(a stack\)\. For more information, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide//Welcome.html)\. - -The following is an AWS CloudFormation YAML template for configuring an Amazon VPC to use the AWS CodeBuild VPC feature\. It is available for download from [https://s3.amazonaws.com/codebuild-cloudformation-templates-public/vpc_cloudformation_template.yml](https://s3.amazonaws.com/codebuild-cloudformation-templates-public/vpc_cloudformation_template.yml)\. - -``` -Description: This template deploys a VPC, with a pair of public and private subnets spread - across two Availability Zones. It deploys an Internet Gateway, with a default - route on the public subnets. It deploys a pair of NAT Gateways (one in each AZ), - and default routes for them in the private subnets. - -Parameters: - EnvironmentName: - Description: An environment name that will be prefixed to resource names - Type: String - - VpcCIDR: - Description: Please enter the IP range (CIDR notation) for this VPC - Type: String - Default: 10.192.0.0/16 - - PublicSubnet1CIDR: - Description: Please enter the IP range (CIDR notation) for the public subnet in the first Availability Zone - Type: String - Default: 10.192.10.0/24 - - PublicSubnet2CIDR: - Description: Please enter the IP range (CIDR notation) for the public subnet in the second Availability Zone - Type: String - Default: 10.192.11.0/24 - - PrivateSubnet1CIDR: - Description: Please enter the IP range (CIDR notation) for the private subnet in the first Availability Zone - Type: String - Default: 10.192.20.0/24 - - PrivateSubnet2CIDR: - Description: Please enter the IP range (CIDR notation) for the private subnet in the second Availability Zone - Type: String - Default: 10.192.21.0/24 - -Resources: - VPC: - Type: AWS::EC2::VPC - Properties: - CidrBlock: !Ref VpcCIDR - EnableDnsSupport: true - EnableDnsHostnames: true - Tags: - - Key: Name - Value: !Ref EnvironmentName - - InternetGateway: - Type: AWS::EC2::InternetGateway - Properties: - Tags: - - Key: Name - Value: !Ref EnvironmentName - - InternetGatewayAttachment: - Type: AWS::EC2::VPCGatewayAttachment - Properties: - InternetGatewayId: !Ref InternetGateway - VpcId: !Ref VPC - - PublicSubnet1: - Type: AWS::EC2::Subnet - Properties: - VpcId: !Ref VPC - AvailabilityZone: !Select [ 0, !GetAZs '' ] - CidrBlock: !Ref PublicSubnet1CIDR - MapPublicIpOnLaunch: true - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Public Subnet (AZ1) - - PublicSubnet2: - Type: AWS::EC2::Subnet - Properties: - VpcId: !Ref VPC - AvailabilityZone: !Select [ 1, !GetAZs '' ] - CidrBlock: !Ref PublicSubnet2CIDR - MapPublicIpOnLaunch: true - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Public Subnet (AZ2) - - PrivateSubnet1: - Type: AWS::EC2::Subnet - Properties: - VpcId: !Ref VPC - AvailabilityZone: !Select [ 0, !GetAZs '' ] - CidrBlock: !Ref PrivateSubnet1CIDR - MapPublicIpOnLaunch: false - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Private Subnet (AZ1) - - PrivateSubnet2: - Type: AWS::EC2::Subnet - Properties: - VpcId: !Ref VPC - AvailabilityZone: !Select [ 1, !GetAZs '' ] - CidrBlock: !Ref PrivateSubnet2CIDR - MapPublicIpOnLaunch: false - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Private Subnet (AZ2) - - NatGateway1EIP: - Type: AWS::EC2::EIP - DependsOn: InternetGatewayAttachment - Properties: - Domain: vpc - - NatGateway2EIP: - Type: AWS::EC2::EIP - DependsOn: InternetGatewayAttachment - Properties: - Domain: vpc - - NatGateway1: - Type: AWS::EC2::NatGateway - Properties: - AllocationId: !GetAtt NatGateway1EIP.AllocationId - SubnetId: !Ref PublicSubnet1 - - NatGateway2: - Type: AWS::EC2::NatGateway - Properties: - AllocationId: !GetAtt NatGateway2EIP.AllocationId - SubnetId: !Ref PublicSubnet2 - - PublicRouteTable: - Type: AWS::EC2::RouteTable - Properties: - VpcId: !Ref VPC - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Public Routes - - DefaultPublicRoute: - Type: AWS::EC2::Route - DependsOn: InternetGatewayAttachment - Properties: - RouteTableId: !Ref PublicRouteTable - DestinationCidrBlock: 0.0.0.0/0 - GatewayId: !Ref InternetGateway - - PublicSubnet1RouteTableAssociation: - Type: AWS::EC2::SubnetRouteTableAssociation - Properties: - RouteTableId: !Ref PublicRouteTable - SubnetId: !Ref PublicSubnet1 - - PublicSubnet2RouteTableAssociation: - Type: AWS::EC2::SubnetRouteTableAssociation - Properties: - RouteTableId: !Ref PublicRouteTable - SubnetId: !Ref PublicSubnet2 - - - PrivateRouteTable1: - Type: AWS::EC2::RouteTable - Properties: - VpcId: !Ref VPC - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Private Routes (AZ1) - - DefaultPrivateRoute1: - Type: AWS::EC2::Route - Properties: - RouteTableId: !Ref PrivateRouteTable1 - DestinationCidrBlock: 0.0.0.0/0 - NatGatewayId: !Ref NatGateway1 - - PrivateSubnet1RouteTableAssociation: - Type: AWS::EC2::SubnetRouteTableAssociation - Properties: - RouteTableId: !Ref PrivateRouteTable1 - SubnetId: !Ref PrivateSubnet1 - - PrivateRouteTable2: - Type: AWS::EC2::RouteTable - Properties: - VpcId: !Ref VPC - Tags: - - Key: Name - Value: !Sub ${EnvironmentName} Private Routes (AZ2) - - DefaultPrivateRoute2: - Type: AWS::EC2::Route - Properties: - RouteTableId: !Ref PrivateRouteTable2 - DestinationCidrBlock: 0.0.0.0/0 - NatGatewayId: !Ref NatGateway2 - - PrivateSubnet2RouteTableAssociation: - Type: AWS::EC2::SubnetRouteTableAssociation - Properties: - RouteTableId: !Ref PrivateRouteTable2 - SubnetId: !Ref PrivateSubnet2 - - NoIngressSecurityGroup: - Type: AWS::EC2::SecurityGroup - Properties: - GroupName: "no-ingress-sg" - GroupDescription: "Security group with no ingress rule" - VpcId: !Ref VPC - -Outputs: - VPC: - Description: A reference to the created VPC - Value: !Ref VPC - - PublicSubnets: - Description: A list of the public subnets - Value: !Join [ ",", [ !Ref PublicSubnet1, !Ref PublicSubnet2 ]] - - PrivateSubnets: - Description: A list of the private subnets - Value: !Join [ ",", [ !Ref PrivateSubnet1, !Ref PrivateSubnet2 ]] - - PublicSubnet1: - Description: A reference to the public subnet in the 1st Availability Zone - Value: !Ref PublicSubnet1 - - PublicSubnet2: - Description: A reference to the public subnet in the 2nd Availability Zone - Value: !Ref PublicSubnet2 - - PrivateSubnet1: - Description: A reference to the private subnet in the 1st Availability Zone - Value: !Ref PrivateSubnet1 - - PrivateSubnet2: - Description: A reference to the private subnet in the 2nd Availability Zone - Value: !Ref PrivateSubnet2 - - NoIngressSecurityGroup: - Description: Security group with no ingress rule - Value: !Ref NoIngressSecurityGroup -``` \ No newline at end of file diff --git a/doc_source/cloudtrail.md b/doc_source/cloudtrail.md deleted file mode 100644 index a698fc5..0000000 --- a/doc_source/cloudtrail.md +++ /dev/null @@ -1,97 +0,0 @@ -# Logging CodeBuild API Calls with AWS CloudTrail - -AWS CodeBuild is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in CodeBuild\. CloudTrail captures all API calls for CodeBuild as events, including calls from the CodeBuild console and from code calls to the CodeBuild APIs\. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for CodeBuild\. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. Using the information collected by CloudTrail, you can determine the request that was made to CodeBuild, the IP address from which the request was made, who made the request, when it was made, and additional details\. - -To learn more about CloudTrail, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. - -## CodeBuild Information in CloudTrail - -CloudTrail is enabled on your AWS account when you create the account\. When activity occurs in CodeBuild, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**\. You can view, search, and download recent events in your AWS account\. For more information, see [Viewing Events with CloudTrail Event History](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html)\. - -For an ongoing record of events in your AWS account, including events for CodeBuild, create a trail\. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket\. By default, when you create a trail in the console, the trail applies to all regions\. The trail logs events from all regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify\. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. For more information, see: -+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) -+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations) -+ [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html) -+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html) - -All CodeBuild actions are logged by CloudTrail and are documented in the [CodeBuild API Reference](https://docs.aws.amazon.com/codebuild/latest/APIReference/)\. For example, calls to the `CreateProject` \(in the AWS CLI, `create-project`\), `StartBuild` \(in the AWS CLI, `start-project`\), and `UpdateProject` \(in the AWS CLI, `update-project`\) actions generate entries in the CloudTrail log files\. - -Every event or log entry contains information about who generated the request\. The identity information helps you determine the following: -+ Whether the request was made with root or IAM user credentials\. -+ Whether the request was made with temporary security credentials for a role or federated user\. -+ Whether the request was made by another AWS service\. - -For more information, see the [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html)\. - -## Understanding CodeBuild Log File Entries - -A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify\. CloudTrail log files contain one or more log entries\. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on\. CloudTrail log files are not an ordered stack trace of the public API calls, so they do not appear in any specific order\. - -The following example shows a CloudTrail log entry that demonstrates creating a build project in CodeBuild\. - -``` -{ - "eventVersion": "1.05", - "userIdentity": { - "type": "FederatedUser", - "principalId": "account-ID:user-name", - "arn": "arn:aws:sts::account-ID:federated-user/user-name", - "accountId": "account-ID", - "accessKeyId": "access-key-ID", - "sessionContext": { - "attributes": { - "mfaAuthenticated": "false", - "creationDate": "2016-09-06T17:59:10Z" - }, - "sessionIssuer": { - "type": "IAMUser", - "principalId": "access-key-ID", - "arn": "arn:aws:iam::account-ID:user/user-name", - "accountId": "account-ID", - "userName": "user-name" - } - } - }, - "eventTime": "2016-09-06T17:59:11Z", - "eventSource": "codebuild.amazonaws.com", - "eventName": "CreateProject", - "awsRegion": "region-ID", - "sourceIPAddress": "127.0.0.1", - "userAgent": "user-agent", - "requestParameters": { - "awsActId": "account-ID" - }, - "responseElements": { - "project": { - "environment": { - "image": "image-ID", - "computeType": "BUILD_GENERAL1_SMALL", - "type": "LINUX_CONTAINER", - "environmentVariables": [] - }, - "name": "codebuild-demo-project", - "description": "This is my demo project", - "arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project:project-ID", - "encryptionKey": "arn:aws:kms:region-ID:key-ID", - "timeoutInMinutes": 10, - "artifacts": { - "location": "arn:aws:s3:::codebuild-region-ID-account-ID-output-bucket", - "type": "S3", - "packaging": "ZIP", - "outputName": "MyOutputArtifact.zip" - }, - "serviceRole": "arn:aws:iam::account-ID:role/CodeBuildServiceRole", - "lastModified": "Sep 6, 2016 10:59:11 AM", - "source": { - "type": "GITHUB", - "location": "https://github.com/my-repo.git" - }, - "created": "Sep 6, 2016 10:59:11 AM" - } - }, - "requestID": "9d32b228-745b-11e6-98bb-23b67EXAMPLE", - "eventID": "581f7dd1-8d2e-40b0-aeee-0dbf7EXAMPLE", - "eventType": "AwsApiCall", - "recipientAccountId": "account-ID" -} -``` \ No newline at end of file diff --git a/doc_source/cmd-ref.md b/doc_source/cmd-ref.md deleted file mode 100644 index 6445a0e..0000000 --- a/doc_source/cmd-ref.md +++ /dev/null @@ -1,35 +0,0 @@ -# Command Line Reference for CodeBuild - -The AWS CLI provides commands for automating AWS CodeBuild\. Use the information in this topic as a supplement to the [AWS Command Line Interface User Guide](https://docs.aws.amazon.com/cli/latest/userguide/) and the [AWS CLI Reference for AWS CodeBuild](https://docs.aws.amazon.com/cli/latest/reference/codebuild/)\. - -Not what you're looking for? If you want to use the AWS SDKs to call CodeBuild, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. - -To use the information in this topic, you should have already installed the AWS CLI and configured it for use with CodeBuild, as described in [Install and Configure the AWS CLI](setting-up.md#setting-up-cli)\. - - To use the AWS CLI to specify the endpoint for CodeBuild, see [Specify the CodeBuild Endpoint \(AWS CLI\)](endpoint-specify.md#endpoint-specify-cli)\. - -Run this command to get a list of CodeBuild commands\. - -``` -aws codebuild help -``` - -Run this command to get information about a CodeBuild command, where *command\-name* is the name of the command\. - -``` -aws codebuild command-name help -``` - -CodeBuild commands include: -+ `batch-delete-builds`: Deletes one or more builds in CodeBuild\. For more information, see [Delete Builds \(AWS CLI\)](delete-builds.md#delete-builds-cli)\. -+ `batch-get-builds`: Gets information about multiple builds in CodeBuild\. For more information, see [View Build Details \(AWS CLI\)](view-build-details.md#view-build-details-cli)\. -+ `batch-get-projects`: Gets information about one or more specified build projects\. For more information, see [View a Build Project's Details \(AWS CLI\)](view-project-details.md#view-project-details-cli)\. -+ `create-project`: Creates a build project\. For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. -+ `delete-project`: Deletes a build project\. For more information, see [Delete a Build Project \(AWS CLI\)](delete-project.md#delete-project-cli)\. -+ `list-builds`: Lists Amazon Resource Names \(ARNs\) for builds in CodeBuild\. For more information, see [View a List of Build IDs \(AWS CLI\)](view-build-list.md#view-build-list-cli)\. -+ `list-builds-for-project`: Gets a list of build IDs that are associated with a specified build project\. For more information, see [View a List of Build IDs for a Build Project \(AWS CLI\)](view-builds-for-project.md#view-builds-for-project-cli)\. -+ `list-curated-environment-images`: Gets a list of Docker images managed by CodeBuild that you can use for your builds\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. -+ `list-projects`: Gets a list of build project names\. For more information, see [View a List of Build Project Names \(AWS CLI\)](view-project-list.md#view-project-list-cli)\. -+ `start-build`: Starts running a build\. For more information, see [Run a Build \(AWS CLI\)](run-build.md#run-build-cli)\. -+ `stop-build`: Attempts to stop the specified build from running\. For more information, see [Stop a Build \(AWS CLI\)](stop-build.md#stop-build-cli)\. -+ `update-project`: Changes information about the specified build project\. For more information, see [Change a Build Project's Settings \(AWS CLI\)](change-project.md#change-project-cli)\. \ No newline at end of file diff --git a/doc_source/codebuild-compliance-validation.md b/doc_source/codebuild-compliance-validation.md deleted file mode 100644 index 6e1bc88..0000000 --- a/doc_source/codebuild-compliance-validation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Compliance Validation for AWS CodeBuild - -Third\-party auditors assess the security and compliance of AWS CodeBuild as part of multiple AWS compliance programs\. These include SOC, PCI, FedRAMP, HIPAA, and others\. - -For a list of AWS services in scope of specific compliance programs, see [AWS Services in Scope by Compliance Program](https://aws.amazon.com/compliance/services-in-scope/)\. For general information, see [AWS Compliance Programs](https://aws.amazon.com/compliance/programs/)\. - -You can download third\-party audit reports using AWS Artifact\. For more information, see [Downloading Reports in AWS Artifact](https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html)\. - -Your compliance responsibility when using CodeBuild is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations\. If your use of CodeBuild is subject to compliance with standards such as HIPAA, PCI, or FedRAMP, AWS provides resources to help: -+ [Security and Compliance Quick Start Guides](https://aws.amazon.com/quickstart/?awsf.quickstart-homepage-filter=categories%23security-identity-compliance) – These deployment guides discuss architectural considerations and provide steps for deploying security\- and compliance\-focused baseline environments on AWS\. -+ [Architecting for HIPAA Security and Compliance Whitepaper ](https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf) – This whitepaper describes how companies can use AWS to create HIPAA\-compliant applications\. -+ [AWS Compliance Resources](https://aws.amazon.com/compliance/resources/) – This collection of workbooks and guides might apply to your industry and location\. -+ [AWS Config](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) – This AWS service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations\. -+ [AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices\. \ No newline at end of file diff --git a/doc_source/codebuild-disaster-recovery-resiliency.md b/doc_source/codebuild-disaster-recovery-resiliency.md deleted file mode 100644 index abe4be9..0000000 --- a/doc_source/codebuild-disaster-recovery-resiliency.md +++ /dev/null @@ -1,5 +0,0 @@ -# Resilience in AWS CodeBuild - -The AWS global infrastructure is built around AWS Regions and Availability Zones\. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low\-latency, high\-throughput, and highly redundant networking\. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption\. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures\. - -For more information about AWS Regions and Availability Zones, see [AWS Global Infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/)\. \ No newline at end of file diff --git a/doc_source/concepts.md b/doc_source/concepts.md deleted file mode 100644 index 65085d4..0000000 --- a/doc_source/concepts.md +++ /dev/null @@ -1,35 +0,0 @@ -# AWS CodeBuild Concepts - -The following concepts are important for understanding how CodeBuild works\. - -**Topics** -+ [How CodeBuild Works](#concepts-how-it-works) -+ [Next Steps](#concepts-next-steps) - -## How CodeBuild Works - -The following diagram shows what happens when you run a build with CodeBuild: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/arch.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. As input, you must provide CodeBuild with a build project\. A *build project* defines how CodeBuild runs a build\. It includes information such as where to get the source code, the build environment to use, the build commands to run, and where to store the build output\. A *build environment* represents a combination of operating system, programming language runtime, and tools that CodeBuild uses to run a build\. For more information, see: - + [Create a Build Project](create-project.md) - + [Build Environment Reference](build-env-ref.md) - -1. CodeBuild uses the build project to create the build environment\. - -1. CodeBuild downloads the source code into the build environment and then uses the build specification \(build spec\), as defined in the build project or included directly in the source code\. A *build spec* is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build\. For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. If there is any build output, the build environment uploads its output to an Amazon S3 bucket\. The build environment can also perform tasks that you specify in the build spec \(for example, sending build notifications to an Amazon SNS topic\)\. For an example, see [Build Notifications Sample](sample-build-notifications.md)\. - -1. While the build is running, the build environment sends information to CodeBuild and Amazon CloudWatch Logs\. - -1. While the build is running, you can use the CodeBuild console, AWS CLI, or AWS SDKs, to get summarized build information from CodeBuild and detailed build information from Amazon CloudWatch Logs\. If you use AWS CodePipeline to run builds, you can get limited build information from CodePipeline\. - -## Next Steps - -Now that you know more about AWS CodeBuild, we recommend that you complete the following steps: - -1. **Experiment** with CodeBuild in an example scenario by following the instructions in [Getting Started](getting-started.md)\. - -1. **Use** CodeBuild in your own scenarios by following the instructions in [Plan a Build](planning.md)\. \ No newline at end of file diff --git a/doc_source/console-resources.md b/doc_source/console-resources.md deleted file mode 100644 index edde35a..0000000 --- a/doc_source/console-resources.md +++ /dev/null @@ -1,15 +0,0 @@ -# Viewing Resources in the Console - -The CodeBuild console requires the `ListRepositories` permission to display a list of repositories for your AWS account in the AWS Region where you are signed in\. The console also includes a **Go to resource** function to quickly perform a case insensitive search for resources\. This search is performed in your AWS account in the AWS Region where you are signed in\. The following resources are displayed across the following services: -+ AWS CodeBuild: Build projects -+ AWS CodeCommit: Repositories -+ AWS CodeDeploy: Applications -+ AWS CodePipeline: Pipelines - -To perform this search across resources in all services, you must have the following permissions: -+ CodeBuild: `ListProjects` -+ CodeCommit: `ListRepositories` -+ CodeDeploy: `ListApplications` -+ CodePipeline: `ListPipelines` - -Results are not returned for a service's resources if you do not have permissions for that service\. Even if you have permissions for viewing resources, some resources are not returned if there is an explicit `Deny` to view those resources\. \ No newline at end of file diff --git a/doc_source/create-project.md b/doc_source/create-project.md deleted file mode 100644 index c3ca173..0000000 --- a/doc_source/create-project.md +++ /dev/null @@ -1,549 +0,0 @@ -# Create a Build Project in CodeBuild - -You can use the CodeBuild console, AWS CLI, or AWS SDKs to create a build project\. - -**Topics** -+ [Prerequisites](#create-project-prerequisites) -+ [Create a Build Project \(Console\)](#create-project-console) -+ [Create a Build Project \(AWS CLI\)](#create-project-cli) -+ [Create a Build Project \(AWS SDKs\)](#create-project-sdks) -+ [Create a Build Project \(AWS CloudFormation\)](#create-project-cloud-formation) - -## Prerequisites - -Answer the questions in [Plan a Build](planning.md)\. - -## Create a Build Project \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. Choose **Create build project**\. - -1. In **Project configuration**: - - On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - - In **Description**, enter an optional description for your project\. - - Select **Build badge** to make your project's build status visible and embeddable\. For more information, see [Build Badges Sample](sample-build-badges.md)\. -**Note** - Build badge does not apply if your source provider is Amazon S3\. - - Expand **Additional configuration**\. - - \(Optional\) For **Tags**, enter the name and value of any tags that you want supporting AWS services to use\. Use **Add row** to add a tag\. You can add up to 50 tags\. - -1. In **Source**: - - For **Source provider**, choose the source code provider type\. Use the following table to make selections appropriate for your source provider: -**Note** -CodeBuild does not support Bitbucket Server\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html) - - For each secondary source you want: - - 1. Choose **Add source**\. - - 1. For **Source identifier**, enter a value that is fewer than 128 characters and contains only alphanumeric characters and underscores\. - - 1. For **Source provider**, choose the source code provider type\. Use the table earlier in this step to make selections appropriate for your secondary source provider\. - -1. In **Environment**: - - For **Environment image**, do one of the following: - + To use a Docker image managed by AWS CodeBuild, choose **Managed image**, and then make selections from **Operating system**, **Runtime**, and **Runtime version**\. - + To use another Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Amazon ECR** or **Other location**\. If you choose **Other location**, enter the name and tag of the Docker image in Docker Hub, using the format `docker repository/docker image name`\. If you choose **Amazon ECR**, then use **Amazon ECR repository** and **Amazon ECR image** to choose the Docker image in your AWS account\. - + To use private Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Other location**, and then enter the Amazon Resource Name \(ARN\) of the credentials for your private Docker image\. The credentials must be created by AWS Secrets Manager\. For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - - \(Optional\) Select **Privileged** only if you plan to use this build project to build Docker images, and the build environment image you chose is not provided by CodeBuild with Docker support\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it\. One way to do this is to initialize the Docker daemon in the `install` phase of your build spec by running the following build commands\. Do not run these commands if you chose a build environment image provided by CodeBuild with Docker support\. - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - - In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - - Expand **Additional configuration**\. - - \(Optional\) For **Timeout**, specify a value between 5 minutes and 480 minutes \(8 hours\) after which CodeBuild stops the build if it is not complete\. If **hours** and **minutes** are left blank, the default value of 60 minutes is used\. - - In **VPC**, do one of the following: - + If you are not using a VPC for your project, choose **No VPC**\. - + If you want CodeBuild to work with your VPC: - + For **VPC**, choose the VPC ID that CodeBuild uses\. - + For **VPC Subnets**, choose the subnets that include resources that CodeBuild uses\. - + For **VPC Security groups**, choose the security groups that CodeBuild uses to allow access to resources in the VPCs\. - - For more information, see [Use CodeBuild with Amazon Virtual Private Cloud](vpc-support.md)\. - - For **Compute**, choose one of the available options\. - - For **Environment variables**, type the name and value, then choose the type, of each environment variable for builds to use\. Use **Add environment variable** to add an environment variable\. -**Note** -CodeBuild sets the environment variable for your AWS Region automatically\. If you do not add them to your buildspec\.yml, then the following environment variables must be set: -AWS\_ACCOUNT\_ID -IMAGE\_REPO\_NAME -IMAGE\_TAG - - Others can see environment variables by using the CodeBuild console and the AWS CLI\. If you have no concerns about the visibility of your environment variable, set the **Name** and **Value** fields, and then set **Type** to **Plaintext**\. - - We recommend that you store an environment variable with a sensitive value, such as an AWS access key ID, an AWS secret access key, or a password as a parameter in Amazon EC2 Systems Manager Parameter Store\. For **Type**, choose **Parameter**\. For **Name**, enter an identifier for CodeBuild to reference\. For **Value**, enter the parameter's name as stored in Amazon EC2 Systems Manager Parameter Store\. Using a parameter named `/CodeBuild/dockerLoginPassword` as an example, for **Type**, choose **Parameter**\. For **Name**, enter `LOGIN_PASSWORD`\. For **Value**, type `/CodeBuild/dockerLoginPassword`\. -**Important** -We recommend that you store parameters in Amazon EC2 Systems Manager Parameter Store with parameter names that start with `/CodeBuild/` \(for example, `/CodeBuild/dockerLoginPassword`\)\. You can use the CodeBuild console to create a parameter in Amazon EC2 Systems Manager\. Choose **Create parameter**, and then follow the instructions in the dialog box\. \(In that dialog box, for **KMS key**, you can optionally specify the ARN of an AWS KMS key in your account\. Amazon EC2 Systems Manager uses this key to encrypt the parameter's value during storage and decrypt during retrieval\.\) If you use the CodeBuild console to create a parameter, the console starts the parameter name with `/CodeBuild/` as it is being stored\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store, the build project's service role must allow the `ssm:GetParameters` action\. If you chose **New service role** earlier, then CodeBuild includes this action in the default service role for your build project automatically\. However, if you chose **Existing service role**, then you must include this action to your service role separately\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store with parameter names that do not start with `/CodeBuild/`, and you chose **New service role**, then you must update that service role to allow access to parameter names that do not start with `/CodeBuild/`\. This is because that service role allows access only to parameter names that start with `/CodeBuild/`\. -If you choose **Create a service role in your account**, the created service role includes permission to decrypt all parameters under the `/CodeBuild/` namespace in the Amazon EC2 Systems Manager Parameter Store\. -Environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that begins with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, the value is determined as follows: -The value in the start build operation call takes highest precedence\. -The value in the build project definition takes next precedence\. -The value in the build spec declaration takes lowest precedence\. - -1. In **Buildspec**: - - For **Build specifications**, do one of the following: - + If your source code includes a buildspec file, choose **Use a buildspec file**\. - + If your source code does not include a buildspec file, or if you want to run build commands different from the ones specified for the `build` phase in the `buildspec.yml` file in the source code's root directory, choose **Insert build commands**\. For **Build commands**, enter the commands you want to run in the `build` phase\. For multiple commands, separate each command by `&&` \(for example, `mvn test && mvn package`\)\. To run commands in other phases, or if you have a long list of commands for the `build` phase, add a `buildspec.yml` file to the source code root directory, add the commands to the file, and then choose **Use the buildspec\.yml in the source code root directory**\. - - For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. In **Artifacts**: - - For **Type**, do one of the following: - + If you do not want to create any build output artifacts, choose **No artifacts**\. You might want to do this if you're only running build tests or you want to push a Docker image to an Amazon ECR repository\. - + To store the build output in an Amazon S3 bucket, choose **Amazon S3**, and then do the following: - + If you want to use your project name for the build output ZIP file or folder, leave **Name** blank\. Otherwise, enter the name\. \(If you want to output a ZIP file, and you want the ZIP file to have a file extension, be sure to include it after the ZIP file name\.\) - + Select **Use the name specified in the buildspec file** if you want a name specified in the buildspec file to override any name that is specified in the console\. The name in a buildspec file is calculated at build time and uses the Shell command language\. For example, you can append a date and time to your artifact name so that it is always unique\. Unique artifact names prevent artifacts from being overwritten\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - + For **Bucket name**, choose the name of the output bucket\. - + If you chose **Insert build commands** earlier in this procedure, then for **Output files**, enter the locations of the files from the build that you want to put into the build output ZIP file or folder\. For multiple locations, separate each location with a comma \(for example, `appspec.yml, target/my-app.jar`\)\. For more information, see the description of `files` in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - + If you do not want your build artifacts encrypted, select **Remove artifacts encryption**\. - - For each secondary set of artifacts you want: - - 1. For **Artifact identifier**, enter a value that is fewer than 128 characters and contains only alphanumeric characters and underscores\. - - 1. Choose **Add artifact**\. - - 1. Follow the previous steps to configure your secondary artifacts\. - - 1. Choose **Save artifact**\. - - Expand **Additional configuration**\. - - \(Optional\) For **Encryption key**, do one of the following: - + To use the AWS\-managed customer master key \(CMK\) for Amazon S3 in your account to encrypt the build output artifacts, leave **Encryption key** blank\. This is the default\. - + To use a customer\-managed CMK to encrypt the build output artifacts, in **Encryption key**, enter the ARN of the CMK\. Use the format `arn:aws:kms:region-ID:account-ID:key/key-ID`\. - - For **Cache type**, choose one of the following: - + If you do not want to use a cache, choose **No cache**\. - + If you want to use an Amazon S3 cache, choose **Amazon S3**, and then do the following: - + For **Bucket**, choose the name of the Amazon S3 bucket where the cache is stored\. - + \(Optional\) For **Cache path prefix**, enter an Amazon S3 path prefix\. The **Cache path prefix** value is similar to a directory name\. It makes it possible for you to store the cache under the same directory in a bucket\. -**Important** -Do not append a trailing slash \(/\) to the end of the path prefix\. - + If you want to use a local cache, choose **Local**, and then choose one or more local cache modes\. -**Note** -**Docker layer cache** mode is available for Linux only\. If you choose it, your project must run in privileged mode\. - - Using a cache saves considerable build time because reusable pieces of the build environment are stored in the cache and used across builds\. For information about specifying a cache in the buildspec file, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. For more information about caching, see [Build Caching in CodeBuild](build-caching.md)\. - -1. In **Logs**, choose the logs you want to create\. You can create Amazon CloudWatch Logs, Amazon S3 logs, or both\. - - If you want Amazon CloudWatch Logs logs: - + Select **CloudWatch logs**\. - + In **Group name**, enter the name of your Amazon CloudWatch Logs log group\. - + In **Stream name**, enter your Amazon CloudWatch Logs log stream name\. - - If you want Amazon S3 logs: - + Select **S3 logs**\. - + From **Bucket**, choose the name of the S3 bucket for your logs\. - + In **Path prefix**, enter the prefix for your logs\. - - \(Optional\) If you chose **Amazon S3** for **Type** in **Artifacts** earlier in this procedure, then for **Artifacts packaging**, do one of the following: - + To have CodeBuild create a ZIP file that contains the build output, choose **Zip**\. - + To have CodeBuild create a folder that contains the build output, choose **None**\. \(This is the default\.\) - + Select **Remove S3 log encryption** if you do not want your S3 logs encrypted\. - -1. Choose **Create build project**\. - -1. On the **Review** page, choose **Start build**\. - -## Create a Build Project \(AWS CLI\) - -For information about using the AWS CLI with CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Run the create\-project command: - - ``` - aws codebuild create-project --generate-cli-skeleton - ``` - - JSON\-formatted data appears in the output\. Copy the data to a file \(for example, `create-project.json`\) in a location on the local computer or instance where the AWS CLI is installed\. Modify the copied data as follows, and save your results\. - - ``` - { - "name": "project-name", - "description": "description", - "source": { - "type": "source-type", - "location": "source-location", - "gitCloneDepth": "gitCloneDepth", - "buildspec": "buildspec", - "InsecureSsl": "InsecureSsl", - "reportBuildStatus": reportBuildStatus", - "gitSubmodulesConfig": { - "fetchSubmodules": "fetchSubmodules" - }, - "auth": { - "type": "auth-type", - "resource": "resource" - } - }, - ”sourceVersion”: “source-version”, - “secondarySourceVersions”: { - “sourceIdentifier”: ”secondary-source-identifier”, - “sourceVersion”: ”secondary-source-version” - }, - "artifacts": { - "type": "artifacts-type", - "location": "artifacts-location", - "path": "path", - "namespaceType": "namespaceType", - "name": "artifacts-name", - "overrideArtifactName": "override-artifact-name", - "packaging": "packaging" - }, - "cache": { - "type": "cache-type", - "location": "cache-location", - "mode": [ - "cache-mode" - ] - }, - "logsConfig": { - "cloudWatchLogs": { - "status": "cloudwatch-logs-status", - "groupName": "group-name", - "streamName": "stream-name" - } - "s3Logs": { - "status": "s3-logs-status", - "location": "s3-logs-location", - "encryptionDisabled": "s3-logs-encryptionDisabled" - } - } - "secondaryArtifacts": [ - { - "type": "artifacts-type", - "location": "artifacts-location", - "path": "path", - "namespaceType": "namespaceType", - "name": "artifacts-name", - "packaging": "packaging", - "artifactIdentifier": "artifact-identifier" - } - ] - , - "secondarySources": [ - { - "type": "source-type", - "location": "source-location", - "gitCloneDepth": "gitCloneDepth", - "buildspec": "buildspec", - "InsecureSsl": "InsecureSsl", - "reportBuildStatus": "reportBuildStatus", - "auth": { - "type": "auth-type", - "resource": "resource" - }, - "sourceIdentifier": "source-identifier" - } - ], - "serviceRole": "serviceRole", - "vpcConfig": { - "securityGroupIds": [ - "security-group-id" - ], - "subnets": [ - "subnet-id" - ], - "vpcId": "vpc-id" - }, - "timeoutInMinutes": timeoutInMinutes, - "encryptionKey": "encryptionKey", - "tags": [ - { - "key": "tag-key", - "value": "tag-value" - } - ], - "environment": { - "type": "environment-type", - "image": "image", - "computeType": "computeType", - "certificate": "certificate", - "environmentVariables": [ - { - "name": "environmentVariable-name", - "value": "environmentVariable-value", - "type": "environmentVariable-type" - } - ], - "registryCredential": [ - { - "credential": "credential-arn-or-name", - "credentialProvider": "credential-provider" - } - ], - "imagePullCredentialsType": "imagePullCredentialsType-value, - "privilegedMode": "privilegedMode" - }, - "badgeEnabled": "badgeEnabled" - } - ``` - - Replace the following: - + *project\-name*: Required value\. The name for this build project\. This name must be unique across all of the build projects in your AWS account\. - + *description*: Optional value\. The description for this build project\. - + For the required `source` object, information about this build project's source code settings\. After you add a `source` object, you can add up to 12 more sources using the [CodeBuild secondarySources object](#cli-secondary-sources)\. These settings include the following: - + *source\-type*: Required value\. The type of repository that contains the source code to build\. Valid values include `CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `GITHUB_ENTERPRISE`, `BITBUCKET`, `S3`, and `NO_SOURCE`\. If you use `NO_SOURCE`, then the buildspec cannot be a file because the project does not have a source\. Instead, you must use the `buildspec` attribute to specify a YAML\-formatted string for your buildspec\. For more information, see [Project Without a Source Sample](sample-multi-in-out.md#no-source)\. - + *source\-location*: Required value \(unless you set *source\-type* to `CODEPIPELINE`\)\. The location of the source code for the specified repository type\. - + For CodeCommit, the HTTPS clone URL to the repository that contains the source code and the build spec \(for example, `https://git-codecommit.region-id.amazonaws.com/v1/repos/repo-name`\)\. - + For Amazon S3, the build input bucket name, followed by a forward slash \(`/`\), followed by the name of the ZIP file that contains the source code and the build spec \(for example, `bucket-name/object-name.zip`\)\. This assumes that the ZIP file is in the root of the build input bucket\. \(If the ZIP file is in a folder inside of the bucket, use `bucket-name/path/to/object-name.zip` instead\.\) - + For GitHub, the HTTPS clone URL to the repository that contains the source code and the build spec\. The URL must contain "github\.com\." You must connect your AWS account to your GitHub account\. To do this, use the CodeBuild console to create a build project\. - - 1. When you use the console to connect \(or reconnect\) with GitHub, on the GitHub **Authorize application** page, for **Organization access**, choose **Request access** next to each repository you want CodeBuild to be able to access\. - - 1. Choose **Authorize application**\. \(After you have connected to your GitHub account, you do not need to finish creating the build project\. You can close the CodeBuild console\.\) - + For GitHub Enterprise, the HTTP or HTTPS clone URL to the repository that contains the source code and the build spec\. You must also connect your AWS account to your GitHub Enterprise account\. To do this, use the CodeBuild console to create a build project\. - - 1. Create a personal access token in GitHub Enterprise\. - - 1. Copy this token to your clipboard so you can use it when you create your CodeBuild project\. For more information, see [Creating a Personal Access Token in GitHub Enterprise](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) on the GitHub Help website\. - - 1. When you use the console to create your CodeBuild project, in **Source**, for **Source provider**, choose **GitHub Enterprise**\. - - 1. For **Personal Access Token**, paste the token that was copied to your clipboard\. Choose **Save Token**\. Your CodeBuild account is now connected to your GitHub Enterprise account\. - + For Bitbucket, the HTTPS clone URL to the repository that contains the source code and the build spec\. The URL must contain "bitbucket\.org\." You must also connect your AWS account to your Bitbucket account\. To do this, use the CodeBuild console to create a build project\. - - 1. When you use the console to connect \(or reconnect\) with Bitbucket, on the Bitbucket **Confirm access to your account** page, choose **Grant access**\. \(After you have connected to your Bitbucket account, you do not need to finish creating the build project\. You can close the CodeBuild console\.\) - + For AWS CodePipeline, do not specify a `location` value for `source`\. It is ignored by CodePipeline because when you create a pipeline in CodePipeline, you specify the source code location in the Source stage of the pipeline\. - + *gitCloneDepth*: Optional value\. The depth of history to download\. Minimum value is 0\. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project\. If your source type is Amazon S3, this value is not supported\. - + *buildspec*: Optional value\. The build specification definition or file to use\. If this value is set, it can be either an inline build spec definition or the path to an alternate build spec file relative to the value of the built\-in `CODEBUILD_SRC_DIR` environment variable\. If this value is not provided or is set to an empty string, then the source code must contain a `buildspec.yml` file in its root directory\. For more information, see [Build Spec File Name and Storage Location](build-spec-ref.md#build-spec-ref-name-storage)\. - + *auth*: This object is used by the CodeBuild console only\. Do not specify values for *auth\-type* \(unless *source\-type* is set to `GITHUB`\) or *resource*\. - + *reportBuildStatus*: Optional value\. Specifies whether to send your source provider the status of a build's start and completion\. If you set this with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown\. - + *gitSubmodulesConfig*: Optional value\. Information about the Git submodules configuration\. Used with CodeCommit, GitHub, GitHub Enterprise, and Bitbucket only\. Set `fetchSubmodules` to true if you want to include the Git submodules in your repository\. Git submodules that are included must be configured as HTTPS\. - + *InsecureSsl*: Optional value\. Used with GitHub Enterprise only\. Set this value to `true` to ignore SSL warnings while connecting to your GitHub Enterprise project repository\. The default value is `false`\. *InsecureSsl* should be used for testing purposes only\. It should not be used in a production environment\. - + *source\-version*: Optional value\. A version of the build input to be built for this project\. If not specified, the latest version is used\. If specified, it must be one of: - + For CodeCommit: the commit ID to use\. - + For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build\. If a pull request ID is specified, it must use the format `pr/pull-request-ID` \(for example `pr/25`\)\. If a branch name is specified, the branch's HEAD commit ID is used\. If not specified, the default branch's HEAD commit ID is used\. - + For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build\. If a branch name is specified, the branch's HEAD commit ID is used\. If not specified, the default branch's HEAD commit ID is used\. - + For Amazon Simple Storage Service \(Amazon S3\): the version ID of the object that represents the build input ZIP file to use\. - - If `sourceVersion` is specified at the build level, then that version takes precedence over this `sourceVersion` \(at the project level\)\. For more information, see [Source Version Sample with CodeBuild](sample-source-version.md)\. - + *secondarySourceVersions*: Optional value\. An array of `projectSourceVersion` objects\. If `secondarySourceVersions` is specified at the build level, then they take precedence over this\. - + *secondary\-source\-identifier*: An identifier for a source in the build project\. - + *secondary\-source\-version*: A `sourceVersion` object\. - + For the required `artifacts` object, information about this build project's output artifact settings\. After you add an `artifacts` object, you can add up to 12 more artifacts using the [CodeBuild secondaryArtifacts object](#cli-secondary-artifacts)\. These settings include the following: - + *artifacts\-type*: Required value\. The type of build output artifact\. Valid values include `CODEPIPELINE`, `NO_ARTIFACTS`, and `S3`\. - + *artifacts\-location*: Required value \(unless you set *artifacts\-type* to `CODEPIPELINE` or `NO_ARTIFACTS`\)\. The location of the build output artifact: - + If you specified `CODEPIPELINE` for *artifacts\-type*, do not specify a `location` for `artifacts`\. - + If you specified `NO_ARTIFACTS` for *artifacts\-type*, do not specify a `location` for `artifacts`\. - + If you specified `S3` for *artifacts\-type*, then this is the name of the output bucket you created or identified in the prerequisites\. - + *path*: Optional value\. The path and name of the build output ZIP file or folder: - + If you specified `CODEPIPELINE` for *artifacts\-type*, then do not specify a `path` for `artifacts`\. - + If you specified `NO_ARTIFACTS` for *artifacts\-type*, do not specify a `path` for `artifacts`\. - + If you specified `S3` for *artifacts\-type*, then this is the path inside of *artifacts\-location* to the build output ZIP file or folder\. If you do not specify a value for *path*, then CodeBuild uses *namespaceType* \(if specified\) and *artifacts\-name* to determine the path and name of the build output ZIP file or folder\. For example, if you specify `MyPath` for *path* and `MyArtifact.zip` for *artifacts\-name*, then the path and name would be `MyPath/MyArtifact.zip`\. - + *namespaceType*: Optional value\. The path and name of the build output ZIP file or folder: - + If you specified `CODEPIPELINE` for *artifacts\-type*, do not specify a `namespaceType` for `artifacts`\. - + If you specified `NO_ARTIFACTS` for *artifacts\-type*, do not specify a `namespaceType` for `artifacts`\. - + If you specified `S3` for *artifacts\-type*, valid values include `BUILD_ID` and `NONE`\. Use `BUILD_ID` to insert the build ID into the path of the build output ZIP file or folder\. Otherwise, use `NONE`\. If you do not specify a value for *namespaceType*, CodeBuild uses *path* \(if specified\) and *artifacts\-name* to determine the path and name of the build output ZIP file or folder\. For example, if you specify `MyPath` for *path*, `BUILD_ID` for *namespaceType*, and `MyArtifact.zip` for *artifacts\-name*, then the path and name would be `MyPath/build-ID/MyArtifact.zip`\. - + *artifacts\-name*: Required value \(unless you set *artifacts\-type* to `CODEPIPELINE` or `NO_ARTIFACTS`\)\. The path and name of the build output ZIP file or folder: - + If you specified `CODEPIPELINE` for *artifacts\-type*, do not specify a `name` for `artifacts`\. - + If you specified `NO_ARTIFACTS` for *artifacts\-type*, do not specify a `name` for `artifacts`\. - + If you specified `S3` for *artifacts\-type*, then this is the name of the build output ZIP file or folder inside of *artifacts\-location*\. For example, if you specify `MyPath` for *path* and `MyArtifact.zip` for *artifacts\-name*, then the path and name would be `MyPath/MyArtifact.zip`\. - + *override\-artifact\-name*: Optional boolean value\. If set to `true`, the name specified in the `artifacts` block of the buildspec file overrides *artifacts\-name*\. For more information, see [Build Specification Reference for CodeBuild](build-spec-ref.md)\. - + *packaging*: Optional value\. The type of build output artifact to create: - + If you specified `CODEPIPELINE` for *artifacts\-type*, do not specify a `packaging` for `artifacts`\. - + 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\. For information, see [Build Caching](build-caching.md)\. These settings include the following\. - + *cache\-type*: Required value\. Valid values are `S3`, `NO_CACHE`, or `LOCAL_CACHE`\. - + *cache\-location*: Required value only if you set *CacheType* to `S3`\. If you specified Amazon S3 for *CacheType*, this is the ARN of the Amazon 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 `arn:aws:s3:::my-bucket/build-cache`\. - + *cache\-mode*: Required value if you set *CacheType* to `LOCAL`\. You can specify one or more of the following local cache modes: `LOCAL_SOURCE_CACHE`, `LOCAL_DOCKER_LAYER_CACHE`, `LOCAL_CUSTOM_CACHE`\. -**Note** -`LOCAL_DOCKER_LAYER_CACHE` mode is available for Linux only\. If you choose it, your project must run in privileged mode\. - + For the `logsConfig` object, information about where this build's logs are located: - + *cloudwatch\-logs\-status*: Required value\. Valid values are `ENABLED` or `DISABLED`\. If its value is `ENABLED` then the following values are required\. For more information, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html)\. - + *group\-name*: The name of the CloudWatch Logs group\. - + *stream\-name*: The name of the CloudWatch Logs stream\. - + *s3\-logs\-status*: Required value\. Valid values are `ENABLED` or `DISABLED`\. - + *s3\-logs\-location*: Required if *s3\-logs\-status* is `ENABLED`\. This is the ARN of an S3 bucket and the path prefix\. For example, if your Amazon S3 bucket name is `my-bucket`, and your path prefix is `build-log`, then acceptable formats for your *s3\-logs\-location* are `my-bucket/build-log` or `arn:aws:s3:::my-bucket/build-log`\. - + *s3\-logs\-encryptionDisabled*: Optional boolean value\. If set to `true` your S3 build log output is not encrypted\. By default S3 build logs are encrypted\. - + For the optional `secondaryArtifacts` object, information about the settings of a secondary artifiact for a build project\. You can add up to 12 secondary artifacts\. The `secondaryArtifacts` uses many of the same settings used by the [CodeBuild artifacts object](#cli-artifacts) object\. The settings are: - + *artifacts\-type*: Required value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's type property](#cli-artifacts-type)\. - + *artifacts\-location*: Required value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's location property](#cli-artifacts-location)\. - + *path*: Optional value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's path property](#cli-artifacts-path)\. - + *namespaceType*: Optional value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's namespaceType property](#cli-artifacts-namespacetype)\. - + *artifacts\-name*: Required value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's name property](#cli-artifacts-name)\. - + *packaging*: Optional value\. This setting is also used by the `artifacts` object\. See [CodeBuild artifact object's packaging property](#cli-artifacts-packaging)\. - + *artifact\-identifier*: Required value\. A unique string identifier for a secondary artifact\. - + For the optional `secondarySources` object, information about the settings of a secondary source for a build project\. You can add up to 12 `secondarySources`\. The `secondarySources` object uses many of the same settings used by the [CodeBuild source object](#cli-sources)\. They include the following: - + *source\-type*: Required value\. This setting is also used by the `sources` object\. See [CodeBuild source object's type property](#cli-sources-type)\. - + *source\-location*: Required value\. This setting is also used by the `sources` object\. See [CodeBuild source object's location property](#cli-sources-location)\. - + *gitCloneDepth*: Optional value\. This setting is also used by the `sources` object\. See [CodeBuild source object's gitCloneDepth property](#cli-sources-gitclonedepth)\. - + *buildspec*: Optional value\. This setting is also used by the `sources` object\. See [CodeBuild source object's buildspec property](#cli-sources-buildspec)\. - + *auth*: This setting is also used by the `sources` object\. See [CodeBuild source object's auth property](#cli-sources-auth)\. - + *reportBuildStatus*: Optional value\. This setting is also used by the `sources` object\. See [CodeBuild source object's reportBuildStatus property](#cli-sources-reportbuildstatus)\. - + *InsecureSsl*: Optional value\. This setting is also used by the `sources` object\. See [CodeBuild source object's insecureSsl property](#cli-sources-insecuressl)\. - + *source\-identifier*: Required value\. A unique string identifier for a secondary source\. - + *serviceRole*: Required value\. The ARN of the service role 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: - + *vpcId*: Required value\. The VPC ID that CodeBuild uses\. Run this command to get a list of all Amazon VPC IDs in your region: - - ``` - aws ec2 describe-vpcs - ``` - + *subnets*: Required value\. The subnet IDs that include resources used by CodeBuild\. Run this command to get these IDs: - - ``` - aws ec2 describe-subnets --filters "Name=vpc-id,Values=" --region us-east-1 - ``` -**Note** -If you are using a region other than us\-east\-1, be sure to use it when you run the command\. - + *securityGroupIds*: Required value\. The security group IDs used by CodeBuild to allow access to resources in the VPCs\. Run this command to get these IDs: - - ``` - aws ec2 describe-security-groups --filters "Name=vpc-id,Values=" --region us-east-1 - ``` -**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\. 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 CodeBuild uses to manage its Docker images, this could be `aws/codebuild/standard:2.0`\. 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 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 S3 bucket, path prefix and object key that contains 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\. - + For the optional `environmentVariables` array, information about any environment variables you want to specify for this build environment\. Each environment variable is expressed as an object that contains a `name`, `value`, and `type` of *environmentVariable\-name*, *environmentVariable\-value*, and *environmentVariable\-type*\. - - Others can see an environment variable by using the CodeBuild console and the AWS CLI\. If you have no concerns about the visibility of your environment variable, set *environmentVariable\-name* and *environmentVariable\-value*, and then set *environmentVariable\-type* to `PLAINTEXT`\. - - We recommend you store an environment variable with a sensitive value, such as an AWS access key ID, an AWS secret access key, or a password as a parameter in Amazon EC2 Systems Manager Parameter Store\. For *environmentVariable\-name*, for that stored parameter, set an identifier for CodeBuild to reference\. For *environmentVariable\-value*, set the parameter's name as stored in Amazon EC2 Systems Manager Parameter Store\. Set *environmentVariable\-type* to `PARAMETER_STORE`\. Using a parameter named `/CodeBuild/dockerLoginPassword` as an example, set *environmentVariable\-name* to `LOGIN_PASSWORD`\. Set *environmentVariable\-value* to `/CodeBuild/dockerLoginPassword`\. Set *environmentVariable\-type* to `PARAMETER_STORE`\. -**Important** -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store, the build project's service role must allow the `ssm:GetParameters` action\. If you chose **Create a service role in your account** earlier, then CodeBuild includes this action in the default service role for your build project automatically\. However, if you chose **Choose an existing service role from your account**, then you must include this action to your service role separately\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store with parameter names that do not start with `/CodeBuild/`, and you chose **Create a service role in your account**, then you must update that service role to allow access to parameter names that do not start with `/CodeBuild/`\. This is because that service role allows access only to parameter names that start with `/CodeBuild/`\. -Any environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that begins with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, the value is determined as follows: -The value in the start build operation call takes highest precedence\. -The value in the build project definition takes next precedence\. -The value in the build spec declaration takes lowest precedence\. - + Use the optional `registryCredential` to specify information about credentials that provide access to a private Docker registry\. - + *credential\-arn\-or\-name*: Specifies the ARN or name of credentials created using AWS Managed Services \. You can use the name of the credentials only if they exist in your current region - + *credential\-provider*: the only valid value is `SECRETS_MANAGER`\. - - When this is set: - + `imagePullCredentials` must be set to `SERVICE_ROLE`\. - + images cannot be curated or an Amazon ECR image\. - + *imagePullCredentialsType\-value*: Optional value\. The type of credentials CodeBuild uses to pull images in your build\. There are two valid values: - + `CODEBUILD` specifies that CodeBuild uses its own credentials\. This requires that you modify your Amazon ECR repository policy to trust the CodeBuild service principal\. - + `SERVICE_ROLE` specifies that CodeBuild uses your build project's service role\. - - When you use a cross\-account or private registry image, you must use `SERVICE_ROLE` credentials\. When you use a CodeBuild curated image, you must use `CODEBUILD` credentials\. - + You must specify *privilegedMode* with a value of `true` only if you plan to use this build project to build Docker images, and the build environment image you specified is not provided by CodeBuild with Docker support\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it\. One way to do this is to initialize the Docker daemon in the `install` phase of your build spec by running the following build commands\. Do not run these commands if you specified a build environment image provided by CodeBuild with Docker support\. - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - + *badgeEnabled*: Optional value\. To include build badges with your CodeBuild project, you must specify *badgeEnabled* with a value of `true`\. For more information, see [Build Badges Sample with CodeBuild](sample-build-badges.md)\. - + *timeoutInMinutes*: Optional value\. The number of minutes, between 5 to 480 \(8 hours\), after which CodeBuild stops the build if it is not complete\. If not specified, the default of 60 is used\. To determine if and when CodeBuild stopped a build due to a timeout, run the `batch-get-builds` command\. To determine if the build has stopped, look in the output for a `buildStatus` value of `FAILED`\. To determine when the build timed out, look in the output for the `endTime` value associated with a `phaseStatus` value of `TIMED_OUT`\. - + *encryptionKey*: Optional value\. The alias or ARN of the AWS KMS customer master key \(CMK\) CodeBuild uses to encrypt the build output\. If you specify an alias, use the format `arn:aws:kms:region-ID:account-ID:key/key-ID` or, if an alias exists, use the format `alias/key-alias`\. If not specified, the AWS\-managed CMK for Amazon S3 is used\. - + For the optional *tags* array, information about any tags you want to associate with this build project\. You can specify up to 50 tags\. These tags can be used by any AWS service that supports CodeBuild build project tags\. Each tag is expressed as an object that contains a `key` and `value` value of *tag\-key* and *tag\-value*\. - - For an example, see [To create the build project \(AWS CLI\)](getting-started.md#getting-started-create-build-project-cli)\. - -1. Switch to the directory that contains the file you just saved, and run the create\-projectcommand again: - - ``` - aws codebuild create-project --cli-input-json file://create-project.json - ``` - -1. If successful, data similar to the following appears in the output: - - ``` - { - "project": { - "name": "project-name", - "description": "description", - "serviceRole": "serviceRole", - "tags": [ - { - "key": "tags-key", - "value": "tags-value" - } - ], - "artifacts": { - "namespaceType": "namespaceType", - "packaging": "packaging", - "path": "path", - "type": "artifacts-type", - "location": "artifacts-location", - "name": "artifacts-name" - }, - "lastModified": lastModified, - "timeoutInMinutes": timeoutInMinutes, - "created": created, - "environment": { - "computeType": "computeType", - "image": "image", - "type": "environment-type", - "environmentVariables": [ - { - "name": "environmentVariable-name", - "value": "environmentVariable-value", - "type": "environmentVariable-type" - } - ] - }, - "source": { - "type": "source-type", - "location": "source-location", - "buildspec": "buildspec", - "auth": { - "type": "auth-type", - "resource": "resource" - } - }, - "encryptionKey": "encryptionKey", - "arn": "arn" - } - } - ``` - + The `project` object contains information about the new build project: - + The `lastModified` value represents the time, in Unix time format, when information about the build project was last changed\. - + The `created` value represents the time, in Unix time format, when the build project was created\. - + The `arn` value represents the ARN of the build project\. - -**Note** -Except for the build project name, you can change any of the build project's settings later\. For more information, see [Change a Build Project's Settings \(AWS CLI\)](change-project.md#change-project-cli)\. - -To start running a build, see [Run a Build \(AWS CLI\)](run-build.md#run-build-cli)\. - -If your source code is stored in a GitHub repository, and you want CodeBuild to rebuild the source code every time a code change is pushed to the repository, see [Start Running Builds Automatically \(AWS CLI\)](run-build.md#run-build-cli-auto-start)\. - -## Create a Build Project \(AWS SDKs\) - -For information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. - -## Create a Build Project \(AWS CloudFormation\) - -For information about using AWS CodeBuild with AWS CloudFormation, see [the AWS CloudFormation template for CodeBuild](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) in the *AWS CloudFormation User Guide*\. \ No newline at end of file diff --git a/doc_source/data-protection.md b/doc_source/data-protection.md deleted file mode 100644 index 4f0a2f4..0000000 --- a/doc_source/data-protection.md +++ /dev/null @@ -1,19 +0,0 @@ -# Data Protection in AWS CodeBuild - - AWS CodeBuild conforms to the AWS [shared responsibility model](https://aws.amazon.com/compliance/shared-responsibility-model/), which includes regulations and guidelines for data protection\. AWS is responsible for protecting the global infrastructure that runs all the AWS services\. AWS maintains control over data hosted on this infrastructure, including the security configuration controls for handling customer content and personal data\. AWS customers and APN partners, acting either as data controllers or data processors, are responsible for any personal data that they put in the AWS Cloud\. - - For data protection purposes, we recommend that you protect AWS account credentials and set up individual user accounts with AWS Identity and Access Management \(IAM\), so that each user is given only the permissions necessary to fulfill their job duties\. We also recommend that you secure your data in the following ways: -+ Use multi\-factor authentication \(MFA\) with each account\. -+ Use SSL/TLS to communicate with AWS resources\. -+ Set up API and user activity logging with AWS CloudTrail\. -+ Use AWS encryption solutions, along with all default security controls in AWS services\. -+ Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon S3\. - -We strongly recommend that you never put sensitive identifying information, such as your customers' account numbers, into free\-form fields such as a **Name** field\. This includes when you work with CodeBuild or other AWS services using the console, API, AWS CLI, or AWS SDKs\. Any data that you enter into CodeBuild or other services might get picked up for inclusion in diagnostic logs\. When you provide a URL to an external server, don't include credentials information in the URL to validate your request to that server\. - -For more information about data protection, see the [AWS Shared Responsibility Model and GDPR](http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) blog post on the *AWS Security Blog*\. - -**Topics** -+ [Data Encryption](security-encryption.md) -+ [Key Management](security-key-management.md) -+ [Traffic Privacy](security-traffic-privacy.md) \ No newline at end of file diff --git a/doc_source/delete-builds.md b/doc_source/delete-builds.md deleted file mode 100644 index 7916da1..0000000 --- a/doc_source/delete-builds.md +++ /dev/null @@ -1,44 +0,0 @@ -# Delete Builds in CodeBuild - -To delete builds in CodeBuild, you can use the AWS CLI, or the AWS SDKs\. - -## Delete Builds \(AWS CLI\) - -Run the `batch-delete-builds` command: - -``` -aws codebuild batch-delete-builds --ids ids -``` - -In the preceding command, replace the following placeholder: -+ *ids*: Required string\. The IDs of the builds to delete\. To specify multiple builds, separate each build ID with a space\. To get a list of build IDs, see the following topics: - + [View a List of Build IDs \(AWS CLI\)](view-build-list.md#view-build-list-cli) - + [View a List of Build IDs for a Build Project \(AWS CLI\)](view-builds-for-project.md#view-builds-for-project-cli) - -If successful, a `buildsDeleted` array appears in the output, containing the Amazon Resource Name \(ARN\) of each build that was successfully deleted\. Information about builds that were not successfully deleted appears in output within a `buildsNotDeleted` array\. - -For example, if you run this command: - -``` -aws codebuild batch-delete-builds --ids my-demo-build-project:f8b888d2-5e1e-4032-8645-b115195648EX my-other-demo-build-project:a18bc6ee-e499-4887-b36a-8c90349c7eEX -``` - -Information similar to the following appears in the output: - -``` -{ - "buildsNotDeleted": [ - { - "id": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-build-project:f8b888d2-5e1e-4032-8645-b115195648EX", - "statusCode": "BUILD_IN_PROGRESS" - } - ], - "buildsDeleted": [ - "arn:aws:codebuild:us-west-2:123456789012:build/my-other-demo-build-project:a18bc6ee-e499-4887-b36a-8c90349c7eEX" - ] -} -``` - -## Delete Builds \(AWS SDKs\) - -For information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/delete-project.md b/doc_source/delete-project.md deleted file mode 100644 index f4ca655..0000000 --- a/doc_source/delete-project.md +++ /dev/null @@ -1,42 +0,0 @@ -# Delete a Build Project in AWS CodeBuild - -You can use the CodeBuild console, AWS CLI, or AWS SDKs to delete a build project in CodeBuild\. - -**Warning** -If you delete a build project, it cannot be recovered\. All information about builds is also deleted and cannot be recovered\. - -**Topics** -+ [Delete a Build Project \(Console\)](#delete-project-console) -+ [Delete a Build Project \(AWS CLI\)](#delete-project-cli) -+ [Delete a Build Project \(AWS SDKs\)](#delete-project-sdks) - -## Delete a Build Project \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. Do one of the following: - + Choose the radio button next to the build project you want to delete, and then choose **Delete**\. - + Choose the link for the build project you want to delete, and then choose **Delete**\. -**Note** -By default, only the most recent 10 build projects are displayed\. To view more build projects, choose a different value for **Projects per page** or use the back and forward arrows for viewing projects\. - -## Delete a Build Project \(AWS CLI\) - -For more information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Run the `delete-project` command: - - ``` - aws codebuild delete-project --name name - ``` - - Replace the following placeholder: - + *name*: Required string\. The name of the build project to delete\. To get a list of available build projects, run the `list-projects` command\. For more information, see [View a List of Build Project Names \(AWS CLI\)](view-project-list.md#view-project-list-cli)\. - -1. If successful, no data and no errors appear in the output\. - -## Delete a Build Project \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/endpoint-specify.md b/doc_source/endpoint-specify.md deleted file mode 100644 index bc34755..0000000 --- a/doc_source/endpoint-specify.md +++ /dev/null @@ -1,82 +0,0 @@ -# Specify the CodeBuild Endpoint - - You can use the AWS Command Line Interface \(AWS CLI\) or one of the AWS SDKs to specify the endpoint used by AWS CodeBuild\. There is an endpoint for each region in which CodeBuild is available\. In addition to a regional endpoint, four regions also have a Federal Information Processing Standards \(FIPS\) endpoint\. For more information about FIPS endpoints, see [FIPS 140\-2 Overview](https://aws.amazon.com/compliance/fips/)\. - - Specifying an endpoint is optional\. If you don't explicitly tell CodeBuild which endpoint to use, the service uses the endpoint associated with the region your AWS account uses\. CodeBuild never defaults to a FIPS endpoint\. If you want to use a FIPS endpoint, you must associate CodeBuild with it using one of the following methods\. - -**Note** - You can use an alias or region name to specify an endpoint using an AWS SDK\. If you use the AWS CLI, then you must use the full endpoint name\. - - For endpoints that can be used with CodeBuild, see [CodeBuild Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region)\. - -**Topics** -+ [Specify the CodeBuild Endpoint \(AWS CLI\)](#endpoint-specify-cli) -+ [Specify the CodeBuild Endpoint \(AWS SDK\)](#endpoint-specify-sdk) - -## Specify the CodeBuild Endpoint \(AWS CLI\) - - You can use the AWS CLI to specify the endpoint through which AWS CodeBuild is accessed by using the `--endpoint-url` argument in any CodeBuild command\. For example, run this command to get a list of project build names using the Federal Information Processing Standards \(FIPS\) endpoint in the US East \(N\. Virginia\) Region: - -``` -aws codebuild list-projects --endpoint-url https://codebuild-fips.us-east-1.amazonaws.com -``` - -Include the `https://` at the begining of the endpoint\. - - The `--endpoint-url` AWS CLI argument is available to all AWS services\. For more information about this and other AWS CLI arguments, see [AWS CLI Command Reference](https://docs.aws.amazon.com/cli/latest/reference/)\. - -## Specify the CodeBuild Endpoint \(AWS SDK\) - - You can use an AWS SDK to specify the endpoint through which AWS CodeBuild is accessed\. Although this example uses the [AWS SDK for Java](https://aws.amazon.com/sdk-for-java/), you can specify the endpoint with the other AWS SDKs\. - - Use the `withEndpointConfiguration` method when constructing the AWSCodeBuild client\. Here is format to use: - -``` -AWSCodeBuild awsCodeBuild = AWSCodeBuildClientBuilder.standard(). - withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("endpoint", "region")). - withCredentials(new AWSStaticCredentialsProvider(sessionCredentials)). - build(); -``` - - For information about `AWSCodeBuildClientBuilder`, see [Class AWSCodeBuildClientBuilder](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/codebuild/AWSCodeBuildClientBuilder.html)\. - - The credentials used in `withCredentials` must be of type `AWSCredentialsProvider`\. For more information, see [Working with AWS Credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html)\. - - Do not include `https://` at the begining of the endpoint\. - - If you want to specify a non\-FIPS endpoint, you can use the region instead of the actual endpoint\. For example, to specify the endpoint in the US East \(N\. Virginia\) region, you can use `us-east-1` instead of the full endpoint name, `codebuild.us-east-1.amazonaws.com`\. - -If you want to specify a FIPS endpoint, you can use an alias to simplify your code\. Only FIPS endpoints have an alias\. Other endpoints must be specified using their region or full name\. - -The following table lists the alias for each of the four available FIPS endpoints: - - -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/endpoint-specify.html) - - To specify use of the FIPS endpoint in the US West \(Oregon\) region using an alias: - -``` -AWSCodeBuild awsCodeBuild = AWSCodeBuildClientBuilder.standard(). - withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("us-west-2-fips", "us-west-2")). - withCredentials(new AWSStaticCredentialsProvider(sessionCredentials)). - build(); -``` - - To specify use of the non\-FIPS endpoint in the US East \(N\. Virginia\) region: - -``` -AWSCodeBuild awsCodeBuild = AWSCodeBuildClientBuilder.standard(). - withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("us-east-1", "us-east-1")). - withCredentials(new AWSStaticCredentialsProvider(sessionCredentials)). - build(); -``` - - To specify use of the non\-FIPS endpoint in the Asia Pacific \(Mumbai\) region: - -``` -AWSCodeBuild awsCodeBuild = AWSCodeBuildClientBuilder.standard(). - withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("ap-south-1", "ap-south-1")). - withCredentials(new AWSStaticCredentialsProvider(sessionCredentials)). - build(); -``` \ No newline at end of file diff --git a/doc_source/getting-started.md b/doc_source/getting-started.md deleted file mode 100644 index 7f5ac82..0000000 --- a/doc_source/getting-started.md +++ /dev/null @@ -1,704 +0,0 @@ -# Getting Started with CodeBuild - -In this walkthrough, you use AWS CodeBuild to build a collection of sample source code input files \(called *build input artifacts* or *build input*\) into a deployable version of the source code \(called *build output artifact* or *build output*\)\. Specifically, you instruct CodeBuild to use Apache Maven, a common build tool, to build a set of Java class files into a Java Archive \(JAR\) file\. You do not need to be familiar with Apache Maven or Java to complete this walkthrough\. - -**Important** -Completing this walkthrough may result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, and CloudWatch Logs\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), and [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing)\. - -**Topics** -+ [Step 1: Create or Use Amazon S3 Buckets to Store the Build Input and Output](#getting-started-input-bucket) -+ [Step 2: Create the Source Code to Build](#getting-started-create-source-code) -+ [Step 3: Create the Build Spec](#getting-started-create-build-spec) -+ [Step 4: Add the Source Code and the Build Spec to the Input Bucket](#getting-started-upload-source-code) -+ [Step 5: Create the Build Project](#getting-started-create-build-project) -+ [Step 6: Run the Build](#getting-started-run-build) -+ [Step 7: View Summarized Build Information](#getting-started-monitor-build) -+ [Step 8: View Detailed Build Information](#getting-started-build-log) -+ [Step 9: Get the Build Output Artifact](#getting-started-output) -+ [Step 10: Clean Up](#getting-started-clean-up) -+ [Next Steps](#getting-started-next-steps) - -## Step 1: Create or Use Amazon S3 Buckets to Store the Build Input and Output - -To complete this walkthrough, you need two Amazon S3 buckets: -+ One of these buckets stores the build input \(the *input bucket*\)\. In this walkthrough, we name this input bucket `codebuild-region-ID-account-ID-input-bucket`, where *region\-ID* represents the AWS Region of the bucket, and *account\-ID* represents your AWS account ID\. -+ The other bucket stores the build output \(the *output bucket*\)\. In this walkthrough, we name this output bucket `codebuild-region-ID-account-ID-output-bucket`\. - -If you chose a different name for either of these buckets, be sure to use it throughout this walkthrough\. - -These two buckets must be in the same AWS Region as your builds\. For example, if you instruct CodeBuild to run a build in the US East \(Ohio\) Region, then these buckets must also be in the US East \(Ohio\) Region\. - -To create a bucket, see [Creating a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/CreatingaBucket.html) in the *Amazon Simple Storage Service User Guide*\. - -**Note** -You can use a single bucket for this walkthrough, but using two buckets makes it easier to see where the build input is coming from and where the build output is going\. -Although CodeBuild also supports build input stored in CodeCommit, GitHub, and Bitbucket repositories, this walkthrough does not show you how to use them\. For more information, see [Plan a Build](planning.md)\. - -## Step 2: Create the Source Code to Build - -In this step, you create the source code that you want CodeBuild to build to the output bucket\. This source code consists of two Java class files and an Apache Maven Project Object Model \(POM\) file\. - -1. In an empty directory on your local computer or instance, create this directory structure\. - - ``` - (root directory name) - `-- src - |-- main - | `-- java - `-- test - `-- java - ``` - -1. Using a text editor of your choice, create this file, name it `MessageUtil.java`, and then save it in the `src/main/java` directory\. - - ``` - public class MessageUtil { - private String message; - - public MessageUtil(String message) { - this.message = message; - } - - public String printMessage() { - System.out.println(message); - return message; - } - - public String salutationMessage() { - message = "Hi!" + message; - System.out.println(message); - return message; - } - } - ``` - - This class file creates as output the string of characters passed into it\. The `MessageUtil` constructor sets the string of characters\. The `printMessage` method creates the output\. The `salutationMessage` method outputs `Hi!` followed by the string of characters\. - -1. Create this file, name it `TestMessageUtil.java`, and then save it in the `/src/test/java` directory\. - - ``` - import org.junit.Test; - import org.junit.Ignore; - import static org.junit.Assert.assertEquals; - - public class TestMessageUtil { - - String message = "Robert"; - MessageUtil messageUtil = new MessageUtil(message); - - @Test - public void testPrintMessage() { - System.out.println("Inside testPrintMessage()"); - assertEquals(message,messageUtil.printMessage()); - } - - @Test - public void testSalutationMessage() { - System.out.println("Inside testSalutationMessage()"); - message = "Hi!" + "Robert"; - assertEquals(message,messageUtil.salutationMessage()); - } - } - ``` - - This class file sets the `message` variable in the `MessageUtil` class to `Robert`\. It then tests to see if the `message` variable was successfully set by checking whether the strings `Robert` and `Hi!Robert` appear in the output\. - -1. Create this file, name it `pom.xml`, and then save it in the root \(top level\) directory\. - - ``` - - 4.0.0 - org.example - messageUtil - 1.0 - jar - Message Utility Java Sample App - - - junit - junit - 4.11 - test - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.8.0 - - - - - ``` - - Apache Maven uses the instructions in this file to convert the `MessageUtil.java` and `TestMessageUtil.java` files into a file named `messageUtil-1.0.jar` and then run the specified tests\. - -At this point, your directory structure should look like this\. - -``` -(root directory name) - |-- pom.xml - `-- src - |-- main - | `-- java - | `-- MessageUtil.java - `-- test - `-- java - `-- TestMessageUtil.java -``` - -## Step 3: Create the Build Spec - -In this step, you create a build specification \(build spec\) file\. A *build spec* is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build\. Without a build spec, CodeBuild cannot successfully convert your build input into build output or locate the build output artifact in the build environment to upload to your output bucket\. - -Create this file, name it `buildspec.yml`, and then save it in the root \(top level\) directory\. - -``` -version: 0.2 - -phases: - install: - runtime-versions: - java: openjdk11 - pre_build: - commands: - - echo Nothing to do in the pre_build phase... - build: - commands: - - echo Build started on `date` - - mvn install - post_build: - commands: - - echo Build completed on `date` -artifacts: - files: - - target/messageUtil-1.0.jar -``` - -**Important** -Because a build spec declaration must be valid YAML, the spacing in a build spec declaration is important\. If the number of spaces in your build spec declaration does not match this one, the build might fail immediately\. You can use a YAML validator to test whether your build spec declaration is valid YAML\. - -**Note** -Instead of including a build spec file in your source code, you can declare build commands separately when you create a build project\. This is helpful if you want to build your source code with different build commands without updating your source code's repository each time\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -In this build spec declaration: -+ `version` represents the version of the build spec standard being used\. This build spec declaration uses the latest version, `0.2`\. -+ `phases` represents the build phases during which you can instruct CodeBuild to run commands\. These build phases are listed here as `install`, `pre_build`, `build`, and `post_build`\. You cannot change the spelling of these build phase names, and you cannot create more build phase names\. - - In this example, during the `build` phase, CodeBuild runs the `mvn install` command\. This command instructs Apache Maven to compile, test, and package the compiled Java class files into a build output artifact\. For completeness, a few `echo` commands are placed in each build phase in this example\. When you view detailed build information later in this walkthrough, the output of these `echo` commands can help you better understand how CodeBuild runs commands and in which order\. \(Although all build phases are included in this example, you are not required to include a build phase if you do not plan to run any commands during that phase\.\) For each build phase, CodeBuild runs each specified command, one at a time, in the order listed, from beginning to end\. -+ `artifacts` represents the set of build output artifacts that CodeBuild uploads to the output bucket\. `files` represents the files to include in the build output\. CodeBuild uploads the single `messageUtil-1.0.jar` file found in the `target` relative directory in the build environment\. The file name `messageUtil-1.0.jar` and the directory name `target` are based on the way Apache Maven creates and stores build output artifacts for this example only\. In your own builds, these file names and directories are different\. - -For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -At this point, your directory structure should look like this\. - -``` -(root directory name) - |-- pom.xml - |-- buildspec.yml - `-- src - |-- main - | `-- java - | `-- MessageUtil.java - `-- test - `-- java - `-- TestMessageUtil.java -``` - -## Step 4: Add the Source Code and the Build Spec to the Input Bucket - -In this step, you add the source code and build spec file to the input bucket\. - -Using your operating system's zip utility, create a file named `MessageUtil.zip` that includes `MessageUtil.java`, `TestMessageUtil.java`, `pom.xml`, and `buildspec.yml`\. - -The `MessageUtil.zip` file's directory structure must look like this\. - -``` -MessageUtil.zip - |-- pom.xml - |-- buildspec.yml - `-- src - |-- main - | `-- java - | `-- MessageUtil.java - `-- test - `-- java - `-- TestMessageUtil.java -``` - -**Important** -Do not include the `(root directory name)` directory, only the directories and files in the `(root directory name)` directory\. - -Upload the `MessageUtil.zip` file to the input bucket named `codebuild-region-ID-account-ID-input-bucket`\. - -**Important** -For CodeCommit, GitHub, and Bitbucket repositories, by convention, you must store a build spec file named `buildspec.yml` in the root \(top level\) of each repository or include the build spec declaration as part of the build project definition\. Do not create a ZIP file that contains the repository's source code and build spec file\. -For build input stored in Amazon S3 buckets only, you must create a ZIP file that contains the source code and, by convention, a build spec file named `buildspec.yml` at the root \(top level\) or include the build spec declaration as part of the build project definition\. -If you want to use a different name for your build spec file, or you want to reference a build spec in a location other than the root, you can specify a build spec override as part of the build project definition\. For more information, see [Build Spec File Name and Storage Location](build-spec-ref.md#build-spec-ref-name-storage)\. - -## Step 5: Create the Build Project - -In this step, you create a build project that AWS CodeBuild uses to run the build\. A *build project* defines how CodeBuild runs a build\. It includes information such as where to get the source code, the build environment to use, the build commands to run, and where to store the build output\. A *build environment* represents a combination of operating system, programming language runtime, and tools that CodeBuild uses to run a build\. The build environment is expressed as a Docker image\. \(For more information, see the [Docker Overview](https://docs.docker.com/engine/docker-overview/) topic on the Docker Docs website\.\) For this build environment, you instruct CodeBuild to use a Docker image that contains a version of the Java Development Kit \(JDK\) and Apache Maven\. - -You can use the [CodeBuild console](#getting-started-create-build-project-console) or [AWS CLI](#getting-started-create-build-project-cli) to complete this step\. - -**Note** -You can work with CodeBuild in several ways: through the CodeBuild console, AWS CodePipeline, the AWS CLI, or the AWS SDKs\. This walkthrough demonstrates how to use the CodeBuild console and the AWS CLI\. To learn how to use CodePipeline, see [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. To learn how to use the AWS SDKs, see [Run AWS CodeBuild Directly](how-to-run.md)\. - -**To create the build project \(console\)** - -1. Sign in to the AWS Management Console and open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the AWS region selector, choose a region that supports CodeBuild\. For more information, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the "Regions and Endpoints" topic in the *Amazon Web Services General Reference*\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project \(in this example, `codebuild-demo-project`\)\. Build project names must be unique across each AWS account\. If you use a different name, be sure to use it throughout this walkthrough\. -**Note** -On the **Create build project** page, you might see an error message similar to the following: **User: *user\-ARN* is not authorized to perform: codebuild:ListProjects**\. This is most likely because you signed in to the AWS Management Console as an IAM user that does not have sufficient permissions to use CodeBuild in the console\. To fix this, sign out of the AWS Management Console, and then sign back in with credentials belonging to one of the following IAM entities: -Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. -An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. -An IAM user in your AWS account with the AWS managed policies named **AWSCodeBuildAdminAccess**, **AmazonS3ReadOnlyAccess**, and **IAMFullAccess** attached to that IAM user or to an IAM group that the IAM user belongs to\. If you do not have an IAM user or group in your AWS account with these permissions, and you cannot add these permissions to your IAM user or group, contact your AWS account administrator for assistance\. For more information, see [AWS Managed \(Predefined\) Policies for CodeBuild](auth-and-access-control-iam-identity-based-access-control.md#managed-policies)\. - -1. In **Source**, for **Source provider**, choose **Amazon S3**\. - -1. For **Bucket**, choose **codebuild\-*region\-ID*\-*account\-ID*\-input\-bucket**\. - -1. For **S3 object key**, enter **MessageUtil\.zip**\. - -1. In **Environment**, for **Environment image**, leave **Managed image** selected\. - -1. For **Operating system**, choose **Ubuntu**\. - -1. For **Runtime\(s\)**, choose **Standard**\. - -1. For **Image**, choose **aws/codebuild/standard:2\.0**\. - -1. In **Service role**, leave **New service role** selected, and leave **Role name** unchanged\. - -1. For **Buildspec**, leave **Use a buildspec file** selected\. - -1. In **Artifacts**, for **Type**, choose **Amazon S3**\. - -1. For **Bucket name**, choose **codebuild\-*region\-ID*\-*account\-ID*\-output\-bucket**\. - -1. Leave **Name** and **Path** blank\. - -1. Choose **Create build project**\. - - Skip ahead to [Step 6: Run the Build](#getting-started-run-build)\. - -**To create the build project \(AWS CLI\)** - -1. Use the AWS CLI to run the create\-project command: - - ``` - aws codebuild create-project --generate-cli-skeleton - ``` - - JSON\-formatted data appears in the output\. Copy the data to a file named `create-project.json` in a location on the local computer or instance where the AWS CLI is installed\. If you choose to use a different file name, be sure to use it throughout this walkthrough\. - - Modify the copied data to follow this format, and then save your results: - - ``` - { - "name": "codebuild-demo-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" - }, - "artifacts": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL" - }, - "serviceRole": "serviceIAMRole" - } - ``` - - Replace *serviceIAMRole* with the Amazon Resource Name \(ARN\) of a CodeBuild service role \(for example, `arn:aws:iam::account-ID:role/role-name`\)\. To create one, see [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - - In this data: - + `name` represents a required identifier for this build project \(in this example, `codebuild-demo-project`\)\. Build project names must be unique across all build projects in your account\. - + For `source`, `type` is a required value that represents the source code's repository type \(in this example, `S3` for an Amazon S3 bucket\)\. - + For `source`, `location` represents the path to the source code \(in this example, the input bucket name followed by the ZIP file name\)\. - + For `artifacts`, `type` is a required value that represents the build output artifact's repository type \(in this example, `S3` for an Amazon S3 bucket\)\. - + For `artifacts`, `location` represents the name of the output bucket you created or identified earlier \(in this example, `codebuild-region-ID-account-ID-output-bucket`\)\. - + For `environment`, `type` is a required value that represents the type of build environment \(`LINUX_CONTAINER` is currently the only allowed value\)\. - + For `environment`, `image` is a required value that represents the Docker image name and tag combination this build project uses, as specified by the Docker image repository type \(in this example, `aws/codebuild/standard:2.0` for a Docker image in the CodeBuild Docker images repository\)\. `aws/codebuild/standard` is the name of the Docker image\. `1.0` is the tag of the Docker image\. - - To find more Docker images you can use in your scenarios, see the [Build Environment Reference](build-env-ref.md)\. - + For `environment`, `computeType` is a required value that represents the computing resources CodeBuild uses \(in this example, `BUILD_GENERAL1_SMALL`\)\. -**Note** -Other available values in the original JSON\-formatted data, such as `description`, `buildspec`, `auth` \(including `type` and `resource`\), `path`, `namespaceType`, `name` \(for `artifacts`\), `packaging`, `environmentVariables` \(including `name` and `value`\), `timeoutInMinutes`, `encryptionKey`, and `tags` \(including `key` and `value`\) are optional\. They are not used in this walkthrough, so they are not shown here\. For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -1. Switch to the directory that contains the file you just saved, and then run the create\-project command again\. - - ``` - aws codebuild create-project --cli-input-json file://create-project.json - ``` - - If successful, data similar to this appears in the output\. - - ``` - { - "project": { - "name": "codebuild-demo-project", - "serviceRole": "serviceIAMRole", - "tags": [], - "artifacts": { - "packaging": "NONE", - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket", - "name": "message-util.zip" - }, - "lastModified": 1472661575.244, - "timeoutInMinutes": 60, - "created": 1472661575.244, - "environment": { - "computeType": "BUILD_GENERAL1_SMALL", - "image": "aws/codebuild/standard:2.0", - "type": "LINUX_CONTAINER", - "environmentVariables": [] - }, - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" - }, - "encryptionKey": "arn:aws:kms:region-ID:account-ID:alias/aws/s3", - "arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project" - } - } - ``` - + `project` represents information about this build project\. - + `tags` represents any tags that were declared\. - + `packaging` represents how the build output artifact is stored in the output bucket\. `NONE` means that a folder is created in the output bucket\. The build output artifact is stored in that folder\. - + `lastModified` represents the time, in Unix time format, when information about the build project was last changed\. - + `timeoutInMinutes` represents the number of minutes after which CodeBuild stops the build if the build has not been completed\. \(The default is 60 minutes\.\) - + `created` represents the time, in Unix time format, when the build project was created\. - + `environmentVariables` represents any environment variables that were declared and are available for CodeBuild to use during the build\. - + `encryptionKey` represents the ARN of the AWS KMS customer master key \(CMK\) that CodeBuild used to encrypt the build output artifact\. - + `arn` represents the ARN of the build project\. - -**Note** -After you run the create\-project command, an error message similar to the following might be output: **User: *user\-ARN* is not authorized to perform: codebuild:CreateProject**\. This is most likely because you configured the AWS CLI with the credentials of an IAM user that does not have sufficient permissions to use CodeBuild to create build projects\. To fix this, configure the AWS CLI with credentials belonging to one of the following IAM entities: -Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. -An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. -An IAM user in your AWS account with the AWS managed policies named **AWSCodeBuildAdminAccess**, **AmazonS3ReadOnlyAccess**, and **IAMFullAccess** attached to that IAM user or to an IAM group that the IAM user belongs to\. If you do not have an IAM user or group in your AWS account with these permissions, and you cannot add these permissions to your IAM user or group, contact your AWS account administrator for assistance\. For more information, see [AWS Managed \(Predefined\) Policies for CodeBuild](auth-and-access-control-iam-identity-based-access-control.md#managed-policies)\. - -## Step 6: Run the Build - -In this step, you instruct AWS CodeBuild to run the build with the settings in the build project\. - -You can use the [CodeBuild console](#getting-started-run-build-console) or [AWS CLI](#getting-started-run-build-cli) to complete this step\. - -**To run the build \(console\)** - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. In the list of build projects, choose **codebuild\-demo\-project**, and then choose **Start build**\. - -1. On the **Start new build** page, choose **Start build**\. - -1. Skip ahead to [Step 7: View Summarized Build Information](#getting-started-monitor-build)\. - -**To run the build \(AWS CLI\)** - -1. Use the AWS CLI to run the start\-build command: - - ``` - aws codebuild start-build --project-name project-name - ``` - - Replace *project\-name* with your build project name from the previous step \(for example, `codebuild-demo-project`\)\. - -1. If successful, data similar to the following appears in the output: - - ``` - { - "build": { - "buildComplete": false, - "initiator": "user-name", - "artifacts": { - "location": "arn:aws:s3:::codebuild-region-ID-account-ID-output-bucket/message-util.zip" - }, - "projectName": "codebuild-demo-project", - "timeoutInMinutes": 60, - "buildStatus": "IN_PROGRESS", - "environment": { - "computeType": "BUILD_GENERAL1_SMALL", - "image": "aws/codebuild/standard:2.0", - "type": "LINUX_CONTAINER", - "environmentVariables": [] - }, - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" - }, - "currentPhase": "SUBMITTED", - "startTime": 1472848787.882, - "id": "codebuild-demo-project:0cfbb6ec-3db9-4e8c-992b-1ab28EXAMPLE", - "arn": "arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:0cfbb6ec-3db9-4e8c-992b-1ab28EXAMPLE" - } - } - ``` - + `build` represents information about this build\. - + `buildComplete` represents whether the build was completed \(`true`\); otherwise, `false`\. - + `initiator` represents the entity that started the build\. - + `artifacts` represents information about the build output, including its location\. - + `projectName` represents the name of the build project\. - + `buildStatus` represents the current build status when the start\-build command was run\. - + `currentPhase` represents the current build phase when the start\-build command was run\. - + `startTime` represents the time, in Unix time format, when the build process started\. - + `id` represents the ID of the build\. - + `arn` represents the ARN of the build\. - - Make a note of the `id` value\. You need it in the next step\. - -## Step 7: View Summarized Build Information - -In this step, you view summarized information about the status of your build\. - -You can use the [AWS CodeBuild console](#getting-started-monitor-build-console) or the [AWS CLI](#getting-started-monitor-build-cli) to complete this step\. - -### To view summarized build information \(console\) - -1. If the **codebuild\-demo\-project:*build\-ID*** page is not displayed, then in the navigation bar, choose **Build history**\. Next, in the list of build projects, for **Project**, choose the **Build run** link for **codebuild\-demo\-project**\. There should be only one matching link\. \(If you have completed this walkthrough before, choose the link in the **Completed** column for the most recent value\.\) - -1. On the build details page, in **Phase details**, the following list of build phases should be displayed, with **Succeeded** in the **Status** column: - + **SUBMITTED** - + **QUEUED** - + **PROVISIONING** - + **DOWNLOAD\_SOURCE** - + **INSTALL** - + **PRE\_BUILD** - + **BUILD** - + **POST\_BUILD** - + **UPLOAD\_ARTIFACTS** - + **FINALIZING** - + **COMPLETED** - - In **Build Status**, **Succeeded** should be displayed\. - - If you see **In Progress** instead, choose the refresh button to see the latest progress\. - -1. Next to each build phase, the **Duration** value indicates how long that build phase lasted\. The **End time** value indicates when that build phase ended\. - - Skip ahead to [Step 8: View Detailed Build Information](#getting-started-build-log)\. - -### To view summarized build information \(AWS CLI\) - -Use the AWS CLI to run the batch\-get\-builds command\. - -``` -aws codebuild batch-get-builds --ids id -``` - -Replace *id* with the `id` value that appeared in the output of the previous step\. - -If successful, data similar to this appears in the output\. - -``` -{ - "buildsNotFound": [], - "builds": [ - { - "buildComplete": true, - "phases": [ - { - "phaseStatus": "SUCCEEDED", - "endTime": 1472848788.525, - "phaseType": "SUBMITTED", - "durationInSeconds": 0, - "startTime": 1472848787.882 - }, - ... The full list of build phases has been omitted for brevity ... - { - "phaseType": "COMPLETED", - "startTime": 1472848878.079 - } - ], - "logs": { - "groupName": "/aws/codebuild/codebuild-demo-project", - "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=region-ID#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=38ca1c4a-e9ca-4dbc-bef1-d52bfEXAMPLE", - "streamName": "38ca1c4a-e9ca-4dbc-bef1-d52bfEXAMPLE" - }, - "artifacts": { - "md5sum": "MD5-hash", - "location": "arn:aws:s3:::codebuild-region-ID-account-ID-output-bucket/message-util.zip", - "sha256sum": "SHA-256-hash" - }, - "projectName": "codebuild-demo-project", - "timeoutInMinutes": 60, - "initiator": "user-name", - "buildStatus": "SUCCEEDED", - "environment": { - "computeType": "BUILD_GENERAL1_SMALL", - "image": "aws/codebuild/standard:2.0", - "type": "LINUX_CONTAINER", - "environmentVariables": [] - }, - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" - }, - "currentPhase": "COMPLETED", - "startTime": 1472848787.882, - "endTime": 1472848878.079, - "id": "codebuild-demo-project:38ca1c4a-e9ca-4dbc-bef1-d52bfEXAMPLE", - "arn": "arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:38ca1c4a-e9ca-4dbc-bef1-d52bfEXAMPLE" - } - ] -} -``` -+ `buildsNotFound` represents the build IDs for any builds where information is not available\. In this example, it should be empty\. -+ `builds` represents information about each build where information is available\. In this example, information about only one build appears in the output\. - + `phases` represents the set of build phases CodeBuild runs during the build process\. Information about each build phase is listed separately as `startTime`, `endTime`, and `durationInSeconds` \(when the build phase started and ended, expressed in Unix time format, and how long it lasted, in seconds\), and `phaseType` such as \(`SUBMITTED`, `PROVISIONING`, `DOWNLOAD_SOURCE`, `INSTALL`, `PRE_BUILD`, `BUILD`, `POST_BUILD`, `UPLOAD_ARTIFACTS`, `FINALIZING`, or `COMPLETED`\) and `phaseStatus` \(such as `SUCCEEDED`, `FAILED`, `FAULT`, `TIMED_OUT`, `IN_PROGRESS`, or `STOPPED`\)\. The first time you run the batch\-get\-builds command, there might not be many \(or any\) phases\. After subsequent runs of the batch\-get\-builds command with the same build ID, more build phases should appear in the output\. - + `logs` represents information in Amazon CloudWatch Logs about the build's logs\. - + `md5sum` and `sha256sum` represent MD5 and SHA\-256 hashes of the build's output artifact\. These appear in the output only if the build project's `packaging` value is set to `ZIP`\. \(You did not set this value in this walkthrough\.\) You can use these hashes along with a checksum tool to confirm file integrity and authenticity\. -**Note** -You can also use the Amazon S3 console to view these hashes\. Select the box next to the build output artifact, and then choose **Actions**, **Properties**\. In the **Properties** pane, expand **Metadata**, and view the values for **x\-amz\-meta\-codebuild\-content\-md5** and **x\-amz\-meta\-codebuild\-content\-sha256**\. \(In the Amazon S3 console, the build output artifact's **ETag** value should not be interpreted to be either the MD5 or SHA\-256 hash\.\) -If you use the AWS SDKs to get these hashes, the values are named `codebuild-content-md5` and `codebuild-content-sha256`\. - + `endTime` represents the time, in Unix time format, when the build process ended\. - -## Step 8: View Detailed Build Information - -In this step, you view detailed information about your build in CloudWatch Logs\. - -You can use the [CodeBuild console](#getting-started-build-log-console) or [AWS CLI](#getting-started-build-log-cli) to complete this step\. - -**To view detailed build information \(console\)** - -1. With the build details page still displayed from the previous step, the last 10,000 lines of the build log are displayed in **Build logs**\. To see the entire build log in CloudWatch Logs, choose the **View entire log** link\. - -1. In the CloudWatch Logs log stream, you can browse the log events\. By default, only the last set of log events is displayed\. To see earlier log events, scroll to the beginning of the list\. - -1. In this walkthrough, most of the log events contain verbose information about CodeBuild downloading and installing build dependency files into its build environment, which you probably don't care about\. You can use the **Filter events** box to reduce the information displayed\. For example, if you enter `"[INFO]"` in the **Filter events** box, only those events that contain `[INFO]` are displayed\. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/FilterAndPatternSyntax.html) in the *Amazon CloudWatch User Guide*\. - -Skip ahead to [Step 9: Get the Build Output Artifact](#getting-started-output)\. - -**To view detailed build information \(AWS CLI\)** - -1. Use your web browser to go to the `deepLink` location that appeared in the output in the previous step \(for example, `https://console.aws.amazon.com/cloudwatch/home?region=region-ID#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=38ca1c4a-e9ca-4dbc-bef1-d52bfEXAMPLE`\)\. - -1. In the CloudWatch Logs log stream, you can browse the log events\. By default, only the last set of log events is displayed\. To see earlier log events, scroll to the beginning of the list\. - -1. In this walkthrough, most of the log events contain verbose information about CodeBuild downloading and installing build dependency files into its build environment, which you probably don't care about\. You can use the **Filter events** box to reduce the information displayed\. For example, if you enter `"[INFO]"` in the **Filter events** box, only those events that contain `[INFO]` are displayed\. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) in the *Amazon CloudWatch User Guide*\. - -These portions of a CloudWatch Logs log stream pertain to this walkthrough\. - -``` -... -[Container] 2016/04/15 17:49:42 Entering phase PRE_BUILD -[Container] 2016/04/15 17:49:42 Running command echo Entering pre_build phase... -[Container] 2016/04/15 17:49:42 Entering pre_build phase... -[Container] 2016/04/15 17:49:42 Phase complete: PRE_BUILD Success: true -[Container] 2016/04/15 17:49:42 Entering phase BUILD -[Container] 2016/04/15 17:49:42 Running command echo Entering build phase... -[Container] 2016/04/15 17:49:42 Entering build phase... -[Container] 2016/04/15 17:49:42 Running command mvn install -[Container] 2016/04/15 17:49:44 [INFO] Scanning for projects... -[Container] 2016/04/15 17:49:44 [INFO] -[Container] 2016/04/15 17:49:44 [INFO] ------------------------------------------------------------------------ -[Container] 2016/04/15 17:49:44 [INFO] Building Message Utility Java Sample App 1.0 -[Container] 2016/04/15 17:49:44 [INFO] ------------------------------------------------------------------------ -... -[Container] 2016/04/15 17:49:55 ------------------------------------------------------- -[Container] 2016/04/15 17:49:55 T E S T S -[Container] 2016/04/15 17:49:55 ------------------------------------------------------- -[Container] 2016/04/15 17:49:55 Running TestMessageUtil -[Container] 2016/04/15 17:49:55 Inside testSalutationMessage() -[Container] 2016/04/15 17:49:55 Hi!Robert -[Container] 2016/04/15 17:49:55 Inside testPrintMessage() -[Container] 2016/04/15 17:49:55 Robert -[Container] 2016/04/15 17:49:55 Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.018 sec -[Container] 2016/04/15 17:49:55 -[Container] 2016/04/15 17:49:55 Results : -[Container] 2016/04/15 17:49:55 -[Container] 2016/04/15 17:49:55 Tests run: 2, Failures: 0, Errors: 0, Skipped: 0 -... -[Container] 2016/04/15 17:49:56 [INFO] ------------------------------------------------------------------------ -[Container] 2016/04/15 17:49:56 [INFO] BUILD SUCCESS -[Container] 2016/04/15 17:49:56 [INFO] ------------------------------------------------------------------------ -[Container] 2016/04/15 17:49:56 [INFO] Total time: 11.845 s -[Container] 2016/04/15 17:49:56 [INFO] Finished at: 2016-04-15T17:49:56+00:00 -[Container] 2016/04/15 17:49:56 [INFO] Final Memory: 18M/216M -[Container] 2016/04/15 17:49:56 [INFO] ------------------------------------------------------------------------ -[Container] 2016/04/15 17:49:56 Phase complete: BUILD Success: true -[Container] 2016/04/15 17:49:56 Entering phase POST_BUILD -[Container] 2016/04/15 17:49:56 Running command echo Entering post_build phase... -[Container] 2016/04/15 17:49:56 Entering post_build phase... -[Container] 2016/04/15 17:49:56 Phase complete: POST_BUILD Success: true -[Container] 2016/04/15 17:49:57 Preparing to copy artifacts -[Container] 2016/04/15 17:49:57 Assembling file list -[Container] 2016/04/15 17:49:57 Expanding target/messageUtil-1.0.jar -[Container] 2016/04/15 17:49:57 Found target/messageUtil-1.0.jar -[Container] 2016/04/15 17:49:57 Creating zip artifact -``` - -In this example, CodeBuild successfully completed the pre\-build, build, and post\-build build phases\. It ran the unit tests and successfully built the `messageUtil-1.0.jar` file\. - -## Step 9: Get the Build Output Artifact - -In this step, you get the `messageUtil-1.0.jar` file that CodeBuild built and uploaded to the output bucket\. - -You can use the [CodeBuild console](#getting-started-output-console) or [Amazon S3 console](#getting-started-output-s3) to complete this step\. - -**To get the build output artifact \(CodeBuild console\)** - -1. With the CodeBuild console still open and the build details page still displayed from the previous step, in **Build Status**, choose the **View artifacts** link\. This opens the folder in Amazon S3 for the build output artifact\. \(If the build details page is not displayed, in the navigation bar, choose **Build history**, and then choose the **Build run** link\.\) - -1. Open the folder named `target`, where you find the build output artifact file named `messageUtil-1.0.jar`\. - - Skip ahead to [Step 10: Clean Up](#getting-started-clean-up)\. - -**To get the build output artifact \(Amazon S3 console\)** - -1. Open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. Open the bucket named `codebuild-region-ID-account-ID-output-bucket`\. - -1. Open the folder named `codebuild-demo-project`\. - -1. Open the folder named `target`, where you find the build output artifact file named `messageUtil-1.0.jar`\. - -## Step 10: Clean Up - -To prevent ongoing charges to your AWS account, you can delete the input bucket used in this walkthrough\. For instructions, see [Deleting or Emptying a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-or-empty-bucket.html) in the *Amazon Simple Storage Service Developer Guide*\. - -If you are using the IAM user to delete this bucket instead of an AWS root account or an administrator IAM user, the user must have additional access permissions\. \(Using an AWS root account is not recommended\.\) Add the following statement between the markers \(*\#\#\# BEGIN ADDING STATEMENT HERE \#\#\#* and *\#\#\# END ADDING STATEMENTS HERE \#\#\#*\) to an existing access policy for the user\. Ellipses \(`...`\) are used for brevity\. Do not remove any statements in the existing access policy\. Do not enter these ellipses into the policy\. - -``` -{ - "Version": "2012-10-17", - "Id": "...", - "Statement": [ - ### BEGIN ADDING STATEMENT HERE ### - { - "Effect": "Allow", - "Action": [ - "s3:DeleteBucket", - "s3:DeleteObject" - ], - "Resource": "*" - } - ### END ADDING STATEMENT HERE ### - ] -} -``` - -## Next Steps - -In this walkthrough, you used AWS CodeBuild to build a set of Java class files into a JAR file\. You then viewed the build's results\. - -You can now try using CodeBuild in your own scenarios by following the instructions in [Plan a Build](planning.md)\. If you don't feel ready yet, you might want to try building some of the samples\. For more information, see [Samples](samples.md)\. \ No newline at end of file diff --git a/doc_source/glossary.md b/doc_source/glossary.md deleted file mode 100644 index 587d9a2..0000000 --- a/doc_source/glossary.md +++ /dev/null @@ -1,3 +0,0 @@ -# AWS Glossary - -For the latest AWS terminology, see the [AWS Glossary](https://docs.aws.amazon.com/general/latest/gr/glos-chap.html) in the *AWS General Reference*\. \ No newline at end of file diff --git a/doc_source/history.md b/doc_source/history.md deleted file mode 100644 index f891f91..0000000 --- a/doc_source/history.md +++ /dev/null @@ -1,78 +0,0 @@ -# AWS CodeBuild User Guide Document History - -The following table describes the important changes to the documentation since the last release of AWS CodeBuild\. For notification about updates to this documentation, you can subscribe to an RSS feed\. -+ **Latest API version:** 2016\-10\-06 -+ **Latest documentation update: **August 16, 2019 - -| Change | Description | Date | -| --- |--- |--- | -| [Updated topics](#history) | When you create a project, you can now choose the Amazon Linux 2 \(AL2\) managed image\. For more information, see [Docker Images Provided by CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) and [Runtime Versions in Buildspec File Sample for CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runtime-versions.html)\. | August 16, 2019 | -| [Updated topic](#history) | When you create a project, you can now choose to disable encryption of S3 logs and, if you use a Git\-based source repository, include Git submodules\. For more information, see [Create a Build Project in CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html)\. | March 8, 2019 | -| [New topic](#history) | CodeBuild now supports local caching\. You can specify local caching in one or more of four modes when you create a build\. For more information, see [Build Caching in CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html)\. | February 21, 2019 | -| [New topics](#history) | CodeBuild now supports webhook filter groups to specify events that trigger a build\. For more information, see [ Filter GitHub Webhook Events](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-github-pull-request.html#sample-github-pull-request-filter-webhook-events) and [ Filter Bitbucket Webhook Events](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-bitbucket-pull-request.html#sample-bitbucket-pull-request-filter-webhook-events)\. | February 8, 2019 | -| [New topic](#history) | The CodeBuild User Guide now shows how to use CodeBuild with a proxy server\. For more information, see [Use CodeBuild with a Proxy Server](https://docs.aws.amazon.com/codebuild/latest/userguide/use-proxy-server.html)\. | February 4, 2019 | -| [Updated topics](#history) | CodeBuild now supports using an Amazon ECR image that is in another AWS account\. Several topics have been updated to reflect this change, including [Amazon ECR Sample for CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html), [Create a Build Project](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html), and [Create a CodeBuild Service Role](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up.html#setting-up-service-role)\. | January 24, 2019 | -| [Support for private Docker registries](#history) | CodeBuild now supports using a Docker image that is stored in a private registry as your runtime environment\. For more information, see [Private Registry with AWS Secrets Manager Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html)\. | January 24, 2019 | -| [Updated topic](#history) | CodeBuild now supports using an access token to connect to GitHub \(with a personal access token\) and Bitbucket \(with an app password\) repositories\. For more information, see [Create a Build Project \(Console\)](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-console) and [Using Access Tokens with Your Source Provider](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html)\. | December 6, 2018 | -| [Updated topic](#history) | CodeBuild now supports new build metrics that measure the duration of each phase in a build\. For more information, see [ CodeBuild CloudWatch Metrics](https://docs.aws.amazon.com/codebuild/latest/userguide/monitoring-builds.html#cloudwatch_metrics-codebuild)\. | November 15, 2018 | -| [VPC Endpoint Policy Topic](#history) | Amazon VPC endpoints for CodeBuild now support policies\. For more information, see [ Create a VPC Endpoint Policy for CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/use-vpc-endpoints-with-codebuild.html#creating-vpc-endpoint-policy)\. | November 9, 2018 | -| [Updated content](#history) | Topics have been updated to reflect the new console experience\. | October 30, 2018 | -| [Amazon EFS sample](#history) | CodeBuild can mount an Amazon EFS file system during a build using commands in a project's buildspec file\. For more information, see [Amazon EFS Sample for CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-efs.html)\. | October 26, 2018 | -| [BitBucket webhooks](#history) | CodeBuild now supports webhooks when you use BitBucket for your repository\. For more information, see [Bitbucket Pull Request Sample for CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-bitbucket-pull-request.html)\. | October 2, 2018 | -| [S3 logs](#history) | CodeBuild now supports build logs in an S3 bucket\. Previously, you could only build logs using CloudWatch Logs\. For more information, see [Create Project](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html)\. | September 17, 2018 | -| [Multiple inpout sources and mulitple output artifacts](#history) | CodeBuild now supports projects that use more than one input source and publish more than one set of artifacts\. For more information, see [ Multiple Input Sources and Output Artifacts Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html) and [CodePipeline Integration with CodeBuild and Multiple Input Sources and Output Artifacts Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-pipeline-multi-input-output.html)\. | August 30, 2018 | -| [Semantic versioning sample](#history) | The CodeBuild User Guide now has a use case\-based sample that demonstrates how to use semantic versioning to create artifact names at build time\. For more information, see [ Semantic Versioning Your Build Artifacts Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-buildspec-artifact-naming.html)\. | August 14, 2018 | -| [New static website sample](#history) | The CodeBuild User Guide now has a use case\-based sample that demonstrates how to host build output in an Amazon S3 bucket\. The sample takes advantage of the recent support of unencrypted build artifiacts\. For more information, see [ Create a Static Website with Build Output Hosted in an Amazon S3 Bucket](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-disable-artifact-encryption.html)\. | August 14, 2018 | -| [Support for overriding an artifact name with semantic versioning](#history) | You can now use semantic versioning to specify a format that CodeBuild uses to name build artifacts\. This is useful because a build artifact with a hard\-coded name overwrites previous build artifacts that use the same hard\-coded name\. For example, if a build is triggered multiple times a day, you can now add a timestamp to its artifact name\. Each build artifact name is unique and does not overwrite the artifacts of previous builds\. | August 7, 2018 | -| [Support of unencrypted build artifacts](#history) | CodeBuild now supports builds with unencrypted build artifacts\. For more information, see [Create a Build Project \(Console\)](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-console)\. | July 26, 2018 | -| [Support for Amazon CloudWatch metrics and alarms](#history) | CodeBuild now provides integration with CloudWatch metrics and alarms\. You can use the CodeBuild or CloudWatch console to monitor builds at the project and account level\. For more information, see [Monitoring Builds](https://docs.aws.amazon.com/codebuild/latest/userguide/monitoring-builds.html)\. | July 19, 2018 | -| [Support for reporting a build's status](#history) | CodeBuild can now report the status of a build's start and completion to your source provider\. For more information, see [ Create a Build Project in CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html)\. | July 10, 2018 | -| [Environment variables added to CodeBuild documentation](#history) | The [Environment Variables in Build Environments](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html) page was updated with the CODEBUILD\_BUILD\_ID, CODEBUILD\_LOG\_PATH, and CODEBUILD\_START\_TIME environment variables\. | July 9, 2018 | -| [Support for a finally block in the build spec file](#history) | The CodeBuild documentation was updated with details about the optional `finally` block in a build spec file\. Commands in the finally block always execute after the commands in its corresponding commands block\. For more information, see [Build Spec Syntax](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-syntax)\. | June 20, 2018 | -| [CodeBuild agent update notifications](#history) | The CodeBuild documentation was updated with details about how you can use Amazon SNS to be notified when new versions of the CodeBuild agent are released\. For more information, see [Receive Notifications for New AWS CodeBuild Agent Versions](https://docs.aws.amazon.com/codebuild/latest/userguide/use-codebuild-agent.html#receive-codebuild-agent-notifications)\. | June 15, 2018 | - -## Earlier Updates - -The following table describes important changes in each release of the *AWS CodeBuild User Guide* before June 2018\. - - -**** - -| Change | Description | Date | -| --- | --- | --- | -| Support for Windows builds | CodeBuild now supports builds for the Microsoft Windows Server platform, including a prepackaged build environment for the \.NET Core 2\.0 on Windows\. For more information, see [Microsoft Windows Samples for CodeBuild](sample-windows.md)\. | May 25, 2018 | -| Support for build idempotency | When you run the start\-build command with the AWS Command Line Interface \(AWS CLI\), you can specify that the build is idempotent\. For more information, see [Run a Build \(AWS CLI\)](run-build.md#run-build-cli)\. | May 15, 2018 | -| Support for overriding more build project settings | You can now override more build project settings when you create a build\. The overrides are only for that build\. For more information, see [Run a Build in CodeBuild](run-build.md)\. | May 15, 2018 | -| VPC Endpoint support | You can now use VPC endpoints to improve the security of your builds\. For more information, see [Use VPC Endpoints](use-vpc-endpoints-with-codebuild.md)\. | March 18, 2018 | -| Support of triggers | You can now create riggers to schedule builds at regular frequencies\. For more information, see [Create CodeBuild Triggers](trigger-create.md)\. | March 28, 2018 | -| FIPS endpoints documentation | You can now learn about how to use the AWS Command Line Interface \(AWS CLI\) or an AWS SDK to tell CodeBuild to use one of four Federal Information Processing Standards \(FIPS\) endpoints\. For more information, see [Specify the CodeBuild Endpoint](endpoint-specify.md)\. | March 28, 2018 | -| AWS CodeBuild available in Asia Pacific \(Mumbai\), EU \(Paris\), and South America \(São Paulo\) | AWS CodeBuild is now available in the Asia Pacific \(Mumbai\), EU \(Paris\), and South America \(São Paulo\) regions\. For more information, see the [AWS CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) section of the "AWS Regions and Endpoints" topic in the Amazon Web Services General Reference\. | March 28, 2018 | -| GitHub Enterprise support | CodeBuild can now build from source code stored in a GitHub Enterprise repository\. For more information, see [GitHub Enterprise Sample](sample-github-enterprise.md)\. | January, 25, 2018 | -| Git clone depth support | CodeBuild now supports the creation of a shallow clone with a history truncated to the specified number of commits\. For more information, see [Create a Build Project](create-project.md)\. | January, 25, 2018 | -| VPC support | VPC\-enabled builds are now able to access resources inside your VPC\. For more information, see [VPC Support](vpc-support.md)\. | November, 27, 2017 | -| Dependency caching support | CodeBuild now supports the dependency caching\. This allows CodeBuild to save certain reusable pieces of the build environment in the cache and use this across builds\. | November, 27, 2017 | -| Build badges support | CodeBuild now supports the use of build badges, which provide an embeddable, dynamically generated image \(badge\) that displays the status of the latest build for a project\. For more information, see [Build Badges Sample](sample-build-badges.md)\. | November 27, 2017 | -| AWS Config integration | AWS Config now supports CodeBuild as an AWS resource, which means the service can track your CodeBuild projects\. For more information about AWS Config, see [Use AWS Config with AWS CodeBuild Sample](how-to-integrate-config.md)\. | October 20, 2017 | -| Automatically rebuild updated source code in GitHub repositories | If your source code is stored in a GitHub repository, you can enable AWS CodeBuild to rebuild your source code whenever a code change is pushed to the repository\. For more information, see [GitHub Pull Request and Webhook Filter Sample](sample-github-pull-request.md)\. | September 21, 2017 | -| New ways for storing and retrieving sensitive or large environment variables in Amazon EC2 Systems Manager Parameter Store | You can now use the AWS CodeBuild console or the AWS CLI to retrieve sensitive or large environment variables stored in Amazon EC2 Systems Manager Parameter Store\. You can also now use the AWS CodeBuild console to store these types of environment variables in Amazon EC2 Systems Manager Parameter Store\. Previously, you could only retrieve these types of environment variables by including them in a build spec or by running build commands to automate the AWS CLI\. You could only store these types of environment variables by using the Amazon EC2 Systems Manager Parameter Store console\. For more information, see [Create a Build Project](create-project.md), [Change a Build Project's Settings](change-project.md), and [Run a Build](run-build.md)\. | September 14, 2017 | -| Build deletion support | You can now delete builds in AWS CodeBuild\. For more information, see [Delete Builds](delete-builds.md)\. | August 31, 2017 | -| Updated way to retrieve sensitive or large environment variables stored in Amazon EC2 Systems Manager Parameter Store by using a build spec | AWS CodeBuild now makes it easier to use a build spec to retrieve sensitive or large environment variables stored in Amazon EC2 Systems Manager Parameter Store\. Previously, you could only retrieve these types of environment variables by running build commands to automate the AWS CLI\. For more information, see the parameter\-store mapping in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. | August 10, 2017 | -| AWS CodeBuild supports Bitbucket | CodeBuild can now build from source code stored in a Bitbucket repository\. For more information, see [Create a Build Project](create-project.md) and [Run a Build](run-build.md)\. | August 10, 2017 | -| AWS CodeBuild available in US West \(N\. California\), EU \(London\), and Canada \(Central\) | AWS CodeBuild is now available in the US West \(N\. California\), EU \(London\), and Canada \(Central\) regions\. For more information, see the [AWS CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) section of the "AWS Regions and Endpoints" topic in the Amazon Web Services General Reference\. | June 29, 2017 | -| Alternate build spec file names and locations supported | You can now specify an alternate file name or location of a build spec file to use for a build project, instead of a default build spec file named buildspec\.yml at the root of the source code\. For more information, see [Build Spec File Name and Storage Location](build-spec-ref.md#build-spec-ref-name-storage)\. | June 27, 2017 | -| Updated build notifications sample | CodeBuild now provides built\-in support for build notifications through Amazon CloudWatch Events and Amazon Simple Notification Service \(Amazon SNS\)\. The previous [Build Notifications Sample](sample-build-notifications.md) has been updated to demonstrate this new behavior\. | June 22, 2017 | -| Docker in custom image sample added | A sample showing how to use CodeBuild and a custom Docker build image to build and run a Docker image has been added\. For more information, see the [Docker in Custom Image Sample](sample-docker-custom-image.md)\. | June 7, 2017 | -| Fetch source code for GitHub pull requests | When you run a build with CodeBuild that relies on source code stored in a GitHub repository, you can now specify a GitHub pull request ID to build\. You can also specify a commit ID, a branch name, or a tag name instead\. For more information, see the **Source version** value in [Run a Build \(Console\)](run-build.md#run-build-console) or the `sourceVersion` value in [Run a Build \(AWS CLI\)](run-build.md#run-build-cli)\. | June 6, 2017 | -| Build specification version updated | A new version of the build spec format has been released\. Version 0\.2 addresses the issue of CodeBuild running each build command in a separate instance of the default shell\. Also in version 0\.2, environment\_variables is renamed to env, and plaintext is renamed to variables\. For more information, see [Build Specification Reference for CodeBuild](build-spec-ref.md)\. | May 9, 2017 | -| Dockerfiles for build images available in GitHub | Definitions for many of the build images provided by AWS CodeBuild are available as Dockerfiles in GitHub\. For more information, see the "Definition" column of the table in [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. | May 2, 2017 | -| AWS CodeBuild available in EU \(Frankfurt\), Asia Pacific \(Singapore\), Asia Pacific \(Sydney\), and Asia Pacific \(Tokyo\) | AWS CodeBuild is now available in the EU \(Frankfurt\), Asia Pacific \(Singapore\), Asia Pacific \(Sydney\), and Asia Pacific \(Tokyo\) regions\. For more information, see the [AWS CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) section of the "AWS Regions and Endpoints" topic in the Amazon Web Services General Reference\. | March 21, 2017 | -| CodePipeline test action support for CodeBuild | You can now add to a pipeline in CodePipeline a test action that uses CodeBuild\. For more information, see [Add an CodeBuild Test Action to a Pipeline \(CodePipeline Console\)](how-to-create-pipeline.md#how-to-create-pipeline-add-test)\. | March 8, 2017 | -| Build specs support fetching build output from within selected top\-level directories | Build specs now enable you to specify individual top\-level directories whose contents you can instruct CodeBuild to include in build output artifacts\. You do this by using the base\-directory mapping\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. | February 8, 2017 | -| Built\-in environment variables | AWS CodeBuild provides additional built\-in environment variables for your builds to use\. These include environment variables describing the entity that started the build, the URL to the source code repository, the source code's version ID, and more\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. | January 30, 2017 | -| AWS CodeBuild available in US East \(Ohio\) | AWS CodeBuild is now available in the US East \(Ohio\) region\. For more information, see the [AWS CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) section of the "AWS Regions and Endpoints" topic in the Amazon Web Services General Reference\. | January 19, 2017 | -| AWS Lambda sample | A reference was added to a sample showing how to use CodeBuild along with Lambda, AWS CloudFormation, and CodePipeline to build and deploy a serverless application that follows the AWS Serverless Application Model \(AWS SAM\) standard\. For more information, see the [AWS Lambda Sample](sample-lambda.md)\. | December 20, 2016 | -| Shell and command behaviors information | CodeBuild runs each command you specify in a separate instance of a build environment's default shell\. This default behavior can produce some unexpected side effects for your commands\. We recommend some approaches to work around this default behavior if needed\. For more information, see [Shells and Commands in Build Environments](build-env-ref-cmd.md)\. | December 9, 2016 | -| Environment variables information | CodeBuild provides several environment variables that you can use in your build commands\. You can also define your own environment variables\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. | December 7, 2016 | -| Troubleshooting topic | Troubleshooting information is now available\. For more information, see [Troubleshooting CodeBuild](troubleshooting.md)\. | December 5, 2016 | -| Jenkins plugin initial release | This is the initial release of the CodeBuild Jenkins Plugin\. For more information, see [Use AWS CodeBuild with Jenkins](jenkins-plugin.md)\. | December 5, 2016 | -| User Guide initial release | This is the initial release of the CodeBuild User Guide\. | December 1, 2016 | \ No newline at end of file diff --git a/doc_source/how-to-create-pipeline.md b/doc_source/how-to-create-pipeline.md deleted file mode 100644 index 0ceeaa3..0000000 --- a/doc_source/how-to-create-pipeline.md +++ /dev/null @@ -1,622 +0,0 @@ -# Use CodePipeline with CodeBuild to Test Code and Run Builds - -You can automate your release process by using AWS CodePipeline to test your code and run your builds with CodeBuild\. - -The following table lists tasks and the methods available for performing them\. Using the AWS SDKs to accomplish these tasks is outside the scope of this topic\. - - -**** - -| Task | Available approaches | Approaches described in this topic | -| --- | --- | --- | -| Create a continuous delivery \(CD\) pipeline with CodePipeline that automates builds with CodeBuild | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html) | -| Add test and build automation with CodeBuild to an existing pipeline in CodePipeline | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html) | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html) | - -**Topics** -+ [Prerequisites](#how-to-create-pipeline-prerequisites) -+ [Create a Pipeline That Uses CodeBuild \(CodePipeline Console\)](#how-to-create-pipeline-console) -+ [Create a Pipeline That Uses CodeBuild \(AWS CLI\)](#how-to-create-pipeline-cli) -+ [Add an CodeBuild Build Action to a Pipeline \(CodePipeline Console\)](#how-to-create-pipeline-add) -+ [Add an CodeBuild Test Action to a Pipeline \(CodePipeline Console\)](#how-to-create-pipeline-add-test) - -## Prerequisites - -1. Answer the questions in [Plan a Build](planning.md)\. - -1. If you are using an IAM user to access CodePipeline instead of an AWS root account or an administrator IAM user, attach the managed policy named `AWSCodePipelineFullAccess` to the user \(or to the IAM group to which the user belongs\)\. \(Using an AWS root account is not recommended\.\) This enables the user to create the pipeline in CodePipeline\. For more information, see [Attaching Managed Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-using.html#attach-managed-policy-console) in the *IAM User Guide*\. -**Note** -The IAM entity that attaches the policy to the user \(or to the IAM group to which the user belongs\) must have permission in IAM to attach policies\. For more information, see [Delegating Permissions to Administer IAM Users, Groups, and Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_delegate-permissions.html) in the *IAM User Guide*\. - -1. Create a CodePipeline service role, if you do not already have one available in your AWS account\. This service role enables CodePipeline to interact with other AWS services, including AWS CodeBuild, on your behalf\. For example, to use the AWS CLI to create a CodePipeline service role, run the IAM `create-role` command: - - For Linux, macOS, or Unix: - - ``` - aws iam create-role --role-name AWS-CodePipeline-CodeBuild-Service-Role --assume-role-policy-document '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Principal":{"Service":"codepipeline.amazonaws.com"},"Action":"sts:AssumeRole"}}' - ``` - - For Windows: - - ``` - aws iam create-role --role-name AWS-CodePipeline-CodeBuild-Service-Role --assume-role-policy-document "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"codepipeline.amazonaws.com\"},\"Action\":\"sts:AssumeRole\"}}" - ``` -**Note** -The IAM entity that creates this CodePipeline service role must have permission in IAM to create service roles\. - -1. After you create a CodePipeline service role or identify an existing one, you must add the default CodePipeline service role policy to the service role as described in [Review the Default CodePipeline Service Role Policy](https://docs.aws.amazon.com/codepipeline/latest/userguide/iam-identity-based-access-control.html#how-to-custom-role) in the *CodePipeline User Guide*, if it isn't already a part of the policy for the role\. -**Note** -The IAM entity that adds this CodePipeline service role policy must have permission in IAM to add service role policies to service roles\. - -1. Create and upload the source code to a repository type supported by CodeBuild and CodePipeline, such as CodeCommit, Amazon S3, or GitHub\. \(CodePipeline does not currently support Bitbucket\.\) The source code should contain a build spec file, but you can declare one when you define a build project later in this topic\. For more information, see the [Build Spec Reference](build-spec-ref.md)\. -**Important** -If you plan to use the pipeline to deploy built source code, then the build output artifact must be compatible with the deployment system you use\. -For CodeDeploy, see the [CodeDeploy Sample](sample-codedeploy.md) in this guide and see [Prepare a Revision for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-prepare-revision.html) in the *CodeDeploy User Guide*\. -For AWS Elastic Beanstalk, see the [Elastic Beanstalk Sample](sample-elastic-beanstalk.md) in this guide and see [Create an Application Source Bundle](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.deployment.source.html) in the *AWS Elastic Beanstalk Developer Guide*\. -For AWS OpsWorks, see [Application Source](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-source) and [Using CodePipeline with AWS OpsWorks](https://docs.aws.amazon.com/opsworks/latest/userguide/other-services-cp.html) in the *AWS OpsWorks User Guide*\. - -## Create a Pipeline That Uses CodeBuild \(CodePipeline Console\) - -Use the following procedure to create a pipeline that uses CodeBuild to build and deploy your source code\. - -To create a pipeline that only tests your source code: -+ Use the following procedure to create the pipeline, and then delete the Build and Beta stages from the pipeline\. Then use the [Add an CodeBuild Test Action to a Pipeline \(CodePipeline Console\)](#how-to-create-pipeline-add-test) procedure in this topic to add to the pipeline a test action that uses CodeBuild\. -+ Use one of the other procedures in this topic to create the pipeline, and then use the [Add an CodeBuild Test Action to a Pipeline \(CodePipeline Console\)](#how-to-create-pipeline-add-test) procedure in this topic to add to the pipeline a test action that uses CodeBuild\. - -**To use the Create Pipeline wizard in CodePipeline to create a pipeline that uses CodeBuild** - -1. Open the CodePipeline console at [https://console\.aws\.amazon\.com/codesuite/codepipeline/home](https://console.aws.amazon.com/codesuite/codepipeline/home)\. - - You need to have already signed in to the AWS Management Console by using: - + Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. - + An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - + An IAM user in your AWS account with permission to use the following minimum set of actions: - - ``` - codepipeline:* - iam:ListRoles - iam:PassRole - s3:CreateBucket - s3:GetBucketPolicy - s3:GetObject - s3:ListAllMyBuckets - s3:ListBucket - s3:PutBucketPolicy - codecommit:ListBranches - codecommit:ListRepositories - codedeploy:GetApplication - codedeploy:GetDeploymentGroup - codedeploy:ListApplications - codedeploy:ListDeploymentGroups - elasticbeanstalk:DescribeApplications - elasticbeanstalk:DescribeEnvironments - lambda:GetFunctionConfiguration - lambda:ListFunctions - opsworks:DescribeStacks - opsworks:DescribeApps - opsworks:DescribeLayers - ``` - -1. In the AWS region selector, choose the region where your build project AWS resources are located\. This region must also support CodeBuild\. For more information, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the "Regions and Endpoints" topic in the *Amazon Web Services General Reference*\. - -1. Create a pipeline\. If a CodePipeline information page is displayed, choose **Create pipeline**\. If a **Pipelines** page is displayed, choose **Create pipeline**\. - -1. On the **Step 1: Choose pipeline settings** page, for **Pipeline name**, enter a name for the pipeline \(for example, **CodeBuildDemoPipeline**\)\. If you choose a different name, be sure to use it throughout this procedure\. - -1. For **Role name**, do one of the following: - - Choose **New service role**, and in **Role Name**, enter the name for your new service role\. - - Choose **Existing service role**, and then choose CodePipeline service role you created or identified as part of this topic's prerequisites\. - -1. For **Artifact store**, do one of the following: - + Choose **Default location** to use the default artifact store, such as the Amazon S3 artifact bucket designated as the default, for your pipeline in the region you have selected for your pipeline\. - + Choose **Custom location** if you already have an existing artifact store you have created, such as an Amazon S3 artifact bucket, in the same region as your pipeline\. -**Note** -This is not the source bucket for your pipeline's source code\. This is the artifact store for your pipeline\. A separate artifact store, such as an Amazon S3 bucket, is required for each pipeline, in the same region as the pipeline - -1. Choose **Next**\. - -1. On the **Step 2: Add source stage** page, for **Source provider**, do one of the following: - + If your source code is stored in an Amazon S3 bucket, choose **Amazon S3**\. For **Bucket**, select the Amazon S3 bucket that contains your source code\. For **S3 object key**, enter the name of the file the contains the source code \(for example, `file-name.zip`\)\. Choose **Next**\. - + If your source code is stored in an AWS CodeCommit repository, choose **CodeCommit**\. For **Repository name**, choose the name of the repository that contains the source code\. For **Branch name**, choose the name of the branch that represents the version of the source code you want to build\. Choose **Next**\. - + If your source code is stored in a GitHub repository, choose **GitHub**\. Choose **Connect to GitHub**, and follow the instructions to authenticate with GitHub\. For **Repository**, choose the name of the repository that contains the source code\. For **Branch**, choose the name of the branch that represents the version of the source code you want to build\. - - Choose **Next**\. - -1. On the **Step 3: Add build stage** page, for **Build provider**, choose **CodeBuild**\. - -1. If you already have a build project you want to use, for **Project name**, choose the name of the build project and skip ahead to step 22 in this procedure\. Otherwise, use the following steps to create a project in CodeBuild\. -**Note** -If you choose an existing build project, it must have build output artifact settings already defined \(even though CodePipeline overrides them\)\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) or [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. -**Important** -If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit\. One build is triggered through webhooks, and one through CodePipeline\. Because billing is on a per\-build basis, you are billed for both builds\. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild \. In the CodeBuild console, clear the **Webhook** box\. For more information, see [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. For **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. - -1. \(Optional\) Enter a description\. - -1. For **Environment**, do one of the following: - + To use a build environment based on a Docker image that is managed by CodeBuild, choose **Managed image**\. Make your selections from the **Operating system**, **Runtime**, and **Runtime version** drop\-down lists\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. - + To use a build environment based on a Docker image in an Amazon ECR repository in your AWS account, choose **Custom image**\. For **Environment type**, choose an environment type, and then choose **Amazon ECR**\. Use the **Amazon ECR repository** and **Amazon ECR image** drop\-down lists to choose the Amazon ECR repository and Docker image in that repository\. - + To use a build environment based on a publicly available Docker image in Docker Hub, choose **Other location**\. In **Other location**, enter the Docker image ID, using the format `docker repository/docker-image-name`\. - - Select **Privileged** only if you plan to use this build project to build Docker images, and the build environment image you chose is not one provided by CodeBuild with Docker support\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it as needed\. You can do this by running the following build commands to initialize the Docker daemon in the `install` phase of your build spec\. \(Do not run the following build commands if you chose a build environment image provided by CodeBuild with Docker support\.\) - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. Expand **Additional configuration**\. - - To specify a build timeout other than 60 minutes \(the default\), use the **hours** and **minutes** boxes to set a timeout between 5 and 480 minutes \(8 hours\)\. - - For **Compute**, choose one of the available options\. - - For **Environment variables**, use **Name** and **Value** to specify any optional environment variables for the build environment to use\. To add more environment variables, choose **Add environment variable**\. -**Important** -We strongly discourage storing sensitive values, especially AWS access key IDs and secret access keys, in environment variables\. Environment variables can be displayed in plain text using the CodeBuild console and AWS CLI\. -To store and retrieve sensitive values, we recommend your build commands use the AWS CLI to interact with the Amazon EC2 Systems Manager Parameter Store\. The AWS CLI is already installed and configured on all build environments provided by CodeBuild\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store CLI Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-cli) in the *Amazon EC2 Systems Manager User Guide* - -1. For **Buildspec**, do one of the following: - + If your source code includes a build spec file, choose **Use a buildspec file**\. - + If your source code does not include a build spec file, choose **Insert build commands**\. For **Build commands**, enter the commands you want to run during the build phase in the build environment\. For multiple commands, separate each command with `&&` for Linux\-based build environments or `;` for Windows\-based build environments\. For **Output files**, enter the paths to the build output files in the build environment that you want to send to CodePipeline\. For multiple files, separate each file path with a comma\. - -1. Choose **Create build project**\. - -1. Return to the CodePipeline console\. - -1. On the **Step 4: Add deploy stage** page, do one of the following: - + If you do not want to deploy the build output artifact, choose **Skip**, and confirm this choice when prompted\. - + If you want to deploy the build output artifact, for **Deploy provider**, choose a deployment provider, and then specify the settings when prompted\. - - Choose **Next**\. - -1. On the ** Review** page, review your choices, and then choose **Create pipeline**\. - -1. After the pipeline runs successfully, you can get the build output artifact\. With the pipeline displayed in the CodePipeline console, in the **Build** action, choose the tooltip\. Make a note of the value for **Output artifact** \(for example, **MyAppBuild**\)\. -**Note** -You can also get the build output artifact by choosing the **Build artifacts** link on the build details page in the CodeBuild console\. To get to this page, skip the rest of the steps in this procedure, and see [View Build Details \(Console\)](view-build-details.md#view-build-details-console)\. - -1. Open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. In the list of buckets, open the bucket used by the pipeline\. The name of the bucket should follow the format `codepipeline-region-ID-random-number`\. You can use the AWS CLI to run the CodePipeline get\-pipeline command to get the name of the bucket, where *my\-pipeline\-name* is the display name of your pipeline: - - ``` - aws codepipeline get-pipeline --name my-pipeline-name - ``` - - In the output, the `pipeline` object contains an `artifactStore` object, which contains a `location` value with the name of the bucket\. - -1. Open the folder that matches the name of your pipeline \(depending on the length of the pipeline's name, the folder name might be truncated\), and then open the folder matching the value for **Output artifact** that you noted in step 24 of this procedure\. - -1. Extract the contents of the file\. If there are multiple files in that folder, extract the contents of the file with the latest **Last Modified** timestamp\. \(You might need to give the file the `.zip` extension so that you can work with it in your system's ZIP utility\.\) The build output artifact is in the extracted contents of the file\. - -1. If you instructed CodePipeline to deploy the build output artifact, use the deployment provider's instructions to get to the build output artifact on the deployment targets\. - -## Create a Pipeline That Uses CodeBuild \(AWS CLI\) - -Use the following procedure to create a pipeline that uses CodeBuild to build your source code\. - -To use the AWS CLI to create a pipeline that deploys your built source code or that only tests your source code, you can adapt the instructions in [Edit a Pipeline \(AWS CLI\)](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-edit-pipelines.html#how-to-edit-pipelines-cli) and the [CodePipeline Pipeline Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html) in the *AWS CodePipeline User Guide*\. - -1. Create or identify a build project in CodeBuild\. For more information, see [Create a Build Project](create-project.md)\. -**Important** -The build project must define build output artifact settings \(even though CodePipeline overrides them\)\. For more information, see the description of `artifacts` in [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -1. Make sure you have configured the AWS CLI with the AWS access key and AWS secret access key that correspond to one of the IAM entities described in this topic\. For more information, see [Getting Set Up with the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html) in the *AWS Command Line Interface User Guide*\. - -1. Create a JSON\-formatted file that represents the structure of the pipeline\. Name the file `create-pipeline.json` or similar\. For example, this JSON\-formatted structure creates a pipeline with a source action that references an Amazon S3 input bucket and a build action that uses CodeBuild: - - ``` - { - "pipeline": { - "roleArn": "arn:aws:iam::account-id:role/my-AWS-CodePipeline-service-role-name", - "stages": [ - { - "name": "Source", - "actions": [ - { - "inputArtifacts": [], - "name": "Source", - "actionTypeId": { - "category": "Source", - "owner": "AWS", - "version": "1", - "provider": "S3" - }, - "outputArtifacts": [ - { - "name": "MyApp" - } - ], - "configuration": { - "S3Bucket": "my-input-bucket-name", - "S3ObjectKey": "my-source-code-file-name.zip" - }, - "runOrder": 1 - } - ] - }, - { - "name": "Build", - "actions": [ - { - "inputArtifacts": [ - { - "name": "MyApp" - } - ], - "name": "Build", - "actionTypeId": { - "category": "Build", - "owner": "AWS", - "version": "1", - "provider": "CodeBuild" - }, - "outputArtifacts": [ - { - "name": "default" - } - ], - "configuration": { - "ProjectName": "my-build-project-name" - }, - "runOrder": 1 - } - ] - } - ], - "artifactStore": { - "type": "S3", - "location": "AWS-CodePipeline-internal-bucket-name" - }, - "name": "my-pipeline-name", - "version": 1 - } - } - ``` - - In this JSON\-formatted data: - + The value of `roleArn` must match the ARN of the CodePipeline service role you created or identified as part of the prerequisites\. - + The values of `S3Bucket` and `S3ObjectKey` in `configuration` assume the source code is stored in an Amazon S3 bucket\. For settings for other source code repository types, see the [CodePipeline Pipeline Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html) in the *CodePipeline User Guide*\. - + The value of `ProjectName` is the name of the CodeBuild build project you created earlier in this procedure\. - + The value of `location` is the name of the Amazon S3 bucket used by this pipeline\. For more information, see [Create a Policy for an Amazon S3 Bucket to Use as the Artifact Store for CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/access-permissions.html#how-to-create-bucket-policy) in the *CodePipeline User Guide*\. - + The value of `name` is the name of this pipeline\. All pipeline names must be unique to your account\. - - Although this data describes only a source action and a build action, you can add actions for activities related to testing, deploying the build output artifact, invoking AWS Lambda functions, and more\. For more information, see the [CodePipeline Pipeline Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html) in the *CodePipeline User Guide*\. - -1. Switch to the folder that contains the JSON file, and then run the CodePipeline [create\-pipeline](https://docs.aws.amazon.com/cli/latest/reference/codepipeline/create-pipeline.html) command, specifying the file name: - - ``` - aws codepipeline create-pipeline --cli-input-json file://create-pipeline.json - ``` -**Note** -You must create the pipeline in an AWS Region that supports CodeBuild\. For more information, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the "Regions and Endpoints" topic in the *Amazon Web Services General Reference*\. - - The JSON\-formatted data appears in the output, and CodePipeline creates the pipeline\. - -1. To get information about the pipeline's status, run the CodePipeline [get\-pipeline\-state](https://docs.aws.amazon.com/cli/latest/reference/codepipeline/get-pipeline-state.html) command, specifying the name of the pipeline: - - ``` - aws codepipeline get-pipeline-state --name my-pipeline-name - ``` - - In the output, look for information that confirms the build was successful\. Ellipses \(`...`\) are used to show data that has been omitted for brevity\. - - ``` - { - ... - "stageStates": [ - ... - { - "actionStates": [ - { - "actionName": "CodeBuild", - "latestExecution": { - "status": "SUCCEEDED", - ... - }, - ... - } - ] - } - ] - } - ``` - - If you run this command too early, you might not see any information about the build action\. You might need to run this command multiple times until the pipeline has finished running the build action\. - -1. After a successful build, follow these instructions to get the build output artifact\. Open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. -**Note** -You can also get the build output artifact by choosing the **Build artifacts** link on the related build details page in the CodeBuild console\. To get to this page, skip the rest of the steps in this procedure, and see [View Build Details \(Console\)](view-build-details.md#view-build-details-console)\. - -1. In the list of buckets, open the bucket used by the pipeline\. The name of the bucket should follow the format `codepipeline-region-ID-random-number`\. You can get the bucket name from the `create-pipeline.json` file or you can run the CodePipeline get\-pipeline command to get the bucket's name\. - - ``` - aws codepipeline get-pipeline --name my-pipeline-name - ``` - - In the output, the `pipeline` object contains an `artifactStore` object, which contains a `location` value with the name of the bucket\. - -1. Open the folder that matches the name of your pipeline \(for example, `my-pipeline-name`\)\. - -1. In that folder, open the folder named `default`\. - -1. Extract the contents of the file\. If there are multiple files in that folder, extract the contents of the file with the latest **Last Modified** timestamp\. \(You might need to give the file a `.zip` extension so that you can work with it in your system's ZIP utility\.\) The build output artifact is in the extracted contents of the file\. - -## Add an CodeBuild Build Action to a Pipeline \(CodePipeline Console\) - -1. Open the CodePipeline console at [https://console\.aws\.amazon\.com/codesuite/codepipeline/home](https://console.aws.amazon.com/codesuite/codepipeline/home)\. - - You should have already signed in to the AWS Management Console by using: - + Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. - + An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - + An IAM user in your AWS account with permission to perform the following minimum set of actions: - - ``` - codepipeline:* - iam:ListRoles - iam:PassRole - s3:CreateBucket - s3:GetBucketPolicy - s3:GetObject - s3:ListAllMyBuckets - s3:ListBucket - s3:PutBucketPolicy - codecommit:ListBranches - codecommit:ListRepositories - codedeploy:GetApplication - codedeploy:GetDeploymentGroup - codedeploy:ListApplications - codedeploy:ListDeploymentGroups - elasticbeanstalk:DescribeApplications - elasticbeanstalk:DescribeEnvironments - lambda:GetFunctionConfiguration - lambda:ListFunctions - opsworks:DescribeStacks - opsworks:DescribeApps - opsworks:DescribeLayers - ``` - -1. In the AWS region selector, choose the region where your pipeline is located\. This region must also support CodeBuild\. For more information, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the "Regions and Endpoints" topic in the *Amazon Web Services General Reference*\. - -1. On the **Pipelines** page, choose the name of the pipeline\. - -1. On the pipeline details page, in the **Source** action, choose the tooltip\. Make a note of the value for **Output artifact** \(for example, **MyApp**\)\. -**Note** -This procedure shows you how to add a build action in a build stage between the **Source** and **Beta** stages\. If you want to add the build action somewhere else, choose the tooltip on the action just before the place where you want to add the build action, and make a note of the value for **Output artifact**\. - -1. Choose **Edit**\. - -1. Between the **Source** and **Beta** stages, choose **Add stage**\. -**Note** -This procedure shows you how to add a build stage to your pipeline\. To add a build action to an existing stage, choose **Edit stage** in the stage, and then skip to step 8 of this procedure\. -This procedure shows you how to add a build stage between the **Source** and **Beta** stages\. To add the build stage somewhere else, choose **Add stage** in the desired place\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-stage.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. For **Stage name**, enter the name of the build stage \(for example, **Build**\)\. If you choose a different name, use it throughout this procedure\. - -1. Inside of the selected stage, choose **Add action**\. -**Note** -This procedure shows you want how to add the build action inside of a build stage\. To add the build action somewhere else, choose **Add action** in the desired place\. You might first need to choose **Edit stage** in the existing stage where you want to add the build action\. - -1. In **Edit action**, for **Action name**, enter a name for the action \(for example, **CodeBuild**\)\. If you choose a different name, use it throughout this procedure\. - -1. For **Action provider**, choose **CodeBuild**\. - -1. If you already have a build project in CodeBuild, for **Project name**, choose the name of the build project, and then skip to step 22 of this procedure\. -**Note** -If you choose an existing build project, it must have build output artifact settings already defined \(even though CodePipeline overrides them\)\. For more information, see the description of **Artifacts** in [Create a Build Project \(Console\)](create-project.md#create-project-console) or [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console)\. -**Important** -If you enable webhooks for a CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit\. One build is triggered through webhooks and one through CodePipeline\. Because billing is on a per\-build basis, you are billed for both builds\. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild\. In the CodeBuild console, clear the **Webhook** box\. For more information, see [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. For **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. - -1. \(Optional\) Enter a description\. - -1. For **Environment**, do one of the following: - + To use a build environment based on a Docker image that is managed by CodeBuild, choose **Managed image**\. Make your selections from the **Operating system**, **Runtime**, and **Runtime version** drop\-down lists\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. - + To use a build environment based on a Docker image in an Amazon ECR repository in your AWS account, choose **Custom image**\. For **Environment type**, choose an environment type, and then choose **Amazon ECR**\. Use the **Amazon ECR repository** and **Amazon ECR image** drop\-down lists to choose the Amazon ECR repository and Docker image in that repository\. - + To use a build environment based on a publicly available Docker image in Docker Hub, choose **Other location**\. In **Other location**, enter the Docker image ID, using the format `docker repository/docker-image-name`\. - - Select **Privileged** only if you plan to use this build project to build Docker images, and the build environment image you chose is not one provided by CodeBuild with Docker support\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it as needed\. You can do this by running the following build commands to initialize the Docker daemon in the `install` phase of your build spec\. \(Do not run the following build commands if you chose a build environment image provided by CodeBuild with Docker support\.\) - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. Expand **Additional configuration**\. - - To specify a build timeout other than 60 minutes \(the default\), use the **hours** and **minutes** boxes to set a timeout between 5 and 480 minutes \(8 hours\)\. - - For **Compute**, choose one of the available options\. - - For **Environment variables**, use **Name** and **Value** to specify any optional environment variables for the build environment to use\. To add more environment variables, choose **Add environment variable**\. -**Important** -We strongly discourage storing sensitive values, especially AWS access key IDs and secret access keys, in environment variables\. Environment variables can be displayed in plain text using the CodeBuild console and AWS CLI\. -To store and retrieve sensitive values, we recommend your build commands use the AWS CLI to interact with the Amazon EC2 Systems Manager Parameter Store\. The AWS CLI is already installed and configured on all build environments provided by CodeBuild\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store CLI Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-cli) in the *Amazon EC2 Systems Manager User Guide* - -1. For **Buildspec**, do one of the following: - + If your source code includes a build spec file, choose **Use a buildspec file**\. - + If your source code does not include a build spec file, choose **Insert build commands**\. For **Build commands**, enter the commands you want to run during the build phase in the build environment\. For multiple commands, separate each command with `&&` for Linux\-based build environments or `;` for Windows\-based build environments\. For **Output files**, enter the paths to the build output files in the build environment that you want to send to CodePipeline\. For multiple files, separate each file path with a comma\. - -1. Choose **Create build project**\. - -1. Return to the CodePipeline console\. - -1. For **Input artifacts**, choose the output artifact that you noted in step 4 of this procedure\. - -1. For **Output artifacts**, enter a name for the output artifact \(for example, **MyAppBuild**\)\. - -1. Choose **Add action**\. - -1. Choose **Save**, and then choose **Save** to save your changes to the pipeline\. - -1. Choose **Release change**\. - -1. After the pipeline runs successfully, you can get the build output artifact\. With the pipeline displayed in the CodePipeline console, in the **Build** action, choose the tooltip\. Make a note of the value for **Output artifact** \(for example, **MyAppBuild**\)\. -**Note** -You can also get the build output artifact by choosing the **Build artifacts** link on the build details page in the CodeBuild console\. To get to this page, see [View Build Details \(Console\)](view-build-details.md#view-build-details-console), and then skip to step 31 of this procedure\. - -1. Open the Amazon S3 console at [https://console\.aws\.amazon\.com/s3/](https://console.aws.amazon.com/s3/)\. - -1. In the list of buckets, open the bucket used by the pipeline\. The name of the bucket should follow the format `codepipeline-region-ID-random-number`\. You can use the AWS CLI to run the CodePipeline get\-pipeline command to get the name of the bucket: - - ``` - aws codepipeline get-pipeline --name my-pipeline-name - ``` - - In the output, the `pipeline` object contains an `artifactStore` object, which contains a `location` value with the name of the bucket\. - -1. Open the folder that matches the name of your pipeline \(depending on the length of the pipeline's name, the folder name might be truncated\), and then open the folder matching the value for **Output artifact** that you noted in step 28 of this procedure\. - -1. Extract the contents of the file\. If there are multiple files in that folder, extract the contents of the file with the latest **Last Modified** timestamp\. \(You might need to give the file the `.zip` extension so that you can work with it in your system's ZIP utility\.\) The build output artifact is in the extracted contents of the file\. - -1. If you instructed CodePipeline to deploy the build output artifact, use the deployment provider's instructions to get to the build output artifact on the deployment targets\. - -## Add an CodeBuild Test Action to a Pipeline \(CodePipeline Console\) - -1. Open the CodePipeline console at [https://console\.aws\.amazon\.com/codesuite/codepipeline/home](https://console.aws.amazon.com/codesuite/codepipeline/home)\. - - You should have already signed in to the AWS Management Console by using: - + Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. - + An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - + An IAM user in your AWS account with permission to perform the following minimum set of actions: - - ``` - codepipeline:* - iam:ListRoles - iam:PassRole - s3:CreateBucket - s3:GetBucketPolicy - s3:GetObject - s3:ListAllMyBuckets - s3:ListBucket - s3:PutBucketPolicy - codecommit:ListBranches - codecommit:ListRepositories - codedeploy:GetApplication - codedeploy:GetDeploymentGroup - codedeploy:ListApplications - codedeploy:ListDeploymentGroups - elasticbeanstalk:DescribeApplications - elasticbeanstalk:DescribeEnvironments - lambda:GetFunctionConfiguration - lambda:ListFunctions - opsworks:DescribeStacks - opsworks:DescribeApps - opsworks:DescribeLayers - ``` - -1. In the AWS region selector, choose the region where your pipeline is located\. This region must also support CodeBuild\. For more information, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the "Regions and Endpoints" topic in the *Amazon Web Services General Reference*\. - -1. On the **Pipelines** page, choose the name of the pipeline\. - -1. On the pipeline details page, in the **Source** action, choose the tooltip\. Make a note of the value for **Output artifact** \(for example, **MyApp**\): -**Note** -This procedure shows you how to add a test action inside of a test stage between the **Source** and **Beta** stages\. If you want to add the test action somewhere else, rest your mouse pointer on the action just before, and make a note of the value for **Output artifact**\. - -1. Choose **Edit**\. - -1. Immediately after the **Source** stage, choose **Add stage**\. -**Note** -This procedure shows you how to add a test stage to your pipeline\. To add a test action to an existing stage, choose **Edit stage** in the stage, and then skip to step 8 of this procedure\. -This procedure also shows you how to add a test stage immediately after the **Source** stage\. To add the test stage somewhere else, choose **Add stage** in the desired place\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-stage.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. For **Stage name**, enter the name of the test stage \(for example, **Test**\)\. If you choose a different name, use it throughout this procedure\. - -1. In the selected stage, choose **Add action**\. -**Note** -This procedure shows you how to add the test action in a test stage\. To add the test action somewhere else, choose **Add action** in the desired place\. You might first need to choose **Edit** in the existing stage where you want to add the test action\. - -1. In **Edit action**, for **Action name**, enter a name for the action \(for example, **Test**\)\. If you choose a different name, use it throughout this procedure\. - -1. For **Action provider**, under **Test**, choose **CodeBuild**\. - -1. If you already have a build project in CodeBuild, for **Project name**, choose the name of the build project, and then skip to step 22 of this procedure\. -**Important** -If you enable webhooks for a CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit\. One build is triggered through webhooks and one through CodePipeline\. Because billing is on a per\-build basis, you are billed for both builds\. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild\. In the CodeBuild console, clear the **Webhook**box\. For more information, see [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. For **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. - -1. \(Optional\) Enter a description\. - -1. For **Environment**, do one of the following: - + To use a build environment based on a Docker image that is managed by CodeBuild, choose **Managed image**\. Make your selections from the **Operating system**, **Runtime**, and **Runtime version** drop\-down lists\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. - + To use a build environment based on a Docker image in an Amazon ECR repository in your AWS account, choose **Custom image**\. For **Environment type**, choose an environment type, and then choose **Amazon ECR**\. Use the **Amazon ECR repository** and **Amazon ECR image** drop\-down lists to choose the Amazon ECR repository and Docker image in that repository\. - + To use a build environment based on a publicly available Docker image in Docker Hub, choose **Other location**\. In **Other location**, enter the Docker image ID, using the format `docker repository/docker-image-name`\. - - Select **Privileged** only if you plan to use this build project to build Docker images, and the build environment image you chose is not one provided by CodeBuild with Docker support\. Otherwise, all associated builds that attempt to interact with the Docker daemon fail\. You must also start the Docker daemon so that your builds can interact with it as needed\. You can do this by running the following build commands to initialize the Docker daemon in the `install` phase of your build spec\. \(Do not run the following build commands if you chose a build environment image provided by CodeBuild with Docker support\.\) - - ``` - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay& - - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" - ``` - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. Expand **Additional configuration**\. - - To specify a build timeout other than 60 minutes \(the default\), use the **hours** and **minutes** boxes to set a timeout between 5 and 480 minutes \(8 hours\)\. - - For **Compute**, choose one of the available options\. - - For **Environment variables**, use **Name** and **Value** to specify any optional environment variables for the build environment to use\. To add more environment variables, choose **Add environment variable**\. -**Important** -We strongly discourage storing sensitive values, especially AWS access key IDs and secret access keys, in environment variables\. Environment variables can be displayed in plain text using the CodeBuild console and AWS CLI\. -To store and retrieve sensitive values, we recommend your build commands use the AWS CLI to interact with the Amazon EC2 Systems Manager Parameter Store\. The AWS CLI is already installed and configured on all build environments provided by CodeBuild\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store CLI Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-cli) in the *Amazon EC2 Systems Manager User Guide* - -1. For **Buildspec**, do one of the following: - + If your source code includes a build spec file, choose **Use a buildspec file**\. - + If your source code does not include a build spec file, choose **Insert build commands**\. For **Build commands**, enter the commands you want to run during the build phase in the build environment\. For multiple commands, separate each command with `&&` for Linux\-based build environments or `;` for Windows\-based build environments\. For **Output files**, enter the paths to the build output files in the build environment that you want to send to CodePipeline\. For multiple files, separate each file path with a comma\. - -1. Choose **Create build project**\. - -1. Return to the CodePipeline console\. - -1. For **Input artifacts**, select the value for **Output artifact** that you noted in step 4 of this procedure\. - -1. \(Optional\) If you want your test action to produce an output artifact, and you set up your build spec accordingly, then for **Output artifact**, enter the value you want to assign to the output artifact\. - -1. Choose **Save**\. - -1. Choose **Release change**\. - -1. After the pipeline runs successfully, you can get the test results\. In the **Test** stage of the pipeline, choose the **CodeBuild** hyperlink to open the related build project page in the CodeBuild console\. - -1. On the build project page, in **Build history**, choose the **Build run** hyperlink\. - -1. On the build run page, in **Build logs**, choose the **View entire log** hyperlink to open the build log in the Amazon CloudWatch console\. - -1. Scroll through the build log to view the test results\. \ No newline at end of file diff --git a/doc_source/how-to-integrate-config.md b/doc_source/how-to-integrate-config.md deleted file mode 100644 index 7f30d1d..0000000 --- a/doc_source/how-to-integrate-config.md +++ /dev/null @@ -1,51 +0,0 @@ -# Use AWS Config with AWS CodeBuild Sample - -AWS Config provides an inventory of your AWS resources and a history of configuration changes to these resources\. AWS Config now supports AWS CodeBuild as an AWS resource, which means the service can track your CodeBuild projects\. For more information about AWS Config, see [What Is AWS Config?](https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html) in the *AWS Config Developer Guide*\. - -You can see the following information about CodeBuild resources on the **Resource Inventory** page in the AWS Config console: -+ A timeline of your CodeBuild configuration changes\. -+ Configuration details for each CodeBuild project\. -+ Relationships with other AWS resources\. -+ A list of changes to your CodeBuild projects\. - -The procedures in this topic show you how to set up AWS Config and look up and view CodeBuild projects\. - -**Topics** -+ [Prerequisites](#how-to-create-a-build-project) -+ [Set Up AWS Config](#setup-config) -+ [Look Up AWS CodeBuild Projects](#lookup-projects) -+ [Viewing AWS CodeBuild Configuration Details in the AWS Config Console](#viewing-config-details) - -## Prerequisites - -Create your AWS CodeBuild project\(s\)\. For more information, see [Create a Build Project](create-project.md)\. - -## Set Up AWS Config -+ [Setting up AWS Config \(Console\)](https://docs.aws.amazon.com/config/latest/developerguide/gs-console.html) -+ [Setting up AWS Config \(AWS CLI\)](https://docs.aws.amazon.com/config/latest/developerguide/gs-cli.html) - -**Note** -It can take up to 10 minutes before a user is able to see AWS CodeBuild projects in the AWS Config console\. - -## Look Up AWS CodeBuild Projects - -1. Sign in to the AWS Management Console and open the AWS Config console at [https://console\.aws\.amazon\.com/config](https://console.aws.amazon.com/config)\. - -1. On the **Resource inventory** page, choose **Resources**\. Scroll down and select the **CodeBuild project** check box\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/config-select-project.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Look up**\. - -1. After the list of CodeBuild projects is added, choose the CodeBuild project name link in the **Config timeline** column\. - -## Viewing AWS CodeBuild Configuration Details in the AWS Config Console - -When you look up resources on the **Resource inventory** page, you can choose the AWS Config timeline to view details about your CodeBuild project\. The details page for a resource provides information about the configuration, relationships, and number of changes made to that resource\. - -The blocks at the top of the page are collectively called the timeline\. The timeline shows the date and time that the recording was made\. - -For more information, see [Viewing Configuration Details in the AWS Config Console](https://docs.aws.amazon.com/config/latest/developerguide/view-manage-resource-console.html) in the *AWS Config Developer Guide*\. - -**Example of a CodeBuild Project in AWS Config:** - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/config-resources.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) \ No newline at end of file diff --git a/doc_source/how-to-run.md b/doc_source/how-to-run.md deleted file mode 100644 index 7464cfc..0000000 --- a/doc_source/how-to-run.md +++ /dev/null @@ -1,32 +0,0 @@ -# Run AWS CodeBuild Directly - -To set up, run, and monitor builds directly with CodeBuild, you can use the CodeBuild console, AWS CLI, or AWS SDK\. - -Not what you're looking for? To use AWS CodePipeline to run CodeBuild, see [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. - -**Topics** -+ [Prerequisites](#how-to-run-prerequisites) -+ [Run AWS CodeBuild Directly \(Console\)](#how-to-run-console) -+ [Run AWS CodeBuild Directly \(AWS CLI\)](#how-to-run-cli) - -## Prerequisites - -Answer the questions in [Plan a Build](planning.md)\. - -## Run AWS CodeBuild Directly \(Console\) - -1. Create the build project\. For information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - -1. Run the build\. For information, see [Run a Build \(Console\)](run-build.md#run-build-console)\. - -1. Get information about the build\. For information, see [View Build Details \(Console\)](view-build-details.md#view-build-details-console)\. - -## Run AWS CodeBuild Directly \(AWS CLI\) - -For more information about using the AWS CLI with CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Create the build project\. For information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -1. Run the build\. For information, see [Run a Build \(AWS CLI\)](run-build.md#run-build-cli)\. - -1. Get information about the build\. For information, see [View Build Details \(AWS CLI\)](view-build-details.md#view-build-details-cli)\. \ No newline at end of file diff --git a/doc_source/index.md b/doc_source/index.md deleted file mode 100644 index e5187d0..0000000 --- a/doc_source/index.md +++ /dev/null @@ -1,104 +0,0 @@ -# AWS CodeBuild User Guide - ------ -*****Copyright © 2019 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.***** - ------ -Amazon's trademarks and trade dress may not be used in - connection with any product or service that is not Amazon's, - in any manner that is likely to cause confusion among customers, - or in any manner that disparages or discredits Amazon. All other - trademarks not owned by Amazon are the property of their respective - owners, who may or may not be affiliated with, connected to, or - sponsored by Amazon. - ------ -## Contents -+ [What Is AWS CodeBuild?](welcome.md) - + [AWS CodeBuild Concepts](concepts.md) -+ [Getting Started with CodeBuild](getting-started.md) -+ [CodeBuild Samples](samples.md) - + [Microsoft Windows Samples for CodeBuild](sample-windows.md) - + [CodeBuild Use Case-Based Samples](use-case-based-samples.md) - + [Using Access Tokens with Your Source Provider in CodeBuild](sample-access-tokens.md) - + [Amazon ECR Sample for CodeBuild](sample-ecr.md) - + [Runtime Versions in Buildspec File Sample for CodeBuild](sample-runtime-versions.md) - + [Private Registry with AWS Secrets Manager Sample for CodeBuild](sample-private-registry.md) - + [Docker Sample for CodeBuild](sample-docker.md) - + [GitHub Enterprise Sample for CodeBuild](sample-github-enterprise.md) - + [GitHub Pull Request and Webhook Filter Sample for CodeBuild](sample-github-pull-request.md) - + [Bitbucket Pull Request and Webhook Filter Sample for CodeBuild](sample-bitbucket-pull-request.md) - + [Use AWS Config with AWS CodeBuild Sample](how-to-integrate-config.md) - + [Build Badges Sample with CodeBuild](sample-build-badges.md) - + [Build Notifications Sample for CodeBuild](sample-build-notifications.md) - + [Docker in Custom Image Sample for CodeBuild](sample-docker-custom-image.md) - + [Amazon Elastic File System Sample for CodeBuild](sample-efs.md) - + [Multiple Input Sources and Output Artifacts Sample](sample-multi-in-out.md) - + [CodePipeline Integration with CodeBuild and Multiple Input Sources and Output Artifacts Sample](sample-pipeline-multi-input-output.md) - + [Using Semantic Versioning to Name Build Artifacts Sample](sample-buildspec-artifact-naming.md) - + [Create a Static Website with Build Output Hosted in an Amazon S3 Bucket](sample-disable-artifact-encryption.md) - + [CodeDeploy Sample for CodeBuild](sample-codedeploy.md) - + [AWS Lambda Sample for CodeBuild](sample-lambda.md) - + [AWS Elastic Beanstalk Sample for AWS CodeBuild](sample-elastic-beanstalk.md) - + [Source Version Sample with CodeBuild](sample-source-version.md) -+ [Plan a Build for AWS CodeBuild](planning.md) - + [Build Specification Reference for CodeBuild](build-spec-ref.md) - + [Build Environment Reference for CodeBuild](build-env-ref.md) - + [Docker Images Provided by CodeBuild](build-env-ref-available.md) - + [Build Environment Compute Types](build-env-ref-compute-types.md) - + [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 CodeBuild Agent](use-codebuild-agent.md) -+ [Run AWS CodeBuild Directly](how-to-run.md) -+ [Use CodeBuild with Amazon Virtual Private Cloud](vpc-support.md) - + [Use VPC Endpoints](use-vpc-endpoints-with-codebuild.md) - + [AWS CloudFormation VPC Template](cloudformation-vpc-template.md) - + [Use CodeBuild with a Proxy Server](use-proxy-server.md) -+ [Use CodePipeline with CodeBuild to Test Code and Run Builds](how-to-create-pipeline.md) -+ [Use AWS CodeBuild with Jenkins](jenkins-plugin.md) -+ [Working with Build Projects and Builds in CodeBuild](builds-projects-and-builds.md) - + [Working with Build Projects](working-with-build-projects.md) - + [Create a Build Project in CodeBuild](create-project.md) - + [View a List of Build Project Names in CodeBuild](view-project-list.md) - + [View a Build Project's Details in CodeBuild](view-project-details.md) - + [Build Caching in CodeBuild](build-caching.md) - + [Create CodeBuild Triggers](trigger-create.md) - + [Edit CodeBuild Triggers](triggers-edit.md) - + [Change a Build Project's Settings in CodeBuild](change-project.md) - + [Delete a Build Project in AWS CodeBuild](delete-project.md) - + [Working with Builds in CodeBuild](builds-working.md) - + [Run a Build in CodeBuild](run-build.md) - + [View Build Details in CodeBuild](view-build-details.md) - + [View a List of Build IDs in CodeBuild](view-build-list.md) - + [View a List of Build IDs for a Build Project in CodeBuild](view-builds-for-project.md) - + [Stop a Build in CodeBuild](stop-build.md) - + [Delete Builds in CodeBuild](delete-builds.md) -+ [Security in AWS CodeBuild](security.md) - + [Data Protection in AWS CodeBuild](data-protection.md) - + [Data Encryption](security-encryption.md) - + [Key Management](security-key-management.md) - + [Traffic Privacy](security-traffic-privacy.md) - + [Identity and Access Management in CodeBuild](auth-and-access-control.md) - + [Overview of Managing Access Permissions to Your CodeBuild Resources](auth-and-access-control-iam-access-control-identity-based.md) - + [Using Identity-Based Policies for CodeBuild](auth-and-access-control-iam-identity-based-access-control.md) - + [CodeBuild Permissions Reference](auth-and-access-control-permissions-reference.md) - + [Viewing Resources in the Console](console-resources.md) - + [Logging and Monitoring in AWS CodeBuild](security-incident-response.md) - + [Logging CodeBuild API Calls with AWS CloudTrail](cloudtrail.md) - + [Monitoring AWS CodeBuild](monitoring-builds.md) - + [Monitoring Builds with CloudWatch Metrics](monitoring-metrics.md) - + [Monitoring Builds with CloudWatch Alarms](monitoring-alarms.md) - + [Compliance Validation for AWS CodeBuild](codebuild-compliance-validation.md) - + [Resilience in AWS CodeBuild](codebuild-disaster-recovery-resiliency.md) - + [Infrastructure Security in AWS CodeBuild](infrastructure-security.md) -+ [Advanced Topics](advanced-topics.md) - + [Advanced Setup](setting-up.md) - + [Command Line Reference for CodeBuild](cmd-ref.md) - + [AWS SDKs and Tools Reference for CodeBuild](sdk-ref.md) - + [Specify the CodeBuild Endpoint](endpoint-specify.md) -+ [Troubleshooting CodeBuild](troubleshooting.md) -+ [Limits for CodeBuild](limits.md) -+ [CodeBuild for Windows—Third Party Notices](notice.md) -+ [AWS CodeBuild User Guide Document History](history.md) -+ [AWS Glossary](glossary.md) \ No newline at end of file diff --git a/doc_source/infrastructure-security.md b/doc_source/infrastructure-security.md deleted file mode 100644 index af9d3c1..0000000 --- a/doc_source/infrastructure-security.md +++ /dev/null @@ -1,7 +0,0 @@ -# Infrastructure Security in AWS CodeBuild - -As a managed service, AWS CodeBuild is protected by the AWS global network security procedures that are described in the [Amazon Web Services: Overview of Security Processes](https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf) whitepaper\. - -You use AWS published API calls to access CodeBuild through the network\. Clients must support Transport Layer Security \(TLS\) 1\.0 or later\. We recommend TLS 1\.2 or later\. Clients must also support cipher suites with perfect forward secrecy \(PFS\) such as Ephemeral Diffie\-Hellman \(DHE\) or Elliptic Curve Ephemeral Diffie\-Hellman \(ECDHE\)\. Most modern systems such as Java 7 and later support these modes\. - -Requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal\. Or you can use the [AWS Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html) \(AWS STS\) to generate temporary security credentials to sign requests\. \ No newline at end of file diff --git a/doc_source/jenkins-plugin.md b/doc_source/jenkins-plugin.md deleted file mode 100644 index a2a2c58..0000000 --- a/doc_source/jenkins-plugin.md +++ /dev/null @@ -1,81 +0,0 @@ -# Use AWS CodeBuild with Jenkins - -The Jenkins plugin for AWS CodeBuild enables you to integrate CodeBuild with your Jenkins build jobs\. Instead of sending your build jobs to Jenkins build nodes, you use the plugin to send your build jobs to CodeBuild\. This eliminates the need for you to provision, configure, and manage Jenkins build nodes\. - -## Setting Up Jenkins - -For information about setting up Jenkins with the AWS CodeBuild plugin, see the [ Simplify Your Jenkins Builds with CodeBuild](https://aws.amazon.com/blogs/devops/simplify-your-jenkins-builds-with-aws-codebuild/) blog post on the AWS DevOps Blog\. You can download the CodeBuild Jenkins from [ https://github\.com/awslabs/aws\-codebuild\-jenkins\-plugin](https://github.com/awslabs/aws-codebuild-jenkins-plugin)\. - -## Installing the Plugin - -If you already have a Jenkins set up and would like to only install the AWS CodeBuild plugin, then on your Jenkins instance, in the Plugin Manager, search for "CodeBuild Plugin for Jenkins" \. - -## Using the Plugin - -**To use AWS CodeBuild with sources from outside of an Amazon VPC** - -1. Create a project in the CodeBuild console\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - + Choose the region where you want to run the build\. - + \(Optional\) Set the Amazon VPC configuration to allow the CodeBuild build container to access resources in your Amazon VPC\. - + Write down the name of your project\. You need it in step 3\. - + \(Optional\) If your source repository is not natively supported by CodeBuild, you can set Amazon S3 as the input source type for your project\. - -1. In the IAMconsole, create an IAM user to be used by the Jenkins plugin\. - + When you create credentials for the user, choose **Programmatic Access**\. - + Create a policy similar to the following and then attach the policy to your user\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Resource": ["arn:aws:logs:{{region}}:{{awsAccountId}}:log-group:/aws/codebuild/{{projectName}}:*"], - "Action": ["logs:GetLogEvents"] - }, - { - "Effect": "Allow", - "Resource": ["arn:aws:s3:::{{inputBucket}}"], - "Action": ["s3:GetBucketVersioning"] - }, - { - "Effect": "Allow", - "Resource": ["arn:aws:s3:::{{inputBucket}}/{{inputObject}}"], - "Action": ["s3:PutObject"] - }, - { - "Effect": "Allow", - "Resource": ["arn:aws:s3:::{{outputBucket}}/*"], - "Action": ["s3:GetObject"] - }, - { - "Effect": "Allow", - "Resource": ["arn:aws:codebuild:{{region}}:{{awsAccountId}}:project/{{projectName}}"], - "Action": ["codebuild:StartBuild", - "codebuild:BatchGetBuilds", - "codebuild:BatchGetProjects"] - } - ] - } - ``` - -1. Create a freestyle project in Jenkins\. - + On the **Configure** page, choose **Add build step**, and then choose **Run build on CodeBuild**\. - + Configure your build step\. - + Provide values for **Region**, **Credentials**, and **Project Name**\. - + Choose **Use Project source**\. - + Save the configuration and run a build from Jenkins\. - -1. For **Source Code Management**, choose how you want to retrieve your source\. You might need to install the GitHub plugin \(or the Jenkins plugin for your source repository provider\) on your Jenkins server\. - + On the **Configure** page, choose **Add build step**, and then choose **Run build on AWS CodeBuild**\. - + Configure your build step\. - + Provide values for **Region**, **Credentials**, and **Project Name**\. - + Choose **Use Jenkins source**\. - + Save the configuration and run a build from Jenkins\. - -**To use the AWS CodeBuild plugin with the Jenkins Pipeline plugin** -+ On your Jenkins pipeline project page, use the snippet generator to generate a pipeline script that adds CodeBuild as a step in your pipeline\. It should generate a script similar to this: - - ``` - awsCodeBuild projectName: 'project', credentialsType: 'keys', region: 'us-west-2', sourceControlType: 'jenkins' - ``` \ No newline at end of file diff --git a/doc_source/limits.md b/doc_source/limits.md deleted file mode 100644 index 896ccd8..0000000 --- a/doc_source/limits.md +++ /dev/null @@ -1,35 +0,0 @@ -# Limits for CodeBuild - -The following tables list the current limits in CodeBuild\. These limits are for each supported AWS Region for each AWS account, unless otherwise specified\. - -## Build Project Limits - - -**** - -| Resource | Default limit | -| --- | --- | -| Maximum number of build projects | 5,000 | -| Length of a build project name | 2 to 255 characters, inclusive | -| Allowed characters in a build project name | The letters A\-Z and a\-z, the numbers 0\-9, and the special characters \- and \_ | -| Maximum length of a build project description | 255 characters | -| Allowed characters in a build project description | Any | -| Maximum number of build projects you can request information about at any one time by using the AWS CLI or AWS SDKs | 100 | -| Maximum number of tags you can associate with a build project | 50 | -| Number of minutes you can specify in a build project for the build timeout of all related builds | 5 to 480 \(8 hours\) | -| Number of subnets you can add under VPC configuration | 1 to 16 | -| Number of security groups you can add under VPC configuration | 1 to 5 | - -## Build Limits - - -**** - -| Resource | Default limit | -| --- | --- | -| Maximum number of concurrent running builds \* | 60 | -| Maximum number of builds you can request information about at any one time by using the AWS CLI or AWS SDKs | 100 | -| Number of minutes you can specify for the build timeout of a single build | 5 to 480 \(8 hours\) | -| Maximum time the history of a build can be accessed | 1 year | - -\* Limits for the maximum number of concurrent running builds vary, depending on the compute type\. For some platforms and compute types, the default is 20\. For a new account, the limit can be between 1 and 5\. To request a higher concurrent build limit or if you get a "Cannot have more than X active builds for the account" error, contact AWS Support\. \ No newline at end of file diff --git a/doc_source/monitoring-alarms.md b/doc_source/monitoring-alarms.md deleted file mode 100644 index 9ef6a66..0000000 --- a/doc_source/monitoring-alarms.md +++ /dev/null @@ -1,26 +0,0 @@ -# Monitoring Builds with CloudWatch Alarms - - You can create a CloudWatch alarm for your builds\. An alarm watches a single metric over a period of time that you specify and performs one or more actions based on the value of the metric relative to a specified threshold over a number of time periods\. Using native CloudWatch alarm functionality, you can specify any of the actions supported by CloudWatch when a threshold is exceeded\. For example, you can specify that an Amazon SNS notification is sent when more than three builds in your account fail within fifteen minutes\. - -**To create a CloudWatch alarm for a CodeBuild metric** - -1. Sign in to the AWS Management Console and open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. In the navigation pane, choose **Alarms**\. - -1. Choose **Create Alarm**\. - -1. Under **CloudWatch Metrics by Category**, choose **CodeBuild Metrics**\. If you know you want only project\-level metrics, choose **By Project**\. If you know you want only account\-level metrics, choose **Account Metrics**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-alarm-metrics-in-cw.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. On **Create Alarm**, if it isn't already selected, choose **Select Metric**\. - -1. Choose a metric for which you want to create an alarm\. The options are **By Project** or **Account Metrics**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-alarm-account-metrics-in-cw.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Next** or **Define Alarm** and then create your alarm\. For more information, see [Creating Amazon CloudWatch Alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)\. For more information about setting up Amazon SNS notifications when an alarm is triggered, see [Set Up Amazon SNS Notifications](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/US_SetupSNS.html)\. - - The following shows an alarm that sends an Amazon SNS notification to a list named **codebuild\-sns\-notifications** when one or more failed builds are detected over 15 minutes\. The 15 minutes is calculated by multiplying the five minute period by the three specified data points\. The information displayed for a failed builds alarm at the project level or account level is identical\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-alarm-sample-cw.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Create Alarm**\. \ No newline at end of file diff --git a/doc_source/monitoring-builds.md b/doc_source/monitoring-builds.md deleted file mode 100644 index 03f90a0..0000000 --- a/doc_source/monitoring-builds.md +++ /dev/null @@ -1,51 +0,0 @@ -# Monitoring AWS CodeBuild - - You can use Amazon CloudWatch to watch your builds, report when something is wrong, and take automatic actions when appropriate\. You can monitor your builds at two levels: -+ Project level: These metrics are for all builds in the specified project only\. To see metrics for a project, specify `ProjectName` for the dimension in CloudWatch\. -+ AWS account level: These metrics are for all builds in one account\. To see metrics at the AWS account level, do not enter a dimension in CloudWatch\. - - CloudWatch metrics show the behavior of your builds over time\. For example, you can monitor: -+ How many builds were attempted in a build project or an AWS account over time\. -+ How many builds were successful in a build project or an AWS account over time\. -+ How many builds failed in a build project or an AWS account over time\. -+ How much time CodeBuild spent executing builds in a build project or an AWS account over time\. - - Metrics displayed in the CodeBuild console are always from the past three days\. You can use the CloudWatch console to view CodeBuild metrics over different durations\. - - For information about creating CloudWatch metrics for CodeBuild, see [Monitoring Builds with CloudWatch Metrics](monitoring-metrics.md)\. - -## CodeBuild CloudWatch Metrics - - The following metrics can be tracked per AWS account or build project\. - - -**** - -| Metric | Description | -| --- | --- | -| BuildDuration | Measures the duration of the build's BUILD phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| `Builds` | Measures the number of builds triggered\. Units: Count Valid CloudWatch statistics: Sum | -| DownloadSourceDuration | Measures the duration of the build's DOWNLOAD\_SOURCE phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| `Duration` | Measures the duration of all builds over time\. Units: Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| `FailedBuilds` | Measures the number of builds that failed because of client error or a timeout\. Units: Count Valid CloudWatch statistics: Sum | -| FinalizingDuration | Measures the duration of the build's FINALIZING phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| InstallDuration | Measures the duration of the build's INSTALL phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| PostBuildDuration | Measures the duration of the build's POST\_BUILD phase Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| PreBuildDuration | Measures the duration of the build's PRE\_BUILD phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| ProvisioningDuration | Measures the duration of the build's PROVISIONING phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| QueuedDuration | Measures the duration of the build's QUEUED phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| SubmittedDuration | Measures the duration of the build's SUBMITTED phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | -| `SucceededBuilds` | Measures the number of successful builds\. Units: Count Valid CloudWatch statistics: Sum | -| UploadArtifactsDuration | Measures the duration of the build's UPLOAD\_ARTIFACTS phase\. Units:Seconds Valid CloudWatch statistics: Average \(recommended\), Maximum, Minimum | - -## CodeBuild CloudWatch Dimensions - - `ProjectName` is the only AWS CodeBuild metrics dimension\. If it is specified, then the metrics are for that project\. If it is not specified, then the metrics are for the current AWS account\. - -## CodeBuild CloudWatch Alarms - - You can use the CloudWatch console to create alarms based on CodeBuild metrics so you can react if something goes wrong with your builds\. The two metrics that are most useful with alarms are: -+ `FailedBuild`\. You can create an alarm that is triggered when a certain number of failed builds are detected within a predetermined number of seconds\. In CloudWatch you specify the number of seconds and how many faild builds trigger an alarm\. -+ `Duration`\. You can create an alarm that is triggered when a build takes longer than expected\. You specify how many seconds must elapse after a build is started and before a build is completed before the alarm is triggered\. - - For infomration about how to create alarms for CodeBuild metrics, see [Monitoring Builds with CloudWatch Alarms](monitoring-alarms.md)\. For more information about alarms, see [ Creating Amazon CloudWatch Alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)\. \ No newline at end of file diff --git a/doc_source/monitoring-metrics.md b/doc_source/monitoring-metrics.md deleted file mode 100644 index 99da9b2..0000000 --- a/doc_source/monitoring-metrics.md +++ /dev/null @@ -1,57 +0,0 @@ -# Monitoring Builds with CloudWatch Metrics - - CodeBuild monitors functions on your behalf and reports metrics through Amazon CloudWatch\. These metrics include the number of total builds, failed builds, successful builds, and the duration of builds\. - - You can use the CodeBuild console or the CloudWatch console to monitor metrics for CodeBuild\. The following procedures show you how to access metrics\. - -## Access Build Metrics \(CodeBuild Console\) - -The graphs in the CodeBuild console show three days of metrics\. You cannot customize the metrics or the graphs used to display them\. Use the Amazon CloudWatch console to view your build metrics if you want to edit them\. - -**To access AWS account level metrics** - -1. Sign in to the AWS Management Console and open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Account metrics**\. - -**To access project\-level metrics** - -1. Sign in to the AWS Management Console and open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. In the list of build projects, in the **Name** column, choose the project where you want to view metrics\. - -1. Choose the **Metrics** tab\. - -## Access Build Metrics \(Amazon CloudWatch Console\) - - You can customize the metrics and the graphs used to display them\. - -**To access account level metrics** - -1. Sign in to the AWS Management Console and open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. In the navigation pane, choose **Metrics**\. - -1. On the **All metrics** tab, choose **CodeBuild**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-metrics-in-cw.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Account Metrics**\. - -1. Choose one or more projects and metrics\. For each project, you can choose the **SucceededBuilds**, **FailedBuilds**, **Builds**, and **Duration** metrics\. All selected project and metric combinations are displayed in the graph on the page\. - -**To access project\-level metrics** - -1. Sign in to the AWS Management Console and open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\. - -1. In the navigation pane, choose **Metrics**\. - -1. On the **All metrics** tab, choose **CodeBuild**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-metrics-in-cw.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **By Project**\. - -1. Choose one or more project and metric combinations\. For each project, you can choose the **SucceededBuilds**, **FailedBuilds**, **Builds**, and **Duration** metrics\. All selected project and metric combinations are displayed in the graph on the page\. - -1. \(Optional\) You can customize your metrics and graphs\. For example, from the drop\-down list in the **Statistic** columm, you can choose a different statistic to display\. Or from the drop\-down menu in the **Period** column, you can choose a different time period to use to monitor the metrics\. For more information, see [Graph Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph_metrics.html) and [View Available Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/viewing_metrics_with_cloudwatch.html) in the *Amazon CloudWatch User Guide*\. \ No newline at end of file diff --git a/doc_source/notice.md b/doc_source/notice.md deleted file mode 100644 index 406dd52..0000000 --- a/doc_source/notice.md +++ /dev/null @@ -1,389 +0,0 @@ -# CodeBuild for Windows—Third Party Notices - -When you use CodeBuild for Windows builds, you have the option to use some third party packages/modules to enable your built application to run on Microsoft Windows operating systems and to interoperate with some third party products\. The following list contains the applicable third\-party legal terms that govern your use of the specified third\-party packages/modules\. - -**Topics** -+ [1\) Base Docker Image—windowsservercore](#base-docker-image) -+ [2\) windows\-base Docker Image—Choco](#3-windows-base-docker-image) -+ [3\) windows\-base Docker Image—git \-\-version 2\.16\.2](#4-windows-base-docker-image-2-16-2) -+ [4\) windows\-base Docker Image—microsoft\-build\-tools \-\-version 15\.0\.26320\.2](#5-windows-base-docker-image-15-x) -+ [5\) windows\-base Docker Image—nuget\.commandline \-\-version 4\.5\.1](#6-windows-base-docker-image-4-5-1) -+ [7\) windows\-base Docker Image—netfx\-4\.6\.2\-devpack](#7-windows-base-docker-image-4-6-2) -+ [8\) windows\-base Docker Image—visualfsharptools, v 4\.0](#8-windows-base-docker-image-visualfsharptools) -+ [9\) windows\-base Docker Image—netfx\-pcl\-reference\-assemblies\-4\.6](#9-windows-base-docker-image) -+ [10\) windows\-base Docker Image—visualcppbuildtools v 14\.0\.25420\.1](#10-windows-base-docker-image) -+ [11\) windows\-base Docker Image—microsoft\-windows\-netfx3\-ondemand\-package\.cab](#11-windows-base-docker-image) -+ [12\) windows\-base Docker Image—dotnet\-sdk](#12-windows-base-docker-image) - -## 1\) Base Docker Image—windowsservercore - -\(license terms available at: [https://hub\.docker\.com/r/microsoft/windowsservercore/\)](https://hub.docker.com/r/microsoft/windowsservercore/) - -License: By requesting and using this Container OS Image for Windows containers, you acknowledge, understand, and consent to the following Supplemental License Terms: - -MICROSOFT SOFTWARE SUPPLEMENTAL LICENSE TERMS - -CONTAINER OS IMAGE - -Microsoft Corporation \(or based on where you live, one of its affiliates\) \(referenced as "us," "we," or "Microsoft"\) licenses this Container OS Image supplement to you \("Supplement"\)\. You are licensed to use this Supplement in conjunction with the underlying host operating system software \("Host Software"\) solely to assist running the containers feature in the Host Software\. The Host Software license terms apply to your use of the Supplement\. You may not use it if you do not have a license for the Host Software\. You may use this Supplement with each validly licensed copy of the Host Software\. - -ADDITIONAL LICENSING REQUIREMENTS AND/OR USE RIGHTS - -Your use of the Supplement as specified in the preceding paragraph may result in the creation or modification of a container image \("Container Image"\) that includes certain Supplement components\. For clarity, a Container Image is separate and distinct from a virtual machine or virtual appliance image\. Pursuant to these license terms, we grant you a restricted right to redistribute such Supplement components under the following conditions: - -\(i\) you may use the Supplement components only as used in, and as a part of your Container Image, - -\(ii\) you may use such Supplement components in your Container Image as long as you have significant primary functionality in your Container Image that is materially separate and distinct from the Supplement; and - -\(iii\) you agree to include these license terms \(or similar terms required by us or a hoster\) with your Container Image to properly license the possible use of the Supplement components by your end\-users\. - -We reserve all other rights not expressly granted herein\. - -By using this Supplement, you accept these terms\. If you do not accept them, do not use this Supplement\. - -As part of the Supplemental License Terms for this Container OS Image for Windows containers, you are also subject to the underlying Windows Server host software license terms, which are located at: [https://www\.microsoft\.com/en\-us/useterms\.](https://www.microsoft.com/en-us/useterms) - -## 2\) windows\-base Docker Image—Choco - -\(license terms available at: [https://github\.com/chocolatey/chocolatey\.org/blob/master/LICENSE\.txt\)](https://github.com/chocolatey/chocolatey.org/blob/master/LICENSE.txt) - -Copyright 2011 \- Present RealDimensions Software, LLC - -Licensed under the Apache License, version 2\.0 \(the "License"\); you may not use these files except in compliance with the License\. You may obtain a copy of the License at - -[http://www\.apache\.org/licenses/LICENSE\-2\.0](http://www.apache.org/licenses/LICENSE-2.0) - -Unless required by applicable law or as agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\. See the License for the specific language governing permissions and limitations under the License\. - -## 3\) windows\-base Docker Image—git \-\-version 2\.16\.2 - -\(license terms available at: [https://chocolatey\.org/packages/git/2\.16\.2](https://chocolatey.org/packages/git/2.16.2)\) - -**Licensed under GNU General Public License, version 2, available at**: [https://www\.gnu\.org/licenses/old\-licenses/gpl\-2\.0\.html](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) - -## 4\) windows\-base Docker Image—microsoft\-build\-tools \-\-version 15\.0\.26320\.2 - -\(license terms available at: [https://www\.visualstudio\.com/license\-terms/mt171552/](https://www.visualstudio.com/license-terms/mt171552/)\) - -MICROSOFT VISUAL STUDIO 2015 EXTENSIONS, VISUAL STUDIO SHELLS and C\+\+ REDISTRIBUTABLE - -\-\-\-\-\- - -These license terms are an agreement between Microsoft Corporation \(or based on where you live, one of its affiliates\) and you\. They apply to the software named above\. The terms also apply to any Microsoft services or updates for the software, except to the extent those have additional terms\. - -\-\-\-\-\- - -IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW\. - -1. **INSTALLATION AND USE RIGHTS**\. You may install and use any number of copies of the software\. - -1. **TERMS FOR SPECIFIC COMPONENTS**\. - - 1. **Utilities**\. The software may contain some items on the Utilities List at [https://docs\.microsoft\.com/en\-us/visualstudio/productinfo/2015\-redistribution\-vs](https://docs.microsoft.com/en-us/visualstudio/productinfo/2015-redistribution-vs)\. You may copy and install those items, if included with the software, on to yours or other third party machines, to debug and deploy your applications and databases you developed with the software\. Please note that Utilities are designed for temporary use, that Microsoft may not be able to patch or update Utilities separately from the rest of the software, and that some Utilities by their nature may make it possible for others to access machines on which they are installed\. As a result, you should delete all Utilities you have installed after you finish debugging or deploying your applications and databases\. Microsoft is not responsible for any third party use or access of Utilities you install on any machine\. - - 1. **Microsoft Platforms**\. The software may include components from Microsoft Windows; Microsoft Windows Server; Microsoft SQL Server; Microsoft Exchange; Microsoft Office; and Microsoft SharePoint\. These components are governed by separate agreements and their own product support policies, as described in the license terms found in the installation directory for that component or in the "Licenses" folder accompanying the software\. - - 1. **Third Party Components**\. The software may include third party components with separate legal notices or governed by other agreements, as described in the ThirdPartyNotices file accompanying the software\. Even if such components are governed by other agreements, the disclaimers and the limitations on and exclusions of damages below also apply\. The software may also include components licensed under open source licenses with source code availability obligations\. Copies of those licenses, if applicable, are included in the ThirdPartyNotices file\. You may obtain this source code from us, if and as required under the relevant open source licenses, by sending a money order or check for $5\.00 to: Source Code Compliance Team, Microsoft Corporation, 1 Microsoft Way, Redmond, WA 98052\. Please write source code for one or more of the components listed below in the memo line of your payment: - + Remote Tools for Visual Studio 2015; - + Standalone Profiler for Visual Studio 2015; - + IntelliTraceCollector for Visual Studio 2015; - + Microsoft VC\+\+ Redistributable 2015; - + Multibyte MFC Library for Visual Studio 2015; - + Microsoft Build Tools 2015; - + Feedback Client; - + Visual Studio 2015 Integrated Shell; or - + Visual Studio 2015 Isolated Shell\. - - We may also make a copy of the source code available at [http://thirdpartysource\.microsoft\.com](http://thirdpartysource.microsoft.com)\. - -1. **DATA**\. The software may collect information about you and your use of the software, and send that to Microsoft\. Microsoft may use this information to provide services and improve our products and services\. You may opt\-out of many of these scenarios, but not all, as described in the product documentation\. There are also some features in the software that may enable you to collect data from users of your applications\. If you use these features to enable data collection in your applications, you must comply with applicable law, including providing appropriate notices to users of your applications\. You can learn more about data collection and use in the help documentation and the privacy statement at [https://privacy\.microsoft\.com/en\-us/privacystatement](https://privacy.microsoft.com/en-us/privacystatement)\. Your use of the software operates as your consent to these practices\. - -1. **SCOPE OF LICENSE**\. The software is licensed, not sold\. This agreement only gives you some rights to use the software\. Microsoft reserves all other rights\. Unless applicable law gives you more rights despite this limitation, you may use the software only as expressly permitted in this agreement\. In doing so, you must comply with any technical limitations in the software that only allow you to use it in certain ways\. You may not - + work around any technical limitations in the software; - + reverse engineer, decompile or disassemble the software, or attempt to do so, except and only to the extent required by third party licensing terms governing the use of certain open\-source components that may be included with the software; - + remove, minimize, block or modify any notices of Microsoft or its suppliers in the software; - + use the software in any way that is against the law; or - + share, publish, rent or lease the software, or provide the software as a stand\-alone hosted as solution for others to use\. - -1. **EXPORT RESTRICTIONS**\. You must comply with all domestic and international export laws and regulations that apply to the software, which include restrictions on destinations, end users, and end use\. For further information on export restrictions, visit \(aka\.ms/exporting\)\. - -1. **SUPPORT SERVICES**\. Because this software is "as is," we may not provide support services for it\. - -1. **ENTIRE AGREEMENT**\. This agreement, and the terms for supplements, updates, Internet\-based services and support services that you use, are the entire agreement for the software and support services\. - -1. **APPLICABLE LAW**\. If you acquired the software in the United States, Washington law applies to interpretation of and claims for breach of this agreement, and the laws of the state where you live apply to all other claims\. If you acquired the software in any other country, its laws apply\. - -1. **CONSUMER RIGHTS; REGIONAL VARIATIONS**\. This agreement describes certain legal rights\. You may have other rights, including consumer rights, under the laws of your state or country\. Separate and apart from your relationship with Microsoft, you may also have rights with respect to the party from which you acquired the software\. This agreement does not change those other rights if the laws of your state or country do not permit it to do so\. For example, if you acquired the software in one of the below regions, or mandatory country law applies, then the following provisions apply to you: - - 1. **Australia**\. You have statutory guarantees under the Australian Consumer Law and nothing in this agreement is intended to affect those rights\. - - 1. **Canada**\. If you acquired this software in Canada, you may stop receiving updates by turning off the automatic update feature, disconnecting your device from the Internet \(if and when you re\-connect to the Internet, however, the software will resume checking for and installing updates\), or uninstalling the software\. The product documentation, if any, may also specify how to turn off updates for your specific device or software\. - - 1. **Germany and Austria**\. - - 1. **Warranty**\. The properly licensed software will perform substantially as described in any Microsoft materials that accompany the software\. However, Microsoft gives no contractual guarantee in relation to the licensed software\. - - 1. **Limitation of Liability**\. In case of intentional conduct, gross negligence, claims based on the Product Liability Act, as well as, in case of death or personal or physical injury, Microsoft is liable according to the statutory law\.Subject to the foregoing clause \(ii\), Microsoft will only be liable for slight negligence if Microsoft is in breach of such material contractual obligations, the fulfillment of which facilitate the due performance of this agreement, the breach of which would endanger the purpose of this agreement and the compliance with which a party may constantly trust in \(so\-called "cardinal obligations"\)\. In other cases of slight negligence, Microsoft will not be liable for slight negligence\. - -1. **DISCLAIMER OF WARRANTY\. THE SOFTWARE IS LICENSED “AS\-IS\.” YOU BEAR THE RISK OF USING IT\. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES OR CONDITIONS\. TO THE EXTENT PERMITTED UNDER YOUR LOCAL LAWS, MICROSOFT EXCLUDES THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON\-INFRINGEMENT\.** - -1. **LIMITATION ON AND EXCLUSION OF DAMAGES\. YOU CAN RECOVER FROM MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U\.S\. $5\.00\. YOU CANNOT RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL, INDIRECT OR INCIDENTAL DAMAGES\.** This limitation applies to \(a\) anything related to the software, services, content \(including code\) on third party Internet sites, or third party applications; and \(b\) claims for breach of contract, breach of warranty, guarantee or condition, strict liability, negligence, or other tort to the extent permitted by applicable law\. - - It also applies even if Microsoft knew or should have known about the possibility of the damages\. The above limitation or exclusion may not apply to you because your country may not allow the exclusion or limitation of incidental, consequential or other damages\. - -EULA ID: VS2015\_Update3\_ShellsRedist\_ - -## 5\) windows\-base Docker Image—nuget\.commandline \-\-version 4\.5\.1 - -\(license terms available at: [https://github\.com/NuGet/Home/blob/dev/LICENSE\.txt](https://github.com/NuGet/Home/blob/dev/LICENSE.txt)\) - -Copyright \(c\) \.NET Foundation\. All rights reserved\. - -Licensed under the Apache License, version 2\.0 \(the "License"\); you may not use these files except in compliance with the License\. You may obtain a copy of the License at - -[http://www\.apache\.org/licenses/LICENSE\-2\.0](http://www.apache.org/licenses/LICENSE-2.0) - -Unless required by applicable law or as agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\. See the License for the specific language governing permissions and limitations under the License\. - -## 7\) windows\-base Docker Image—netfx\-4\.6\.2\-devpack - -**MICROSOFT SOFTWARE SUPPLEMENTAL LICENSE TERMS** - -**\.NET FRAMEWORK AND ASSOCIATED LANGUAGE PACKS FOR MICROSOFT WINDOWS OPERATING SYSTEM** - -\-\-\-\-\- - -Microsoft Corporation \(or based on where you live, one of its affiliates\) licenses this supplement to you\. If you are licensed to use Microsoft Windows operating system software \(the "software"\), you may use this supplement\. You may not use it if you do not have a license for the software\. You may use this supplement with each validly licensed copy of the software\. - -The following license terms describe additional use terms for this supplement\. These terms and the license terms for the software apply to your use of the supplement\. If there is a conflict, these supplemental license terms apply\. - -**BY USING THIS SUPPLEMENT, YOU ACCEPT THESE TERMS\. IF YOU DO NOT ACCEPT THEM, DO NOT USE THIS SUPPLEMENT\.** - -\-\-\-\-\- - -**If you comply with these license terms, you have the rights below\.** - -1. **DISTRIBUTABLE CODE\. ** The supplement is comprised of Distributable Code\. "Distributable Code" is code that you are permitted to distribute in programs you develop if you comply with the terms below\. - - 1. **Right to Use and Distribute**\. - + You may copy and distribute the object code form of the supplement\. - + *Third Party Distribution\.* You may permit distributors of your programs to copy and distribute the Distributable Code as part of those programs\. - - 1. **Distribution Requirements\. For any Distributable Code you distribute, you must** - + add significant primary functionality to it in your programs; - + for any Distributable Code having a filename extension of \.lib, distribute only the results of running such Distributable Code through a linker with your program; - + distribute Distributable Code included in a setup program only as part of that setup program without modification; - + require distributors and external end users to agree to terms that protect it at least as much as this agreement; - + display your valid copyright notice on your programs; and - + indemnify, defend, and hold harmless Microsoft from any claims, including attorneys' fees, related to the distribution or use of your programs\. - - 1. **Distribution Restrictions\. You may not** - + alter any copyright, trademark or patent notice in the Distributable Code; - + use Microsoft's trademarks in your programs' names or in a way that suggests your programs come from or are endorsed by Microsoft; - + distribute Distributable Code to run on a platform other than the Windows platform; - + include Distributable Code in malicious, deceptive or unlawful programs; or - + modify or distribute the source code of any Distributable Code so that any part of it becomes subject to an Excluded License\. An Excluded License is one that requires, as a condition of use, modification or distribution, that - + the code be disclosed or distributed in source code form; or - + others have the right to modify it\. - -1. **SUPPORT SERVICES FOR SUPPLEMENT**\. Microsoft provides support services for this software as described at [www\.support\.microsoft\.com/common/international\.aspx](http://www.support.microsoft.com/common/international.aspx)\. - -## 8\) windows\-base Docker Image—visualfsharptools, v 4\.0 - -\(license terms available at: [https://raw\.githubusercontent\.com/Microsoft/visualfsharp/master/License\.txt](https://raw.githubusercontent.com/Microsoft/visualfsharp/master/License.txt)\) - -Copyright \(c\) Microsoft Corporation\. All rights reserved\. - -Licensed under the Apache License, version 2\.0 \(the "License"\); you may not use these files except in compliance with the License\. You may obtain a copy of the License at - -[http://www\.apache\.org/licenses/LICENSE\-2\.0](http://www.apache.org/licenses/LICENSE-2.0) - -Unless required by applicable law or as agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\. See the License for the specific language governing permissions and limitations under the License\. - -## 9\) windows\-base Docker Image—netfx\-pcl\-reference\-assemblies\-4\.6 - -**MICROSOFT SOFTWARE LICENSE TERMS** - -**MICROSOFT \.NET PORTABLE CLASS LIBRARY REFERENCE ASSEMBLIES – 4\.6** - -\-\-\-\-\- - -These license terms are an agreement between Microsoft Corporation \(or based on where you live, one of its affiliates\) and you\. Please read them\. They apply to the software named above\. The terms also apply to any Microsoft -+ updates, -+ supplements, -+ Internet\-based services, and -+ support services - -for this software, unless other terms accompany those items\. If so, those terms apply\. - -**BY USING THE SOFTWARE, YOU ACCEPT THESE TERMS\. IF YOU DO NOT ACCEPT THEM, DO NOT USE THE SOFTWARE\.** - -\-\-\-\-\- - -**IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE PERPETUAL RIGHTS BELOW\.** - -1. **INSTALLATION AND USE RIGHTS**\. You may install and use any number of copies of the software to design, develop and test your programs\. - -1. **ADDITIONAL LICENSING REQUIREMENTS AND/OR USE RIGHTS**\. - - 1. **Distributable Code**\. You may distribute the software in developer tool programs you develop, to enable customers of your programs to develop portable libraries for use with any device or operating system, if you comply with the terms below\. - - 1. **Right to Use and Distribute\. The software is "Distributable Code\."** - + *Distributable Code\.* You may copy and distribute the object code form of the software\. - + *Third Party Distribution\.* You may permit distributors of your programs to copy and distribute the Distributable Code as part of those programs\. - - 1. **Distribution Requirements\. For any Distributable Code you distribute, you must** - + add significant primary functionality to it in your programs; - + require distributors and your customers to agree to terms that protect it at least as much as this agreement; - + display your valid copyright notice on your programs; and - + indemnify, defend, and hold harmless Microsoft from any claims, including attorneys' fees, related to the distribution or use of your programs\. - - 1. **Distribution Restrictions\. You may not** - + alter any copyright, trademark or patent notice in the Distributable Code; - + use Microsoft's trademarks in your programs' names or in a way that suggests your programs come from or are endorsed by Microsoft; - + include Distributable Code in malicious, deceptive or unlawful programs; or - + modify or distribute the Distributable Code so that any part of it becomes subject to an Excluded License\. An Excluded License is one that requires, as a condition of use, modification or distribution, that - + the code be disclosed or distributed in source code form; or - + others have the right to modify it\. - -1. **SCOPE OF LICENSE**\. The software is licensed, not sold\. This agreement only gives you some rights to use the software\. Microsoft reserves all other rights\. Unless applicable law gives you more rights despite this limitation, you may use the software only as expressly permitted in this agreement\. In doing so, you must comply with any technical limitations in the software that only allow you to use it in certain ways\. You may not - + work around any technical limitations in the software; - + reverse engineer, decompile or disassemble the software, except and only to the extent that applicable law expressly permits, despite this limitation; - + publish the software for others to copy; or - + rent, lease or lend the software\. - -1. **FEEDBACK**\. You may provide feedback about the software\. If you give feedback about the software to Microsoft, you give to Microsoft, without charge, the right to use, share and commercialize your feedback in any way and for any purpose\. You also give to third parties, without charge, any patent rights needed for their products, technologies and services to use or interface with any specific parts of a Microsoft software or service that includes the feedback\. You will not give feedback that is subject to a license that requires Microsoft to license its software or documentation to third parties because we include your feedback in them\. These rights survive this agreement\. - -1. **TRANSFER TO A THIRD PARTY**\. The first user of the software may transfer it, and this agreement, directly to a third party\. Before the transfer, that party must agree that this agreement applies to the transfer and use of the software\. The first user must uninstall the software before transferring it separately from the device\. The first user may not retain any copies\. - -1. **EXPORT RESTRICTIONS**\. The software is subject to United States export laws and regulations\. You must comply with all domestic and international export laws and regulations that apply to the software\. These laws include restrictions on destinations, end users and end use\. For additional information, see [www\.microsoft\.com/exporting](http://www.microsoft.com/exporting)\. - -1. **SUPPORT SERVICES**\. Because this software is "as is," we may not provide support services for it\. - -1. **ENTIRE AGREEMENT**\. This agreement, and the terms for supplements, updates, Internet\-based services and support services that you use, are the entire agreement for the software and any support services we provide\. - -1. **APPLICABLE LAW**\. - - 1. **United States**\. If you acquired the software in the United States, Washington state law governs the interpretation of this agreement and applies to claims for breach of it, regardless of conflict of laws principles\. The laws of the state where you live govern all other claims, including claims under state consumer protection laws, unfair competition laws, and in tort\. - - 1. **Outside the United States**\. If you acquired the software in any other country, the laws of that country apply\. - -1. **LEGAL EFFECT**\. This agreement describes certain legal rights\. You may have other rights under the laws of your country\. You may also have rights with respect to the party from whom you acquired the software\. This agreement does not change your rights under the laws of your country if the laws of your country do not permit it to do so\. - -1. **DISCLAIMER OF WARRANTY\. THE SOFTWARE IS LICENSED "AS\-IS\." YOU BEAR THE RISK OF USING IT\. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES OR CONDITIONS\. YOU MAY HAVE ADDITIONAL CONSUMER RIGHTS OR STATUTORY GUARANTEES UNDER YOUR LOCAL LAWS WHICH THIS AGREEMENT CANNOT CHANGE\. TO THE EXTENT PERMITTED UNDER YOUR LOCAL LAWS, MICROSOFT EXCLUDES THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON\-INFRINGEMENT\.** - - **FOR AUSTRALIA—YOU HAVE STATUTORY GUARANTEES UNDER THE AUSTRALIAN CONSUMER LAW AND NOTHING IN THESE TERMS IS INTENDED TO AFFECT THOSE RIGHTS\.** - -1. **LIMITATION ON AND EXCLUSION OF REMEDIES AND DAMAGES\. YOU CAN RECOVER FROM MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U\.S\. $5\.00\. YOU CANNOT RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL, INDIRECT OR INCIDENTAL DAMAGES\.** - - This limitation applies to - + anything related to the software, services, content \(including code\) on third party Internet sites, or third party programs; and - + claims for breach of contract, breach of warranty, guarantee or condition, strict liability, negligence, or other tort to the extent permitted by applicable law\. - - It also applies even if Microsoft knew or should have known about the possibility of the damages\. The above limitation or exclusion may not apply to you because your country may not allow the exclusion or limitation of incidental, consequential or other damages\. - -## 10\) windows\-base Docker Image—visualcppbuildtools v 14\.0\.25420\.1 - -\(license terms available at: [https://www\.visualstudio\.com/license\-terms/mt644918/](https://www.visualstudio.com/license-terms/mt644918/)\) - -MICROSOFT VISUAL C\+\+ BUILD TOOLS - -**MICROSOFT SOFTWARE LICENSE TERMS** - -**MICROSOFT VISUAL C\+\+ BUILD TOOLS** - -\-\-\-\-\- - -These license terms are an agreement between Microsoft Corporation \(or based on where you live, one of its affiliates\) and you\. They apply to the software named above\. The terms also apply to any Microsoft services or updates for the software, except to the extent those have different terms\. - -\-\-\-\-\- - -**IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW\.** - -1. **INSTALLATION AND USE RIGHTS**\. - - 1. One user may use copies of the software to develop and test their applications\. - -1. **DATA**\. The software may collect information about you and your use of the software, and send that to Microsoft\. Microsoft may use this information to provide services and improve our products and services\. You may opt\-out of many of these scenarios, but not all, as described in the product documentation\. There are also some features in the software that may enable you to collect data from users of your applications\. If you use these features to enable data collection in your applications, you must comply with applicable law, including providing appropriate notices to users of your applications\. You can learn more about data collection and use in the help documentation and the privacy statement at [http://go\.microsoft\.com/fwlink/?LinkID=528096](http://go.microsoft.com/fwlink/?LinkID=528096)\. Your use of the software operates as your consent to these practices\. - -1. **TERMS FOR SPECIFIC COMPONENTS**\. - - 1. **Build Server**\. The software may contain some Build Server components listed in BuildServer\.TXT files, and/or any files listed on the BuildeServer list located following this Microsoft Software License Terms\. You may copy and install those items, if included in the software, onto your build machines\. You and others in your organization may use these items on your build machines solely for the purpose of compiling, building, verifying and archiving your applications or running quality or performance tests as part of the build process\. - - 1. **Microsoft Platforms**\. The software may include components from Microsoft Windows; Microsoft Windows Server; Microsoft SQL Server; Microsoft Exchange; Microsoft Office; and Microsoft SharePoint\. These components are governed by separate agreements and their own product support policies, as described in the license terms found in the installation directory for that component or in the "Licenses" folder accompanying the software\. - - 1. **Third Party Components**\. The software may include third party components with separate legal notices or governed by other agreements, as described in the ThirdPartyNotices file accompanying the software\. Even if such components are governed by other agreements, the disclaimers and the limitations on and exclusions of damages below also apply\. - - 1. **Package Managers**\. The software may include package managers, like Nuget, that give you the option to download other Microsoft and third party software packages to use with your application\. Those packages are under their own licenses, and not this agreement\. Microsoft does not distribute, license or provide any warranties for any of the third party packages\. - -1. **SCOPE OF LICENSE**\. The software is licensed, not sold\. This agreement only gives you some rights to use the software\. Microsoft reserves all other rights\. Unless applicable law gives you more rights despite this limitation, you may use the software only as expressly permitted in this agreement\. In doing so, you must comply with any technical limitations in the software that only allow you to use it in certain ways\. For more information, see [https://docs\.microsoft\.com/en\-us/legal/information\-protection/software\-license\-terms\#1\-installation\-and\-use\-rights](https://docs.microsoft.com/en-us/legal/information-protection/software-license-terms#1-installation-and-use-rights)\. You may not - + work around any technical limitations in the software; - + reverse engineer, decompile or disassemble the software, or attempt to do so, except and only to the extent required by third party licensing terms governing use of certain open source components that may be included with the software; - + remove, minimize, block or modify any notices of Microsoft or its suppliers; - + use the software in any way that is against the law; or - + share, publish, rent or lease the software, or provide the software as a stand\-alone hosted as solution for others to use\. - -1. **EXPORT RESTRICTIONS**\. You must comply with all domestic and international export laws and regulations that apply to the software, which include restrictions on destinations, end users and end use\. For further information on export restrictions, visit \([aka\.ms/exporting](http://aka.ms/exporting)\)\. - -1. **SUPPORT SERVICES**\. Because this software is "as is," we may not provide support services for it\. - -1. **ENTIRE AGREEMENT**\. This agreement, and the terms for supplements, updates, Internet\-based services and support services that you use, are the entire agreement for the software and support services\. - -1. **APPLICABLE LAW**\. If you acquired the software in the United States, Washington law applies to interpretation of and claims for breach of this agreement, and the laws of the state where you live apply to all other claims\. If you acquired the software in any other country, its laws apply\. - -1. **CONSUMER RIGHTS; REGIONAL VARIATIONS**\. This agreement describes certain legal rights\. You may have other rights, including consumer rights, under the laws of your state or country\. Separate and apart from your relationship with Microsoft, you may also have rights with respect to the party from which you acquired the software\. This agreement does not change those other rights if the laws of your state or country do not permit it to do so\. For example, if you acquired the software in one of the below regions, or mandatory country law applies, then the following provisions apply to you: - + **Australia**\. You have statutory guarantees under the Australian Consumer Law and nothing in this agreement is intended to affect those rights\. - + **Canada**\. If you acquired this software in Canada, you may stop receiving updates by turning off the automatic update feature, disconnecting your device from the Internet \(if and when you re\-connect to the Internet, however, the software will resume checking for and installing updates\), or uninstalling the software\. The product documentation, if any, may also specify how to turn off updates for your specific device or software\. - + **Germany and Austria**\. - + **Warranty**\. The properly licensed software will perform substantially as described in any Microsoft materials that accompany the software\. However, Microsoft gives no contractual guarantee in relation to the licensed software\. - + *Limitation of Liability*\. In case of intentional conduct, gross negligence, claims based on the Product Liability Act, as well as, in case of death or personal or physical injury, Microsoft is liable according to the statutory law\. - - Subject to the foregoing clause \(ii\), Microsoft will only be liable for slight negligence if Microsoft is in breach of such material contractual obligations, the fulfillment of which facilitate the due performance of this agreement, the breach of which would endanger the purpose of this agreement and the compliance with which a party may constantly trust in \(so\-called "cardinal obligations"\)\. In other cases of slight negligence, Microsoft will not be liable for slight negligence\. - -1. **LEGAL EFFECT**\. This agreement describes certain legal rights\. You may have other rights under the laws of your state or country\. This agreement does not change your rights under the laws of your state or country if the laws of your state or country do not permit it to do so\. Without limitation of the foregoing, for Australia, **YOU HAVE STATUTORY GUARANTEES UNDER THE AUSTRALIAN CONSUMER LAW AND NOTHING IN THESE TERMS IS INTENDED TO AFFECT THOSE RIGHTS** - -1. **DISCLAIMER OF WARRANTY\. THE SOFTWARE IS LICENSED "AS\-IS\." YOU BEAR THE RISK OF USING IT\. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES OR CONDITIONS\. TO THE EXTENT PERMITTED UNDER YOUR LOCAL LAWS, MICROSOFT EXCLUDES THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON\-INFRINGEMENT\.** - -1. **LIMITATION ON AND EXCLUSION OF DAMAGES\. YOU CAN RECOVER FROM MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U\.S\. $5\.00\. YOU CANNOT RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL, INDIRECT OR INCIDENTAL DAMAGES\.** - - This limitation applies to \(a\) anything related to the software, services, content \(including code\) on third party Internet sites, or third party applications; and \(b\) claims for breach of contract, breach of warranty, guarantee or condition, strict liability, negligence, or other tort to the extent permitted by applicable law\. - - It also applies even if Microsoft knew or should have known about the possibility of the damages\. The above limitation or exclusion may not apply to you because your country may not allow the exclusion or limitation of incidental, consequential or other damages\. - -## 11\) windows\-base Docker Image—microsoft\-windows\-netfx3\-ondemand\-package\.cab - -**MICROSOFT SOFTWARE SUPPLEMENTAL LICENSE TERMS** - -**MICROSOFT \.NET FRAMEWORK 3\.5 SP1 FOR MICROSOFT WINDOWS OPERATING SYSTEM** - -\-\-\-\-\- - -Microsoft Corporation \(or based on where you live, one of its affiliates\) licenses this supplement to you\. If you are licensed to use Microsoft Windows operating system software \(for which this supplement is applicable\) \(the "software"\), you may use this supplement\. You may not use it if you do not have a license for the software\. You may use a copy of this supplement with each validly licensed copy of the software\. - -The following license terms describe additional use terms for this supplement\. These terms and the license terms for the software apply to your use of the supplement\. If there is a conflict, these supplemental license terms apply\. - -**BY USING THIS SUPPLEMENT, YOU ACCEPT THESE TERMS\. IF YOU DO NOT ACCEPT THEM, DO NOT USE THIS SUPPLEMENT\.** - -\-\-\-\-\- - -**If you comply with these license terms, you have the rights below\.** - -1. **SUPPORT SERVICES FOR SUPPLEMENT**\. Microsoft provides support services for this software as described at [www\.support\.microsoft\.com/common/international\.aspx](http://www.support.microsoft.com/common/international.aspx)\. - -1. **MICROSOFT \.NET BENCHMARK TESTING**\. The software includes the \.NET Framework, Windows Communication Foundation, Windows Presentation Foundation, and Windows Workflow Foundation components of the Windows operating systems \(\.NET Components\)\. You may conduct internal benchmark testing of the \.NET Components\. You may disclose the results of any benchmark test of the \.NET Components, provided that you comply with the conditions set forth at [http://go\.microsoft\.com/fwlink/?LinkID=66406](http://go.microsoft.com/fwlink/?LinkID=66406)\. - - Notwithstanding any other agreement you may have with Microsoft, if you disclose such benchmark test results, Microsoft shall have the right to disclose the results of benchmark tests it conducts of your products that compete with the applicable \.NET Component, provided it complies with the same conditions set forth at [http://go\.microsoft\.com/fwlink/?LinkID=66406](http://go.microsoft.com/fwlink/?LinkID=66406)\. - -## 12\) windows\-base Docker Image—dotnet\-sdk - -\(available at [https://github\.com/dotnet/core/blob/master/LICENSE\.TXT](https://github.com/dotnet/core/blob/master/LICENSE.TXT)\) - -The MIT License \(MIT\) - -Copyright \(c\) Microsoft Corporation - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\. \ No newline at end of file diff --git a/doc_source/planning.md b/doc_source/planning.md deleted file mode 100644 index 14f5b26..0000000 --- a/doc_source/planning.md +++ /dev/null @@ -1,23 +0,0 @@ -# Plan a Build for AWS CodeBuild - -Before you run your build with CodeBuild, you must answer these questions: - -1. **Where is the source code located?** CodeBuild currently supports building from the following source code repository providers\. The source code must contain a build specification \(build spec\) file, or the build spec must be declared as part of a build project definition\. A *build spec* is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/planning.html) - -1. **Which build commands do you need to run and in what order?** By default, CodeBuild downloads the build input from the provider you specify and uploads the build output to the bucket you specify\. You use the build spec to instruct how to turn the downloaded build input into the expected build output\. For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. **Which runtimes and tools do you need to run the build?** For example, are you building for Java, Ruby, Python, or Node\.js? Does the build need Maven or Ant or a compiler for Java, Ruby, or Python? Does the build need Git, the AWS CLI, or other tools? - - CodeBuild runs builds in build environments that use Docker images\. These Docker images must be stored in a repository type supported by CodeBuild\. These include the CodeBuild Docker image repository, Docker Hub, and Amazon Elastic Container Registry \(Amazon ECR\)\. For more information about the CodeBuild Docker image repository, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. -**Important** -If you use the Ubuntu standard image 2\.0 or later, or the Amazon Linux 2 \(AL2\) standard image 1\.0 or later, you must specify `runtime-versions` in your buildspec file\. For more information, see [Specify Runtime Versions in the Buildspec File](build-spec-ref.md#runtime-versions-buildspec-file)\. - -1. **Do you need AWS resources that aren't provided automatically by CodeBuild? If so, which security policies will those resources need?** For example, you might need to modify the CodeBuild service role to allow CodeBuild to work with those resources\. - -1. **Do you want CodeBuild to work with your VPC?** If so, you need the VPC ID, the subnet IDs, and security group IDs for your VPC configuration\. For more information, see [Use CodeBuild with Amazon Virtual Private Cloud](vpc-support.md)\. - -After you have answered these questions, you should have the settings and resources you need to run a build successfully\. To run your build, you can: -+ Use the CodeBuild console, AWS CLI, or AWS SDKs\. For more information, see [Run AWS CodeBuild Directly](how-to-run.md)\. -+ Create or identify a pipeline in AWS CodePipeline, and then add a build or test action that instructs CodeBuild to automatically test your code, run your build, or both\. For more information, see [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. \ No newline at end of file diff --git a/doc_source/run-build.md b/doc_source/run-build.md deleted file mode 100644 index a8f81ce..0000000 --- a/doc_source/run-build.md +++ /dev/null @@ -1,273 +0,0 @@ -# Run a Build in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to run a build in CodeBuild\. - -**Topics** -+ [Run a Build \(Console\)](#run-build-console) -+ [Run a Build \(AWS CLI\)](#run-build-cli) -+ [Start Running Builds Automatically \(AWS CLI\)](#run-build-cli-auto-start) -+ [Stop Running Builds Automatically \(AWS CLI\)](#run-build-cli-auto-stop) -+ [Run a Build \(AWS SDKs\)](#run-build-sdks) - -## Run a Build \(Console\) - -To use AWS CodePipeline to run a build with CodeBuild, skip these steps and follow the instructions in [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Do one of the following: - + If you just finished creating a build project, the **Build project: *project\-name*** page should be displayed\. Choose **Start build**\. - + If you created a build project earlier, in the navigation pane, choose **Build projects**\. Choose the build project, and then choose **Start build**\. - -1. On the **Start build** page, do one of the following: - + For Amazon S3, for the optional **Source version** value, type the version ID for the version of the input artifact you want to build\. If **Source version** is left blank, the latest version is used\. - + For CodeCommit, for **Reference type**, choose **Branch**, **Git tag**, or **Commit ID**\. Next, choose the branch, Git tag, or enter a commit ID to specify the version of you source code\. For more information, see [Source Version Sample with CodeBuild](sample-source-version.md)\. Change the value for **Git clone depth**\. This creates a shallow clone with a history truncated to the specified number of commits\. If you want a full clone, choose **Full**\. - + For GitHub or GitHub Enterprise, for the optional **Source version** value, enter a commit ID, pull request ID, branch name, or tag name for the version of the source code you want to build\. If you specify a pull request ID, it must use the format `pr/pull-request-ID` \(for example, `pr/25`\)\. If you specify a branch name, the branch's HEAD commit ID is used\. If **Source version** is blank, the default branch's HEAD commit ID is used\. Change the value for **Git clone depth**\. This creates a shallow clone with a history truncated to the specified number of commits\. If you want a full clone, choose **Full**\. - + For Bitbucket, for the optional **Source version** value, enter a commit ID, branch name, or tag name for the version of the source code you want to build\. If you specify a branch name, the branch's HEAD commit ID is used\. If **Source version** is blank, the default branch's HEAD commit ID is used\. Change the value for **Git clone depth**\. This creates a shallow clone with a history truncated to the specified number of commits\. If you want a full clone, choose **Full**\. - + To use a different source provider for this build only, choose **Advanced build options**\. For more information about source provider options and settings, see [Choose source provider](create-project.md#create-project-source-provider)\. - -1. Choose **Advanced build overrides**\. - - Here you can change settings for this build only\. The settings in this section are optional\. - - Under **Source**, you can: - + Choose **Add source** to add a secondary source\. - + Choose **Remove source** to remove a secondary source\. - + Use **Source provider** and **Source version** to modify settings for a source\. - - Under **Environment**, you can: - + Override settings for **Environment image**, **Operating system**, **Runtime**, and **Runtime version**\. - + Select or clear **Privileged**\. - + In **Service role**, you can change the service role that CodeBuild uses to call dependent AWS services for you\. Choose **New service role** to have CodeBuild create a service role for you\. - + Choose **Override build specification** to use a different build specification\. - + Change the value for **Timeout**\. - + Change the value for **Compute**\. - + From **Certificate**, choose a different setting\. - - Under **Buildspec**, you can: - + Choose **Use a buildspec file** to use the buildspec\.yml in the source code root directory\. - + Choose **Insert build commands** to enter commands you want to run during the build phase\. - - Under **Build Artifacts**, you can: - + From **Type**, choose a different artifacts type\. - + In **Name**, enter a different output artifact name\. - + If you want a name specified in the build spec file to override any name specified in the console, select **Use the name specified in the buildspec file**\. The name in a build spec file uses the Shell command language\. For example, you can append a date and time to your artifact name so that it is always unique\. Unique artifact names prevent artifacts from being overwritten\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - + In **Path**, enter a different output artifact path\. - + In **Namespace type**, choose a different type\. Choose **Build ID** to insert the build ID into the path of the build output file \(for example, `My-Path/Build-ID/My-Artifact.zip`\)\. Otherwise, choose **None**\. - + From **Bucket name** choose a different Amazon S3 bucket for your output artifacts\. - + If you do not want your build artifacts encrypted, select **Disable artifacts encryption**\. - + Select **Artifacts packaging**, and then choose **Zip** to put the build artifact files in a compressed file\. To put the build artifact files in the specified Amazon S3 bucket individually \(not compressed\), choose **None**\. - + Under **Cache**, from **Type**, choose a different cache setting\. - + To override secondary artifacts for this build only: - + To remove a secondary artifact, in **Secondary artifacts**, choose the **X** in its row\. - + To add a secondary artifact, choose **Add artifact**, and then enter the information for your secondary artifact\. For more information, see step 8 in [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - - Under **Logs**, you can override your log settings by selecting or clearing **CloudWatch Logs** and **S3 logs**\. - + If you enable **CloudWatch logs**: - + In **Group name**, enter the name of your Amazon CloudWatch Logs group\. - + In **Stream name**, enter your Amazon CloudWatch Logs stream name\. - + If you enable **S3 logs**: - + From **Bucket**, choose the name of the S3 bucket for your logs\. - + In **Path prefix**, enter the prefix for your logs\. - - Under **Service role**, you can change the service role that CodeBuild uses to call dependent AWS services for you\. Choose **Create a role** to have CodeBuild create a service role for you\. - -1. Expand **Environment variables override**\. - - If you want to change the environment variables for this build only, change the values for **Name**, **Value**, and **Type**\. Choose **Add environment variable** to add a new environment variable for this build only\. Choose **Remove environment variable** to remove an environment variable you do not want to use in this build\. - - Others can see an environment variable by using the CodeBuild console and the AWS CLI\. If you have no concerns about the visibility of your environment variable, set the **Name** and **Value** fields, and then set **Type** to **Plaintext**\. - - We recommend that you store an environment variable with a sensitive value, such as an AWS access key ID, an AWS secret access key, or a password as a parameter in Amazon EC2 Systems Manager Parameter Store\. For **Type**, choose **Parameter**\. For **Name**, type an identifier for CodeBuild to reference\. For **Value**, enter the parameter's name as stored in Amazon EC2 Systems Manager Parameter Store\. Using a parameter named `/CodeBuild/dockerLoginPassword` as an example, for **Type**, choose **Parameter**\. For **Name**, enter `LOGIN_PASSWORD`\. For **Value**, enter `/CodeBuild/dockerLoginPassword`\. -**Important** -We recommend that you store parameters in Amazon EC2 Systems Manager Parameter Store with parameter names that start with `/CodeBuild/` \(for example, `/CodeBuild/dockerLoginPassword`\)\. You can use the CodeBuild console to create a parameter in Amazon EC2 Systems Manager\. Choose **Create a parameter**, and then follow the instructions\. \(In that dialog box, for **KMS key**, you can optionally specify the ARN of an AWS KMS key in your account\. Amazon EC2 Systems Manager uses this key to encrypt the parameter's value during storage and decrypt during retrieval\.\) If you use the CodeBuild console to create a parameter, the console starts the parameter with `/CodeBuild/` as it is being stored\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store, the build project's service role must allow the `ssm:GetParameters` action\. If you chose **Create a service role in your account** earlier, then CodeBuild includes this action in the default service role for your build project automatically\. However, if you chose **Choose an existing service role from your account**, then you must include this action in your service role separately\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store with parameter names that do not start with `/CodeBuild/`, and you chose **Create a service role in your account**, then you must update that service role to allow access to parameter names that do not start with `/CodeBuild/`\. This is because that service role allows access only to parameter names that start with `/CodeBuild/`\. -Any environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that begins with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, its value is determined as follows: -The value in the start build operation call takes highest precedence\. -The value in the build project definition takes next precedence\. -The value in the build spec declaration takes lowest precedence\. - -1. Choose **Start build**\. - - For detailed information about this build, see [View Build Details \(Console\)](view-build-details.md#view-build-details-console)\. - -## Run a Build \(AWS CLI\) - -**Note** -To use CodePipeline to run a build with AWS CodeBuild, skip these steps and follow the instructions in [Create a Pipeline That Uses CodeBuild \(AWS CLI\)](how-to-create-pipeline.md#how-to-create-pipeline-cli)\. -For more information about using the AWS CLI with CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Run the `start-build` command in one of the following ways: - - ``` - aws codebuild start-build --project-name project-name - ``` - - Use this if you want to run a build that uses the latest version of the build input artifact and the build project's existing settings\. - - ``` - aws codebuild start-build --generate-cli-skeleton - ``` - - Use this if you want to run a build with an earlier version of the build input artifact or if you want to override the settings for the build output artifacts, environment variables, build spec, or default build timeout period\. - -1. If you run the start\-build command with the `--project-name` option, replace *project\-name* with the name of the build project, and then skip to step 6 of this procedure\. To get a list of build projects, see [View a List of Build Project Names](view-project-list.md)\. - -1. If you run the start\-build command with the `--idempotency-token` option, a unique case sensitive identifier or token, is included with the `start-build` request\. The token is valid for 12 hours after the request\. If you repeat the `start-build` request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error\. - -1. If you run the start\-buildcommand with the `--generate-cli-skeleton` option, JSON\-formatted data appears in the output\. Copy the data to a file \(for example, `start-build.json`\) in a location on the local computer or instance where the AWS CLI is installed\. Modify the copied data to match the following format, and save your results: - - ``` - { - "projectName": "projectName", - "sourceVersion": "sourceVersion", - "artifactsOverride": { - "type": "type", - "location": "location", - "path": "path", - "namespaceType": "namespaceType", - "name": "artifactsOverride-name", - "packaging": "packaging" - }, - "buildspecOverride": "buildspecOverride", - "cacheOverride": { - "location": "cacheOverride-location", - "type": "cacheOverride-type" - }, - "certificateOverride": "certificateOverride", - "computeTypeOverride": "computeTypeOverride", - "environmentTypeOverride": "environmentTypeOverride", - "environmentVariablesOverride": { - "name": "environmentVariablesOverride-name", - "value": "environmentVariablesValue", - "type": "environmentVariablesOverride-type" - }, - "gitCloneDepthOverride": "gitCloneDepthOverride", - "imageOverride": "imageOverride", - "idempotencyToken": "idempotencyToken", - "insecureSslOverride": "insecureSslOverride", - "privilegedModeOverride": "privilegedModeOverride", - "queuedTimeoutInMinutesOverride": "queuedTimeoutInMinutesOverride", - "reportBuildStatusOverride": "reportBuildStatusOverride", - "timeoutInMinutesOverride": "timeoutInMinutesOverride", - "sourceAuthOverride": "sourceAuthOverride", - "sourceLocationOverride": "sourceLocationOverride", - "serviceRoleOverride": "serviceRoleOverride", - "sourceTypeOverride": "sourceTypeOverride" - } - ``` - - Replace the following placeholders: - + *projectName*: Required string\. The name of the build project to use for this build\. - + *sourceVersion*: Optional string\. A version of the source code to be built, as follows: - + For Amazon S3, the version ID that corresponds to the version of the input ZIP file you want to build\. If *sourceVersion* is not specified, then the latest version is used\. - + For CodeCommit, the commit ID that corresponds to the version of the source code you want to build\. If *sourceVersion* is not specified, the default branch's HEAD commit ID is used\. \(You cannot specify a tag name for *sourceVersion*, but you can specify the tag's commit ID\.\) - + For GitHub, the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build\. If a pull request ID is specified, it must use the format `pr/pull-request-ID` \(for example, `pr/25`\)\. If a branch name is specified, the branch's HEAD commit ID is used\. If *sourceVersion* is not specified, the default branch's HEAD commit ID is used\. - + For Bitbucket, the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build\. If a branch name is specified, the branch's HEAD commit ID is used\. If *sourceVersion* is not specified, the default branch's HEAD commit ID is used\. - + The following placeholders are for `artifactsOveride`\. - + *type*: Optional string\. The build output artifact type that overrides for this build the one defined in the build project\. - + *location*: Optional string\. The build output artifact location that overrides for this build the one defined in the build project\. - + *path*: Optional string\. The build output artifact path that overrides for this build the one defined in the build project\. - + *namespaceType*: Optional string\. The build output artifact path type that overrides for this build the one defined in the build project\. - + *name*: Optional string\. The build output artifact name that overrides for this build the one defined in the build project\. - + *packaging*: Optional string\. The build output artifact packaging type that overrides for this build the one defined in the build project\. - + *buildspecOverride*: Optional string\. A build spec declaration that overrides for this build the one defined in the build project\. If this value is set, it can be either an inline build spec definition or the path to an alternate build spec file relative to the value of the built\-in `CODEBUILD_SRC_DIR` environment variable\. - + The following placeholders are for `cacheOveride`\. - + *cacheOverride\-location*: Optional string\. The location of a `ProjectCache` object for this build that overrides the `ProjectCache` object specified in the build project\. `cacheOverride` is optional and takes a `ProjectCache` object\. `location` is required in a `ProjectCache` object\. - + *cacheOverride\-type*: Optional string\. The type of a `ProjectCache` object for this build that overrides the `ProjectCache` object specified in the build project\. `cacheOverride` is optional and takes a `ProjectCache` object\. `type` is required in a `ProjectCache` object\. - + *certificateOverride*: Optional string\. The name of a certificate for this build that overrides the one specified in the build project\. - + *environmentTypeOverride*: Optional string\. A container type for this build that overrides the one specified in the build project\. The current valid string is `LINUX_CONTAINER`\. - + The following placeholders are for `environmentVariablesOveride`\. - + *environmentVariablesOverride\-name*: Optional string\. The name of an environment variable in the build project whose value you want to override for this build\. - + *environmentVariablesOverride\-type*: Optional string\. The type of environment variable in the build project whose value you want to override for this build\. - + *environmentVariablesValue*: Optional string\. The value of the environment variable defined in the build project that you want to override for this build\. - + *gitCloneDepthOverride*: Optional string\. The value of the **Git clone depth** in the build project whose value you want to override for this build\. If your source type is Amazon S3, this value is not supported\. - + *imageOverride*: Optional string\. The name of an image for this build that overrides the one specified in the build project\. - + *idempotencyToken*: Optional string\. A string that serves as a token to specify that the build request is idempotent\. You can choose any string that is 64 characters or less\. The token is valid for 12 hours after the start\-build request\. If you repeat the start\-build request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error\. - + *insecureSslOverride*: Optional boolean that specifies whether to override the insecure SSL setting specified in the build project\. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code\. This override applies only if the build's source is GitHub Enterprise\. - + *privilegedModeOverride*: Optional boolean\. If set to true, the build overrides privileged mode in the build project\. - + *queuedTimeoutInMinutesOverride*: Optional integer that specifies the number of minutes a build is allowed to be queued before it times out\. Its minimum value is five minutes and its maximum value is 480 minutes \(eight hours\)\. - + *reportBuildStatusOverride*: Optional boolean that specifies whether to send your source provider the status of a build's start and completion\. If you set this with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown\. - + *sourceAuthOverride*: Optional string\. An authorization type for this build that overrides the one defined in the build project\. This override applies only if the build project's source is BitBucket or GitHub\. - + *sourceLocationOverride*: Optional string\. A location that overrides for this build the source location for the one defined in the build project\. - + *serviceRoleOverride*: Optional string\. The name of a service role for this build that overrides the one specified in the build project\. - + *sourceTypeOverride*: Optional string\. A source input type for this build that overrides the source input defined in the build project\. Valid strings are `NO_SOURCE`, `CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `S3`, `BITBUCKET`, and `GITHUB_ENTERPRISE`\. - + *timeoutInMinutesOverride*: Optional number\. The number of build timeout minutes that overrides for this build the one defined in the build project\. -**Important** -We recommend that you store an environment variable with a sensitive value, such as an AWS access key ID, an AWS secret access key, or a password as a parameter in Amazon EC2 Systems Manager Parameter Store\. CodeBuild can use a parameter stored in Amazon EC2 Systems Manager Parameter Store only if that parameter's name starts with `/CodeBuild/` \(for example, `/CodeBuild/dockerLoginPassword`\)\. You can use the CodeBuild console to create a parameter in Amazon EC2 Systems Manager\. Choose **Create a parameter**, and then follow the instructions\. \(In that dialog box, for **KMS key**, you can optionally specify the ARN of an AWS KMS key in your account\. Amazon EC2 Systems Manager uses this key to encrypt the parameter's value during storage and decrypt during retrieval\.\) If you use the CodeBuild console to create a parameter, the console starts the parameter with `/CodeBuild/` as it is being stored\. However, if you use the Amazon EC2 Systems Manager Parameter Store console to create a parameter, you must start the parameter's name with `/CodeBuild/`, and you must set **Type** to **Secure String**\. For more information, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. -If your build project refers to parameters stored in Amazon EC2 Systems Manager Parameter Store, the build project's service role must allow the `ssm:GetParameters` action\. If you chose **Create a new service role in your account** earlier, then CodeBuild includes this action in the default service role for your build project automatically\. However, if you chose **Choose an existing service role from your account**, then you must include this action in your service role separately\. -Environment variables you set replace existing environment variables\. For example, if the Docker image already contains an environment variable named `MY_VAR` with a value of `my_value`, and you set an environment variable named `MY_VAR` with a value of `other_value`, then `my_value` is replaced by `other_value`\. Similarly, if the Docker image already contains an environment variable named `PATH` with a value of `/usr/local/sbin:/usr/local/bin`, and you set an environment variable named `PATH` with a value of `$PATH:/usr/share/ant/bin`, then `/usr/local/sbin:/usr/local/bin` is replaced by the literal value `$PATH:/usr/share/ant/bin`\. -Do not set any environment variable with a name that begins with `CODEBUILD_`\. This prefix is reserved for internal use\. -If an environment variable with the same name is defined in multiple places, the environment variable's value is determined as follows: -The value in the start build operation call takes highest precedence\. -The value in the build project definition takes next precedence\. -The value in the build spec declaration takes lowest precedence\. - - For information about valid values for these placeholders, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. For a list of the latest settings for a build project, see [View a Build Project's Details](view-project-details.md)\. - -1. Switch to the directory that contains the file you just saved, and run the `start-build` command again\. - - ``` - aws codebuild start-build --cli-input-json file://start-build.json - ``` - -1. If successful, data similar to that described in the [To run the build \(AWS CLI\)](getting-started.md#getting-started-run-build-cli) procedure appears in the output\. - -To work with detailed information about this build, make a note of the `id` value in the output, and then see [View Build Details \(AWS CLI\)](view-build-details.md#view-build-details-cli)\. - -## Start Running Builds Automatically \(AWS CLI\) - -If your source code is stored in a GitHub or a GitHub Enterprise repository, you can use GitHub webhooks to have AWS CodeBuild rebuild your source code whenever a code change is pushed to the repository\. - -Run the create\-webhookcommand as follows: - -``` -aws codebuild create-webhook --project-name -``` -+ where *project\-name* is the name of the build project that contains the source code to be rebuilt\. - -For GitHub, information similar to the following appears in the output: - -``` -{ - "webhook": { - "url": "url" - } -} -``` -+ where *url* is the URL to the GitHub webhook\. - -For GitHub Enterprise, information similar to the following appears in the output: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-webhook-ghe.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Copy the secret key and payload URL from the output\. You need them to add a webhook in GitHub Enterprise\. - -1. In GitHub Enterprise, choose the repository where your CodeBuild project is stored\. Choose **Settings**, choose **Hooks & services**, and then choose **Add webhook**\. - -1. Enter the payload URL and secret key, accept the defaults for the other fields, and then choose **Add webhook**\. - -## Stop Running Builds Automatically \(AWS CLI\) - -If your source code is stored in a GitHub or a GitHub Enterprise repository, you can set up GitHub webhooks to have AWS CodeBuild rebuild your source code whenever a code change is pushed to the repository\. For more information, see [Start Running Builds Automatically \(AWS CLI\)](#run-build-cli-auto-start)\. - -If you have enabled this behavior, you can turn it off by running the `delete-webhook` command as follows: - -``` -aws codebuild delete-webhook --project-name -``` -+ where *project\-name* is the name of the build project that contains the source code to be rebuilt\. - -If this command is successful, no information and no errors appear in the output\. - -**Note** -This deletes the webhook from your CodeBuild project only\. You should also delete the webhook from your GitHub or GitHub Enterprise repository\. - -## Run a Build \(AWS SDKs\) - -To use CodePipeline to run a build with AWS CodeBuild, skip these steps and follow the instructions in [Use CodePipeline with CodeBuild to Test Code and Run Builds](how-to-create-pipeline.md) instead\. - -For information about using CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/sample-access-tokens.md b/doc_source/sample-access-tokens.md deleted file mode 100644 index da37f7f..0000000 --- a/doc_source/sample-access-tokens.md +++ /dev/null @@ -1,137 +0,0 @@ -# Using Access Tokens with Your Source Provider in CodeBuild - - This sample shows you how to connect to GitHub or Bitbucket with an access token\. For GitHub or GitHub Enterprise, you use a personal access token\. For Bitbucket, you use an app password\. - -## Access Token Prerequisites - - Before you begin, you must add the proper permission scopes to your access token\. - - For GitHub, your personal access token must have the following scopes\. -+ **repo**: Grants full control of private repositories\. -+ **repo:status**: Grants access to commit statuses\. -+ **admin:repo\_hook**: Grants full control of repository hooks\. This scope is not required if your token has the `repo` scope\. - -For more information, see [Understanding Scopes for OAuth Apps](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)\. - - For Bitbucket, your app password must have the following scopes\. -+ **repository:read**: Grants read access to all the repositories to which the authorizing user has access\. -+ **pullrequest:read**: Grants read access to pull requests\. If your project has a Bitbucket webhook, then your app password must have this scope\. -+ **webhook**: Grants access to webhooks\. If your project has a webhook operation, then your app password must have this scope\. - -For more information, see [Scopes for Bitbucket Cloud REST API](https://developer.atlassian.com/cloud/bitbucket/bitbucket-cloud-rest-api-scopes/) and [OAuth on Bitbucket Cloud](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)\. - -## Connect Source Providers with Access Tokens \(Console\) - - To use the console to connect your project to GitHub or Bitbucket using access tokens, do the following while you create a project\. For information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - -For GitHub: - -1. For **Source provider**, choose **GitHub**\. - -1. For **Repository**, choose **Connect with a GitHub personal access token**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-access-token-console.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. In **GitHub personal access token**, enter your GitHub personal access token\. - -1. Choose **Save token**\. - -For Bitbucket: - -1. For **Source provider**, choose **Bitbucket**\. -**Note** -CodeBuild does not support Bitbucket Server\. - -1. For **Repository**, choose **Connect with a Bitbucket app password**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/bitbucket-access-token-console.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. In **Bitbucket username**, enter your Bitbucket user name\. - -1. In **Bitbucket app password**, enter your Bitbucket app password\. - -1. Choose **Save Bitbucket credentials**\. - -## Connect Source Providers with Access Tokens \(CLI\) - -Follow these steps to use the AWS CLI to connect your project to GitHub or Bitbucket using access tokens\. For information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -1. Run the import\-source\-credentials command: - - ``` - aws codebuild import-source-credentials --generate-cli-skeleton - ``` - - JSON\-formatted data appears in the output\. Copy the data to a file \(for example, `import-source-credentials.json`\) in a location on the local computer or instance where the AWS CLI is installed\. Modify the copied data as follows, and save your results\. - - ``` - { - "serverType": "server-type", - "authType": "auth-type", - "shouldOverwrite": "should-overwrite", - "token": "token", - "username": "username" - } - ``` - - Replace the following: - + *server\-type*: Required value\. The source provider used for this credential\. Valid values are GITHUB, GITHUB\_ENTERPRISE, and BITBUCKET\. - + *auth\-type*: Required value\. The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository\. Valid values include PERSONAL\_ACCESS\_TOKEN and BASIC\_AUTH\. You cannot use the CodeBuild API to create an OAUTH connection\. You must use the CodeBuild console instead\. - + *should\-overwrite*: Optional value\. Set to `false` to prevent overwriting the repository source credentials\. Set to `true` to overwrite the repository source credentials\. The default value is `true`\. - + *token*: Required value\. For GitHub or GitHub Enterprise, this is the personal access token\. For Bitbucket, this is the app password\. - + *username*: Optional value\. The Bitbucket user name when authType is BASIC\_AUTH\. This parameter is ignored for other types of source providers or connections\. - -1. To connect your account with an access token, switch to the directory that contains the `import-source-credentials.json` file you saved in step 1 and run the import\-source\-credentials command again\. - - ``` - aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json - ``` - - JSON\-formatted data appears in the output with an Amazon Resource Name \(ARN\)\. - - ``` - { - "arn": "arn:aws:codebuild:region:account-id:token/server-type" - } - ``` -**Note** - If you run the import\-source\-credentials command with the same server type and auth type a second time, the stored access token is updated\. - - After your account is connected with an access token, you can use `create-project` to create your CodeBuild project\. For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -1. To view the connected access tokens, run the list\-source\-credentials command\. - - ``` - aws codebuild list-source-credentials - ``` - - A JSON\-formatted `sourceCredentialsInfos` object appears in the output: - - ``` - { - "sourceCredentialsInfos": [ - { - "authType": "auth-type", - "serverType": "server-type", - "arn": "arn" - } - ] - } - ``` - - The `sourceCredentialsObject` contains a list of connected source credentials information: - + The `authType` is the type of authentication used by credentials\. This can be `OAUTH`, `BASIC_AUTH`, or `PERSONAL_ACCESS_TOKEN`\. - + The `serverType` is the type of source provider\. This can be `GITHUB`, `GITHUB_ENTERPRISE`, or `BITBUCKET`\. - + The `arn` is the ARN of the token\. - -1. To disconnect from a source provider and remove its access tokens, run the delete\-source\-credentials command with its ARN\. - - ``` - aws codebuild delete-source-credentials --arn arn-of-your-credentials - ``` - - JSON\-formatted data is returned with an ARN of the deleted credentials\. - - ``` - { - "arn": "arn:aws:codebuild:region:account-id:token/server-type" - } - ``` \ No newline at end of file diff --git a/doc_source/sample-bitbucket-pull-request.md b/doc_source/sample-bitbucket-pull-request.md deleted file mode 100644 index ca65fbb..0000000 --- a/doc_source/sample-bitbucket-pull-request.md +++ /dev/null @@ -1,253 +0,0 @@ -# Bitbucket Pull Request and Webhook Filter Sample for CodeBuild - -This sample shows you how to create a pull request using a Bitbucket repository\. It also shows you how to use a Bitbucket webhook to trigger CodeBuild to create a build of a project\. - -**Topics** -+ [Bitbucket Pull Request Prerequisites](#sample-bitbucket-pull-request-prerequisites) -+ [Create a Build Project with Bitbucket as the Source Repository and Enable Webhooks](#sample-bitbucket-pull-request-create) -+ [Trigger a Build with a Bitbucket Webhook](#sample-bitbucket-pull-request-trigger) -+ [Filter Bitbucket Webhook Events](#sample-bitbucket-pull-request-filter-webhook-events) - -## Bitbucket Pull Request Prerequisites - - To run this sample you must connect your AWS CodeBuild project with your Bitbucket account\. - -**Note** - CodeBuild has updated its permissions with Bitbucket\. If you previously connected your project to Bitbucket and now receive a Bitbucket connection error, you must reconnect to grant CodeBuild permission to manage your webhooks\. - -## Create a Build Project with Bitbucket as the Source Repository and Enable Webhooks - - The following steps describe how to create an AWS CodeBuild project with Bitbucket as a source repository and enable webhooks\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - -1. In **Source**, for **Source provider**, choose **Bitbucket**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/bitbucket-pr-sample-source.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - - Follow the instructions to connect or reconnect, and then choose **Grant access**\. -**Note** -CodeBuild does not support Bitbucket Server\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/bitbucket-webhook-prerequisite.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Use a repository in my account**\. You cannot use a webhook if you use a public Bitbucket repository\. - -1. In **Primary source webhook events** select **Rebuild every time a code change is pushed to this repository**\. You can select this check box only if you chose **Repository in my Bitbucket account**\. -**Note** - If a build is triggered by a Bitbucket webhook, the **Report build status** setting is ignored\. The build status is always sent to Bitbucket\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-pr-webhook.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose other settings for your project\. For more information about source provider options and settings, see [Choose source provider](create-project.md#create-project-source-provider)\. - -1. Choose **Create build project**\. On the **Review** page, choose **Start build** to run the build\. - -## Trigger a Build with a Bitbucket Webhook - - For a project that uses Bitbucket webhooks, AWS CodeBuild creates a build when the Bitbucket repository detects a change in your source code\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. On the navigation pane, choose **Build projects**, and then choose a project associated with a Bitbucket repository with webhooks\. For information about creating a Bitbucket webhook project, see [Create a Build Project with Bitbucket as the Source Repository and Enable Webhooks](#sample-bitbucket-pull-request-create)\. - -1. Make some changes in the code in your project's Bitbucket repository\. - -1. Create a pull request on your Bitbucket repository\. For more information, see [Making a Pull Request](https://www.atlassian.com/git/tutorials/making-a-pull-request)\. - -1. On the Bitbucket webhooks page, choose **View request** to see a list of recent events\. - -1. Choose **View details** to see details about the response returned by CodeBuild\. It might look something like this: - - ``` - "response":"Webhook received and buld started: https://us-east-1.console.aws.amazon.com/codebuild/home..." - "statusCode":200 - ``` - -1. Navigate to the Bitbucket pull request page to see the status of the build\. - -## Filter Bitbucket Webhook Events - - You can use webhook filter groups to specify which Bitbucket webhook events trigger a build\. For example, you can specify that a build is triggered for specified branches only\. - - You can specify more than one webhook filter group\. A build is triggered if the filters on one or more filter groups evaluate to true\. When you create a filter group, you specify: -+ An event\. For Bitbucket, you can choose one or more of the following events: `PUSH`, `PULL_REQUEST_CREATED`, `PULL_REQUEST_UPDATED`, and `PULL_REQUEST_MERGED`\. The webhook's event type is in its header in the `X-Event-Key` field\. The following table shows how `X-Event-Key` header values map to the event types\. -**Note** -You must enable the `merged` event in your Bitbucket webhook setting if you create a webhook filter group that uses the `PULL_REQUEST_MERGED` event type\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-bitbucket-pull-request.html) -+ One or more optional filters\. Use a regular expression to specify a filter\. For an event to trigger a build, every filter associated with it must evaluate to true\. - + `ACTOR_ACCOUNT_ID` \(`ACTOR_ID` in the console\): A webhook event triggers a build when a Bitbucket account ID matches the regular expression pattern\. This value is found in the `account_id` property of the `actor` object in the webhook filter payload\. - + `HEAD_REF`: A webhook event triggers a build when the head reference matches the regular expression pattern \(for example, `refs/heads/branch-name` and `refs/tags/tag-name`\)\. A `HEAD_REF` filter evaluates the Git reference name for the branch or tag\. The branch or tag name is found in the `name` field of the `new` object in the `push` object of the webhook payload\. For pull request events, the branch name is found in the `name` field in the `branch` object of the `source` object in the webhook payload\. - + `BASE_REF`: A webhook event triggers a build when the base reference matches the regular expression pattern\. A `BASE_REF` filter works with pull request events only \(for example, `refs/heads/branch-name`\)\. A `BASE_REF` filter evaluates the Git reference name for the branch\. The branch name is found in the `name` field of the `branch` object in the `destination` object in the webhook payload\. - -**Note** - You can find the webhook payload in the webhook settings of your Bitbucket repository\. - -**Topics** -+ [Filter BitBucket Webhook Events \(Console\)](#sample-bitbucket-pull-request-filter-webhook-events-console) -+ [Filter BitBucket Webhook Events \(SDK\)](#sample-bitbucket-pull-request-filter-webhook-events-sdk) -+ [Filter Bitbucket Webhook Events \(AWS CloudFormation\)](#sample-bitbucket-pull-request-filter-webhook-events-cfn) - -### Filter BitBucket Webhook Events \(Console\) - - To use the AWS Management Console to filter webhook events: - -1. Select **Rebuild every time a code change is pushed to this repository** when you create your project\. - -1. From **Event type**, choose one or more events\. - -1. To filter when an event triggers a build, under **Start a build under these conditions**, add one or more optional filters\. - -1. To filter when an event is not triggered, under **Don't start a build under these conditions**, add one or more optional filters\. - -1. Choose **Add filter group** to add another filter group\. - - For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [WebhookFilter](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_WebhookFilter.html) in the *AWS CodeBuild API Reference*\. - -In this example, a webhook filter group triggers a build for pull requests only: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-bitbucket.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -Using an example of two filter groups, a build is triggered when one or both evaluate to true: -+ The first filter group specifies pull requests that are created or updated on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that matches `^refs/heads/branch1!`\. -+ The second filter group specifies push requests on branches with Git reference names that match the regular expression `^refs/heads/branch1$`\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-head-base-regexes-bitbucket.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -In this example, a webhook filter group triggers a build for all requests except tag events\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-exclude-bitbucket.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -In this example, a webhook filter group triggers a build only when a change is made by a Bitbucket user that does not have an account ID that matches the regular expression `actor-account-id`\. - -**Note** - For information about how to find your Bitbucket account ID, see https://api\.bitbucket\.org/2\.0/users/*user\-name*, where *user\-name* is your Bitbucket user name\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-actor-bitbucket.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -### Filter BitBucket Webhook Events \(SDK\) - - To use the AWS CodeBuild SDK to filter webhook events, use the `filterGroups` field in the request syntax of the `CreateWebhook` or `UpdateWebhook` API methods\. For more information, see [WebhookFilter](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_WebhookFilter.html) in the *CodeBuild API Reference*\. - - To create a webhook filter that triggers a build for pull requests only, insert the following into the request syntax: - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_MERGED" - } - ] -] -``` - - To create a webhook filter that triggers a build for specified branches only, use the `pattern` parameter to specify a regular expression to filter branch names\. Using an example of two filter groups, a build is triggered when one or both are evaluate to true: -+ The first filter group specifies pull requests that are created or updated on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that match `^refs/heads/myBranch$`\. -+ The second filter group specifies push requests on branches with Git reference names that match the regular expression `^refs/heads/myBranch$` and \. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/heads/myBranch$" - }, - { - "type": "BASE_REF", - "pattern": "^refs/heads/master$" - } - ], - [ - { - "type": "EVENT", - "pattern": "PUSH" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/heads/myBranch$" - } - ] -] -``` - - You can use the `excludeMatchedPattern` parameter to specify which events do not trigger a build\. In this example, a build is triggered for all requests except tag events\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_MERGED" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/tags/.*", - "excludeMatchedPattern": true - } - ] -] -``` - -You can create a filter that triggers a build only when a change is made by a Bitbucket user with account ID `actor-account-id`\. - -**Note** - For information about how to find your Bitbucket account ID, see https://api\.bitbucket\.org/2\.0/users/*user\-name*, where *user\-name* is your Bitbucket user name\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_MERGED" - }, - { - "type": "ACTOR_ACCOUNT_ID", - "pattern": "actor-account-id" - } - ] -] -``` - -### Filter Bitbucket Webhook Events \(AWS CloudFormation\) - - To use an AWS CloudFormation template to filter webhook events, use the AWS CodeBuild project's `FilterGroups` property\. The following YAML\-formatted portion of a AWS CloudFormation template creates two filter groups\. Together, they trigger a build when one or both evaluate to true: -+ The first filter group specifies pull requests are created or updated on branches with Git reference names that match the regular expression `^refs/heads/master$` by a Bitbucket user that does not have account ID `12345`\. -+ The second filter group specifies push requests are created on branches with Git reference names that match the regular expression `^refs/heads/.*`\. - -``` -CodeBuildProject: - Type: AWS::CodeBuild::Project - Properties: - Name: MyProject - ServiceRole: service-role - Artifacts: - Type: NO_ARTIFACTS - Environment: - Type: LINUX_CONTAINER - ComputeType: BUILD_GENERAL1_SMALL - Image: aws/codebuild/standard:2.0 - Source: - Type: BITBUCKET - Location: source-location - Triggers: - Webhook: true - FilterGroups: - - - Type: EVENT - Pattern: PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED - - Type: BASE_REF - Pattern: ^refs/heads/master$ - ExcludeMatchedPattern: false - - Type: ACTOR_ACCOUNT_ID - Pattern: 12345 - ExcludeMatchedPattern: true - - - Type: EVENT - Pattern: PUSH - - Type: HEAD_REF - Pattern: ^refs/heads/.* -``` \ No newline at end of file diff --git a/doc_source/sample-build-badges.md b/doc_source/sample-build-badges.md deleted file mode 100644 index de30dc4..0000000 --- a/doc_source/sample-build-badges.md +++ /dev/null @@ -1,78 +0,0 @@ -# Build Badges Sample with CodeBuild - -AWS CodeBuild now supports the use of build badges, which provide an embeddable, dynamically generated image \(*badge*\) that displays the status of the latest build for a project\. This image is accessible through a publicly available URL generated for your CodeBuild project\. This allows anyone to view the status of a CodeBuild project\. Build badges do not contain any security information, so they do not require authentication\. - -## Create a Build Project with Build Badges Enabled \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - -1. In **Source**, for **Source provider**, choose the source code provider type, and then do one of the following: - + If you chose **Amazon S3**, then for **Bucket**, choose the name of the input bucket that contains the source code\. For **S3 object key**, enter the name of the ZIP file that contains the source code\. - + If you chose **CodeCommit**, then for **Repository**, choose the name of the repository\. Select **Enable build badge** to make your project's build status visible and embeddable\. - + If you chose **GitHub**, follow the instructions to connect \(or reconnect\) with GitHub\. On the GitHub **Authorize application** page, for **Organization access**, choose **Request access** next to each repository you want AWS CodeBuild to be able to access\. After you choose **Authorize application**, back in the AWS CodeBuild console, for **Repository**, choose the name of the repository that contains the source code\. Select **Enable build badge** to make your project's build status visible and embeddable\. - + If you chose **Bitbucket**, follow the instructions to connect \(or reconnect\) with Bitbucket\. On the Bitbucket **Confirm access to your account** page, for **Organization access**, choose **Grant access**\. After you choose **Grant access**, back in the AWS CodeBuild console, for **Repository**, choose the name of the repository that contains the source code\. Select **Enable build badge** to make your project's build status visible and embeddable\. -**Important** -Updating your project source might affect the accuracy of the project's build badges\. - -1. In **Environment**: - - For **Environment image**, do one of the following: - + To use a Docker image managed by AWS CodeBuild, choose **Managed image**, and then make selections from **Operating system**, **Runtime**, and **Runtime version**\. - + To use another Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Amazon ECR** or **Other location**\. If you choose **Other location**, enter the name and tag of the Docker image in Docker Hub, using the format `docker repository/docker image name`\. If you choose **Amazon ECR**, then use **Amazon ECR repository** and **Amazon ECR image** to choose the Docker image in your AWS account\. - + To use private Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Other location**, and then enter the Amazon Resource Name \(ARN\) of the credentials for your private Docker image\. The credentials must be created by AWS Secrets Manager\. For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. For **Buildspec**, do one of the following: - + Choose **Use a buildspec file** to use the buildspec\.yml file in the source code root directory\. - + Choose **Insert build commands** to use the console to insert build commands\. - - For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. In **Artifacts**, for **Type**, do one of the following: - + If you do not want to create any build output artifacts, choose **No artifacts**\. - + To store the build output in an Amazon S3 bucket, choose **Amazon S3**, and then do the following: - + If you want to use your project name for the build output ZIP file or folder, leave **Name** blank\. Otherwise, enter the name\. By default, the artifact name is the project name\. If you want to use a different name, enter it in the artifacts name box\. If you want to output a ZIP file, include the zip extension\. - + For **Bucket name**, choose the name of the output bucket\. - + If you chose **Insert build commands** earlier in this procedure, then for **Output files**, enter the locations of the files from the build that you want to put into the build output ZIP file or folder\. For multiple locations, separate each location with a comma \(for example, `appspec.yml, target/my-app.jar`\)\. For more information, see the description of `files` in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -1. Expand **Additional configuration** and set options as appropriate\. - -1. Choose **Create build project**\. On the **Review** page, choose **Start build** to run the build\. - -## Create a Build Project with Build Badges Enabled \(CLI\) - -For information about creating a build project, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. To include build badges with your AWS CodeBuild project, you must specify *badgeEnabled* with a value of `true` \. - -## Access Your AWS CodeBuild Build Badges - -You can use AWS CodeBuild console or the AWS CLI to access build badges\. -+ In the CodeBuild console, in the list of build projects, in the **Name** column, choose the link that corresponds to the build project\. On the **Build project: *project\-name*** page, in **Configuration**, choose **Copy badge URL**\. For more information, see [View a Build Project's Details \(Console\)](view-project-details.md#view-project-details-console)\. -+ In the AWS CLI, run the `batch-get-projects` command\. The build badge URL is included in the project environment details section of the output\. For more information, see [View a Build Project's Details \(AWS CLI\)](view-project-details.md#view-project-details-cli)\. - -**Important** -The given build badge request URL is for the master branch, but you can specify any branch in your source repository that you have used to run a build\. - -## Publish Your CodeBuild Build Badges - -You can include your build badge request URL in a markdown file in your preferred repository \(for example, GitHub or CodeCommit\) to display the status of the latest build\. - -Sample markdown code: - -``` -![Build Status](https://codebuild.us-east-1.amazon.com/badges?uuid=...&branch=master) -``` - -## CodeBuild Badge Statuses -+ **PASSING** The most recent build on the given branch passed\. -+ **FAILING** The most recent build on the given branch timed out, failed, faulted, or was stopped\. -+ **IN\_PROGRESS** The most recent build on the given branch is in progress\. -+ **UNKNOWN** The project has not yet run a build for the given branch or at all\. Also, the build badges feature might have been disabled\. \ No newline at end of file diff --git a/doc_source/sample-build-notifications.md b/doc_source/sample-build-notifications.md deleted file mode 100644 index 8ce4ee8..0000000 --- a/doc_source/sample-build-notifications.md +++ /dev/null @@ -1,531 +0,0 @@ -# Build Notifications Sample for CodeBuild - -Amazon CloudWatch Events has built\-in support for AWS CodeBuild\. CloudWatch Events is a stream of system events describing changes in your AWS resources\. With CloudWatch Events, you write declarative rules to associate events of interest with automated actions to be taken\. This sample uses Amazon CloudWatch Events and Amazon Simple Notification Service \(Amazon SNS\) to send build notifications to subscribers whenever builds succeed, fail, go from one build phase to another, or any combination of these events\. - -**Important** -Running this sample may result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon CloudWatch and Amazon SNS\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing), and [Amazon SNS Pricing](http://aws.amazon.com/sns/pricing)\. - -## Running the Sample - -To run this sample: - -1. If you already have a topic set up and subscribed to in Amazon SNS that you want to use for this sample, skip ahead to step 4\. Otherwise, if you are using an IAM user instead of an AWS root account or an administrator IAM user to work with Amazon SNS, add the following statement \(between *\#\#\# BEGIN ADDING STATEMENT HERE \#\#\#* and *\#\#\# END ADDING STATEMENT HERE \#\#\#*\) to the user \(or IAM group the user is associated with\)\. \(Using an AWS root account is not recommended\.\) This statement enables viewing, creating, subscribing, and testing the sending of notifications to topics in Amazon SNS\. Ellipses \(`...`\) are used for brevity and to help you locate where to add the statement\. Do not remove any statements, and do not type these ellipses into the existing policy\. - - ``` - { - "Statement": [ - ### BEGIN ADDING STATEMENT HERE ### - { - "Action": [ - "sns:CreateTopic", - "sns:GetTopicAttributes", - "sns:List*", - "sns:Publish", - "sns:SetTopicAttributes", - "sns:Subscribe" - ], - "Resource": "*", - "Effect": "Allow" - }, - ### END ADDING STATEMENT HERE ### - ... - ], - "Version": "2012-10-17" - } - ``` -**Note** -The IAM entity that modifies this policy must have permission in IAM to modify policies\. -For more information, see [Editing Customer Managed Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-using.html#edit-managed-policy-console) or the "To edit or delete an inline policy for a group, user, or role" section in [Working with Inline Policies \(Console\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_inline-using.html#AddingPermissions_Console) in the *IAM User Guide*\. - -1. Create or identify a topic in Amazon SNS\. AWS CodeBuild will use CloudWatch Events to send build notifications to this topic through Amazon SNS\. To create a topic: - - 1. Open the Amazon SNS console, at [https://console\.aws\.amazon\.com/sns](https://console.aws.amazon.com/sns)\. - - 1. Choose **Create topic**\. - - 1. In the **Create new topic** dialog box, for **Topic name**, type a name for the topic, for example **CodeBuildDemoTopic**\. \(If you choose a different name, substitute it throughout this sample\.\) - - 1. Choose **Create topic**\. - - 1. On the **Topic details: CodeBuildDemoTopic** page, copy the **Topic ARN** value, as shown in the following screen shot\. You will need this value for the next step\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/topic-arn.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - - For more information, see [Create a Topic](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in the *Amazon SNS Developer Guide*\. - -1. Subscribe one or more recipients to the topic to receive email notifications\. To subscribe a recipient to a topic: - - 1. With the Amazon SNS console open from the previous step, in the navigation pane, choose **Subscriptions**, and then choose **Create subscription**\. - - 1. In the **Create subscription** dialog box, for **Topic ARN**, paste the topic ARN you copied from the previous step\. - - 1. For **Protocol**, choose **Email**\. - - 1. For **Endpoint**, type the recipient's full email address\. Compare your results to the following screen shot\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-subscription.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - - 1. Choose **Create Subscription**\. - - 1. Amazon SNS sends a subscription confirmation email to the recipient\. To begin receiving email notifications, the recipient must choose the **Confirm subscription** link in the subscription confirmation email\. After the recipient clicks the link, if successfully subscribed, Amazon SNS displays a confirmation message in the recipient's web browser\. - - For more information, see [Subscribe to a Topic](https://docs.aws.amazon.com/sns/latest/dg/SubscribeTopic.html) in the *Amazon SNS Developer Guide*\. - -1. If you are using an IAM user instead of an AWS root account or an administrator IAM user to work with CloudWatch Events, add the following statement \(between *\#\#\# BEGIN ADDING STATEMENT HERE \#\#\#* and *\#\#\# END ADDING STATEMENT HERE \#\#\#*\) to the user \(or IAM group the user is associated with\)\. \(Using an AWS root account is not recommended\.\) This statement enables working with CloudWatch Events\. Ellipses \(`...`\) are used for brevity and to help you locate where to add the statement\. Do not remove any statements, and do not type these ellipses into the existing policy\. - - ``` - { - "Statement": [ - ### BEGIN ADDING STATEMENT HERE ### - { - "Action": [ - "events:*", - "iam:PassRole" - ], - "Resource": "*", - "Effect": "Allow" - }, - ### END ADDING STATEMENT HERE ### - ... - ], - "Version": "2012-10-17" - } - ``` -**Note** -The IAM entity that modifies this policy must have permission in IAM to modify policies\. -For more information, see [Editing Customer Managed Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-using.html#edit-managed-policy-console) or the "To edit or delete an inline policy for a group, user, or role" section in [Working with Inline Policies \(Console\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_inline-using.html#AddingPermissions_Console) in the *IAM User Guide*\. - -1. Create a rule in CloudWatch Events\. To do this, open the CloudWatch console, at [https://console\.aws\.amazon\.com/cloudwatch](https://console.aws.amazon.com/cloudwatch)\. - -1. In the navigation pane, under **Events**, choose **Rules**, and then choose **Create rule**\. - -1. On the **Step 1: Create rule page**, the following should already be chosen: **Event Pattern** and **Build event pattern to match events by service**\. - -1. For **Service Name**, choose **CodeBuild**\. For **Event Type**, **All Events** should already be chosen\. - -1. **Event Pattern Preview** should show the following code\. - - ``` - { - "source": [ - "aws.codebuild" - ] - } - ``` - - Compare your results so far to the following screen shot: -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-rule.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Replace the code in **Event Pattern Preview** with one of the following two rule patterns by choosing **Edit**\. - - This first rule pattern triggers an event whenever a build starts or completes, for the specified build projects in AWS CodeBuild\. - - ``` - { - "source": [ - "aws.codebuild" - ], - "detail-type": [ - "CodeBuild Build State Change" - ], - "detail": { - "build-status": [ - "IN_PROGRESS", - "SUCCEEDED", - "FAILED", - "STOPPED" - ], - "project-name": [ - "my-demo-project-1", - "my-demo-project-2" - ] - } - } - ``` - - In the preceding rule, make the following code changes as needed\. - + To trigger an event whenever a build starts or completes, either leave all of the values as shown in the `build-status` array, or remove the `build-status` array altogether\. - + To trigger an event only when a build completes, remove `IN_PROGRESS` from the `build-status` array\. - + To trigger an event only when a build starts, remove all of the values except `IN_PROGRESS` from the `build-status` array\. - + To trigger events for all build projects, remove the `project-name` array altogether\. - + To trigger events only for individual build projects, specify the name of each build project in the `project-name` array\. - - This second rule pattern triggers an event whenever a build moves from one build phase to another, for the specified build projects in AWS CodeBuild\. - - ``` - { - "source": [ - "aws.codebuild" - ], - "detail-type": [ - "CodeBuild Build Phase Change" - ], - "detail": { - "completed-phase": [ - "SUBMITTED", - "PROVISIONING", - "DOWNLOAD_SOURCE", - "INSTALL", - "PRE_BUILD", - "BUILD", - "POST_BUILD", - "UPLOAD_ARTIFACTS", - "FINALIZING" - ], - "completed-phase-status": [ - "TIMED_OUT", - "STOPPED", - "FAILED", - "SUCCEEDED", - "FAULT", - "CLIENT_ERROR" - ], - "project-name": [ - "my-demo-project-1", - "my-demo-project-2" - ] - } - } - ``` - - In the preceding rule, make the following code changes as needed\. - + To trigger an event for every build phase change \(which may send up to 9 notifications for each build\), either leave all of the values as shown in the `completed-phase` array, or remove the `completed-phase` array altogether\. - + To trigger events only for individual build phase changes, remove the name of each build phase in the `completed-phase` array that you do not want to trigger an event for\. - + To trigger an event for every build phase status change, either leave all of the values as shown in the `completed-phase-status` array, or remove the `completed-phase-status` array altogether\. - + To trigger events only for individual build phase status changes, remove the name of each build phase status in the `completed-phase-status` array that you do not want to trigger an event for\. - + To trigger events for all build projects, remove the `project-name` array\. - + To trigger events for individual build projects, specify the name of each build project in the `project-name` array\. -**Note** -If you want to trigger events for both build state changes and build phase changes, you must create two separate rules, one for build state changes and another for build phase changes\. If you try to combine both rules into a single rule, the combined rule may produce unexpected results or stop working altogether\. - - When you have finished replacing the code, choose **Save**\. - -1. For **Targets**, choose **Add target**\. - -1. In the list of targets, choose **SNS topic**\. - -1. For **Topic**, choose the topic you identified or created earlier\. - -1. Expand **Configure input**, and then choose **Input Transformer**\. - -1. In the **Input Path** box, type one of the following input paths\. - - For a rule with a `detail-type` value of `CodeBuild Build State Change`, type the following\. - - ``` - {"build-id":"$.detail.build-id","project-name":"$.detail.project-name","build-status":"$.detail.build-status"} - ``` - - For a rule with a `detail-type` value of `CodeBuild Build Phase Change`, type the following\. - - ``` - {"build-id":"$.detail.build-id","project-name":"$.detail.project-name","completed-phase":"$.detail.completed-phase","completed-phase-status":"$.detail.completed-phase-status"} - ``` -**Note** -To get other types of information, see the [Build Notifications Input Format Reference](#sample-build-notifications-ref)\. - -1. In the **Input Template** box, type one of the following input templates\. - - For a rule with a `detail-type` value of `CodeBuild Build State Change`, type the following\. - - ``` - "Build '' for build project '' has reached the build status of ''." - ``` - - For a rule with a `detail-type` value of `CodeBuild Build Phase Change`, type the following\. - - ``` - "Build '' for build project '' has completed the build phase of '' with a status of ''." - ``` - - Compare your results so far to the following screen shot, which shows a rule with a `detail-type` value of `CodeBuild Build State Change`: -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-rule-2.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Configure details**\. - -1. On the **Step 2: Configure rule details** page, type a **Name** and an optional **Description**\. Leave the **Enabled** box checked for **State**\. - - Compare your results so far to the following screen shot: -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/create-rule-3.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Choose **Create rule**\. - -1. Create build projects, run the builds, and view build information, for example by following the steps in [Run AWS CodeBuild Directly](how-to-run.md)\. - -1. Confirm that CodeBuild is now successfully sending build notifications\. For example, check to see if the build notification emails are now in your inbox\. - -To change a rule's behavior, in the CloudWatch console, choose the rule you want to change, and then choose **Actions**, **Edit**\. Make changes to the rule, and then choose **Configure details**, followed by choosing **Update rule**\. - -To stop using a rule to send build notifications, in the CloudWatch console, choose the rule you want to stop using, and then choose **Actions**, **Disable**\. - -To delete a rule altogether, in the CloudWatch console, choose the rule you want to delete, and then choose **Actions**, **Delete**\. - -### Related Resources -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. - -## Build Notifications Input Format Reference - -CloudWatch delivers notifications in JSON format\. - -Build state change notifications use the following format: - -``` -{ - "version": "0", - "id": "c030038d-8c4d-6141-9545-00ff7b7153EX", - "detail-type": "CodeBuild Build State Change", - "source": "aws.codebuild", - "account": "123456789012", - "time": "2017-09-01T16:14:28Z", - "region": "us-west-2", - "resources":[ - "arn:aws:codebuild:us-west-2:123456789012:build/my-sample-project:8745a7a9-c340-456a-9166-edf953571bEX" - ], - "detail":{ - "build-status": "SUCCEEDED", - "project-name": "my-sample-project", - "build-id": "arn:aws:codebuild:us-west-2:123456789012:build/my-sample-project:8745a7a9-c340-456a-9166-edf953571bEX", - "additional-information": { - "artifact": { - "md5sum": "da9c44c8a9a3cd4b443126e823168fEX", - "sha256sum": "6ccc2ae1df9d155ba83c597051611c42d60e09c6329dcb14a312cecc0a8e39EX", - "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/my-output-artifact.zip" - }, - "environment": { - "image": "aws/codebuild/standard:2.0", - "privileged-mode": false, - "compute-type": "BUILD_GENERAL1_SMALL", - "type": "LINUX_CONTAINER", - "environment-variables": [] - }, - "timeout-in-minutes": 60, - "build-complete": true, - "initiator": "MyCodeBuildDemoUser", - "build-start-time": "Sep 1, 2017 4:12:29 PM", - "source": { - "location": "codebuild-123456789012-input-bucket/my-input-artifact.zip", - "type": "S3" - }, - "logs": { - "group-name": "/aws/codebuild/my-sample-project", - "stream-name": "8745a7a9-c340-456a-9166-edf953571bEX", - "deep-link": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-sample-project;stream=8745a7a9-c340-456a-9166-edf953571bEX" - }, - "phases": [ - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:12:29 PM", - "end-time": "Sep 1, 2017 4:12:29 PM", - "duration-in-seconds": 0, - "phase-type": "SUBMITTED", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:12:29 PM", - "end-time": "Sep 1, 2017 4:13:05 PM", - "duration-in-seconds": 36, - "phase-type": "PROVISIONING", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:05 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 4, - "phase-type": "DOWNLOAD_SOURCE", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 0, - "phase-type": "INSTALL", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 0, - "phase-type": "PRE_BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 70, - "phase-type": "BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 0, - "phase-type": "POST_BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 0, - "phase-type": "UPLOAD_ARTIFACTS", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:26 PM", - "duration-in-seconds": 4, - "phase-type": "FINALIZING", - "phase-status": "SUCCEEDED" - }, - { - "start-time": "Sep 1, 2017 4:14:26 PM", - "phase-type": "COMPLETED" - } - ] - }, - "current-phase": "COMPLETED", - "current-phase-context": "[]", - "version": "1" - } -} -``` - -Build phase change notifications use the following format: - -``` -{ - "version": "0", - "id": "43ddc2bd-af76-9ca5-2dc7-b695e15adeEX", - "detail-type": "CodeBuild Build Phase Change", - "source": "aws.codebuild", - "account": "123456789012", - "time": "2017-09-01T16:14:21Z", - "region": "us-west-2", - "resources":[ - "arn:aws:codebuild:us-west-2:123456789012:build/my-sample-project:8745a7a9-c340-456a-9166-edf953571bEX" - ], - "detail":{ - "completed-phase": "COMPLETED", - "project-name": "my-sample-project", - "build-id": "arn:aws:codebuild:us-west-2:123456789012:build/my-sample-project:8745a7a9-c340-456a-9166-edf953571bEX", - "completed-phase-context": "[]", - "additional-information": { - "artifact": { - "md5sum": "da9c44c8a9a3cd4b443126e823168fEX", - "sha256sum": "6ccc2ae1df9d155ba83c597051611c42d60e09c6329dcb14a312cecc0a8e39EX", - "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/my-output-artifact.zip" - }, - "environment": { - "image": "aws/codebuild/standard:2.0", - "privileged-mode": false, - "compute-type": "BUILD_GENERAL1_SMALL", - "type": "LINUX_CONTAINER", - "environment-variables": [] - }, - "timeout-in-minutes": 60, - "build-complete": true, - "initiator": "MyCodeBuildDemoUser", - "build-start-time": "Sep 1, 2017 4:12:29 PM", - "source": { - "location": "codebuild-123456789012-input-bucket/my-input-artifact.zip", - "type": "S3" - }, - "logs": { - "group-name": "/aws/codebuild/my-sample-project", - "stream-name": "8745a7a9-c340-456a-9166-edf953571bEX", - "deep-link": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-sample-project;stream=8745a7a9-c340-456a-9166-edf953571bEX" - }, - "phases": [ - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:12:29 PM", - "end-time": "Sep 1, 2017 4:12:29 PM", - "duration-in-seconds": 0, - "phase-type": "SUBMITTED", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:12:29 PM", - "end-time": "Sep 1, 2017 4:13:05 PM", - "duration-in-seconds": 36, - "phase-type": "PROVISIONING", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:05 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 4, - "phase-type": "DOWNLOAD_SOURCE", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 0, - "phase-type": "INSTALL", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:13:10 PM", - "duration-in-seconds": 0, - "phase-type": "PRE_BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:13:10 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 70, - "phase-type": "BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 0, - "phase-type": "POST_BUILD", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:21 PM", - "duration-in-seconds": 0, - "phase-type": "UPLOAD_ARTIFACTS", - "phase-status": "SUCCEEDED" - }, - { - "phase-context": [], - "start-time": "Sep 1, 2017 4:14:21 PM", - "end-time": "Sep 1, 2017 4:14:26 PM", - "duration-in-seconds": 4, - "phase-type": "FINALIZING", - "phase-status": "SUCCEEDED" - }, - { - "start-time": "Sep 1, 2017 4:14:26 PM", - "phase-type": "COMPLETED" - } - ] - }, - "completed-phase-status": "SUCCEEDED", - "completed-phase-duration-seconds": 4, - "version": "1", - "completed-phase-start": "Sep 1, 2017 4:14:21 PM", - "completed-phase-end": "Sep 1, 2017 4:14:26 PM" - } -} -``` \ No newline at end of file diff --git a/doc_source/sample-buildspec-artifact-naming.md b/doc_source/sample-buildspec-artifact-naming.md deleted file mode 100644 index b1f037b..0000000 --- a/doc_source/sample-buildspec-artifact-naming.md +++ /dev/null @@ -1,82 +0,0 @@ -# Using Semantic Versioning to Name Build Artifacts Sample - - This sample contains example buildspec files that demonstrate how to specify an artifact name that is created at build time\. A name specified in a buildspec file can incorporate Shell commands and environment variables to make it unique\. A name you specify in a buildspec file overrides a name you enter in the console when you create your project\. - - If you build mulitple times, using an artifact name specified in the buildspec file can ensure your output artifact file names are unique\. For example, you can use a date and time stamp that is inserted into an artifact name at build time\. - -If you want to override the artifact name you entered in the console with a name in the buildspec file, do the following: - -1. Set your build project to override the artifact name with a name in the buildspec file\. - + If you use the console to create your build project, select **Use the name specified in the buildspec file**\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. - + If you use the AWS CLI, set the `overrideArtifactName` to true in the JSON\-formatted file passed to `create-project`\. For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - + If you use the AWS CodeBuild API, set the `overrideArtifactName` flag on the `ProjectArtifacts` object when a project is created or updated or a build is started\. - -1. Specify a name in the buildspec file\. Use the following sample buildspec files as a guide\. - - This Linux example shows you how to specify an artifact name that includes the date the build is created: - -``` -version: 0.2 -phases: - build: - commands: - - rspec HelloWorld_spec.rb -artifacts: - files: - - '**/*' - name: myname-$(date +%Y-%m-%d) -``` - - This Linux example shows you how to specify an artifact name that uses a CodeBuild environment variable\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - -``` -version: 0.2 -phases: - build: - commands: - - rspec HelloWorld_spec.rb -artifacts: - files: - - '**/*' - name: myname-$AWS_REGION -``` - - This Windows example shows you how to specify an artifact name that includes the date and time the build is created: - -``` -version: 0.2 -env: - variables: - TEST_ENV_VARIABLE: myArtifactName -phases: - build: - commands: - - cd samples/helloworld - - dotnet restore - - dotnet run -artifacts: - files: - - '**/*' - name: $Env:TEST_ENV_VARIABLE-$(Get-Date -UFormat "%Y%m%d-%H%M%S") -``` - - This Windows example shows you how to specify an artifact name that uses a variable declared in the buildspec file and a CodeBuild environment variable\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - -``` -version: 0.2 -env: - variables: - TEST_ENV_VARIABLE: myArtifactName -phases: - build: - commands: - - cd samples/helloworld - - dotnet restore - - dotnet run -artifacts: - files: - - '**/*' - name: $Env:TEST_ENV_VARIABLE-$Env:AWS_REGION -``` - - For more information, see [Build Specification Reference for CodeBuild](build-spec-ref.md)\. \ No newline at end of file diff --git a/doc_source/sample-codedeploy.md b/doc_source/sample-codedeploy.md deleted file mode 100644 index 9e47a4a..0000000 --- a/doc_source/sample-codedeploy.md +++ /dev/null @@ -1,172 +0,0 @@ -# CodeDeploy Sample for CodeBuild - -This sample instructs AWS CodeBuild to use Maven to produce as build output a single JAR file named `my-app-1.0-SNAPSHOT.jar`\. This sample then uses CodeDeploy to deploy the JAR file to an Amazon Linux instance\. \(Alternatively, you can use AWS CodePipeline to automate the use of CodeDeploy to deploy the JAR file to an Amazon Linux instance\.\) This sample is based on the [Maven in 5 Minutes](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html) topic on the Apache Maven website\. - -**Important** -Running this sample may result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, CloudWatch Logs, and Amazon EC2\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing), and [Amazon EC2 Pricing](http://aws.amazon.com/ec2/pricing)\. - -## Running the Sample - -To run this sample: - -1. Download and install Maven\. For more information, see [Downloading Apache Maven](https://maven.apache.org/download.cgi) and [Installing Apache Maven](https://maven.apache.org/install.html) on the Apache Maven website\. - -1. Switch to an empty directory on your local computer or instance, and then run this Maven command\. - - ``` - mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false - ``` - - If successful, this directory structure and files will be created\. - - ``` - (root directory name) - `-- my-app - |-- pom.xml - `-- src - |-- main - | `-- java - | `-- com - | `-- mycompany - | `-- app - | `-- App.java - `-- test - `-- java - `-- com - `-- mycompany - `-- app - `-- AppTest.java - ``` - -1. Create a file with this content\. Name the file `buildspec.yml`, and then add it to the `(root directory name)/my-app` directory\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - java: openjdk8 - build: - commands: - - echo Build started on `date` - - mvn test - post_build: - commands: - - echo Build completed on `date` - - mvn package - artifacts: - files: - - target/my-app-1.0-SNAPSHOT.jar - - appspec.yml - discard-paths: yes - ``` - -1. Create a file with this content\. Name the file `appspec.yml`, and then add it to the `(root directory name)/my-app` directory\. - - ``` - version: 0.0 - os: linux - files: - - source: ./my-app-1.0-SNAPSHOT.jar - destination: /tmp - ``` - - When finished, your directory structure and file should look like this\. - - ``` - (root directory name) - `-- my-app - |-- buildspec.yml - |-- appspec.yml - |-- pom.xml - `-- src - |-- main - | `-- java - | `-- com - | `-- mycompany - | `-- app - | `-- App.java - `-- test - `-- java - `-- com - `-- mycompany - `-- app - ` -- AppTest.java - ``` - -1. Create a ZIP file that contains the directory structure and files inside of `(root directory name)/my-app`, and then upload the ZIP file to a source code repository type supported by AWS CodeBuild and CodeDeploy, such as an Amazon S3 input bucket or a GitHub or Bitbucket repository\. -**Important** -If you want to use CodePipeline to deploy the resulting build output artifact, you cannot upload the source code to a Bitbucket repository\. -Do not add `(root directory name)` or `(root directory name)/my-app` to the ZIP file, just the directories and files inside of `(root directory name)/my-app`\. The ZIP file should contain these directories and files: - - ``` - CodeDeploySample.zip - |--buildspec.yml - |-- appspec.yml - |-- pom.xml - `-- src - |-- main - | `-- java - | `-- com - | `-- mycompany - | `-- app - | `-- App.java - `-- test - `-- java - `-- com - `-- mycompany - `-- app - ` -- AppTest.java - ``` - -1. Create a build project by following the steps in [Create a Build Project](create-project.md)\. - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the `create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "sample-codedeploy-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/CodeDeploySample.zip" - }, - "artifacts": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket", - "packaging": "ZIP", - "name": "CodeDeployOutputArtifact.zip" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL" - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - -1. If you plan to deploy the build output artifact with CodeDeploy, then follow the steps in [Run a Build](run-build.md)\. Otherwise, skip this step\. \(This is because if you plan to deploy the build output artifact with CodePipeline, then CodePipeline will use CodeBuild to run the build automatically\.\) - -1. Complete the setup steps for using CodeDeploy, including: - + Grant the IAM user access to CodeDeploy and the AWS services and actions CodeDeploy depends on\. For more information, see [Provision an IAM User](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-setup.html#getting-started-user) in the *CodeDeploy User Guide*\. - + Create or identify a service role to enable CodeDeploy to identify the instances where it will deploy the build output artifact\. For more information, see [Creating a Service Role for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-create-service-role.html) in the *CodeDeploy User Guide*\. - + Create or identify an IAM instance profile to enable your instances to access the Amazon S3 input bucket or GitHub repository that contains the build output artifact\. For more information, see [Creating an IAM Instance Profile for Your Amazon EC2 Instances](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-create-iam-instance-profile.html) in the *CodeDeploy User Guide*\. - -1. Create or identify an Amazon Linux instance compatible with CodeDeploy where the build output artifact will be deployed\. For more information, see [Working with Instances for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-prepare-instances.html) in the *CodeDeploy User Guide*\. - -1. Create or identify a CodeDeploy application and deployment group\. For more information, see [Creating an Application with CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-create-application.html) in the *CodeDeploy User Guide*\. - -1. Deploy the build output artifact to the instance\. - - To deploy with CodeDeploy, see [Deploying a Revision with CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-deploy-revision.html) in the *CodeDeploy User Guide*\. - - To deploy with CodePipeline, see [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. - -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 -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-disable-artifact-encryption.md b/doc_source/sample-disable-artifact-encryption.md deleted file mode 100644 index 360429f..0000000 --- a/doc_source/sample-disable-artifact-encryption.md +++ /dev/null @@ -1,49 +0,0 @@ -# Create a Static Website with Build Output Hosted in an Amazon S3 Bucket - - You can disable the encryption of artifacts in a build\. You might want to do this so that you can publish artifacts to a location that is configured to host a website\. \(You cannot publish encrypted artifacts\.\) This sample shows how you can use webhooks to trigger a build and publish its artifacts to an Amazon S3 bucket that is configured to be a website\. - -1. Follow the instructions in [Setting Up a Static Website](https://docs.aws.amazon.com/AmazonS3/latest/dev//HostingWebsiteOnS3Setup.html) to configure an Amazon S3 bucket to function like a website\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - -1. In **Source**, for **Source provider**, choose **GitHub**\. Follow the instructions to connect \(or reconnect\) with GitHub, and then choose **Authorize**\. - - For **Webhook**, select **Rebuild every time a code change is pushed to this repository**\. You can select this check box only if you chose **Use a repository in my account**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/webhook.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. In **Environment**: - - For **Environment image**, do one of the following: - + To use a Docker image managed by AWS CodeBuild, choose **Managed image**, and then make selections from **Operating system**, **Runtime**, and **Runtime version**\. - + To use another Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Amazon ECR** or **Other location**\. If you choose **Other location**, enter the name and tag of the Docker image in Docker Hub, using the format `docker repository/docker image name`\. If you choose **Amazon ECR**, then use **Amazon ECR repository** and **Amazon ECR image** to choose the Docker image in your AWS account\. - + To use private Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Other location**, and then enter the Amazon Resource Name \(ARN\) of the credentials for your private Docker image\. The credentials must be created by AWS Secrets Manager\. For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. For **Buildspec**, do one of the following: - + Choose **Use a buildspec file** to use the buildspec\.yml file in the source code root directory\. - + Choose **Insert build commands** to use the console to insert build commands\. - - For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. In **Artifacts**, for ** Type**, choose **Amazon S3** to store the build output in an Amazon S3 bucket\. - -1. Select **Disable artifacts encryption**\. - -1. For **Bucket name**, choose the name of the Amazon S3 bucket you configured to function as a website in step 1\. - -1. If you chose **Insert build commands** in **Environment**, then for **Output files**, enter the locations of the files from the build that you want to put into the output bucket\. If you have more than one location, use a comma to separate each location \(for example, "appspec\.yml, target/my\-app\.jar"\)\. - -1. Expand **Additional configuration** and set options as appropriate\. - -1. Choose **Create build project**\. On the build project page, in **Build history**, choose **Start build** to run the build\. - -1. \(Optional\) Follow the instructions in [Example: Speed Up Your Website with Amazon CloudFront](https://docs.aws.amazon.com/AmazonS3/latest/dev//website-hosting-cloudfront-walkthrough.html)\. \ No newline at end of file diff --git a/doc_source/sample-docker-custom-image.md b/doc_source/sample-docker-custom-image.md deleted file mode 100644 index bbd111f..0000000 --- a/doc_source/sample-docker-custom-image.md +++ /dev/null @@ -1,103 +0,0 @@ -# Docker in Custom Image Sample for CodeBuild - -This sample builds and runs a Docker image by using AWS CodeBuild and a custom Docker build image \(`docker:dind` in Docker Hub\)\. - -To learn how to build a Docker image by using a build image provided by CodeBuild with Docker support instead, see our [Docker Sample](sample-docker.md)\. - -**Important** -Running this sample may result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, and CloudWatch Logs\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), and [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing)\. - -**Topics** -+ [Running the Sample](#sample-docker-custom-image-running) -+ [Directory Structure](#sample-docker-custom-image-dir) -+ [Files](#sample-docker-custom-image-files) -+ [Related Resources](#w11aac11c41c32c17) - -## Running the Sample - -To run this sample: - -1. Create the files as described in the Directory Structure and Files sections of this topic, and then upload them to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)`, just the files inside of `(root directory name)`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket\. Do not add `(root directory name)` to the ZIP file, just the files inside of `(root directory name)`\. - -1. Create a build project, run the build, and view related build information by following the steps in [Run AWS CodeBuild Directly](how-to-run.md)\. - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the`create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "sample-docker-custom-image-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/DockerCustomImageSample.zip" - }, - "artifacts": { - "type": "NO_ARTIFACTS" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "docker:dind", - "computeType": "BUILD_GENERAL1_SMALL", - "privilegedMode": true - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - -1. To see the build results, look in the build's log for the string `Hello, World!`\. For more information, see [View Build Details](view-build-details.md)\. - -## Directory Structure - -This sample assumes this directory structure\. - -``` -(root directory name) - |-- buildspec.yml - `-- Dockerfile -``` - -## Files - -The base image of the operating system used in this sample is Ubuntu\. The sample uses these files\. For more information about the OverlayFS storage driver referenced in the buildspec file, see [Use the OverlayFS storage driver](https://docs.docker.com/storage/storagedriver/overlayfs-driver/)\. - -`buildspec.yml` \(in `(root directory name)`\) - -``` -version: 0.2 - -phases: - install: - commands: - - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay2& - - timeout 15 sh -c "until docker info; do echo .; sleep 1; done" - pre_build: - commands: - - docker build -t helloworld . - build: - commands: - - docker images - - docker run helloworld echo "Hello, World!" -``` - -**Note** - If the base operating system is Alpine Linux, in the `buildspec.yml` add the `-t` argument to `timeout`: - -``` -- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" -``` - -`Dockerfile` \(in `(root directory name)`\) - -``` -FROM maven:3.3.9-jdk-8 - -RUN echo "Hello World" -``` - -## Related Resources -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-docker.md b/doc_source/sample-docker.md deleted file mode 100644 index 7e4b1fc..0000000 --- a/doc_source/sample-docker.md +++ /dev/null @@ -1,311 +0,0 @@ -# Docker Sample for CodeBuild - -This sample produces as build output a Docker image and then pushes the Docker image to an Amazon Elastic Container Registry \(Amazon ECR\) image repository\. You can adapt this sample to push the Docker image to Docker Hub\. For more information, see [Adapting the Sample to Push the Image to Docker Hub](#sample-docker-docker-hub)\. - -To learn how to build a Docker image by using a custom Docker build image instead \(`docker:dind` in Docker Hub\), see our [Docker in Custom Image Sample](sample-docker-custom-image.md)\. - -This sample was tested referencing `golang:1.12` - -This sample uses the new multi\-stage Docker builds feature, which produces a Docker image as build output\. It then pushes the Docker image to an Amazon ECR image repository\. Multi\-stage Docker image builds help to reduce the size of the final Docker image\. For more information, see [Use multi\-stage builds with Docker](https://docs.docker.com/engine/userguide/eng-image/multistage-build/)\. - -**Important** -Running this sample may result in charges to your AWS account\. These include possible charges for AWS CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, CloudWatch Logs, and Amazon ECR\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing), and [Amazon Elastic Container Registry Pricing](http://aws.amazon.com/ecr/pricing)\. - -**Topics** -+ [Running the Sample](#sample-docker-running) -+ [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](#w11aac11c41c17c23) - -## Running the Sample - -To run this sample: - -1. If you already have an image repository in Amazon ECR you want to use, skip to step 3\. Otherwise, if you are using an IAM user instead of an AWS root account or an administrator IAM user to work with Amazon ECR, add this statement \(between *\#\#\# BEGIN ADDING STATEMENT HERE \#\#\#* and *\#\#\# END ADDING STATEMENT HERE \#\#\#*\) to the user \(or IAM group the user is associated with\)\. \(Using an AWS root account is not recommended\.\) This statement enables creating Amazon ECR repositories for storing Docker images\. Ellipses \(`...`\) are used for brevity and to help you locate where to add the statement\. Do not remove any statements, and do not type these ellipses into the policy\. For more information, see [Working with Inline Policies Using the AWS Management Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_inline-using.html#AddingPermissions_Console) in the *IAM User Guide*\. - - ``` - { - "Statement": [ - ### BEGIN ADDING STATEMENT HERE ### - { - "Action": [ - "ecr:CreateRepository" - ], - "Resource": "*", - "Effect": "Allow" - }, - ### END ADDING STATEMENT HERE ### - ... - ], - "Version": "2012-10-17" - } - ``` -**Note** -The IAM entity that modifies this policy must have permission in IAM to modify policies\. - -1. Create an image repository in Amazon ECR\. Be sure to create the repository in the same AWS region where you will be creating your build environment and running your build\. For more information, see [Creating a Repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) in the *Amazon ECR User Guide*\. This repository's name must match the repository name you will specify later in this procedure, represented by the `IMAGE_REPO_NAME` environment variable\. - -1. Add this statement \(between *\#\#\# BEGIN ADDING STATEMENT HERE \#\#\#* and *\#\#\# END ADDING STATEMENT HERE \#\#\#*\) to the policy you attached to your AWS CodeBuild service role\. This statement enables CodeBuild to upload Docker images to Amazon ECR repositories\. Ellipses \(`...`\) are used for brevity and to help you locate where to add the statement\. Do not remove any statements, and do not type these ellipses into the policy\. - - ``` - { - "Statement": [ - ### BEGIN ADDING STATEMENT HERE ### - { - "Action": [ - "ecr:BatchCheckLayerAvailability", - "ecr:CompleteLayerUpload", - "ecr:GetAuthorizationToken", - "ecr:InitiateLayerUpload", - "ecr:PutImage", - "ecr:UploadLayerPart" - ], - "Resource": "*", - "Effect": "Allow" - }, - ### END ADDING STATEMENT HERE ### - ... - ], - "Version": "2012-10-17" - } - ``` -**Note** -The IAM entity that modifies this policy must have permission in IAM to modify policies\. - -1. Create the files as described in the Directory Structure and Files sections of this topic, and then upload them to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)`, just the files inside of `(root directory name)`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket\. Do not add `(root directory name)` to the ZIP file, just the files inside of `(root directory name)`\. - -1. Follow the steps in [Run AWS CodeBuild Directly](how-to-run.md) to create a build project, run the build, and view build informatoin\. - - If you use the console to create your project: - - 1. For **Operating system**, choose **Ubuntu**\. - - 1. For **Runtime**, choose **Standard**\. - - 1. For **Image**, choose **aws/codebuild/standard:2\.0**\. - - 1. Because you use this build project to build a Docker image, select **Privileged**\. - - 1. Add the following environment variables: - + AWS\_DEFAULT\_REGION with a value of *region\-ID* - + AWS\_ACCOUNT\_ID with a value of *account\-ID* - + IMAGE\_TAG with a value of Latest - + IMAGE\_REPO\_NAME with a value of *Amazon\-ECR\-repo\-name* - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the `create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "sample-docker-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/DockerSample.zip" - }, - "artifacts": { - "type": "NO_ARTIFACTS" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL", - "environmentVariables": [ - { - "name": "AWS_DEFAULT_REGION", - "value": "region-ID" - }, - { - "name": "AWS_ACCOUNT_ID", - "value": "account-ID" - }, - { - "name": "IMAGE_REPO_NAME", - "value": "Amazon-ECR-repo-name" - }, - { - "name": "IMAGE_TAG", - "value": "latest" - } - ], - "privilegedMode": true - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - -1. Confirm that CodeBuild successfully pushed the Docker image to the repository: - - 1. Open the Amazon ECR console at [https://console\.aws\.amazon\.com/ecr/](https://console.aws.amazon.com/ecr/)\. - - 1. Choose the repository name\. The image should be listed in the **Image tag** column\. - -## Directory Structure - -This sample assumes this directory structure\. - -``` -(root directory name) - |-- buildspec.yml - `-- Dockerfile -``` - -## Files - -This sample uses these files\. - -`buildspec.yml` \(in `(root directory name)`\) - -**Note** -If you are using Docker prior to version 17\.06, remove the `--no-include-email` option\. - -``` -version: 0.2 - -phases: - install: - runtime-versions: - docker: 18 - pre_build: - commands: - - echo Logging in to Amazon ECR... - - $(aws ecr get-login --no-include-email --region $AWS_DEFAULT_REGION) - build: - commands: - - echo Build started on `date` - - echo Building the Docker image... - - docker build -t $IMAGE_REPO_NAME:$IMAGE_TAG . - - docker tag $IMAGE_REPO_NAME:$IMAGE_TAG $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG - post_build: - commands: - - echo Build completed on `date` - - echo Pushing the Docker image... - - docker push $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG -``` - -`Dockerfile` \(in `(root directory name)`\) - -``` -FROM golang:1.12-alpine AS build -#Install git -RUN apk add --no-cache git -#Get the hello world package from a GitHub repository -RUN go get github.com/golang/example/hello -WORKDIR /go/src/github.com/golang/example/hello -# Build the project and send the output to /bin/HelloWorld -RUN go build -o /bin/HelloWorld - -FROM golang:1.12-alpine -#Copy the build's output binary from the previous build container -COPY --from=build /bin/HelloWorld /bin/HelloWorld -ENTRYPOINT ["/bin/HelloWorld"] -``` - -## Adapting the Sample to Push the Image to Docker Hub - -To push the Docker image to Docker Hub instead of Amazon ECR, modify this sample's code\. - -1. Replace these Amazon ECR\-specific lines of code in the `buildspec.yml` file: -**Note** -If you are using Docker prior to version 17\.06, remove the `--no-include-email` option\. - - ``` - ... - pre_build: - commands: - - echo Logging in to Amazon ECR... - - $(aws ecr get-login --no-include-email --region $AWS_DEFAULT_REGION) - build: - commands: - - echo Build started on `date` - - echo Building the Docker image... - - docker build -t $IMAGE_REPO_NAME:$IMAGE_TAG . - - docker tag $IMAGE_REPO_NAME:$IMAGE_TAG $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG - post_build: - commands: - - echo Build completed on `date` - - echo Pushing the Docker image... - - docker push $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG - ... - ``` - - With these Docker Hub\-specific lines of code\. - - ``` - ... - pre_build: - commands: - - echo Logging in to Docker Hub... - # Type the command to log in to your Docker Hub account here. - build: - commands: - - echo Build started on `date` - - echo Building the Docker image... - - docker build -t $IMAGE_REPO_NAME:$IMAGE_TAG . - - docker tag $IMAGE_REPO_NAME:$IMAGE_TAG $IMAGE_REPO_NAME:$IMAGE_TAG - post_build: - commands: - - echo Build completed on `date` - - echo Pushing the Docker image... - - docker push $IMAGE_REPO_NAME:$IMAGE_TAG - ... - ``` - -1. Upload the modified code to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)`, just the files inside of `(root directory name)`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket\. Do not add `(root directory name)` to the ZIP file, just the files inside of `(root directory name)`\. - -1. Replace these lines of code from the JSON\-formatted input to the `create-project` command: - - ``` - ... - "environmentVariables": [ - { - "name": "AWS_DEFAULT_REGION", - "value": "region-ID" - }, - { - "name": "AWS_ACCOUNT_ID", - "value": "account-ID" - }, - { - "name": "IMAGE_REPO_NAME", - "value": "Amazon-ECR-repo-name" - }, - { - "name": "IMAGE_TAG", - "value": "latest" - } - ] - ... - ``` - - With these lines of code\. - - ``` - ... - "environmentVariables": [ - { - "name": "IMAGE_REPO_NAME", - "value": "your-Docker-Hub-repo-name" - }, - { - "name": "IMAGE_TAG", - "value": "latest" - } - ] - ... - ``` - -1. Follow the steps in [Run AWS CodeBuild Directly](how-to-run.md) to create a build environment, run the build, and view related build information\. - -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 -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-ecr.md b/doc_source/sample-ecr.md deleted file mode 100644 index b06c4d1..0000000 --- a/doc_source/sample-ecr.md +++ /dev/null @@ -1,188 +0,0 @@ -# Amazon ECR Sample for CodeBuild - -This sample uses a Docker image in an Amazon Elastic Container Registry \(Amazon ECR\) image repository to build a sample Go project\. - -**Important** -Running this sample may result in charges to your AWS account\. These include possible charges for AWS CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, CloudWatch Logs, and Amazon ECR\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing), and [Amazon Elastic Container Registry Pricing](http://aws.amazon.com/ecr/pricing)\. - -## Running the Sample - -To run this sample: - -1. To create and push the Docker image to your image repository in Amazon ECR, complete the steps in the Running the Sample section of the [Docker Sample](sample-docker.md)\. - -1. Create a Go project: - - 1. Create the files as described in the [Go Project Structure](#ecr-sample-go-project-file-structure) and [Go Project Files](#sample-ecr-go-project-files) sections of this topic, and then upload them to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)`, just the files inside of `(root directory name)`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket\. Do not add `(root directory name)` to the ZIP file, just the files inside of `(root directory name)`\. - - 1. Create a build project, run the build, and view related build information by following the steps in [Run AWS CodeBuild Directly](how-to-run.md)\. - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the`create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "sample-go-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/GoSample.zip" - }, - "artifacts": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket", - "packaging": "ZIP", - "name": "GoOutputArtifact.zip" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL" - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - - 1. To get the build output artifact, open your Amazon S3 output bucket\. - - 1. Download the `GoOutputArtifact.zip` file to your local computer or instance, and then extract the contents of the file\. In the extracted contents, get the `hello` file\. - -1. If one of the following is true, you must add permissions to your image repository in Amazon ECR so that AWS CodeBuild can pull its Docker image into the build environment\. - + Your project uses CodeBuild credentials to pull Amazon ECR images\. This is denoted by a value of `CODEBUILD` in the `imagePullCredentialsType` attribute of your ProjectEnvironment\. - + Your project uses a cross\-account Amazon ECR image\. In this case, your project must use its service role to pull Amazon ECR images\. To enable this behavior, set the `imagePullCredentialsType` attribute of your ProjectEnvironment to `SERVICE_ROLE`\. - - 1. Open the Amazon ECR console at [https://console\.aws\.amazon\.com/ecr/](https://console.aws.amazon.com/ecr/)\. - - 1. In the list of repository names, choose the name of the repository you created or selected\. - - 1. From the navigation pane choose **Permissions**, choose **Edit**, and then choose **Add statement**\. - - 1. For **Statement name**, enter an identifier \(for example, **CodeBuildAccess**\)\. - - 1. For **Effect**, leave **Allow** selected\. This indicates that you want to allow access to another AWS account\. - - 1. For **Principal**, do one of the following: - + If your project uses CodeBuild credentials to pull an Amazon ECR image, in **Service principal** enter `codebuild.amazonaws.com`\. - + If your project uses a cross\-account Amazon ECR image, for **AWS account IDs** enter IDs of the AWS accounts that you want to give access\. - - 1. Skip the **All IAM entities** list\. - - 1. For **Action**, select the pull\-only actions **ecr:GetDownloadUrlForLayer**, **ecr:BatchGetImage**, and **ecr:BatchCheckLayerAvailability**\. - - 1. Choose **Save**\. - - This policy is displayed in **Permissions**\. The principal is what you entered for **Principal** in step 3f of this procedure: - + If your project uses CodeBuild credentials to pull an Amazon ECR image, under **Service principals** is `"codebuild.amazonaws.com"`\. - + If your project uses a cross\-account Amazon ECR image, under **AWS Account IDs** is the ID of the AWS account that you want to give access\. - - The following sample policy uses a cross\-account Amazon ECR image\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CodeBuildAccess", - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::AWS-account-ID:root" - }, - "Action": [ - "ecr:GetDownloadUrlForLayer", - "ecr:BatchGetImage", - "ecr:BatchCheckLayerAvailability" - ] - } - ] - } - ``` - -1. Create a build project, run the build, and view build information by following the steps in [Run AWS CodeBuild Directly](how-to-run.md)\. - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the `create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "amazon-ecr-sample-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/GoSample.zip" - }, - "artifacts": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket", - "packaging": "ZIP", - "name": "GoOutputArtifact.zip" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "account-ID.dkr.ecr.region-ID.amazonaws.com/your-Amazon-ECR-repo-name:latest", - "computeType": "BUILD_GENERAL1_SMALL" - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - -1. To get the build output artifact, open your Amazon S3 output bucket\. - -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\. - -## Go Project Structure - -This sample assumes this directory structure\. - -``` -(root directory name) - |-- buildspec.yml - `-- hello.go -``` - -## Go Project Files - -This sample uses these files\. - -`buildspec.yml` \(in `(root directory name)`\) - -``` -version: 0.2 - -phases: - install: - runtime-versions: - golang: 1.12 - build: - commands: - - echo Build started on `date` - - echo Compiling the Go code... - - go build hello.go - post_build: - commands: - - echo Build completed on `date` -artifacts: - files: - - hello -``` - -`hello.go` \(in `(root directory name)`\) - -``` -package main -import "fmt" - -func main() { - fmt.Println("hello world") - fmt.Println("1+1 =", 1+1) - fmt.Println("7.0/3.0 =", 7.0/3.0) - fmt.Println(true && false) - fmt.Println(true || false) - fmt.Println(!true) -} -``` - -## Related Resources -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-efs.md b/doc_source/sample-efs.md deleted file mode 100644 index 1a46cd4..0000000 --- a/doc_source/sample-efs.md +++ /dev/null @@ -1,122 +0,0 @@ -# Amazon Elastic File System Sample for CodeBuild - - You might want to create your AWS CodeBuild builds on Amazon EFS\. Amazon EFS is a scalable, shared file service for Amazon EC2 instances\. The storage capacity with Amazon EFS is elastic, so it grows or shrinks as files are added and removed\. It has a simple web services interface that you can use to create and configure file systems\. It also manages all of the file storage infrastructure for you, so you do not need to worry about deploying, patching, or maintaining file system configurations\. For more information, see [What Is Amazon Elastic File System](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html)\. - - This sample shows you how to configure a CodeBuild project so that it mounts and then builds a Java application to an Amazon EFS file system\. Before you begin, you must have a Java application ready to build that is uploaded to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, GitHub Enterprise, or Bitbucket repository\. - -## Amazon Elastic File System and AWS CodeBuild Sample High\-Level Steps - - This sample covers the three high\-level steps required to use Amazon EFS with AWS CodeBuild: - -1. Create an Amazon VPC\. - -1. Create an Amazon EFS that uses this Amazon VPC\. - -1. Create and build a CodeBuild project that uses the Amazon VPC\. Instructions that include how to mount an Amazon Elastic File System file system are entered into the buildspec editor when you build the project\. - -## Create an Amazon VPC Using AWS CloudFormation - - Create your Amazon VPC with an AWS CloudFormation template\. - -1. Follow the instructions here, [AWS CloudFormation VPC Template](cloudformation-vpc-template.md), to use AWS CloudFormation to create an Amazon VPC\. If you are already familiar with AWS CloudFormation, you can go directly to the AWS CloudFormation console to create a stack using the template available for download from [https://s3.amazonaws.com/codebuild-cloudformation-templates-public/vpc_cloudformation_template.yml](https://s3.amazonaws.com/codebuild-cloudformation-templates-public/vpc_cloudformation_template.yml)\. For more information, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide//Welcome.html)\. -**Note** - The Amazon VPC created by this AWS CloudFormation template has two private subnets and two public subnets\. You must only use private subnets when you use AWS CodeBuild to mount Amazon EFS\. If you use one of the public subnets, the build fails\. - -1. Sign in to the AWS Management Console and open the Amazon VPC console at [https://console\.aws\.amazon\.com/vpc/](https://console.aws.amazon.com/vpc/)\. - -1. Choose the Amazon VPC you created with AWS CloudFormation\. - -1. Make a note of the VPC ID displayed on the **Summary** tab\. This ID is required when you create your AWS CodeBuild project later in this sample\. - -## Create an Amazon Elastic File System File System with Your Amazon VPC - - Create a simple Amazon EFS file system for this sample using the Amazon VPC you created earlier\. - -1. Sign in to the AWS Management Console and open the Amazon EFS console at [ https://console\.aws\.amazon\.com/efs/](https://console.aws.amazon.com/efs/)\. - -1. Choose **Create file system**\. - -1. From **VPC**, choose the VPC ID you noted earlier in this sample\. - -1. Leave the Availability Zones associated with your subnets selected\. - -1. Choose **Next Step**\. - -1. In **Add tags**, for the default **Name** key, in **Value**, enter the name of your Amazon EFS file system\. - -1. Keep **General Purpose** and **Bursting** selected as your default performance and throughput modes, and then choose **Next Step**\. - -1. Choose **Create File System**\. - -1. Choose the name of the file system you created from the list\. Make a note of the DNS name\. You enter this in the buildspec file that is used to build your AWS CodeBuild project\. - -## Create a CodeBuild Project to Use with Amazon EFS - - Create a AWS CodeBuild project that uses the Amazon VPC you created earlier in this sample\. This CodeBuild project does not use a source and does not create an artifact\. When the build is run, it mounts the Amazon EFS file system created earlier in this sample and caches the Maven dependency to it\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. From the navigation pane, choose **Build projects**, and then choose **Create build project**\. - -1. In **Project name**, enter a name for your project\. - -1. From **Source provider**, choose the repository that contains the Java application you want to build\. - -1. Enter information, such as a repository URL, that CodeBuild uses to locate your application\. The options are different for each source provider\. For more information, see [Choose source provider](create-project.md#create-project-source-provider)\. - -1. From **Environment image**, choose **Managed image**\. - -1. From **Operating system**, choose **Ubuntu**\. - -1. From **Runtime**, choose **Standard**\. - -1. From **Runtime version** choose **aws/codebuild/standard:2\.0** \. - -1. Select **Privileged**\. - -1. Under **Service role**, choose **New service role**\. In **Role name**, enter a name for the role CodeBuild creates for you\. - -1. For **Build specification**, choose **Insert build commands** and then choose **Switch to editor**\. - -1. Enter the following buildspec commands into the editor\. For the `EFS_DNS`, enter the DNS name of your file system\. - - ``` - version: 0.2 - - env: - variables: - EFS_DIR: "/efs" - M3_HOME: ".m2" - EFS_DNS: "fs-11223344.efs.us-east-1.amazonaws.com" - phases: - install: - runtime-versions: - java: openjdk11 - commands: - - mkdir -p $EFS_DIR - - apt-get update && apt-get install -y nfs-common - pre_build: - commands: - - mount -t nfs4 -o nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2 $EFS_DNS:/ $EFS_DIR - - df -h - - mkdir -p $EFS_DIR/$M3_HOME/ - build: - commands: - - mvn compile -Dgpg.skip=true -Dmaven.repo.local=$EFS_DIR/$M3_HOME/ - ``` - -1. Expand **Additional configuration**\. - -1. From **VPC**, choose the VPC ID\. - -1. From **Subnets**, choose one or more of the private subnets associated with your Amazon VPC\. You must use private subnets in a build that mounts an Amazon EFS file system\. If you use a public subnet, the build fails\. - -1. From **Security Groups**, choose the security group that works with your Amazon VPC\. - -1. Use the default values for all other settings, and then choose **Create build project**\. When your build is complete, you are on the console page for your project\. - -1. Choose **Start build**\. - -## CodeBuild and Amazon EFS Sample Summary - - After your AWS CodeBuild project is built, you have a \.jar file created by your Java application\. The \.jar file is built to your Amazon EFS file system in a directory called `/efs/.m2`\. CodeBuild uses the mount command, `mount -t nfs4 -o nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2`, to mount the Amazon EFS file system\. For more information, see [Mounting File Systems](https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html)\. \ No newline at end of file diff --git a/doc_source/sample-elastic-beanstalk.md b/doc_source/sample-elastic-beanstalk.md deleted file mode 100644 index eb72b8d..0000000 --- a/doc_source/sample-elastic-beanstalk.md +++ /dev/null @@ -1,340 +0,0 @@ -# AWS Elastic Beanstalk Sample for AWS CodeBuild - -This sample instructs AWS CodeBuild to use Maven to produce as build output a single WAR file named `my-web-app.war`\. This sample then deploys the WAR file to the instances in an Elastic Beanstalk environment\. - -**Important** -Running this sample might result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, CloudWatch Logs, and Amazon EC2\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing), and [Amazon EC2 Pricing](http://aws.amazon.com/ec2/pricing)\. - -## Create the Source Code - -In this section, you use Maven to produce the source code\. Later on, you use AWS CodeBuild to build a WAR file based on this source code\. - -1. Download and install Maven\. For information, see [Downloading Apache Maven](https://maven.apache.org/download.cgi) and [Installing Apache Maven](https://maven.apache.org/install.html) on the Apache Maven website\. - -1. Switch to an empty directory on your local computer or instance, and then run this Maven command\. - - ``` - mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-web-app -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false - ``` - - If successful, this directory structure and files are created\. - - ``` - (root directory name) - `-- my-web-app - |-- pom.xml - `-- src - `-- main - |-- resources - `-- webapp - |-- WEB-INF - | `-- web.xml - `-- index.jsp - ``` - -After you run Maven, continue with one of the following scenarios: -+ [Scenario A: Run AWS CodeBuild Manually and Deploy to Elastic Beanstalk Manually](#sample-elastic-beanstalk-manual) -+ [Scenario B: Use CodePipeline to Run AWS CodeBuild and Deploy to Elastic Beanstalk](#sample-elastic-beanstalk-codepipeline) -+ [Scenario C: Use the Elastic Beanstalk CLI to Run AWS CodeBuild and Deploy to an Elastic Beanstalk Environment](#sample-elastic-beanstalk-eb-cli) - -## Scenario A: Run AWS CodeBuild Manually and Deploy to Elastic Beanstalk Manually - -In this scenario, you create and upload the source code\. You then use the AWS CodeBuild and Elastic Beanstalk consoles to build the source code, create an Elastic Beanstalk application and environment, and deploy the build output to the environment\. - -### Step A1: Add Files to the Source Code - -In this step, you add an Elastic Beanstalk configuration file and a build spec file to the code in [Create the Source Code](#sample-elastic-beanstalk-prepare-source)\. You then upload the source code to an Amazon S3 input bucket or an AWS CodeCommit or GitHub repository \. - -1. Create a subdirectory named `.ebextensions` in the `(root directory name)/my-web-app` directory\. In the `.ebextensions` subdirectory, create a file named `fix-path.config` with this content\. - - ``` - container_commands: - fix_path: - command: "unzip my-web-app.war 2>&1 > /var/log/my_last_deploy.log" - ``` - -1. Create a file named `buildspec.yml` with the following contents\. Store the file in the `(root directory name)/my-web-app` directory\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - java: openjdk11 - post_build: - commands: - - mvn package - - mv target/my-web-app.war my-web-app.war - artifacts: - files: - - my-web-app.war - - .ebextensions/**/* - ``` - -1. Your file structure should now look like this\. - - ``` - (root directory name) - `-- my-web-app - |-- .ebextensions - | `-- fix-path.config - |-- src - | `-- main - | |-- resources - | `-- webapp - | |-- WEB-INF - | | `-- web.xml - | `-- index.jsp - |-- buildpsec.yml - `-- pom.xml - ``` - -1. Upload the contents of the `my-web-app` directory to an Amazon S3 input bucket or a CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)` or `(root directory name)/my-web-app`, just the directories and files in `(root directory name)/my-web-app`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the directory structure and files, and then upload it to the input bucket\. Do not add `(root directory name)` or `(root directory name)/my-web-app` to the ZIP file, just the directories and files in `(root directory name)/my-web-app`\. - -### Step A2: Create the Build Project and Run the Build - -In this step, you use the AWS CodeBuild console to create a build project and then run a build\. - -1. Create or identify an Amazon S3 output bucket to store the build output\. If you're storing the source code in an Amazon S3 input bucket, the output bucket must be in the same AWS region as the input bucket\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - - Use the AWS region selector to choose a region that supports CodeBuild and matches the region where your Amazon S3 output bucket is stored\. - -1. Create a build project and then run a build\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings\. - + For **Environment**: - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Ubuntu**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/standard:2\.0**\. - + For **Artifacts**: - + For **Name**, enter a build output file name that's easy for you to remember\. Include the `.zip` extension\. - + For **Artifacts packaging**, choose **Zip**\. - -### Step A3: Create the Application and Environment and Deploy - -In this step, you use the Elastic Beanstalk console to create an application and environment\. As part of creating the environment, you deploy the build output from the previous step to the environment\. - -1. Open the Elastic Beanstalk console at [https://console\.aws\.amazon\.com/elasticbeanstalk](https://console.aws.amazon.com/elasticbeanstalk)\. - - Use the AWS region selector to choose the region where your Amazon S3 output bucket is stored\. - -1. Create an Elastic Beanstalk application\. For more information, see [Managing and Configuring AWS Elastic Beanstalk Applications](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications.html)\. - -1. Create an Elastic Beanstalk environment for this application\. For more information, see [The Create New Environment Wizard](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environments-create-wizard.html)\. Leave all settings at their default values, except for these settings\. - + For **Platform**, choose **Tomcat**\. - + For **Application code**, choose **Upload your code**, and then choose **Upload**\. For **Source code origin**, choose **Public S3 URL**, and then enter the full URL to the build output ZIP file in the output bucket\. Choose **Upload**\. - -1. After Elastic Beanstalk deploys the build output to the environment, you can see the results in a web browser\. Go to the environment URL for the instance \(for example, `http://my-environment-name.random-string.region-ID.elasticbeanstalk.com`\)\. The web browser should display the text `Hello World!`\. - -## Scenario B: Use CodePipeline to Run AWS CodeBuild and Deploy to Elastic Beanstalk - -In this scenario, you complete the steps to prepare and upload the source code\. You create a build project with CodeBuild and an AWS Elastic Beanstalk application and environment with the AWS Elastic Beanstalk console\. You then use the AWS CodePipeline console to create a pipeline\. After you create the pipeline, CodePipeline builds the source code and deploys the build output to the environment\. - -### Step B1: Add a Build Spec File to the Source Code - -In this step, you create and add a build spec file to the code you created in [Create the Source Code](#sample-elastic-beanstalk-prepare-source)\. You then upload the source code to an Amazon S3 input bucket or a CodeCommit or GitHub repository\. - -1. Create a file named `buildspec.yml` with the following contents\. Store the file in the `(root directory name)/my-web-app` directory\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - java: openjdk11 - post_build: - commands: - - mvn package - artifacts: - files: - - '**/*' - base-directory: 'target/my-web-app' - ``` - -1. Your file structure should now look like this\. - - ``` - (root directory name) - `-- my-web-app - |-- src - | `-- main - | |-- resources - | `-- webapp - | |-- WEB-INF - | | `-- web.xml - | `-- index.jsp - |-- buildpsec.yml - `-- pom.xml - ``` - -1. Upload this contents of the `my-web-app` directory to an Amazon S3 input bucket or a CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)` or `(root directory name)/my-web-app`, just the directories and files in `(root directory name)/my-web-app`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the directory structure and files, and then upload it to the input bucket\. Do not add `(root directory name)` or `(root directory name)/my-web-app` to the ZIP file, just the directories and files in `(root directory name)/my-web-app`\. - -### Step B2: Create a build project - -In this step, you create an AWS CodeBuild build project to use with your pipeline\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Create a build project\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings\. - + For **Environment**: - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Ubuntu**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/standard:2\.0**\. - + For **Artifacts**: - + For **Name**, enter a build output file name that's easy for you to remember\. Include the `.zip` extension\. - + For **Artifacts packaging**, choose **Zip**\. - -### Step B3: Create an AWS Elastic Beanstalk application and environment - -In this step, you create an AWS Elastic Beanstalk application and environment to use with CodePipeline\. - -1. Open the Elastic Beanstalk console at [https://console\.aws\.amazon\.com/elasticbeanstalk/](https://console.aws.amazon.com/elasticbeanstalk/)\. - -1. Use the Elastic Beanstalk console to create an application\. For more information, see [Managing and Configuring AWS Elastic Beanstalk Applications](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications.html)\. - -1. Use the Elastic Beanstalk console to create an environment\. For more information, see [The Create New Environment Wizard](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environments-create-wizard.html)\. Except for **Platform**, leave all settings at their default values\. For **Platform**, choose **Tomcat**\. - -### Step B4: Create the Pipeline and Deploy - -In this step, you use the CodePipeline console to create a pipeline\. After you create and run the pipeline, CodePipeline uses AWS CodeBuild to build the source code\. CodePipeline then uses Elastic Beanstalk to deploy the build output to the environment\. - -1. Create or identify a service role that CodePipeline, CodeBuild, and Elastic Beanstalk can use to do their work on your behalf\. For more information, see [Prerequisites](how-to-create-pipeline.md#how-to-create-pipeline-prerequisites)\. - -1. Open the CodePipeline console at [https://console\.aws\.amazon\.com/codesuite/codepipeline/home](https://console.aws.amazon.com/codesuite/codepipeline/home)\. - - Use the AWS region selector to choose a region that supports CodeBuild and, if you're storing the source code in an Amazon S3 input bucket, choose the region where your input bucket is stored\. - -1. Create a pipeline\. For information, see [Create a Pipeline That Uses CodeBuild \(CodePipeline Console\)](how-to-create-pipeline.md#how-to-create-pipeline-console)\. Leave all settings at their default values, except for these settings\. - + For **Step 3: Add build stage**, for **Build provider**, choose CodeBuild\. For **Project name**, choose the build project you just created\. - + For **Step 4: Add deploy stage**, for **Deployment provider**, choose **AWS Elastic Beanstalk**\. - + For **Application name**, choose the Elastic Beanstalk application you just created\. - + For **Environment name**, choose the environment you just created\. - -1. After the pipeline has run successfully, you can see the results in a web browser\. Go to the environment URL for the instance \(for example, `http://my-environment-name.random-string.region-ID.elasticbeanstalk.com`\)\. The web browser should display the text `Hello World!`\. - -Now, whenever you make changes to the source code and upload those changes to the original Amazon S3 input bucket or to the CodeCommit, GitHub, or Bitbucket repository, CodePipeline detects the change and runs the pipeline again\. This causes CodeBuild to rebuild the code and then causes Elastic Beanstalk to deploy the rebuilt output to the environment\. - -## Scenario C: Use the Elastic Beanstalk CLI to Run AWS CodeBuild and Deploy to an Elastic Beanstalk Environment - -In this scenario, you complete the steps to prepare and upload the source code\. You then run the Elastic Beanstalk CLI to create an Elastic Beanstalk application and environment, use CodeBuild to build the source code, and then deploy the build output to the environment\. For more information, see [Using the EB CLI with CodeBuild](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli-codebuild.html) in the *AWS Elastic Beanstalk Developer Guide*\. - -### Step C1: Add Files to the Source Code - -In this step, you add an Elastic Beanstalk configuration file and a build spec file to the code you created in [Create the Source Code](#sample-elastic-beanstalk-prepare-source)\. You also create or identify a service role for the build spec file\. - -1. Create or identify a service role that Elastic Beanstalk and the CLI can use on your behalf\. For information, see [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - -1. Create a subdirectory named `.ebextensions` in the `(root directory name)/my-web-app` directory\. In the `.ebextensions` subdirectory, create a file named `fix-path.config` with this content\. - - ``` - container_commands: - fix_path: - command: "unzip my-web-app.war 2>&1 > /var/log/my_last_deploy.log" - ``` - -1. Create a file named `buildspec.yml` with the following contents\. Store the file in the `(root directory name)/my-web-app` directory\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - java: openjdk11 - post_build: - commands: - - mvn package - - mv target/my-web-app.war my-web-app.war - artifacts: - files: - - my-web-app.war - - .ebextensions/**/* - eb_codebuild_settings: - CodeBuildServiceRole: my-service-role-name - ComputeType: BUILD_GENERAL1_SMALL - Image: aws/codebuild/standard:2.0 - Timeout: 60 - ``` - - In the preceding code, replace *my\-service\-role\-name* with the name of the service role you created or identified earlier\. - -1. Your file structure should now look like this\. - - ``` - (root directory name) - `-- my-web-app - |-- .ebextensions - | `-- fix-path.config - |-- src - | `-- main - | |-- resources - | `-- webapp - | |-- WEB-INF - | | `-- web.xml - | `-- index.jsp - |-- buildpsec.yml - `-- pom.xml - ``` - -### Step C2: Install and Run the EB CLI - -1. If you have not already done so, install and configure the EB CLI on the same computer or instance where you created the source code\. For information, see [Install the Elastic Beanstalk Command Line Interface \(EB CLI\)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html) and [Configure the EB CLI](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-configuration.html) in the *AWS Elastic Beanstalk Developer Guide*\. - -1. From your computer's or instance's command line or terminal, run the cd command or similar to switch to your `(root directory name)/my-web-app` directory\. Run the eb init command to configure the EB CLI\. - - ``` - eb init - ``` - - When prompted: - + Choose an AWS Region where AWS CodeBuild is supported and where you want to create your Elastic Beanstalk application and environment\. - + Create an Elastic Beanstalk application, and enter a name for the application\. - + Choose the `Tomcat` platform\. - + Choose the `Tomcat 8 Java 8` version\. - + Choose whether you want to use SSH to set up access to your environment's instances\. - -1. From the same directory, run the eb create command to create an Elastic Beanstalk environment\. - - ``` - eb create - ``` - - When prompted: - + Enter the name for the environment or accept the suggested name\. - + Enter the DNS CNAME prefix for the environment or accept the suggested value\. - + For this sample, accept the Classic load balancer type\. - -1. After you run the eb create command, the EB CLI does the following: - - 1. Creates a ZIP file from the source code and then uploads the ZIP file to an Amazon S3 bucket in your account\. - - 1. Creates an Elastic Beanstalk application and application version\. - - 1. Creates a AWS CodeBuild project\. - - 1. Runs a build based on the new project\. - - 1. Deletes the project after the build is complete\. - - 1. Creates an Elastic Beanstalk environment\. - - 1. Deploys the build output to the environment\. - -1. After the EB CLI deploys the build output to the environment, you can see the results in a web browser\. Go to the environment URL for the instance \(for example, `http://my-environment-name.random-string.region-ID.elasticbeanstalk.com`\)\. The web browser should display the text `Hello World!`\. - -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 -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-github-enterprise.md b/doc_source/sample-github-enterprise.md deleted file mode 100644 index 403a6a5..0000000 --- a/doc_source/sample-github-enterprise.md +++ /dev/null @@ -1,126 +0,0 @@ -# GitHub Enterprise Sample for CodeBuild - -AWS CodeBuild supports GitHub Enterprise as a source repository\. This sample shows how to set up your CodeBuild projects when your GitHub Enterprise repository has a certificate installed\. It also shows how to enable webhooks so that CodeBuild rebuilds the source code every time a code change is pushed to your GitHub Enterprise repository\. - -## Prerequisites - -1. Generate a personal access token for your CodeBuild project\. We recommend that you create a GitHub Enterprise user and generate a personal access token for this user\. Copy it to your clipboard so that it can be used when you create your CodeBuild project\. For more information, see [Creating a Personal Access Token in GitHub Enterprise](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) on the GitHub Help website\. - - When you create the personal access token, include the **repo** scope in the definition\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/scopes.png) - -1. Download your certificate from GitHub Enterprise\. CodeBuild uses the certificate to make a trusted SSL connection to the repository\. - - **Linux/macOS clients:** - - From a terminal window, run the following command: - - ``` - echo -n | openssl s_client -connect HOST:PORTNUMBER \ - | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /folder/filename.pem - ``` - - Replace the placeholders in the command with the following values: - - *HOST*\. The IP address of your GitHub Enterprise repository\. - - *PORTNUMBER*\. The port number you are using to connect \(for example, 443\)\. - - *folder*\. The folder where you downloaded your certificate\. - - *filename*\. The file name of your certificate file\. -**Important** -Save the certificate as a \.pem file\. - - **Windows clients:** - - Use your browser to download your certificate from GitHub Enterprise\. To see the site's certificate details, choose the padlock icon\. For information about how to export the certificate, see your browser documentation\. -**Important** -Save the certificate as a \.pem file\. - -1. Upload your certificate file to an Amazon S3 bucket\. For information about how to create an Amazon S3 bucket, see [How Do I Create an Amazon S3 Bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html) For information about how to upload objects to an Amazon S3 bucket, see [How Do I Upload Files and Folders to a Bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-objects.html) -**Note** -This bucket must be in the same AWS region as your builds\. For example, if you instruct CodeBuild to run a build in the US East \(Ohio\) Region, the bucket must be in the US East \(Ohio\) Region\. - -## Create a Build Project with GitHub Enterprise as the Source Repository and Enable Webhooks \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - -1. In **Source**, in **Source provider**, choose **GitHub Enterprise**\. - + For **Personal Access Token**, paste the token you copied to your clipboard and choose **Save Token**\. In **Repository URL**, enter the URL for your GitHub Enterprise repository\. -**Note** -You only need to enter and save the personal access token once\. All future AWS CodeBuild projects use this token\. - + In **Repository URL**, enter the path to your repository, including the name of the repository\. - + Expand **Additional configuration\.** - + Select **Rebuild every time a code change is pushed to this repository** to rebuild every time a code change is pushed to this repository\. - + Select **Enable insecure SSL** to ignore SSL warnings while connecting to your GitHub Enterprise project repository\. -**Note** -We recommend that you use **Enable insecure SSL** for testing only\. It should not be used in a production environment\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-enterprise.png) - -1. In **Environment**: - - For **Environment image**, do one of the following: - + To use a Docker image managed by AWS CodeBuild, choose **Managed image**, and then make selections from **Operating system**, **Runtime**, and **Runtime version**\. - + To use another Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Amazon ECR** or **Other location**\. If you choose **Other location**, enter the name and tag of the Docker image in Docker Hub, using the format `docker repository/docker image name`\. If you choose **Amazon ECR**, then use **Amazon ECR repository** and **Amazon ECR image** to choose the Docker image in your AWS account\. - + To use private Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Other location**, and then enter the Amazon Resource Name \(ARN\) of the credentials for your private Docker image\. The credentials must be created by AWS Secrets Manager\. For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. Expand **Additional configuration**\. - - In **VPC**, do one of the following: - + If you are not using a VPC for your project, choose **No VPC**\. - + If you want CodeBuild to work with your VPC: - + For **VPC**, choose the VPC ID that CodeBuild uses\. - + For **VPC Subnets**, choose the subnets that include resources that CodeBuild uses\. - + For **VPC Security groups**, choose the security groups that CodeBuild uses to allow access to resources in the VPCs\. - - For more information, see [Use CodeBuild with Amazon Virtual Private Cloud](vpc-support.md)\. - -1. For **Buildspec**, do one of the following: - + Choose **Use a buildspec file** to use the buildspec\.yml file in the source code root directory\. - + Choose **Insert build commands** to use the console to insert build commands\. - - For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. In **Artifacts**, for **Type**, do one of the following: - + If you do not want to create any build output artifacts, choose **No artifacts**\. - + To store the build output in an Amazon S3 bucket, choose **Amazon S3**, and then do the following: - + If you want to use your project name for the build output ZIP file or folder, leave **Name** blank\. Otherwise, enter the name\. By default, the artifact name is the project name\. If you want to use a different name, enter it in the artifacts name box\. If you want to output a ZIP file, include the zip extension\. - + For **Bucket name**, choose the name of the output bucket\. - + If you chose **Insert build commands** earlier in this procedure, then for **Output files**, enter the locations of the files from the build that you want to put into the build output ZIP file or folder\. For multiple locations, separate each location with a comma \(for example, `appspec.yml, target/my-app.jar`\)\. For more information, see the description of `files` in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -1. Expand **Additional configuration**\. In **Cache type**, do one of the following: - + If you do not want to use a cache, choose **No cache**\. - + To use a cache, choose **Amazon S3**, and then do the following: - + For **Cache bucket**, choose the name of the Amazon S3 bucket where the cache is stored\. - + \(Optional\) For **Cache path prefix**, enter an Amazon S3 path prefix\. The **Cache path prefix** value is similar to a directory name\. It makes it possible for you to store the cache under the same directory in a bucket\. -**Important** -Do not append a trailing slash \(/\) to the end of the path prefix\. - - Using a cache saves considerable build time because reusable pieces of the build environment are stored in the cache and used across builds\. - -1. Choose **Create build project**\. On the build project page, choose **Start build**\. - -1. If you enabled webhooks in **Source**, then a **Create webhook** dialog box is displayed with values for **Payload URL** and **Secret**\. -**Important** -The **Create webhook** dialog box appears only once\. Copy the payload URL and secret key\. You need them when you add a webhook in GitHub Enterprise\. -If you need to generate a payload URL and secret key again, you must first delete the webhook from your GitHub Enterprise repository\. In your CodeBuild project, clear the **Webhook** check box and then choose **Save**\. You can then create or update a CodeBuild project with the **Webhook** check box selected\. The **Create webhook** dialog box appears again\. - -1. In GitHub Enterprise, choose the repository where your CodeBuild project is stored\. - -1. Choose **Settings**, choose **Hooks & services**, and then choose **Add webhook**\. - -1. Enter the payload URL and secret key, accept the defaults for the other fields, and then choose **Add webhook**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/ghe-webhook.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. Return to your CodeBuild project\. Close the **Create webhook** dialog box and choose **Start build**\. \ No newline at end of file diff --git a/doc_source/sample-github-pull-request.md b/doc_source/sample-github-pull-request.md deleted file mode 100644 index 5c098cd..0000000 --- a/doc_source/sample-github-pull-request.md +++ /dev/null @@ -1,288 +0,0 @@ -# GitHub Pull Request and Webhook Filter Sample for CodeBuild - -AWS CodeBuild supports webhooks when the source repository is GitHub\. This means that for a CodeBuild build project that has its source code stored in a GitHub repository, webhooks enable CodeBuild to rebuild the source code every time a code change is pushed to the repository\. - -**Note** - We recommend that you use a filter group to specify which GitHub users can trigger a build in a public repository\. This can prevent a user from triggering an unexpected build\. For more information, see [ Filter GitHub Webhook Events](#sample-github-pull-request-filter-webhook-events)\. - -## Create a Build Project with GitHub as the Source Repository and Enable Webhooks \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. If a CodeBuild information page is displayed, choose **Create project**\. Otherwise, on the navigation pane, expand **Build**, and then choose **Build projects**\. - -1. Choose **Create build project**\. - -1. In **Project configuration**: - - On the **Create build project** page, in **Project configuration**, for **Project name**, enter a name for this build project\. Build project names must be unique across each AWS account\. You can also include an optional description of the build project to help other users understand what this project is used for\. - -1. In **Source**, for **Source provider**, choose **GitHub**\. Follow the instructions to connect \(or reconnect\) with GitHub and then choose **Authorize**\. - - Choose **Repository in my GitHub account**\. - - In **GitHub repository**, enter the URL for your GitHub repository\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-pr-sample-source.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. In **Primary source webhook events** select **Rebuild every time a code change is pushed to this repository**\. You can select this check box only if you chose **Repository in my GitHub account**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-pr-webhook.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. In **Environment**: - - For **Environment image**, do one of the following: - + To use a Docker image managed by AWS CodeBuild, choose **Managed image**, and then make selections from **Operating system**, **Runtime**, and **Runtime version**\. - + To use another Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Amazon ECR** or **Other location**\. If you choose **Other location**, enter the name and tag of the Docker image in Docker Hub, using the format `docker repository/docker image name`\. If you choose **Amazon ECR**, then use **Amazon ECR repository** and **Amazon ECR image** to choose the Docker image in your AWS account\. - + To use private Docker image, choose **Custom image**\. For **Environment type**, choose **Linux** or **Windows**\. For **Custom image type**, choose **Other location**, and then enter the Amazon Resource Name \(ARN\) of the credentials for your private Docker image\. The credentials must be created by AWS Secrets Manager\. For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - -1. In **Service role**, do one of the following: - + If you do not have a CodeBuild service role, choose **New service role**\. In **Role name**, accept the default name or enter your own\. - + If you have a CodeBuild service role, choose **Existing service role**\. In **Role name**, choose the service role\. -**Note** -When you use the console to create or update a build project, you can create a CodeBuild service role at the same time\. By default, the role works with that build project only\. If you use the console to associate this service role with another build project, the role is updated to work with the other build project\. A service role can work with up to 10 build projects\. - -1. For **Buildspec**, do one of the following: - + Choose **Use a buildspec file** to use the buildspec\.yml file in the source code root directory\. - + Choose **Insert build commands** to use the console to insert build commands\. - - For more information, see the [Build Spec Reference](build-spec-ref.md)\. - -1. In **Artifacts**, for **Type**, do one of the following: - + If you do not want to create any build output artifacts, choose **No artifacts**\. - + To store the build output in an Amazon S3 bucket, choose **Amazon S3**, and then do the following: - + If you want to use your project name for the build output ZIP file or folder, leave **Name** blank\. Otherwise, enter the name\. By default, the artifact name is the project name\. If you want to use a different name, enter it in the artifacts name box\. If you want to output a ZIP file, include the zip extension\. - + For **Bucket name**, choose the name of the output bucket\. - + If you chose **Insert build commands** earlier in this procedure, then for **Output files**, enter the locations of the files from the build that you want to put into the build output ZIP file or folder\. For multiple locations, separate each location with a comma \(for example, `appspec.yml, target/my-app.jar`\)\. For more information, see the description of `files` in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -1. Expand **Additional configuration** and set options as appropriate\. - -1. Choose **Create build project**\. On the **Review** page, choose **Start build** to run the build\. - -## Verification Checks - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. Do one of the following: - + Choose the link for the build project with webhooks you want to verify, and then choose **Build details**\. - + Choose the button next to the build project with webhooks you want to verify, choose **View details**, and then choose **Build details**\. - -1. In **Source**, choose the **Webhook** URL link\. - -1. In your GitHub repository, on the **Settings** page, under **Webhooks**, verify that **Pull Requests** and **Pushes** are selected\. - -1. In your GitHub profile settings, under **Personal settings**, **Applications**, **Authorized OAuth Apps**, you should see that your AWS CodeBuild region has been authorized\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/github-oauth-apps.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -## Filter GitHub Webhook Events - - You can use webhook filter groups to specify which GitHub webhook events trigger a build\. For example, you can specify that a build is triggered for specified branches only\. - -**Note** -Filter groups work the same way in GitHub and GitHub Enterprise\. - - You can create one or more webhook filter groups to specify which webhook events trigger a build\. A build is triggered if all the filters on one or more filter groups evaluate to true\. When you create a filter group, you specify: -+ An event\. For GitHub, you can choose one or more of the following events: `PUSH`, `PULL_REQUEST_CREATED`, `PULL_REQUEST_UPDATED`, `PULL_REQUEST_REOPENED`, and `PULL_REQUEST_MERGED`\. The webhook event type is in the `X-GitHub-Event` header in the webhook payload\. In the `X-GitHub-Event` header, you might see `pull_request` or `push`\. For a pull request event, the type is in the `action` field of the webhook event payload\. The following table shows how `X-GitHub-Event` header values and webhook pull request payload `action` field values map to the available event types\. -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-github-pull-request.html) -**Note** - The `PULL_REQUEST_REOPENED` event type can be used with GitHub and GitHub Enterprise only\. -+ One or more optional filters\. Use a regular expression to specify a filter\. For an event to trigger a build, every filter associated with it must evaluate to true\. - + `ACTOR_ACCOUNT_ID` \(`ACTOR_ID` in the console\): A webhook event triggers a build when a GitHub or GitHub Enterprise account ID matches the regular expression pattern\. This value is found in the `id` property of the `sender` object in the webhook payload\. - + `HEAD_REF`: A webhook event triggers a build when the head reference matches the regular expression pattern \(for example, `refs/heads/branch-name` or `refs/tags/tag-name`\)\. For a push event, the reference name is found in the `ref` property in the webhook payload\. For pull requests events, the branch name is found in the `ref` property of the `head` object in the webhook payload\. - + `BASE_REF`: A webhook event triggers a build when the base reference matches the regular expression pattern \(for example, `refs/heads/branch-name`\)\. A `BASE_REF` filter can be used with pull request events only\. The branch name is found in the `ref` property of the `base` object in the webhook payload\. - + `FILE_PATH`: A webhook triggers a build when the path of a changed file matches the regular expressions pattern\. A `FILE_PATH` filter can be used with GitHub and GitHub Enterprise push events only\. - -**Note** - You can find the webhook payload in the webhook settings of your GitHub repository\. - -**Topics** -+ [Filter GitHub Webhook Events \(Console\)](#sample-github-pull-request-filter-webhook-events-console) -+ [Filter GitHub Webhook Events \(SDK\)](#sample-github-pull-request-filter-webhook-events-sdk) -+ [Filter GitHub Webhook Events \(AWS CloudFormation\)](#sample-github-pull-request-filter-webhook-events-cfn) - -### Filter GitHub Webhook Events \(Console\) - - To use the AWS Management Console to filter webhook events: - -1. Select **Rebuild every time a code change is pushed to this repository** when you create your project\. - -1. From **Event type**, choose one or more events\. - -1. To filter when an event triggers a build, under **Start a build under these conditions**, add one or more optional filters\. - -1. To filter when an event is not triggered, under **Don't start a build under these conditions**, add one or more optional filters\. - -1. Choose **Add filter group** to add another filter group\. - - For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [WebhookFilter](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_WebhookFilter.html) in the *AWS CodeBuild API Reference*\. - -In this example, a webhook filter group triggers a build for pull requests only: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -Using an example of two webhook filter groups, a build is triggered when one or both evaluate to true: -+ The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that match `^refs/heads/branch1$`\. -+ The second filter group specifies push requests on branches with Git reference names that match the regular expression `^refs/heads/branch1$`\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-head-base-regexes.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -In this example, a webhook filter group triggers a build for all requests except tag events\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-exclude.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -In this example, a webhook filter group triggers a build only when files with names that match the regular expression `^buildspec.*` change\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-file-name-regex.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -In this example, a webhook filter group triggers a build only when a change is made by a specified GitHub or GitHub Enterprise user with account ID that matches the regular expression `actor-account-id`\. - -**Note** - For information about how to find your GitHub account ID, see https://api\.github\.com/users/*user\-name*, where *user\-name* is your GitHub user name\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pull-request-webhook-filter-actor.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -### Filter GitHub Webhook Events \(SDK\) - -To use the AWS CodeBuild SDK to filter webhook events, use the `filterGroups` field in the request syntax of the `CreateWebhook` or `UpdateWebhook` API methods\. For more information, see [WebhookFilter](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_WebhookFilter.html) in the *CodeBuild API Reference*\. - - To create a webhook filter that triggers a build for pull requests only, insert the following into the request syntax: - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" - } - ] -] -``` - - To create a webhook filter that triggers a build for specified branches only, use the `pattern` parameter to specify a regular expression to filter branch names\. Using an example of two filter groups, a build is triggered when one or both evaluate to true: -+ The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that match `^refs/heads/myBranch$`\. -+ The second filter group specifies push requests on branches with Git reference names that match the regular expression `^refs/heads/myBranch$`\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/heads/myBranch$" - }, - { - "type": "BASE_REF", - "pattern": "^refs/heads/master$" - } - ], - [ - { - "type": "EVENT", - "pattern": "PUSH" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/heads/myBranch$" - } - ] -] -``` - - You can use the `excludeMatchedPattern` parameter to specify which events do not trigger a build\. For example, in this example a build is triggered for all requests except tag events\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" - }, - { - "type": "HEAD_REF", - "pattern": "^refs/tags/.*", - "excludeMatchedPattern": true - } - ] -] -``` - - You can create a filter that triggers a build only when files with names that match the regular expression in the `pattern` argument change\. In this example, the filter group specifies that a build is triggered only when files with a name that matches the regular expression `^buildspec.*` change\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PUSH" - }, - { - "type": "FILE_PATH", - "pattern": "^buildspec.*" - } - ] -] -``` - -You can create a filter that triggers a build only when a change is made by a specified GitHub or GitHub Enterprise user with account ID `actor-account-id`\. - -**Note** - For information about how to find your GitHub account ID, see https://api\.github\.com/users/*user\-name*, where *user\-name* is your GitHub user name\. - -``` -"filterGroups": [ - [ - { - "type": "EVENT", - "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" - }, - { - "type": "ACTOR_ACCOUNT_ID", - "pattern": "actor-account-id" - } - ] -] -``` - -### Filter GitHub Webhook Events \(AWS CloudFormation\) - - To use an AWS CloudFormation template to filter webhook events, use the AWS CodeBuild project's `FilterGroups` property\. The following YAML\-formatted portion of a AWS CloudFormation template creates two filter groups\. Together, they trigger a build when one or both evaluate to true: -+ The first filter group specifies pull requests are created or updated on branches with Git reference names that match the regular expression `^refs/heads/master$` by a GitHub user that does not have account ID `12345`\. -+ The second filter group specifies push requests are created on files with names that match the regular expression `READ_ME` in branches with Git reference names that match the regular expression `^refs/heads/.*`\. - -``` -CodeBuildProject: - Type: AWS::CodeBuild::Project - Properties: - Name: MyProject - ServiceRole: service-role - Artifacts: - Type: NO_ARTIFACTS - Environment: - Type: LINUX_CONTAINER - ComputeType: BUILD_GENERAL1_SMALL - Image: aws/codebuild/standard:2.0 - Source: - Type: GITHUB - Location: source-location - Triggers: - Webhook: true - FilterGroups: - - - Type: EVENT - Pattern: PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED - - Type: BASE_REF - Pattern: ^refs/heads/master$ - ExcludeMatchedPattern: false - - Type: ACTOR_ACCOUNT_ID - Pattern: 12345 - ExcludeMatchedPattern: true - - - Type: EVENT - Pattern: PUSH - - Type: HEAD_REF - Pattern: ^refs/heads/.* - - Type: FILE_PATH - Pattern: READ_ME - ExcludeMatchedPattern: true -``` \ No newline at end of file diff --git a/doc_source/sample-lambda.md b/doc_source/sample-lambda.md deleted file mode 100644 index 416e018..0000000 --- a/doc_source/sample-lambda.md +++ /dev/null @@ -1,12 +0,0 @@ -# AWS Lambda Sample for CodeBuild - -To define a standard model for serverless applications that use resources such as Lambda, AWS created the AWS Serverless Application Model \(AWS SAM\)\. For more information, see the [AWS Serverless Application Model](https://github.com/awslabs/serverless-application-model) repository on GitHub\. - -You can use AWS CodeBuild to package and deploy serverless applications that follow the AWS SAM standard\. For the deployment step, CodeBuild can use AWS CloudFormation\. To automate the building and deployment of serverless applications with CodeBuild and AWS CloudFormation, you can use AWS CodePipeline\. - -For more information, see [Deploying Lambda\-based Applications](https://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 CodeBuild along with Lambda, AWS CloudFormation, and CodePipeline, see [Automating Deployment of Lambda\-based Applications](https://docs.aws.amazon.com/lambda/latest/dg/automating-deployment.html) in the *AWS Lambda Developer Guide*\. - -## Related Resources -+ For more information about getting started with AWS CodeBuild, see [Getting Started with CodeBuild](getting-started.md)\. -+ For more information about troubleshooting problems with CodeBuild, see [Troubleshooting CodeBuild](troubleshooting.md)\. -+ For more information about limits in CodeBuild, see [Limits for CodeBuild](limits.md)\. \ No newline at end of file diff --git a/doc_source/sample-multi-in-out.md b/doc_source/sample-multi-in-out.md deleted file mode 100644 index ff62a49..0000000 --- a/doc_source/sample-multi-in-out.md +++ /dev/null @@ -1,140 +0,0 @@ -# Multiple Input Sources and Output Artifacts Sample - -You can create an AWS CodeBuild build project with more than one input source and more than one set of output artifacts\. This sample shows you how to set up a build project that: -+ Uses multiple sources and repositories of varying types\. -+ Publishes build artifacts to multiple Amazon S3 buckets in a single build\. - - In this sample, you create a build project and use it to run a build\. The sample uses the build project's buildspec file to show you how to incorporate more than one source and create more than one set of artifacts\. - -1. Upload your sources to one or more Amazon S3 buckets, CodeCommit, GitHub, GitHub Enterprise, or Bitbucket repositories\. - -1. Choose which source is the primary source\. This is the source in which CodeBuild looks for and executes your buildspec file\. - -1. Create a build project\. For more information, see [Create a Build Project in CodeBuild](create-project.md) - -1. Follow the instructions in [Run AWS CodeBuild Directly](how-to-run.md) to create your build project, run the build, and get information about the build\. - -1. If you use the AWS CLI to create the build project, the JSON\-formatted input to the `create-project` command might look similar to the following: - - ``` - { - "name": "sample-project", - "source": { - "type": "S3", - "location": "bucket/sample.zip" - }, - "secondarySources": [ - { - "type": "CODECOMMIT", - "location": "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/repo" - "sourceIdentifier": "source1" - }, - { - "type": "GITHUB", - "location": "https://github.com/awslabs/aws-codebuild-jenkins-plugin" - "sourceIdentifier": "source2" - } - ], - "secondaryArtifacts": [ - { - "type": "S3", - "location": "output-bucket", - "artifactIdentifier": "artifact1" - }, - { - "type": "S3", - "location": "other-output-bucket", - "artifactIdentifier": "artifact2" - } - ], - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL" - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - - Your primary source is defined under the `source` attribute\. All other sources are called secondary sources and appear under `secondarySources`\. All secondary sources are installed in their own directory\. This directory is stored in the built\-in environment variable `CODEBUILD_SRC_DIR_sourceIdentifer`\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - - The `secondaryArtifacts` attribute contains a list of artifact definitions\. These artifacts use the `secondary-artifacts` block of the buildspec file that is nested inside the `artifacts` block\. - - Secondary artifacts in the buildspec file have the same structure as artifacts and are separated by their artifact identifier\. - -**Note** - In the [CodeBuild API](https://docs.aws.amazon.com/codebuild/latest/APIReference/), the `artifactIdentifier` on a secondary artifact is a required attribute in `CreateProject` and `UpdateProject`\. It must be used to reference a secondary artifact\. - - Using the preceding JSON\-formatted input, the buildspec file for the project might look like: - -``` -version: 0.2 - -phases: - install: - runtime-versions: - java: openjdk11 - build: - commands: - - cd $CODEBUILD_SRC_DIR_source1 - - touch file1 - - cd $CODEBUILD_SRC_DIR_source2 - - touch file2 - -artifacts: - secondary-artifacts: - artifact1: - base-directory: $CODEBUILD_SRC_DIR_source1 - files: - - file1 - artifact2: - base-directory: $CODEBUILD_SRC_DIR_source2 - files: - - file2 -``` - - You can override the version of the primary source using the API with the `sourceVersion` attribute in `StartBuild`\. To override one or more secondary source versions, use the `secondarySourceVersionOverride` attribute\. - - The JSON\-formatted input to the the `start-build` command in the AWS CLI might look like: - -``` -{ - "projectName": "sample-project", - "secondarySourcesVersionOverride": [ - { - "sourceIdentifier": "source1", - "sourceVersion": "codecommit-branch" - }, - { - "sourceIdentifier": "source2", - "sourceVersion": "github-branch" - }, - ] -} -``` - -## Project Without a Source Sample - - You can configure a AWS CodeBuild project by choosing the **NO\_SOURCE** source type when you configure your source\. When your source type is **NO\_SOURCE**, you cannot specify a buildspec file because your project does not have a source\. Instead, you must specify a YAML\-formatted buildspec string in the `buildspec` attribute of the JSON\-formatted input to the `create-project` CLI command\. It might look like this: - -``` -{ - "name": "project-name", - "source": { - "type": "NO_SOURCE", - "buildspec": "version: 0.2\n\nphases:\n build:\n commands:\n - command" - }, - "environment": { - "type": "LINUX_CONTAINER", - "image": "aws/codebuild/standard:2.0", - "computeType": "BUILD_GENERAL1_SMALL", - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" -} -``` - -For more information, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -To learn how to to create a pipeline that uses multiple source inputs to CodeBuild to create multiple output artifacts, see [ CodePipeline Integration with CodeBuild and Multiple Input Sources and Output Artifacts Sample ](sample-pipeline-multi-input-output.md)\. \ No newline at end of file diff --git a/doc_source/sample-pipeline-multi-input-output.md b/doc_source/sample-pipeline-multi-input-output.md deleted file mode 100644 index fb9155d..0000000 --- a/doc_source/sample-pipeline-multi-input-output.md +++ /dev/null @@ -1,131 +0,0 @@ -# CodePipeline Integration with CodeBuild and Multiple Input Sources and Output Artifacts Sample - -An AWS CodeBuild project can take more than one input source\. It can also create more than one output artifact\. This sample demonstrates how to use AWS CodePipeline to create a build project that uses multiple input sources to create multiple output artifacts\. For more information, see [Multiple Input Sources and Output Artifacts Sample](sample-multi-in-out.md)\. - - You can use a JSON\-formatted file that defines the structure of your pipeline, and then use it with the AWS CLI to create the pipeline\. Use the following JSON file as an example of a pipeline structure that creates a build with more than one input source and more than one output artifact\. Later in this sample you see how this file specifies the multiple inputs and outputs\. For more information, see [AWS CodePipeline Pipeline Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html)\. - -``` -{ - "pipeline": { - "roleArn": "arn:aws:iam::account-id:role/my-AWS-CodePipeline-service-role-name", - "stages": [ - { - "name": "Source", - "actions": [ - { - "inputArtifacts": [], - "name": "Source1", - "actionTypeId": { - "category": "Source", - "owner": "AWS", - "version": "1", - "provider": "S3" - }, - "outputArtifacts": [ - { - "name": "source1" - } - ], - "configuration": { - "S3Bucket": "my-input-bucket-name", - "S3ObjectKey": "my-source-code-file-name.zip" - }, - "runOrder": 1 - }, - { - "inputArtifacts": [], - "name": "Source2", - "actionTypeId": { - "category": "Source", - "owner": "AWS", - "version": "1", - "provider": "S3" - }, - "outputArtifacts": [ - { - "name": "source2" - } - ], - "configuration": { - "S3Bucket": "my-other-input-bucket-name", - "S3ObjectKey": "my-other-source-code-file-name.zip" - }, - "runOrder": 1 - } - ] - }, - { - "name": "Build", - "actions": [ - { - "inputArtifacts": [ - { - "name": "source1" - }, - { - "name": "source2" - } - ], - "name": "Build", - "actionTypeId": { - "category": "Build", - "owner": "AWS", - "version": "1", - "provider": "AWS CodeBuild" - }, - "outputArtifacts": [ - { - "name": "artifact1" - }, - { - "name": "artifact2" - } - ], - "configuration": { - "ProjectName": "my-build-project-name", - "PrimarySource": "source1" - }, - "runOrder": 1 - } - ] - } - ], - "artifactStore": { - "type": "S3", - "location": "AWS-CodePipeline-internal-bucket-name" - }, - "name": "my-pipeline-name", - "version": 1 - } -} -``` - - In this JSON file: -+ One of your input sources must be designated the `PrimarySource`\. This source is the directory where CodeBuild looks for and runs your buildspec file\. The keyword `PrimarySource` is used to specify the primary source in the `configuration` section of the CodeBuild stage in the JSON file\. -+ Each input source is installed in its own directory\. This directory is stored in the built\-in environment variable `$CODEBUILD_SRC_DIR` for the primary source and `$CODEBUILD_SRC_DIR_yourInputArtifactName` for all other sources\. For the pipeline in this sample, the two input source directories are `$CODEBUILD_SRC_DIR` and `$CODEBUILD_SRC_DIR_source2`\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. -+ The names of the output artifacts specified in the pipeline's JSON file must match the names of the secondary artifacts defined in your buildspec file\. This pipeline uses the following buildspec file\. For more information, see [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. -+ - - ``` - version: 0.2 - - phases: - build: - commands: - - touch source1_file - - cd $CODEBUILD_SRC_DIR_source2 - - touch source2_file - - artifacts: - secondary-artifacts: - artifact1: - base-directory: $CODEBUILD_SRC_DIR - files: - - source1_file - artifact2: - base-directory: $CODEBUILD_SRC_DIR_source2 - files: - - source2_file - ``` - - After you create the JSON file, you can create your pipeline\. Use the AWS CLI to run the **create\-pipeline** command and pass the file to the `--cli-input-json` parameter\. For more information, see [Create a Pipeline \(CLI\)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-create.html#pipelines-create-cli)\. \ No newline at end of file diff --git a/doc_source/sample-private-registry.md b/doc_source/sample-private-registry.md deleted file mode 100644 index 3330116..0000000 --- a/doc_source/sample-private-registry.md +++ /dev/null @@ -1,60 +0,0 @@ -# Private Registry with AWS Secrets Manager Sample for CodeBuild - - This sample shows you how to use a Docker image that is stored in a private registry as your AWS CodeBuild runtime environment\. The credentials for the private registry are stored in AWS Secrets Manager\. Any private registry works with CodeBuild\. This sample uses Docker Hub\. - -## Private Registry Sample Requirements - - To use a private registry with AWS CodeBuild, you must have the following: -+ An Secrets Manager secret that stores your Docker Hub credentials\. The credentials are used to access your private repository\. -+ A private repository or account\. -+ A CodeBuild service role IAM policy that grants access to your Secrets Manager secret\. - - Follow these steps to create these resources and then create a CodeBuild build project using the Docker images stored in your private registry\. - -## Create a CodeBuild Project with a Private Registry - -1. For information about how to create a free private repository, see [Repositories on Docker Hub](https://docs.docker.com/docker-hub/repos/)\. You can also run the following commands in a terminal to pull an image, get its ID, and push it to a new repository\. - - ``` - docker pull amazonlinux - docker images amazonlinux --format {{.ID}} - docker tag image-id your-username/repository-name:latest - docker login - docker push your-username/repository-name - ``` - -1. Follow the steps in [Creating a Basic Secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) in the *AWS Secrets Manager User Guide*\. In step 3, in **Select secret type**, do the following: - - 1. Choose **Other type of secrets**\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/private-registry-sample-secrets-manager.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - - 1. In **Secret key/value**, create one key\-value pair for your Docker Hub user name and one key\-value pair for your Docker Hub password\. - - 1. For **Secret name**, enter a name, such as **dockerhub**\. You can enter an optional description to help you remember that this is a secret for Docker Hub\. - - 1. Leave **Disable automatic rotation** selected because the keys correspond to your Docker Hub credentials\. - - 1. Choose **Store secret**\. - - 1. When you review your settings, write down the ARN to use later in this sample\. - - For more information, see [What Is AWS Secrets Manager?](https://docs.aws.amazon.com/secretsmanager/latest/userguide/) - -1. When you create an AWS CodeBuild project in the console, CodeBuild attaches the required permission for you\. If you use an AWS KMS key other than `DefaultEncryptionKey`, you must add it to the service role\. For more information, see [Modifying a Role \(Console\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html#roles-managingrole-editing-console)\. - - For your service role to work with Secrets Manager, it must have, at a minimum, the `secretsmanager:GetSecretValue` permission\. -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/private-registry-sample-iam.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -1. To use the console to create a project with an environment stored in a private registry, do the following while you create a project\. For information, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. -**Note** - If your private registry is in your VPC, it must have public internet access\. CodeBuild cannot pull an image from a private IP address in a VPC\. - - 1. In **Environment**, choose **Custom image**\. - - 1. For **Environment type**, choose **Linux** or **Windows**\. - - 1. For **Custom image type**, choose **Other location**\. - - 1. In **Other location**, enter the image location and the ARN or name of your Secrets Manager credentials\. -**Note** - If your credentials do not exist in your current region, then you must use the ARN\. You cannot use the credential name if they exist in a different region\. \ No newline at end of file diff --git a/doc_source/sample-runtime-versions.md b/doc_source/sample-runtime-versions.md deleted file mode 100644 index ea93458..0000000 --- a/doc_source/sample-runtime-versions.md +++ /dev/null @@ -1,373 +0,0 @@ -# Runtime Versions in Buildspec File Sample for CodeBuild - - If you use the Ubuntu standard image version 2\.0, you must specify at least one runtime and its version in the `runtime-versions` section of your buildspec file\. This sample shows how you can change your project runtime, specify more than one runtime, and specify a runtime that is dependent on another runtime\. - -**Note** - If you use Docker in your build container, then your build must run in privileged mode\. For more information, see [Run a Build in CodeBuild](run-build.md) and [Create a Build Project in CodeBuild](create-project.md)\. - -## Update Your Runtime Version - - You can modify the runtime used by your project to a new version by updating the `runtime-versions` section of your buildpec file\. The following examples show how to specify Corretto versions 8 and 11: -+ A `runtime-versions` section that specifies version 8 of Corretto \(Amazon Linux 2 only\): - - ``` - phases: - install: - runtime-versions: - java: corretto8 - ``` -+ A `runtime-versions` section that specifies version 11 of Corretto \(Amazon Linux 2 only\): - - ``` - phases: - install: - runtime-versions: - java: corretto11 - ``` - -The following examples show how to specify Java versions 8 and 10: -+ A `runtime-versions` section that specifies version 8 of Java \(Ubuntu only\): - - ``` - phases: - install: - runtime-versions: - java: openjdk8 - ``` -+ A `runtime-versions` section that specifies version 11 of Java \(Ubuntu only\): - - ``` - phases: - install: - runtime-versions: - java: openjdk11 - ``` - - The following examples show how you to specify different versions of Node\.js: -+ A `runtime-versions` section that specifies Node\.js version 8: - - ``` - phases: - install: - runtime-versions: - nodejs: 8 - ``` -+ A `runtime-versions` section that specifies Node\.js version 10: - - ``` - phases: - install: - runtime-versions: - nodejs: 10 - ``` - - This sample demonstrates a project that starts with the Java version 8 runtime, and then is updated to the Java version 10 runtime\. - -1. Follow steps 1 and 2 in [Create the Source Code](sample-elastic-beanstalk.md#sample-elastic-beanstalk-prepare-source) to generate source code\. If successful, a directory named `my-web-app` is created with your source files\. - -1. Create a file named `buildspec.yml` with the following contents\. Store the file in the ` (root directory name)/my-web-app` directory\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - java: openjdk8 - build: - commands: - - java -version - - mvn package - artifacts: - files: - - '**/*' - base-directory: 'target/my-web-app' - ``` - - In the buildspec file: - + The `runtime-versions` section specifies that the project uses version 8 of the Java runtime\. - + The `- java -version` command displays the version of Java used by your project when it builds\. - - Your file structure should now look like this\. - - ``` - (root directory name) - -- my-web-app - |-- src - | `-- main - | |-- resources - | `-- webapp - | |-- WEB-INF - | | `-- web.xml - | `-- index.jsp - |-- buildspec.yml - `-- pom.xml - ``` - -1. Upload the contents of the `my-web-app` directory to an Amazon S3 input bucket or a CodeCommit, GitHub, or Bitbucket repository\. -**Important** -Do not upload `(root directory name)` or `(root directory name)/my-web-app`, just the directories and files in `(root directory name)/my-web-app`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the directory structure and files, and then upload it to the input bucket\. Do not add `(root directory name)` or `(root directory name)/my-web-app` to the ZIP file, just the directories and files in `(root directory name)/my-web-app`\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Create a build project\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings\. - + For **Environment**: - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Ubuntu**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/standard:2\.0**\. - -1. Choose **Start build**\. - -1. On **Build configuration** accept the defaults, and then choose **Start build**\. - -1. After the build is complete, view the build output on the **Build logs** tab\. You should see output similar to the following: - - ``` - [Container] 2019/05/14 20:45:07 Entering phase INSTALL - [Container] Date Time Running command echo "Installing Java version 8 ..." - Installing Java version 8 ... - - [Container] Date Time Running command export JAVA_HOME="$JAVA_8_HOME" - - [Container] Date Time Running command export JRE_HOME="$JRE_8_HOME" - - [Container] Date Time Running command export JDK_HOME="$JDK_8_HOME" - - [Container] Date Time Running command for tool_path in "$JAVA_8_HOME"/bin/* "$JRE_8_HOME"/bin/*; - ``` - -1. Update the `runtime-versions` section with Java version 11: - - ``` - install: - runtime-versions: - java: openjdk11 - ``` - -1. After you save the change, run your build again and view the build output\. You should see that the installed version of Java is 11\. You should see output similar to the following: - - ``` - [Container] 2019/05/14 20:45:07 Entering phase INSTALL - [Container] Date Time Running command echo "Installing Java version 11 ..." - Installing Java version 11 ... - - [Container] Date Time Running command export JAVA_HOME="$JAVA_11_HOME" - - [Container] Date Time Running command export JRE_HOME="$JRE_11_HOME" - - [Container] Date Time Running command export JDK_HOME="$JDK_11_HOME" - - [Container] Date Time Running command for tool_path in "$JAVA_11_HOME"/bin/* "$JRE_11_HOME"/bin/*; - ``` - -## Specify a Runtime Dependency - - You might use a runtime that is dependent on another runtime\. For example, the Android runtime version 28 is dependent on the Java runtime version 8\. If you specify Android version 28, you must also specify Java version 8\. This example shows how to specify a runtime and a dependency runtime\. The build project uses source code in the GitHub [AWS Samples](https://github.com/aws-samples) repository\. The source code uses the Android version 28 runtime, so it must also specify Java version 8\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Create a build project\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings\. - + For **Environment**: - + For **Source provider**, choose **GitHub**\. - + For **Repository**, choose **Public repository**\. - + For **Repository URL**, type **https://github\.com/aws\-samples/aws\-mobile\-android\-notes\-tutorial**\. - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Amazon Linux 2**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/amazonlinux2\-x86\_64\-standard:1\.0**\. - -1. For **Build specifications**, choose **Insert build commands**, and then choose **Switch to editor**\. - -1. In **Build commands**, replace the placeholder text with the following: - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - android: 28 - java: openjdk8 - build: - commands: - - ./gradlew assembleDebug - artifacts: - files: - - app/build/outputs/apk/app-debug.apk - ``` - - The `runtime-versions` section specifies both Android version 28 and Java version 8 runtimes\. - -1. Choose **Create build project**\. - -1. Choose **Start build**\. - -1. On **Build configuration** accept the defaults, and then choose **Start build**\. - -1. After the build is complete, view the build output on the **Build logs** tab\. You should see output similar to the following\. It shows that Android version 28 and Java version 8 are installed: - - ``` - [Container] 2019/05/14 23:21:42 Entering phase INSTALL - [Container] Date Time Running command echo "Installing Android version 28 ..." - Installing Android version 28 ... - - [Container] Date Time Running command echo "Installing Java version 8 ..." - Installing Java version 8 ... - ``` - -## Specify Two Runtimes - - You can specify more than one runtime in the same CodeBuild build project\. This sample project uses two source files: one that uses the Go runtime and one that uses the Node\.js runtime\. - -1. Create a directory named `my-source`\. - -1. Inside the `my-source` directory, create a directory named `golang-app`\. - -1. Create a file named `hello.go` with the following contents\. Store the file in the `golang-app` directory\. - - ``` - package main - import "fmt" - - func main() { - fmt.Println("hello world from golang") - fmt.Println("1+1 =", 1+1) - fmt.Println("7.0/3.0 =", 7.0/3.0) - fmt.Println(true && false) - fmt.Println(true || false) - fmt.Println(!true) - fmt.Println("good bye from golang") - } - ``` - -1. Inside the `my-source` directory, create a directory named `nodejs-app`\. It should be at the same level as the `golang-app` directory\. - -1. Create a file named `index.js` with the following contents\. Store the file in the `nodejs-app` directory\. - - ``` - console.log("hello world from nodejs"); - console.log("1+1 =" + (1+1)); - console.log("7.0/3.0 =" + 7.0/3.0); - console.log(true && false); - console.log(true || false); - console.log(!true); - console.log("good bye from nodejs"); - ``` - -1. Create a file named `package.json` with the following contents\. Store the file in the `nodejs-app` directory\. - - ``` - { - "name": "mycompany-app", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "test": "echo \"run some tests here\"" - }, - "author": "", - "license": "ISC" - } - ``` - -1. Create a file named `buildspec.yml` with the following contents\. Store the file in the `my-source` directory, at the same level as the `nodejs-app` and `golang-app` directories\. The `runtime-versions` section specifies the Node\.js version 10 and Go version 1\.12 runtimes\. - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - golang: 1.12 - nodejs: 10 - build: - commands: - - echo Building the Go code... - - cd $CODEBUILD_SRC_DIR/golang-app - - go build hello.go - - echo Building the Node code... - - cd $CODEBUILD_SRC_DIR/nodejs-app - - npm run test - artifacts: - secondary-artifacts: - golang_artifacts: - base-directory: golang-app - files: - - hello - nodejs_artifacts: - base-directory: nodejs-app - files: - - index.js - - package.json - ``` - -1. Your file structure should now look like this\. - - ``` - -- my-source - |-- golang-app - | -- hello.go - |-- nodejs.app - | -- index.js - | -- package.json - |-- buildspec.yml - ``` - -1. Upload the contents of the `my-source` directory to an Amazon S3 input bucket or a CodeCommit, GitHub, or Bitbucket repository\. -**Important** - If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the directory structure and files, and then upload it to the input bucket\. Do not add `my-source` to the ZIP file, just the directories and files in `my-source`\. - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Create a build project\. For more information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings\. - + For **Environment**: - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Ubuntu**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/standard:2\.0**\. - -1. Choose **Create build project**\. - -1. Choose **Start build**\. - -1. On **Build configuration**, accept the defaults, and then choose **Start build**\. - -1. After the build is complete, view the build output on the **Build logs** tab\. You should see output similar to the following\. It shows output from the Go and Node\.js runtimes\. It also shows output from the Go and Node\.js applications\. - - ``` - [Container] Date Time Entering phase INSTALL - [Container] Date Time Running command echo "Installing Go version 1.12 ..." - Installing Go version 1.12 ... - - [Container] Date Time Running command echo "Installing Node.js version 10 ..." - Installing Node.js version 10 ... - - [Container] Date Time Running command n 10.15.3 - - [Container] Date Time Phase complete: INSTALL State: SUCCEEDED - [Container] Date Time Phase context status code: Message: - [Container] Date Time Entering phase PRE_BUILD - [Container] Date Time Phase complete: PRE_BUILD State: SUCCEEDED - [Container] Date Time Phase context status code: Message: - [Container] Date Time Entering phase BUILD - [Container] Date Time Running command echo Building the Go code... - Building the Go code... - - [Container] Date Time Running command cd $CODEBUILD_SRC_DIR/golang-app - - [Container] Date Time Running command go build hello.go - - [Container] Date Time Running command echo Building the Node code... - Building the Node code... - - [Container] Date Time Running command cd $CODEBUILD_SRC_DIR/nodejs-app - - [Container] Date Time Running command npm run test - - > mycompany-app@1.0.0 test /codebuild/output/src924084119/src/nodejs-app - > echo "run some tests here" - - run some tests here - ``` \ No newline at end of file diff --git a/doc_source/sample-source-version.md b/doc_source/sample-source-version.md deleted file mode 100644 index 570fecf..0000000 --- a/doc_source/sample-source-version.md +++ /dev/null @@ -1,100 +0,0 @@ -# Source Version Sample with CodeBuild - - This sample demonstrates how to specify a version of your source using a format other than a commit ID \(also known as a commit SHA\)\. You can specify the version of your source the following ways: -+ For an Amazon S3 source provider, use the version ID of the object that represents the build input ZIP file\. -+ For CodeCommit, Bitbucket, GitHub, and GitHub Enterprise, use one of the following: - + Pull request as a pull request reference \(for example, `refs/pull/1/head`\)\. - + Branch as a branch name\. - + Commit ID\. - + Tag\. - + Reference and a commit ID\. The reference can be one of the following: - + A tag \(for example, `refs/tags/mytagv1.0^{full-commit-SHA}`\)\. - + A branch \(for example, `refs/heads/mydevbranch^{full-commit-SHA}`\)\. - + A pull request \(for example, `refs/pull/1/head^{full-commit-SHA}`\)\. - -**Note** - You can specify the version of a pull request source only if your repository is GitHub or GitHub Enterprise\. - - If you use a reference and a commit ID to specify a version, the `DOWNLOAD_SOURCE` phase of your build is faster than if you provide only the version\. This is because when you add a reference, CodeBuild does not need to download the entire repository to find the commit\. -+ You can specify a source version with only a commit ID, such as `12345678901234567890123467890123456789`\. If you do this, CodeBuild must download the entire repository to find the version\. -+ You can specify a source version with a reference and a commit ID in this format: `refs/heads/branchname^{full-commit-SHA}` \(for example, `refs/heads/master^{12345678901234567890123467890123456789}`\)\. If you do this, CodeBuild downloads only the specified branch to find the version\. \. - -**Note** -To speed up the `DOWNLOAD_SOURCE` phase of your build, you can also to set **Git clone depth** to a low number\. CodeBuild downloads fewer versions of your repository with a lower Git clone depth\. - - \. - -**To specify a GitHub repository version with a commit ID** - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Create a build project\. For information, see [Create a Build Project \(Console\)](create-project.md#create-project-console) and [Run a Build \(Console\)](run-build.md#run-build-console)\. Leave all settings at their default values, except for these settings: - + In **Source**: - + For **Source provider**, choose **GitHub**\. If you are not connected to GitHub, ollow the instructions to connect\. - + For **Repository**, choose **Public repository**\. - + For **Repository URL**, enter **https://github\.com/aws/aws\-sdk\-ruby\.git**\. - + In **Environment**: - + For **Environment image**, choose **Managed image**\. - + For **Operating system**, choose **Ubuntu**\. - + For **Runtime\(s\)**, choose **Standard**\. - + For **Image**, choose **aws/codebuild/standard:2\.0**\. - -1. For **Build specifications**, choose **Insert build commands**, and then choose **Switch to editor**\. - -1. In **Build commands**, replace the placeholder text with the following: - - ``` - version: 0.2 - - phases: - install: - runtime-versions: - ruby: 2.6 - build: - commands: - - echo $CODEBUILD_RESOLVED_SOURCE_VERSION - ``` - - The `runtime-versions` section is required when you use the Ubuntu standard image 2\.0\. Here, the Ruby version 2\.6 runtime is specified, but you can use any runtime\. The `echo` command displays the version of the source code stored in the `CODEBUILD_RESOLVED_SOURCE_VERSION` environment variable\. - -1. On **Build configuration**, accept the defaults, and then choose **Start build**\. - -1. For **Source version**, enter **046e8b67481d53bdc86c3f6affdd5d1afae6d369**\. This is the SHA of a commit in the `https://github.com/aws/aws-sdk-ruby.git` repository\. - -1. Choose **Start build**\. - -1. When the build is complete, you should see the following: - + On the **Build logs** tab, which version of the project source was used\. Here is an example\. - - ``` - [Container] Date Time Running command echo $CODEBUILD_RESOLVED_SOURCE_VERSION - 046e8b67481d53bdc86c3f6affdd5d1afae6d369 - - [Container] Date Time Phase complete: BUILD State: SUCCEEDED - ``` - + On the **Environment variables** tab, the **Resolved source version** matches the commit ID used to create the build\. - + On the **Phase details** tab, the duration of the `DOWNLOAD_SOURCE` phase\. - - These steps show you how to create a build using the same version of the source\. This time, the version of the source is specified using a reference with the commit ID\. - -**To specify a GitHub repository version with a commit ID and reference** - -1. From the left navigation pane, choose **Build projects**, and then choose the project you created earlier\. - -1. Choose **Start build**\. - -1. In **Source version**, enter **refs/heads/master^\{046e8b67481d53bdc86c3f6affdd5d1afae6d369\}**\. This is the same commit ID and a reference to a branch in the format `refs/heads/branchname^{full-commit-SHA}`\. - -1. Choose **Start build**\. - -1. When the build is complete, you should see the following: - + On the **Build logs** tab, which version of the project source was used\. Here is an example\. - - ``` - [Container] Date Time Running command echo $CODEBUILD_RESOLVED_SOURCE_VERSION - 046e8b67481d53bdc86c3f6affdd5d1afae6d369 - - [Container] Date Time Phase complete: BUILD State: SUCCEEDED - ``` - + On the **Environment variables** tab, the **Resolved source version** matches the commit ID used to create the build\. - + On the **Phase details** tab, the duration of the `DOWNLOAD_SOURCE` phase should be shorter than the duration when you used only the commit ID to specify the version of your source\. \ No newline at end of file diff --git a/doc_source/sample-windows.md b/doc_source/sample-windows.md deleted file mode 100644 index 3321eaa..0000000 --- a/doc_source/sample-windows.md +++ /dev/null @@ -1,1087 +0,0 @@ -# Microsoft Windows Samples for CodeBuild - -These samples use an AWS CodeBuild build environment running Microsoft Windows Server 2016, the Microsoft \.NET Framework, and the \.NET Core SDK to build executables file out of code written in C\#, F\#, and Visual Basic\. - -**Important** -Running these samples may result in charges to your AWS account\. These include possible charges for CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, and CloudWatch Logs\. For more information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing), [Amazon S3 Pricing](http://aws.amazon.com/s3/pricing), [AWS Key Management Service Pricing](http://aws.amazon.com/kms/pricing), and [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing)\. - -## Running the Samples - -To run these samples: - -1. Create the files as described in the Directory Structure and Files sections of this topic, and then upload them to an Amazon S3 input bucket or a CodeCommit or GitHub repository\. -**Important** -Do not upload `(root directory name)`, just the files inside of `(root directory name)`\. -If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket\. Do not add `(root directory name)` to the ZIP file, just the files inside of `(root directory name)`\. - -1. Create a build project, run the build, and follow the steps in [Run AWS CodeBuild Directly](how-to-run.md)\. - - If you use the AWS CLI to create the build project, the JSON\-formatted input to the `create-project` command might look similar to this\. \(Replace the placeholders with your own values\.\) - - ``` - { - "name": "sample-windows-build-project", - "source": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-input-bucket/windows-build-input-artifact.zip" - }, - "artifacts": { - "type": "S3", - "location": "codebuild-region-ID-account-ID-output-bucket", - "packaging": "ZIP", - "name": "windows-build-output-artifact.zip" - }, - "environment": { - "type": "WINDOWS_CONTAINER", - "image": "aws/codebuild/windows-base:1.0", - "computeType": "BUILD_GENERAL1_MEDIUM" - }, - "serviceRole": "arn:aws:iam::account-ID:role/role-name", - "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" - } - ``` - -1. To get the build output artifact, in your Amazon S3 output bucket, download the `windows-build-output-artifact.zip` file to your local computer or instance\. Extract the contents to get to the executable and other files\. - + The executable file for the C\# sample using the Microsoft \.NET Framework, `CSharpHelloWorld.exe`, can be found in the `CSharpHelloWorld\bin\Debug` directory\. - + The executable file for the F\# sample using the Microsoft \.NET Framework, `FSharpHelloWorld.exe`, can be found in the `FSharpHelloWorld\bin\Debug` directory\. - + The executable file for the Visual Basic sample using the Microsoft \.NET Framework, `VBHelloWorld.exe`, can be found in the `VBHelloWorld\bin\Debug` directory\. - + The executable file for the C\# sample using \.NET Core, `HelloWorldSample.dll`, can be found in the `bin\Debug\netcoreapp1.0` directory\. - -## Directory Structure - -These samples assume the following directory structures\. - -### C\# and the Microsoft \.NET Framework - -``` -(root directory name) - |-- buildspec.yml - |-- CSharpHelloWorld.sln - `-- CSharpHelloWorld - |-- App.config - |-- CSharpHelloWorld.csproj - |-- Program.cs - `-- Properties - `-- AssemblyInfo.cs -``` - -### F\# and the Microsoft \.NET Framework - -``` -(root directory name) - |-- buildspec.yml - |-- FSharpHelloWorld.sln - `-- FSharpHelloWorld - |-- App.config - |-- AssemblyInfo.fs - |-- FSharpHelloWorld.fsproj - `-- Program.fs -``` - -### Visual Basic and the Microsoft \.NET Framework - -``` -(root directory name) - |-- buildspec.yml - |-- VBHelloWorld.sln - `-- VBHelloWorld - |-- App.config - |-- HelloWorld.vb - |-- VBHelloWorld.vbproj - `-- My Project - |-- Application.Designer.vb - |-- Application.myapp - |-- AssemblyInfo.vb - |-- Resources.Designer.vb - |-- Resources.resx - |-- Settings.Designer.vb - `-- Settings.settings -``` - -### C\# and \.NET Core - -``` -(root directory name) - |-- buildspec.yml - |-- HelloWorldSample.csproj - `-- Program.cs -``` - -## Files - -These samples use the following files: - -### C\# and the Microsoft \.NET Framework - -`buildspec.yml` \(in `(root directory name)`\): - -``` -version: 0.2 - -env: - variables: - SOLUTION: .\CSharpHelloWorld.sln - PACKAGE_DIRECTORY: .\packages - DOTNET_FRAMEWORK: 4.6.2 - -phases: - build: - commands: - - '& "C:\ProgramData\chocolatey\bin\NuGet.exe" restore $env:SOLUTION -PackagesDirectory $env:PACKAGE_DIRECTORY' - - '& "C:\Program Files (x86)\MSBuild\14.0\Bin\MSBuild.exe" -p:FrameworkPathOverride="C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v$env:DOTNET_FRAMEWORK" $env:SOLUTION' -artifacts: - files: - - .\CSharpHelloWorld\bin\Debug\* -``` - -`CSharpHelloWorld.sln` \(in `(root directory name)`\): - -``` -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.25420.1 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSharpHelloWorld", "CSharpHelloWorld\CSharpHelloWorld.csproj", "{2F8752D5-E628-4A38-AA7E-BC4B4E697CBB}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {2F8752D5-E628-4A38-AA7E-BC4B4E697CBB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {2F8752D5-E628-4A38-AA7E-BC4B4E697CBB}.Debug|Any CPU.Build.0 = Debug|Any CPU - {2F8752D5-E628-4A38-AA7E-BC4B4E697CBB}.Release|Any CPU.ActiveCfg = Release|Any CPU - {2F8752D5-E628-4A38-AA7E-BC4B4E697CBB}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal -``` - -`App.config` \(in `(root directory name)\CSharpHelloWorld`\): - -``` - - - - - - -``` - -`CSharpHelloWorld.csproj` \(in `(root directory name)\CSharpHelloWorld`\): - -``` - - - - - Debug - AnyCPU - {2F8752D5-E628-4A38-AA7E-BC4B4E697CBB} - Exe - Properties - CSharpHelloWorld - CSharpHelloWorld - v4.6.2 - 512 - true - - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - - - - - - - - - - - - - - - - - - -``` - -`Program.cs` \(in `(root directory name)\CSharpHelloWorld`\): - -``` -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace CSharpHelloWorld -{ - class Program - { - static void Main(string[] args) - { - System.Console.WriteLine("Hello World"); - System.Threading.Thread.Sleep(10); - } - } -} -``` - -`AssemblyInfo.cs` \(in `(root directory name)\CSharpHelloWorld\Properties`\): - -``` -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("CSharpHelloWorld")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("CSharpHelloWorld")] -[assembly: AssemblyCopyright("Copyright © 2017")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("2f8752d5-e628-4a38-aa7e-bc4b4e697cbb")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] -``` - -### F\# and the Microsoft \.NET Framework - -`buildspec.yml` \(in `(root directory name)`\): - -``` -version: 0.2 - -env: - variables: - SOLUTION: .\FSharpHelloWorld.sln - PACKAGE_DIRECTORY: .\packages - DOTNET_FRAMEWORK: 4.6.2 - -phases: - build: - commands: - - '& "C:\ProgramData\chocolatey\bin\NuGet.exe" restore $env:SOLUTION -PackagesDirectory $env:PACKAGE_DIRECTORY' - - '& "C:\Program Files (x86)\MSBuild\14.0\Bin\MSBuild.exe" -p:FrameworkPathOverride="C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v$env:DOTNET_FRAMEWORK" $env:SOLUTION' -artifacts: - files: - - .\FSharpHelloWorld\bin\Debug\* -``` - -`FSharpHelloWorld.sln` \(in `(root directory name)`\): - -``` -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.25420.1 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "FSharpHelloWorld", "FSharpHelloWorld\FSharpHelloWorld.fsproj", "{D60939B6-526D-43F4-9A89-577B2980DF62}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {D60939B6-526D-43F4-9A89-577B2980DF62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D60939B6-526D-43F4-9A89-577B2980DF62}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D60939B6-526D-43F4-9A89-577B2980DF62}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D60939B6-526D-43F4-9A89-577B2980DF62}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal -``` - -`App.config` \(in `(root directory name)\FSharpHelloWorld`\): - -``` - - - - - - -``` - -`AssemblyInfo.fs` \(in `(root directory name)\FSharpHelloWorld`\): - -``` -namespace FSharpHelloWorld.AssemblyInfo - -open System.Reflection -open System.Runtime.CompilerServices -open System.Runtime.InteropServices - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[] -[] -[] -[] -[] -[] -[] -[] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [] -[] -[] - -do - () -``` - -`FSharpHelloWorld.fsproj` \(in `(root directory name)\FSharpHelloWorld`\): - -``` - - - - - Debug - AnyCPU - 2.0 - d60939b6-526d-43f4-9a89-577b2980df62 - Exe - FSharpHelloWorld - FSharpHelloWorld - v4.6.2 - true - 4.4.0.0 - FSharpHelloWorld - - - true - full - false - false - bin\Debug\ - DEBUG;TRACE - 3 - AnyCPU - bin\Debug\FSharpHelloWorld.XML - true - - - pdbonly - true - true - bin\Release\ - TRACE - 3 - AnyCPU - bin\Release\FSharpHelloWorld.XML - true - - - - - True - - - - - - - - - - - - 11 - - - - - $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.0\Microsoft.FSharp.Targets - - - - - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\FSharp\Microsoft.FSharp.Targets - - - - - - -``` - -`Program.fs` \(in `(root directory name)\FSharpHelloWorld`\): - -``` -// Learn more about F# at http://fsharp.org -// See the 'F# Tutorial' project for more help. - -[] -let main argv = - printfn "Hello World" - 0 // return an integer exit code -``` - -### Visual Basic and the Microsoft \.NET Framework - -`buildspec.yml` \(in `(root directory name)`\): - -``` -version: 0.2 - -env: - variables: - SOLUTION: .\VBHelloWorld.sln - PACKAGE_DIRECTORY: .\packages - DOTNET_FRAMEWORK: 4.6.2 - -phases: - build: - commands: - - '& "C:\ProgramData\chocolatey\bin\NuGet.exe" restore $env:SOLUTION -PackagesDirectory $env:PACKAGE_DIRECTORY' - - '& "C:\Program Files (x86)\MSBuild\14.0\Bin\MSBuild.exe" -p:FrameworkPathOverride="C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v$env:DOTNET_FRAMEWORK" $env:SOLUTION'.2 -artifacts: - files: - - .\VBHelloWorld\bin\Debug\* -``` - -`VBHelloWorld.sln` \(in `(root directory name)`\): - -``` -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.25420.1 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{F184B08F-C81C-45F6-A57F-5ABD9991F28F}") = "VBHelloWorld", "VBHelloWorld\VBHelloWorld.vbproj", "{4DCEC446-7156-4FE6-8CCC-219E34DD409D}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {4DCEC446-7156-4FE6-8CCC-219E34DD409D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4DCEC446-7156-4FE6-8CCC-219E34DD409D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4DCEC446-7156-4FE6-8CCC-219E34DD409D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4DCEC446-7156-4FE6-8CCC-219E34DD409D}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal -``` - -`App.config` \(in `(root directory name)\VBHelloWorld`\): - -``` - - - - - - -``` - -`HelloWorld.vb` \(in `(root directory name)\VBHelloWorld`\): - -``` -Module HelloWorld - - Sub Main() - MsgBox("Hello World") - End Sub - -End Module -``` - -`VBHelloWorld.vbproj` \(in `(root directory name)\VBHelloWorld`\): - -``` - - - - - Debug - AnyCPU - {4DCEC446-7156-4FE6-8CCC-219E34DD409D} - Exe - VBHelloWorld.HelloWorld - VBHelloWorld - VBHelloWorld - 512 - Console - v4.6.2 - true - - - AnyCPU - true - full - true - true - bin\Debug\ - VBHelloWorld.xml - 42016,41999,42017,42018,42019,42032,42036,42020,42021,42022 - - - AnyCPU - pdbonly - false - true - true - bin\Release\ - VBHelloWorld.xml - 42016,41999,42017,42018,42019,42032,42036,42020,42021,42022 - - - On - - - Binary - - - Off - - - On - - - - - - - - - - - - - - - - - - - - - - - - - - - True - Application.myapp - - - True - True - Resources.resx - - - True - Settings.settings - True - - - - - VbMyResourcesResXFileCodeGenerator - Resources.Designer.vb - My.Resources - Designer - - - - - MyApplicationCodeGenerator - Application.Designer.vb - - - SettingsSingleFileGenerator - My - Settings.Designer.vb - - - - - - -``` - -`Application.Designer.vb` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` -'------------------------------------------------------------------------------ -' -' This code was generated by a tool. -' Runtime Version:4.0.30319.42000 -' -' Changes to this file may cause incorrect behavior and will be lost if -' the code is regenerated. -' -'------------------------------------------------------------------------------ - -Option Strict On -Option Explicit On -``` - -`Application.myapp` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` - - - false - false - 0 - true - 0 - 2 - true - -``` - -`AssemblyInfo.vb` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` -Imports System -Imports System.Reflection -Imports System.Runtime.InteropServices - -' General Information about an assembly is controlled through the following -' set of attributes. Change these attribute values to modify the information -' associated with an assembly. - -' Review the values of the assembly attributes - - - - - - - - - - -'The following GUID is for the ID of the typelib if this project is exposed to COM - - -' Version information for an assembly consists of the following four values: -' -' Major Version -' Minor Version -' Build Number -' Revision -' -' You can specify all the values or you can default the Build and Revision Numbers -' by using the '*' as shown below: -' - - - -``` - -`Resources.Designer.vb` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` -'------------------------------------------------------------------------------ -' -' This code was generated by a tool. -' Runtime Version:4.0.30319.42000 -' -' Changes to this file may cause incorrect behavior and will be lost if -' the code is regenerated. -' -'------------------------------------------------------------------------------ - -Option Strict On -Option Explicit On - -Namespace My.Resources - - 'This class was auto-generated by the StronglyTypedResourceBuilder - 'class via a tool like ResGen or Visual Studio. - 'To add or remove a member, edit your .ResX file then rerun ResGen - 'with the /str option, or rebuild your VS project. - ''' - ''' A strongly-typed resource class, for looking up localized strings, etc. - ''' - _ - Friend Module Resources - - Private resourceMan As Global.System.Resources.ResourceManager - - Private resourceCulture As Global.System.Globalization.CultureInfo - - ''' - ''' Returns the cached ResourceManager instance used by this class. - ''' - _ - Friend ReadOnly Property ResourceManager() As Global.System.Resources.ResourceManager - Get - If Object.ReferenceEquals(resourceMan, Nothing) Then - Dim temp As Global.System.Resources.ResourceManager = New Global.System.Resources.ResourceManager("VBHelloWorld.Resources", GetType(Resources).Assembly) - resourceMan = temp - End If - Return resourceMan - End Get - End Property - - ''' - ''' Overrides the current thread's CurrentUICulture property for all - ''' resource lookups using this strongly typed resource class. - ''' - _ - Friend Property Culture() As Global.System.Globalization.CultureInfo - Get - Return resourceCulture - End Get - Set(ByVal value As Global.System.Globalization.CultureInfo) - resourceCulture = value - End Set - End Property - End Module -End Namespace -``` - -`Resources.resx` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - -``` - -`Settings.Designer.vb` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` -'------------------------------------------------------------------------------ -' -' This code was generated by a tool. -' Runtime Version:4.0.30319.42000 -' -' Changes to this file may cause incorrect behavior and will be lost if -' the code is regenerated. -' -'------------------------------------------------------------------------------ - -Option Strict On -Option Explicit On - -Namespace My - - _ - Partial Friend NotInheritable Class MySettings - Inherits Global.System.Configuration.ApplicationSettingsBase - - Private Shared defaultInstance As MySettings = CType(Global.System.Configuration.ApplicationSettingsBase.Synchronized(New MySettings), MySettings) - - #Region "My.Settings Auto-Save Functionality" - #If _MyType = "WindowsForms" Then - Private Shared addedHandler As Boolean - - Private Shared addedHandlerLockObject As New Object - - _ - Private Shared Sub AutoSaveSettings(ByVal sender As Global.System.Object, ByVal e As Global.System.EventArgs) - If My.Application.SaveMySettingsOnExit Then - My.Settings.Save() - End If - End Sub - #End If - #End Region - - Public Shared ReadOnly Property [Default]() As MySettings - Get - - #If _MyType = "WindowsForms" Then - If Not addedHandler Then - SyncLock addedHandlerLockObject - If Not addedHandler Then - AddHandler My.Application.Shutdown, AddressOf AutoSaveSettings - addedHandler = True - End If - End SyncLock - End If - #End If - Return defaultInstance - End Get - End Property - End Class -End Namespace - -Namespace My - - _ - Friend Module MySettingsProperty - - _ - Friend ReadOnly Property Settings() As Global.VBHelloWorld.My.MySettings - Get - Return Global.VBHelloWorld.My.MySettings.Default - End Get - End Property - End Module -End Namespace -``` - -`Settings.settings` \(in `(root directory name)\VBHelloWorld\My Project`\): - -``` - - - - - - - -``` - -### C\# and \.NET Core - -`buildspec.yml` \(in `(root directory name)` - -``` -version: 0.2 - -phases: - build: - commands: - - dotnet restore - - dotnet build -artifacts: - files: - - .\bin\Debug\netcoreapp1.0\* -``` - -`HelloWorldSample.csproj` \(in `(root directory name)` - -``` - - - Exe - netcoreapp1.0 - - -``` - -`Program.cs` \(in `(root directory name)` - -``` -using System; - -namespace HelloWorldSample -{ - public static class Program - { - public static void Main() - { - Console.WriteLine("Hello World!"); - } - } -} -``` \ No newline at end of file diff --git a/doc_source/samples.md b/doc_source/samples.md deleted file mode 100644 index 5165c32..0000000 --- a/doc_source/samples.md +++ /dev/null @@ -1,28 +0,0 @@ -# CodeBuild Samples - - These use case\-based samples can be used to experiment with AWS CodeBuild: - - -**** - -| Name | Description | -| --- | --- | -| [Amazon ECR Sample](sample-ecr.md) | Uses a Docker image in an Amazon ECR repository to use Apache Maven to produce a single JAR file\. | -| [Private Registry with AWS Secrets Manager Sample](sample-private-registry.md) | Shows how to use a Docker image in a private registry as the runtime environment\. The private registry credentials are stored in Secrets Manager\. | -| [Docker Sample](sample-docker.md) | Uses a build image provided by CodeBuild with Docker support to produce a Docker image with Apache Maven\. Pushes the Docker image to a repository in Amazon ECR\. You can also adapt this sample to push the Docker image to Docker Hub\. | -| [Amazon EFS Sample](sample-efs.md) | Shows how to configure a buildspec file so that a CodeBuild project mounts and builds on an Amazon EFS file system\. | -| [GitHub Enterprise Sample](sample-github-enterprise.md) | Uses CodeBuild with GitHub Enterprise as the source repository, with certificates installed and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [GitHub Pull Request and Webhook Filter Sample](sample-github-pull-request.md) | Uses CodeBuild with GitHub as the source repository and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [Bitbucket Pull Request and Webhook Filter Sample](sample-bitbucket-pull-request.md) | Uses CodeBuild with Bitbucket as the source repository and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [Use AWS Config with AWS CodeBuild Sample](how-to-integrate-config.md) | Shows how to set up AWS Config\. Lists which CodeBuild resources are tracked and describes how to look up CodeBuild projects in AWS Config\. | -| [ Host Build Output in an Amazon S3 Bucket ](sample-disable-artifact-encryption.md) | Shows how to create a static website in an Amazon S3 bucket using unencrypted build artifacts\. | -| [ Access Token Sample ](sample-access-tokens.md) | Shows how to use access tokens in CodeBuild to connect to GitHub and Bitbucket\. | -| [ Multiple Input Sources and Output Artifacts Sample ](sample-multi-in-out.md) | Shows how to use multiple input sources and multiple output artifacts in a build project\. | -| [ CodePipeline Integration with Multiple Input Sources and Output Artifacts Sample ](sample-pipeline-multi-input-output.md) | Shows how to use AWS CodePipeline to create a build with multiple input sources and multiple output artifacts\. | -| [Build Badges Sample](sample-build-badges.md) | Shows how to set up CodeBuild with build badges\. | -| [Using Semantic Versioning to Name Build Artifacts Sample](sample-buildspec-artifact-naming.md) | Shows how to use semantic versioning to create an artifact name at build time\. | -| [Build Notifications Sample](sample-build-notifications.md) | Uses Apache Maven to produce a single JAR file\. Sends a build notification to subscribers of an Amazon SNS topic\. | -| [Docker in Custom Image Sample](sample-docker-custom-image.md) | Uses a custom Docker image to produce a Docker image\. | -| [CodeDeploy Sample](sample-codedeploy.md) | Uses Apache Maven to produce a single JAR file\. Uses CodeDeploy to deploy the JAR file to an Amazon Linux instance\. You can also use CodePipeline to build and deploy the sample\. | -| [AWS Lambda Sample](sample-lambda.md) | Uses CodeBuild, Lambda, AWS CloudFormation, and CodePipeline to build and deploy a serverless application that follows the AWS Serverless Application Model \(AWS SAM\) standard\. | -| [Elastic Beanstalk Sample](sample-elastic-beanstalk.md) | Uses Apache Maven to produce a single WAR file\. Uses Elastic Beanstalk to deploy the WAR file to an Elastic Beanstalk instance\. | \ No newline at end of file diff --git a/doc_source/sdk-ref.md b/doc_source/sdk-ref.md deleted file mode 100644 index 07bbdeb..0000000 --- a/doc_source/sdk-ref.md +++ /dev/null @@ -1,18 +0,0 @@ -# AWS SDKs and Tools Reference for CodeBuild - -To use one the AWS SDKs or tools to automate CodeBuild, see the following resources\. - -If you want to use the AWS CLI to run CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -## Supported AWS SDKs and Tools for CodeBuild - -The following AWS SDKs and tools support CodeBuild: -+ The [AWS SDK for C\+\+](https://aws.amazon.com/sdk-for-cpp)\. For more information, see the [Aws::CodeBuild](http://sdk.amazonaws.com/cpp/api/LATEST/namespace_aws_1_1_code_build.html) namespace section of the *AWS SDK for C\+\+ API Reference*\. -+ The [AWS SDK for Go](https://aws.amazon.com/sdk-for-go/)\. For more information, see the [codebuild](http://docs.aws.amazon.com/sdk-for-go/api/service/codebuild/) section of the *AWS SDK for Go API Reference*\. -+ The [AWS SDK for Java](https://aws.amazon.com/sdk-for-java/)\. For more information, see the `com.amazonaws.services.codebuild` and `com.amazonaws.services.codebuild.model` sections of the [AWS SDK for Java API Reference](http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html)\. -+ The [AWS SDK for JavaScript in the Browser](https://aws.amazon.com/sdk-for-browser/) and the [AWS SDK for JavaScript in Node\.js](https://aws.amazon.com/sdk-for-node-js/)\. For more information, see the [Class: AWS\.CodeBuild](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CodeBuild.html) section of the *AWS SDK for JavaScript API Reference*\. -+ The [AWS SDK for \.NET](https://aws.amazon.com/sdk-for-net/)\. For more information, see the [Amazon\.CodeBuild](http://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CodeBuild/NCodeBuild.html) and [Amazon\.CodeBuild\.Model](http://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CodeBuild/NCodeBuildModel.html) namespace sections of the *AWS SDK for \.NET API Reference*\. -+ The [AWS SDK for PHP](https://aws.amazon.com/sdk-for-php/)\. For more information, see the [Namespace Aws\\CodeBuild](http://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.CodeBuild.html) section of the *AWS SDK for PHP API Reference*\. -+ The [AWS SDK for Python \(Boto3\)](https://aws.amazon.com/sdk-for-python/)\. For more information, see the [CodeBuild](https://boto3.readthedocs.io/en/latest/reference/services/codebuild.html) section of the *Boto 3 Documentation*\. -+ The [AWS SDK for Ruby](https://aws.amazon.com/sdk-for-ruby/)\. For more information, see the [Module: Aws::CodeBuild](http://docs.aws.amazon.com/sdkforruby/api/Aws/CodeBuild.html) section of the *AWS SDK for Ruby API Reference*\. -+ The [AWS Tools for PowerShell](https://aws.amazon.com/powershell/)\. For more information, see the [AWS CodeBuild](http://docs.aws.amazon.com/powershell/latest/reference/items/AWS_CodeBuild_cmdlets.html) section of the *AWS Tools for PowerShell Cmdlet Reference*\. \ No newline at end of file diff --git a/doc_source/security-encryption.md b/doc_source/security-encryption.md deleted file mode 100644 index 2ebbea1..0000000 --- a/doc_source/security-encryption.md +++ /dev/null @@ -1,10 +0,0 @@ -# Data Encryption - - Encryption is an important part of CodeBuild security\. Some encryption, such as for data in\-transit, is provided by default and does not require you to do anything\. Other encryption, such as for data at\-rest, you can configure when you create your project or build\. -+ **Encryption of data at\-rest** \- Build artifacts, such as a cache, logs, and build results, are encrypted by default using *customer master keys* \(CMKs\) for Amazon S3 that are managed by the AWS Key Management Service\. If you do not want to use these CMKs, you must create and configure a customer\-managed CMK\. For more information [Creating KMS Keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) and [AWS Key Management Service Concepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html)\. - + You can store the identifier of the AWS KMS key that CodeBuild uses to encrypt the build output artifact in the `CODEBUILD_KMS_KEY_ID` environment variable\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md) - + You can specify a customer\-managed CMK when you create a build project\. For more information, see [Set the Encryption Key Using the Console](create-project.md#encryptionkey-console) and [Set the Encryption Key Using the CLI](create-project.md#encryptionkey-cli)\. - - The Amazon Elastic Block Store volumes of your build fleet are encrypted by default using CMKs managed by AWS\. -+ **Encryption of data in\-transit** \- All communication between customers and CodeBuild and between CodeBuild and its downstream dependencies is protected using SSL connections that are signed using the Signature Version 4 signing process\. All CodeBuild endpoints use SHA\-256 certificates that are managed by AWS Certificate Manager Private Certificate Authority\. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) and [What is ACM PCA](https://docs.aws.amazon.com/acm-pca/latest/userguide/)\. -+ **Build artifact encryption** \- CodeBuild requires access to an AWS KMS CMK in order to encrypt its build output artifacts\. By default, CodeBuild uses an AWS Key Management Service CMK for Amazon S3 in your AWS acccount\. If you do not want to use this CMK, you must create and configure a customer\-managed CMK\. For more information [Creating KMS Keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\. \ No newline at end of file diff --git a/doc_source/security-incident-response.md b/doc_source/security-incident-response.md deleted file mode 100644 index 71870e7..0000000 --- a/doc_source/security-incident-response.md +++ /dev/null @@ -1,7 +0,0 @@ -# Logging and Monitoring in AWS CodeBuild - - Monitoring is an important part of maintaining the reliability, availability, and performance of AWS CodeBuild and your AWS solutions\. You should collect monitoring data from all of the parts of your AWS solution so that you can more easily debug a multi\-point failure, if one occurs\. AWS provides the following tools for monitoring your CodeBuild resources and builds and for responding to potential incidents: - -**Topics** -+ [Logging CodeBuild API Calls with AWS CloudTrail](cloudtrail.md) -+ [Monitoring AWS CodeBuild](monitoring-builds.md) \ No newline at end of file diff --git a/doc_source/security-key-management.md b/doc_source/security-key-management.md deleted file mode 100644 index 4fd6776..0000000 --- a/doc_source/security-key-management.md +++ /dev/null @@ -1,7 +0,0 @@ -# Key Management - - You can protect your content from unauthorized use through encryption\. Store your encryption keys in AWS Secrets Manager, and then give CodeBuild permission to obtain the encryption keys from your Secrets Manager account\. For more information, see [Create and Configure an AWS KMS CMK for CodeBuild](setting-up.md#setting-up-kms), [Create a Build Project in CodeBuild](create-project.md), [Run a Build in CodeBuild](run-build.md), and [Tutorial: Storing and Retrieving a Secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html)\. - - Use the `CODEBUILD_KMS_KEY` environment variable in a build command for your AWS KMS key\. For more information, see [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - - You can use Secrets Manager to protect credentials to a private registry that stores a Docker image used for your runtime environment\. For more information, see [ Private Registry with AWS Secrets Manager Sample for CodeBuild](sample-private-registry.md)\. \ No newline at end of file diff --git a/doc_source/security-traffic-privacy.md b/doc_source/security-traffic-privacy.md deleted file mode 100644 index 77fe65e..0000000 --- a/doc_source/security-traffic-privacy.md +++ /dev/null @@ -1,3 +0,0 @@ -# Traffic Privacy - - You can improve the security of your builds by configuring CodeBuild to use an interface VPC endpoint\. To do this, you do not need an internet gateway, NAT device, or virtual private gateway\. It also is not required to configure PrivateLink, though it is recommended\. For more information, see [Use VPC Endpoints](use-vpc-endpoints-with-codebuild.md)\. For more information about PrivateLink and VPC endpoints, see [AWS PrivateLink](https://aws.amazon.com/privatelink/) and [Accessing AWS Services Through PrivateLink](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Introduction.html#what-is-privatelink)\. \ No newline at end of file diff --git a/doc_source/security.md b/doc_source/security.md deleted file mode 100644 index 809f4c7..0000000 --- a/doc_source/security.md +++ /dev/null @@ -1,15 +0,0 @@ -# Security in AWS CodeBuild - -Cloud security at AWS is the highest priority\. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security\-sensitive organizations\. - -Security and compliance is a shared responsibility between AWS and you\. This shared model can help relieve your operational burden: AWS operates, manages, and controls the components from the host operating system and virtualization layer down to the physical security of the service facilities\. You assume responsibility and management of the guest operating system \(including updates and security patches\) and other associated application software\. You're also responsible for the configuration of the AWS provided security group firewall\. Your responsibilities vary with the services you use, the integration of those services into your IT environment, and applicable laws and regulations\. Therefore, you should carefully consider the services that your organization uses\. For more information, see [Shared Responsibility Model](https://aws.amazon.com/compliance/shared-responsibility-model/)\. - -To learn how to secure your CodeBuild resources, see the following topics\. - -**Topics** -+ [Data Protection in AWS CodeBuild](data-protection.md) -+ [Identity and Access Management in CodeBuild](auth-and-access-control.md) -+ [Logging and Monitoring in AWS CodeBuild](security-incident-response.md) -+ [Compliance Validation for AWS CodeBuild](codebuild-compliance-validation.md) -+ [Resilience in AWS CodeBuild](codebuild-disaster-recovery-resiliency.md) -+ [Infrastructure Security in AWS CodeBuild](infrastructure-security.md) \ No newline at end of file diff --git a/doc_source/setting-up.md b/doc_source/setting-up.md deleted file mode 100644 index 320405e..0000000 --- a/doc_source/setting-up.md +++ /dev/null @@ -1,564 +0,0 @@ -# Advanced Setup - -If you follow the steps in [Getting Started](getting-started.md) to access AWS CodeBuild for the first time, most likely you will not need to reference the information in this topic\. However, as you continue using CodeBuild, you will want to do things such as give IAM groups and users in your organization access to CodeBuild, modify existing service roles in IAM or customer master keys in AWS KMS to access CodeBuild, or set up the AWS CLI across your organization's workstations to access CodeBuild\. This topic describes how to complete the related setup steps\. - -We assume you already have an AWS account\. However, if you do not already have one, go to [http://aws\.amazon\.com](http://aws.amazon.com), choose **Sign In to the Console**, and follow the online instructions\. - -**Topics** -+ [Add CodeBuild Access Permissions to an IAM Group or IAM User](#setting-up-service-permissions-group) -+ [Create a CodeBuild Service Role](#setting-up-service-role) -+ [Create and Configure an AWS KMS CMK for CodeBuild](#setting-up-kms) -+ [Install and Configure the AWS CLI](#setting-up-cli) - -## Add CodeBuild Access Permissions to an IAM Group or IAM User - -To access AWS CodeBuild with an IAM group or IAM user, you must add access permissions\. This section describes how to do this with the IAM console or the AWS CLI\. - -If you will access CodeBuild with your AWS root account \(not recommended\) or an administrator IAM user in your AWS account, then you do not need to follow these instructions\. - -For information about AWS root accounts and administrator IAM users, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) and [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - -**To add CodeBuild access permissions to an IAM group or IAM user \(console\)** - -1. Open the IAM console at [https://console\.aws\.amazon\.com/iam/](https://console.aws.amazon.com/iam/)\. - - You should have already signed in to the AWS Management Console by using one of the following: - + Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. - + An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - + An IAM user in your AWS account with permission to perform the following minimum set of actions: - - ``` - iam:AttachGroupPolicy - iam:AttachUserPolicy - iam:CreatePolicy - iam:ListAttachedGroupPolicies - iam:ListAttachedUserPolicies - iam:ListGroups - iam:ListPolicies - iam:ListUsers - ``` - - For more information, see [Overview of IAM Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. - -1. In the navigation pane, choose **Policies**\. - -1. To add a custom set of AWS CodeBuild access permissions to an IAM group or IAM user, skip ahead to step 4 in this procedure\. - - To add a default set of CodeBuild access permissions to an IAM group or IAM user, choose **Policy Type**, **AWS Managed**, and then do the following: - + To add full access permissions to CodeBuild, select the box named **AWSCodeBuildAdminAccess**\. Then choose **Policy Actions**, **Attach**\. Select the box next to the target IAM group or IAM user, and then choose **Attach Policy**\. Repeat this for the policies named **AmazonS3ReadOnlyAccess** and **IAMFullAccess**\. - + To add access permissions to CodeBuild for everything except build project administration, select the box named **AWSCodeBuildDeveloperAccess**\. Then choose **Policy Actions**, **Attach**\. Select the box next to the target IAM group or IAM user, and then choose **Attach Policy**\. Repeat this for the policy named **AmazonS3ReadOnlyAccess**\. - + To add read\-only access permissions to CodeBuild, select the boxes named **AWSCodeBuildReadOnlyAccess**\. Select the box next to the target IAM group or IAM user, and then choose **Attach Policy**\. Repeat this for the policy named **AmazonS3ReadOnlyAccess**\. - - You have now added a default set of CodeBuild access permissions to an IAM group or IAM user\. Skip the rest of the steps in this procedure\. - -1. Choose **Create Policy**\. - -1. On the **Create Policy** page, next to **Create Your Own Policy**, choose **Select**\. - -1. On the **Review Policy** page, for **Policy Name**, type a name for the policy \(for example, **CodeBuildAccessPolicy**\)\. If you use a different name, substitute it throughout this procedure\. - -1. For **Policy Document**, type the following, and then choose **Create Policy**\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CodeBuildDefaultPolicy", - "Effect": "Allow", - "Action": [ - "codebuild:*", - "iam:PassRole" - ], - "Resource": "*" - }, - { - "Sid": "CloudWatchLogsAccessPolicy", - "Effect": "Allow", - "Action": [ - "logs:FilterLogEvents", - "logs:GetLogEvents" - ], - "Resource": "*" - }, - { - "Sid": "S3AccessPolicy", - "Effect": "Allow", - "Action": [ - "s3:CreateBucket", - "s3:GetObject", - "s3:List*", - "s3:PutObject" - ], - "Resource": "*" - }, - { - "Sid": "S3BucketIdentity", - "Effect": "Allow", - "Action": [ - "s3:GetBucketAcl", - "s3:GetBucketLocation" - ], - "Resource": "*" - } - ] - } - ``` -**Note** -This policy allows access to all CodeBuild actions and to a potentially large number of AWS resources\. To restrict permissions to specific CodeBuild actions, change the value of `codebuild:*` in the CodeBuild policy statement\. For more information, see [Identity and Access Management](auth-and-access-control.md)\. To restrict access to specific AWS resources, change the value of the `Resource` object\. For more information, see [Identity and Access Management](auth-and-access-control.md)\. - -1. In the navigation pane, choose **Groups** or **Users**\. - -1. In the list of groups or users, choose the name of the IAM group or IAM user to which you want to add CodeBuild access permissions\. - -1. For a group, on the group settings page, on the **Permissions** tab, expand **Managed Policies**, and choose **Attach Policy**\. - - For a user, on the user settings page, on the **Permissions** tab, choose **Add permissions**\. - -1. For a group, on the **Attach Policy** page, select **CodeBuildAccessPolicy**, and then choose **Attach Policy**\. - - For a user, on the **Add permisions** page, choose **Attach existing policies directly**\. Select **CodeBuildAccessPolicy**, choose **Next: Reivew**, and then choose **Add permissions**\. - -**To add CodeBuild access permissions to an IAM group or IAM user \(AWS CLI\)** - -1. Make sure you have configured the AWS CLI with the AWS access key and AWS secret access key that correspond to one of the IAM entities, as described in the previous procedure\. For more information, see [Getting Set Up with the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html) in the *AWS Command Line Interface User Guide*\. - -1. To add a custom set of AWS CodeBuild access permissions to an IAM group or IAM user, skip ahead to step 3 in this procedure\. - - To add a default set of CodeBuild access permissions to an IAM group or IAM user, do the following: - - Run one of the following commands, depending on whether you want to add permissions to an IAM group or IAM user: - - ``` - aws iam attach-group-policy --group-name group-name --policy-arn policy-arn - - aws iam attach-user-policy --user-name user-name --policy-arn policy-arn - ``` - - You must run the command three times, replacing *group\-name* or *user\-name* with the IAM group name or IAM user name, and replacing *policy\-arn* once for each of the following policy Amazon Resource Names \(ARNs\): - + To add full access permissions to CodeBuild, use the following policy ARNs: - + `arn:aws:iam::aws:policy/AWSCodeBuildAdminAccess` - + `arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess` - + `arn:aws:iam::aws:policy/IAMFullAccess` - + To add access permissions to CodeBuild for everything except build project administration, use the following policy ARNs: - + `arn:aws:iam::aws:policy/AWSCodeBuildDeveloperAccess` - + `arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess` - + To add read\-only access permissions to CodeBuild, use the following policy ARNs: - + `arn:aws:iam::aws:policy/AWSCodeBuildReadOnlyAccess` - + `arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess` - - You have now added a default set of CodeBuild access permissions to an IAM group or IAM user\. Skip the rest of the steps in this procedure\. - -1. In an empty directory on the local workstation or instance where the AWS CLI is installed, create a file named `put-group-policy.json` or `put-user-policy.json`\. If you use a different file name, substitute it throughout this procedure\. - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CodeBuildAccessPolicy", - "Effect": "Allow", - "Action": [ - "codebuild:*", - "iam:PassRole" - ], - "Resource": "*" - }, - { - "Sid": "CloudWatchLogsAccessPolicy", - "Effect": "Allow", - "Action": [ - "logs:FilterLogEvents", - "logs:GetLogEvents" - ], - "Resource": "*" - }, - { - "Sid": "S3AccessPolicy", - "Effect": "Allow", - "Action": [ - "s3:CreateBucket", - "s3:GetObject", - "s3:List*", - "s3:PutObject" - ], - "Resource": "*" - }, - { - "Sid": "S3BucketIdentity", - "Effect": "Allow", - "Action": [ - "s3:GetBucketAcl", - "s3:GetBucketLocation" - ], - "Resource": "*" - } - ] - } - ``` -**Note** -This policy allows access to all CodeBuild actions and to a potentially large number of AWS resources\. To restrict permissions to specific CodeBuild actions, change the value of `codebuild:*` in the CodeBuild policy statement\. For more information, see [Identity and Access Management](auth-and-access-control.md)\. To restrict access to specific AWS resources, change the value of the related `Resource` object\. For more information, see [Identity and Access Management](auth-and-access-control.md) or the specific AWS service's security documentation\. - -1. Switch to the directory where you saved the file, and then run one of the following commands\. You can use different values for `CodeBuildGroupAccessPolicy` and `CodeBuildUserAccessPolicy`\. If you use different values, substitute them here\. - - For an IAM group: - - ``` - aws iam put-group-policy --group-name group-name --policy-name CodeBuildGroupAccessPolicy --policy-document file://put-group-policy.json - ``` - - For an IAM user: - - ``` - aws iam put-user-policy --user-name user-name --policy-name CodeBuildUserAccessPolicy --policy-document file://put-user-policy.json - ``` - - In the preceding commands, replace *group\-name* or *user\-name* with the name of the target IAM group or IAM user\. - -## Create a CodeBuild Service Role - -You need an AWS CodeBuild service role so that CodeBuild can interact with dependent AWS services on your behalf\. You can create a CodeBuild service role by using the CodeBuild or AWS CodePipeline consoles\. For information, see: -+ [Create a Build Project \(Console\)](create-project.md#create-project-console) -+ [Create a Pipeline That Uses CodeBuild \(CodePipeline Console\)](how-to-create-pipeline.md#how-to-create-pipeline-console) -+ [Add an CodeBuild Build Action to a Pipeline \(CodePipeline Console\)](how-to-create-pipeline.md#how-to-create-pipeline-add) -+ [Change a Build Project's Settings \(Console\)](change-project.md#change-project-console) - -If you do not plan to use these consoles, this section describes how to create a CodeBuild service role with the IAM console or the AWS CLI\. - -**Note** -The service role described on this page contains a policy that grants the minimum permissions required to use CodeBuild\. You might need to add additional permissions depending on your use case\. For example, if you want to use CodeBuild with Amazon Virtual Private Cloud, then the service role you create requires the permissions in the following policy: [Create a CodeBuild Service Role](#setting-up-service-role)\. - -**To create a CodeBuild service role \(console\)** - -1. Open the IAM console at [https://console\.aws\.amazon\.com/iam/](https://console.aws.amazon.com/iam/)\. - - You should have already signed in to the console by using one of the following: - + Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. - + An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. - + An IAM user in your AWS account with permission to perform the following minimum set of actions: - - ``` - iam:AddRoleToInstanceProfile - iam:AttachRolePolicy - iam:CreateInstanceProfile - iam:CreatePolicy - iam:CreateRole - iam:GetRole - iam:ListAttachedRolePolicies - iam:ListPolicies - iam:ListRoles - iam:PassRole - iam:PutRolePolicy - iam:UpdateAssumeRolePolicy - ``` - - For more information, see [Overview of IAM Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the *IAM User Guide*\. - -1. In the navigation pane, choose **Policies**\. - -1. Choose **Create Policy**\. - -1. On the **Create Policy** page, choose **JSON**\. - -1. For the JSON Policy, type the following, and then choose **Review Policy**: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CloudWatchLogsPolicy", - "Effect": "Allow", - "Action": [ - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:PutLogEvents" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "CodeCommitPolicy", - "Effect": "Allow", - "Action": [ - "codecommit:GitPull" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3GetObjectPolicy", - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:GetObjectVersion" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3PutObjectPolicy", - "Effect": "Allow", - "Action": [ - "s3:PutObject" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "ECRPullPolicy", - "Effect": "Allow", - "Action": [ - "ecr:BatchCheckLayerAvailability", - "ecr:GetDownloadUrlForLayer", - "ecr:BatchGetImage" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "ECRAuthPolicy", - "Effect": "Allow", - "Action": [ - "ecr:GetAuthorizationToken" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3BucketIdentity", - "Effect": "Allow", - "Action": [ - "s3:GetBucketAcl", - "s3:GetBucketLocation" - ], - "Resource": - "*" - } - ] - } - ``` -**Note** -This policy contains statements that allow access to a potentially large number of AWS resources\. To restrict AWS CodeBuild to access specific AWS resources, change the value of the `Resource` array\. For more information, see the security documentation for the AWS service\. - -1. On the **Review Policy** page, for **Policy Name**, type a name for the policy \(for example, **CodeBuildServiceRolePolicy**\), and then choose **Create policy**\. -**Note** -If you use a different name, substitute it throughout this procedure\. - -1. In the navigation pane, choose **Roles**\. - -1. Choose **Create role**\. - -1. On the **Create role** page, with **AWS Service** already selected, choose **CodeBuild**, as the service that will use this role, and then choose **Next:Permissions**\. - -1. On the **Attach permissions policies** page, select **CodeBuildServiceRolePolicy**, and then choose **Next: Review**\. - -1. On the **Create role and review** page, for **Role name**, type a name for the role \(for example, **CodeBuildServiceRole**\), and then choose **Create role**\. - -**To create a CodeBuild service role \(AWS CLI\)** - -1. Make sure you have configured the AWS CLI with the AWS access key and AWS secret access key that correspond to one of the IAM entities, as described in the previous procedure\. For more information, see [Getting Set Up with the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html) in the *AWS Command Line Interface User Guide*\. - -1. In an empty directory on the local workstation or instance where the AWS CLI is installed, create two files named `create-role.json` and `put-role-policy.json`\. If you choose different file names, substitute them throughout this procedure\. - - `create-role.json`: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Service": "codebuild.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - } - ``` - - `put-role-policy.json`: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "CloudWatchLogsPolicy", - "Effect": "Allow", - "Action": [ - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:PutLogEvents" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "CodeCommitPolicy", - "Effect": "Allow", - "Action": [ - "codecommit:GitPull" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3GetObjectPolicy", - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:GetObjectVersion" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3PutObjectPolicy", - "Effect": "Allow", - "Action": [ - "s3:PutObject" - ], - "Resource": [ - "*" - ] - }, - { - "Sid": "S3BucketIdentity", - "Effect": "Allow", - "Action": [ - "s3:GetBucketAcl", - "s3:GetBucketLocation" - ], - "Resource": [ - "*" - ] - } - ] - } - ``` -**Note** -This policy contains statements that allow access to a potentially large number of AWS resources\. To restrict AWS CodeBuild to access specific AWS resources, change the value of the `Resource` array\. For more information, see the security documentation for the AWS service\. - -1. Switch to the directory where you saved the preceding files, and then run the following two commands, one at a time, in this order\. You can use different values for `CodeBuildServiceRole` and `CodeBuildServiceRolePolicy`, but be sure to substitute them here\. - - ``` - aws iam create-role --role-name CodeBuildServiceRole --assume-role-policy-document file://create-role.json - ``` - - ``` - aws iam put-role-policy --role-name CodeBuildServiceRole --policy-name CodeBuildServiceRolePolicy --policy-document file://put-role-policy.json - ``` - -## Create and Configure an AWS KMS CMK for CodeBuild - -For AWS CodeBuild to encrypt its build output artifacts, it needs access to an AWS KMS customer master key \(CMK\)\. By default, CodeBuild uses the AWS\-managed CMK for Amazon S3 in your AWS account\. - -If you do not want to use this CMK, you must create and configure a customer\-managed CMK yourself\. This section describes how to do this with the IAM console\. - -For information about CMKs, see [AWS Key Management Service Concepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) and [Creating Keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) in the *AWS KMS Developer Guide*\. - -To configure a CMK for use by CodeBuild, follow the instructions in the "How to Modify a Key Policy" section of [Modifying a Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying.html) in the *AWS KMS Developer Guide*\. Then add the following statements \(between *\#\#\# BEGIN ADDING STATEMENTS HERE \#\#\#* and *\#\#\# END ADDING STATEMENTS HERE \#\#\#*\) to the key policy\. Ellipses \(`...`\) are used for brevity and to help you locate where to add the statements\. Do not remove any statements, and do not type these ellipses into the key policy\. - -``` -{ - "Version": "2012-10-17", - "Id": "...", - "Statement": [ - ### BEGIN ADDING STATEMENTS HERE ### - { - "Sid": "Allow access through Amazon S3 for all principals in the account that are authorized to use Amazon S3", - "Effect": "Allow", - "Principal": { - "AWS": "*" - }, - "Action": [ - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:DescribeKey" - ], - "Resource": "*", - "Condition": { - "StringEquals": { - "kms:ViaService": "s3.region-ID.amazonaws.com", - "kms:CallerAccount": "account-ID" - } - } - }, - { - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::account-ID:role/CodeBuild-service-role" - }, - "Action": [ - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncrypt*", - "kms:GenerateDataKey*", - "kms:DescribeKey" - ], - "Resource": "*" - }, - ### END ADDING STATEMENTS HERE ### - { - "Sid": "Enable IAM User Permissions", - ... - }, - { - "Sid": "Allow access for Key Administrators", - ... - }, - { - "Sid": "Allow use of the key", - ... - }, - { - "Sid": "Allow attachment of persistent resources", - ... - } - ] -} -``` -+ *region\-ID* represents the ID of the AWS region where the Amazon S3 buckets associated with CodeBuild are located \(for example, `us-east-1`\)\. -+ *account\-ID* represents the ID of the of the AWS account that owns the CMK\. -+ *CodeBuild\-service\-role* represents the name of the CodeBuild service role you created or identified earlier in this topic\. - -**Note** -To create or configure a CMK through the IAM console, you must first sign in to the AWS Management Console by using one of the following: -Your AWS root account\. This is not recommended\. For more information, see [The Account Root User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html) in the *IAM User Guide*\. -An administrator IAM user in your AWS account\. For more information, see [Creating Your First IAM Admin User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) in the *IAM User Guide*\. -An IAM user in your AWS account with permission to create or modify the CMK\. For more information, see [Permissions Required to Use the AWS KMS Console](https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#console-permissions) in the *AWS KMS Developer Guide*\. - -## Install and Configure the AWS CLI - -To access AWS CodeBuild, you can use the AWS CLI with—or instead of—the CodeBuild console, the CodePipeline console, or the AWS SDKs\. To install and configure the AWS CLI, see [Getting Set Up with the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html) in the *AWS Command Line Interface User Guide*\. - -1. Run the following command to confirm whether your installation of the AWS CLI supports CodeBuild: - - ``` - aws codebuild list-builds - ``` - - If successful, information similar to the following will appear in the output: - - ``` - { - "ids": [] - } - ``` - - The empty square brackets indicate that you have not yet run any builds\. - -1. If an error is output, you must uninstall your current version of the AWS CLI and then install the latest version\. For more information, see [Uninstalling the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-uninstall.html) and [Installing the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the *AWS Command Line Interface User Guide*\. \ No newline at end of file diff --git a/doc_source/stop-build.md b/doc_source/stop-build.md deleted file mode 100644 index 15966d8..0000000 --- a/doc_source/stop-build.md +++ /dev/null @@ -1,41 +0,0 @@ -# Stop a Build in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI,or AWS SDKs to stop a build in AWS CodeBuild\. - -**Topics** -+ [Stop a Build \(Console\)](#stop-build-console) -+ [Stop a Build \(AWS CLI\)](#stop-build-cli) -+ [Stop a Build \(AWS SDKs\)](#stop-build-sdks) - -## Stop a Build \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Do one of the following: - + If the ***build\-project\-name*:*build\-ID*** page is displayed, choose **Stop build**\. - + In the navigation pane, choose **Build history**\. In the list of builds, select the box for the build, and then choose **Stop build**\. - + In the navigation pane, choose **Build projects**\. In the list of build projects, in the **Name** column, choose the link for the build project's name\. In the list of builds, select the box for the build, and then choose **Stop build**\. - -**Note** -By default, only the most recent 100 builds or build projects are displayed\. To view more builds or build projects, choose the gear icon, and then choose a different value for **Builds per page** or **Projects per page** or use the back and forward arrows\. -If AWS CodeBuild cannot successfully stop a build \(for example, if the build process is already complete\), the **Stop** button is disabled or might not appear\. - -## Stop a Build \(AWS CLI\) -+ Run the stop\-build command: - - ``` - aws codebuild stop-build --id id - ``` - - In the preceding command, replace the following placeholder: - + *id*: Required string\. The ID of the build to stop\. To get a list of build IDs, see the following topics: - + [View a List of Build IDs \(AWS CLI\)](view-build-list.md#view-build-list-cli) - + [View a List of Build IDs for a Build Project \(AWS CLI\)](view-builds-for-project.md#view-builds-for-project-cli) - - If AWS CodeBuild successfully stops the build, the `buildStatus` value in the `build` object in the output is `STOPPED`\. - - If CodeBuild cannot successfully stop the build \(for example, if the build is already complete\), the `buildStatus` value in the `build` object in the output is the final build status \(for example, `SUCCEEDED`\)\. - -## Stop a Build \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/trigger-create.md b/doc_source/trigger-create.md deleted file mode 100644 index 2c09fef..0000000 --- a/doc_source/trigger-create.md +++ /dev/null @@ -1,39 +0,0 @@ -# Create CodeBuild Triggers - - You can create a trigger on a project to schedule a build once every hour, day, or week\. You can also create a trigger using a custom rule with an Amazon CloudWatch cron expression\. For example, using a cron expression, you can schedule a build at a specific time every weekday\. - - You create a trigger after you create a project\. - -**To create a trigger** - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. Choose the link for the build project to which you want to add a trigger, and then choose the **Build triggers** tab\. -**Note** -By default, the 100 most recent build projects are displayed\. To view more build projects, choose the gear icon, and then choose a different value for **Projects per page** or use the back and forward arrows\. - -1. Choose **Create trigger**\. - -1. Enter a name in **Trigger name**\. - -1. From the **Frequency** drop\-down list, choose the frequency for your trigger\. If you want to create a frequency using a cron expression, choose **Custom**\. - -1. Specify the parameters for the frequency of your trigger\. You can type the first few characters of your selections in the text box to filter drop\-down menu items\. -**Note** - Start hours and minutes are zero\-based\. The start minute is a number between zero and 59\. The start hour is a number between zero and 23\. For example, a daily trigger that starts every day at 12:15 P\.M\. has a start hour of 12 and a start minute of 15\. A daily trigger that starts every day at midnight has a start hour of zero and a start minute of zero\. A daily trigger that starts every day at 11:59 P\.M\. has a start hour of 23 and a start minute of 59\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/trigger-create.html) - -1. Select **Enable this trigger** to enable the trigger\. - -1. \(Optional\) Expand **Advanced section**\. In **Source version**, type a version of your source\. - + For Amazon S3, type the version ID that corresponds to the version of the input artifact you want to build\. If **Source version** is left blank, the latest version is used\. - + For AWS CodeCommit, type a commit ID\. If **Source version** is left blank, the default branch's HEAD commit ID is used\. - + For GitHub or GitHub Enterprise, type a commit ID, a pull request ID, a branch name, or a tag name that corresponds to the version of the source code you want to build\. If you specify a pull request ID, it must use the format `pr/pull-request-ID` \(for example, `pr/25`\)\. If you specify a branch name, the branch's HEAD commit ID is used\. If **Source version** is blank, the default branch's HEAD commit ID is used\. - + For Bitbucket, type a commit ID, a branch name, or a tag name that corresponds to the version of the source code you want to build\. If you specify a branch name, the branch's HEAD commit ID is used\. If **Source version** is blank, the default branch's HEAD commit ID is used\. - -1. \(Optional\) Specify a timeout between 5 minutes and 480 minutes \(8 hours\)\. This value specifies how long AWS CodeBuild attempts a build before it stops\. If **Hours** and **Minutes** are left blank, the default timeout value specified in the project is used\. - -1. Choose **Create trigger**\. \ No newline at end of file diff --git a/doc_source/triggers-edit.md b/doc_source/triggers-edit.md deleted file mode 100644 index ab92730..0000000 --- a/doc_source/triggers-edit.md +++ /dev/null @@ -1,28 +0,0 @@ -# Edit CodeBuild Triggers - - You can edit a trigger on a project to schedule a build once every hour, day, or week\. You can also edit a trigger to use a custom rule with an Amazon CloudWatch cron expression\. For example, using a cron expression, you can schedule a build at a specific time on every weekday\. For information about creating a trigger, see [Create CodeBuild Triggers](trigger-create.md)\. - - To edit a trigger: - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. - -1. Choose the link for the build project you want to change, and then choose the **Build triggers** tab\. -**Note** -By default, the 100 most recent build projects are displayed\. To view more build projects, choose the gear icon, and then choose a different value for **Projects per page** or use the back and forward arrows\. - -1. Choose the radio button next to the trigger you want to change, and then choose **Edit**\. - -1. From the **Frequency** drop\-down list, choose the frequency for your trigger\. If you want to create a frequency using a cron expression, choose **Custom**\. - -1. Specify the parameters for the frequency of your trigger\. You can type the first few characters of your selections in the text box to filter drop\-down menu items\. -**Note** - Start hours and minutes are zero\-based\. The start minute is a number between zero and 59\. The start hour is a number between zero and 23\. For example, a daily trigger that starts every day at 12:15 P\.M\. has a start hour of 12 and a start minute of 15\. A daily trigger that starts every day at midnight has a start hour of zero and a start minute of zero\. A daily trigger that starts every day at 11:59 P\.M\. has a start hour of 23 and a start minute of 59\. -**** -[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/codebuild/latest/userguide/triggers-edit.html) - -1. Select **Enable this trigger** to enable the trigger\. - -**Note** -You can use the Amazon CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/) to edit source version, timeout, and other options that are not available in AWS CodeBuild\. \ No newline at end of file diff --git a/doc_source/troubleshooting.md b/doc_source/troubleshooting.md deleted file mode 100644 index af475c8..0000000 --- a/doc_source/troubleshooting.md +++ /dev/null @@ -1,467 +0,0 @@ -# Troubleshooting CodeBuild - -Use the information in this topic to help you identify, diagnose, and address issues\. - -**Topics** -+ [Error: "CodeBuild is not authorized to perform: sts:AssumeRole" when creating or updating a build project](#troubleshooting-assume-role) -+ [Error: "This build image requires selecting at least one runtime version\."](#troubleshooting-build-must-specify-runtime) -+ [Error: "Cannot connect to the Docker daemon" when running a build](#troubleshooting-cannot-connect-to-docker-daemon) -+ [Warning: "Skipping install of runtimes\. Runtime version selection is not supported by this build image" when running a build](#troubleshooting-skipping-all-runtimes-warning) -+ [Error: "The bucket you are attempting to access must be addressed using the specified endpoint" when running a build](#troubleshooting-input-bucket-different-region) -+ [Error: "error calling GetBucketAcl: either the bucket owner has changed or the service role no longer has permission to called s3:GetBucketAcl"](#troubleshooting-calling-bucket-error) -+ [Error: "Failed to upload artifacts: Invalid arn" when running a build](#troubleshooting-output-bucket-different-region) -+ [Error: "Unable to Locate Credentials"](#troubleshooting-versions) -+ [Earlier Commands in Buildspec Files Are Not Recognized by Later Commands](#troubleshooting-build-spec-commands) -+ [Apache Maven Builds Reference Artifacts from the Wrong Repository](#troubleshooting-maven-repos) -+ [Build Commands Run as root by Default](#troubleshooting-root-build-commands) -+ [The Bourne Shell \(sh\) Must Exist in Build Images](#troubleshooting-sh-build-images) -+ [Error: "CodeBuild is experiencing an issue" when running a build](#troubleshooting-large-env-vars) -+ [Error: "BUILD\_CONTAINER\_UNABLE\_TO\_PULL\_IMAGE" when using a custom build image](#troubleshooting-unable-to-pull-image) -+ [Builds Might Fail When File Names Have Non\-U\.S\. English Characters](#troubleshooting-utf-8) -+ [Builds Might Fail When Getting Parameters from Amazon EC2 Parameter Store](#troubleshooting-parameter-store) -+ [Cannot Access Branch Filter in the CodeBuild Console](#troubleshooting-webhook-filter) -+ [Procedures in This Guide Do Not Match the CodeBuild Console](#troubleshooting-old-console) -+ ["Access denied" error message when attempting to download cache](#troubleshooting-dependency-caching) -+ [Error: "Unable to download cache: RequestError: send request failed caused by: x509: failed to load system roots and no roots provided"](#troubleshooting-cache-image) -+ [Error: "Unable to download certificate from S3\. AccessDenied"](#troubleshooting-certificate-in-S3) -+ [Error: "Git Clone Failed: unable to access `'your-repository-URL'`: SSL certificate problem: self signed certificate"](#troubleshooting-self-signed-certificate) -+ [Error: "The policy's default version was not created by enhanced zero click role creation or was not the most recent version created by enhanced zero click role creation\."](#enhanced-zero-click-role-creation) -+ [Error: "Build container found dead before completing the build\. Build container died because it was out of memory, or the Docker image is not supported\. ErrorCode: 500"](#windows-server-core-version) -+ [Cannot view build success or failure](#no-status-when-build-triggered) -+ [Cannot find and select the base image of the Windows Server Core 2016 platform](#windows-image-not-available) -+ [RequestError timeout error when running CodeBuild in a proxy server](#code-request-timeout-error) -+ [Error: "QUEUED: INSUFFICIENT\_SUBNET" when a build in a build queue fails](#queued-insufficient-subnet-error) - -## Error: "CodeBuild is not authorized to perform: sts:AssumeRole" when creating or updating a build project - -**Issue:** When you try to create or update a build project, you receive the following error: "Code:InvalidInputException, Message:CodeBuild is not authorized to perform: sts:AssumeRole on arn:aws:iam::*account\-ID*:role/*service\-role\-name*"\. - - **Possible causes:** -+ The AWS Security Token Service \(AWS STS\) has been deactivated for the AWS region where you are attempting to create or update the build project\. -+ The AWS CodeBuild service role associated with the build project does not exist or does not have sufficient permissions to trust CodeBuild\. - - **Recommended solutions:** -+ Make sure AWS STS is activated for the AWS region where you are attempting to create or update the build project\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*\. -+ Make sure the target CodeBuild service role exists in your AWS account\. If you are not using the console, make sure you did not misspell the Amazon Resource Name \(ARN\) of the service role when you created or updated the build project\. -+ Make sure the target CodeBuild service role has sufficient permissions to trust CodeBuild\. For more information, see the trust relationship policy statement in [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - -## Error: "This build image requires selecting at least one runtime version\." - -**Issue:** When you run a build, the `DOWNLOAD_SOURCE` build phase fails with the error "YAML\_FILE\_ERROR: This build image requires selecting at least one runtime version\." - -**Possible cause:** Your build uses version 2\.0 or later of the Ubuntu standard image and a runtime is not specified in the buildspec file\. - -**Recommended solution:** If you use the `aws/codebuild/standard:2.0` CodeBuild managed image, you must specify a runtime version in the `runtime-versions` section of the buildspec file\. For example, you might use the following buildspec file for a project that uses PHP: - -``` -version: 0.2 - -phases: - install: - runtime-versions: - php: 7.3 - build: - commands: - - php --version -artifacts: - files: - - README.md -``` - -**Note** - If you specify a `runtime-versions` section and use an image other than Ubuntu Standard Image 2\.0 or later, or the Amazon Linux 2 \(AL2\) standard image 1\.0 or later, the build issues the warning, "Skipping install of runtimes\. Runtime version selection is not supported by this build image\." - - For more information, see [Specify Runtime Versions in the Buildspec File](build-spec-ref.md#runtime-versions-buildspec-file)\. - -## Error: "Cannot connect to the Docker daemon" when running a build - -**Issue: **Your build fails and you receive an error similar to `Cannot connect to the Docker daemon at unix:/var/run/docker.sock. Is the docker daemon running?` in the build log\. - -**Possible cause: **You are not running your build in privileged mode\. - -**Recommended solution: ** Run your build in privileged mode: - -1. Open the CodeBuild console at [https://console\.aws\.amazon\.com/codebuild/](https://console.aws.amazon.com/codebuild/)\. - -1. In the navigation pane, choose **Build projects**, and then choose your build project\. - -1. From **Edit**, choose **Environment**\. - -1. Choose **Override images**, and then choose **Environment**\. - -1. Specify your environment image, operating system, runtime, and image\. These should match your settings for the build that failed\. - -1. Select **Privileged**\. - -1. Choose **Update environment**\. - -1. Choose **Start build** to retry your build\. - -## Warning: "Skipping install of runtimes\. Runtime version selection is not supported by this build image" when running a build - -**Issue:** When you run a build, the build log contains the warning, "Skipping install of runtimes\. Runtime version selection is not supported by this build image\." - -**Possible cause:** Your build does not use version 2\.0 or later of the Ubuntu standard image and a runtime is specified in a `runtime-versions` section in your buildspec file\. - -**Recommended solution:** Be sure your buildspec file does not contain a `runtime-versions` section\. The `runtime-versions` section is only required if you use the Ubuntu standard image version 2\.0 or higher\. - -## Error: "The bucket you are attempting to access must be addressed using the specified endpoint" when running a build - -**Issue:** When you run a build, the `DOWNLOAD_SOURCE` build phase fails with the error "The bucket you are attempting to access must be addressed using the specified endpoint\. Please send all future requests to this endpoint\." - -**Possible cause:** Your pre\-built source code is stored in an Amazon S3 bucket, and that bucket is in a different AWS region than the AWS CodeBuild build project\. - -**Recommended solution:** Update the build project's settings to point to a bucket that contains your pre\-built source code, and that bucket is in the same region as the build project\. - -## Error: "error calling GetBucketAcl: either the bucket owner has changed or the service role no longer has permission to called s3:GetBucketAcl" - -**Issue:** When you run a build, you receive an error about a change in ownership of an Amazon S3 bucket and `GetBucketAcl` permissions\. - -**Possible cause:** You added the `s3:GetBucketACL` and `s3:GetBucketLocation` permissions to your IAM role\. These permissions secure your project's Amazon S3 bucket and ensure that only you can access it\. After adding these permissions, the owner of the Amazon S3 bucket changed\. - -**Recommended solution:** Verify you are an owner of the Amazon S3 bucket, and then add permissions to your IAM role again\. For more information, see [Secure Access to Amazon S3 Buckets](auth-and-access-control-iam-access-control-identity-based.md#secure-s3-buckets)\. - -## Error: "Failed to upload artifacts: Invalid arn" when running a build - -**Issue:** When you run a build, the `UPLOAD_ARTIFACTS` build phase fails with the error "Failed to upload artifacts: Invalid arn"\. - -**Possible cause:** Your Amazon S3 output bucket \(the bucket where AWS CodeBuild stores its output from the build\) is in a different AWS region than the CodeBuild build project\. - -**Recommended solution:** Update the build project's settings to point to an output bucket that is in the same region as the build project\. - -## Error: "Unable to Locate Credentials" - -**Issue:** When you try to run the AWS CLI, use an AWS SDK, or call another similar component as part of a build, you get build errors that are directly related to the AWS CLI, AWS SDK, or component\. For example, you may get a build error such as "unable to locate credentials\." - - **Possible causes:** -+ The version of the AWS CLI, AWS SDK, or component in the build environment is incompatible with AWS CodeBuild\. -+ You are running a Docker container within a build environment that uses Docker, and that Docker container does not have access to the necessary AWS credentials by default\. - - **Recommended solutions:** -+ Make sure your build environment has the following version or higher of the AWS CLI, AWS SDK, or component\. - + AWS CLI: 1\.10\.47 - + AWS SDK for C\+\+: 0\.2\.19 - + AWS SDK for Go: 1\.2\.5 - + AWS SDK for Java: 1\.11\.16 - + AWS SDK for JavaScript: 2\.4\.7 - + AWS SDK for PHP: 3\.18\.28 - + AWS SDK for Python \(Boto3\): 1\.4\.0 - + AWS SDK for Ruby: 2\.3\.22 - + Botocore: 1\.4\.37 - + CoreCLR: 3\.2\.6\-beta - + Node\.js: 2\.4\.7 -+ If you need to run a Docker container in a build environment and that container requires AWS credentials, you must pass through the credentials from the build environment to the container\. In your buildspec file, include a Docker `run` command such as the following, which in this example uses the `aws s3 ls` command to list your available Amazon S3 buckets\. The `-e` option passes through the necessary environment variables for your container to access AWS credentials\. - - ``` - docker run -e AWS_DEFAULT_REGION -e AWS_CONTAINER_CREDENTIALS_RELATIVE_URI your-image-tag aws s3 ls - ``` -+ If you are building a Docker image and the build requires AWS credentials \(for example, to download a file from Amazon S3\), you must pass through the credentials from the build environment to the Docker build process as follows\. - - 1. In your source code's Dockerfile for the Docker image, specify the following `ARG` instructions\. - - ``` - ARG AWS_DEFAULT_REGION - ARG AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - ``` - - 1. In your buildspec file, include a Docker `build` command such as the following\. The `--build-arg` options will set the necessary environment variables for your Docker build process to access the AWS credentials\. - - ``` - docker build --build-arg AWS_DEFAULT_REGION=$AWS_DEFAULT_REGION --build-arg AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=$AWS_CONTAINER_CREDENTIALS_RELATIVE_URI -t your-image-tag . - ``` - -## Earlier Commands in Buildspec Files Are Not Recognized by Later Commands - -**Issue:** The results of one or more commands in your buildspec file are not recognized by later commands in the same buildspec file\. For example, a command might set a local environment variable, but a command run later might fail to get the value of that local environment variable\. - -**Possible cause:** In buildspec file version 0\.1, AWS CodeBuild runs each command in a separate instance of the default shell in the build environment\. This means that each command runs in isolation from all other commands\. By default, then, you cannot run a single command that relies on the state of any previous commands\. - -**Recommended solutions:** We recommend you use build spec version 0\.2, which solves this issue\. If you must use build spec version 0\.1 for some reason, we recommend using the shell command chaining operator \(for example, `&&` in Linux\) to combine multiple commands into a single command\. Or include a shell script in your source code that contains multiple commands, and then call that shell script from a single command in the buildspec file\. For more information, see [Shells and Commands in Build Environments](build-env-ref-cmd.md) and [Environment Variables in Build Environments](build-env-ref-env-vars.md)\. - -## Apache Maven Builds Reference Artifacts from the Wrong Repository - -**Issue:** When you use Maven with an AWS CodeBuild provided Java build environment, Maven pulls build and plugin dependencies from the secure central Maven repository at [https://repo1\.maven\.org/maven2](https://repo1.maven.org/maven2)\. This happens even if your build project's `pom.xml` file explicitly declares other locations to use instead\. - -**Possible cause:** CodeBuild provided Java build environments include a file named `settings.xml` that is preinstalled in the build environment's `/root/.m2` directory\. This `settings.xml` file contains the following declarations, which instruct Maven to always pull build and plugin dependencies from the secure central Maven repository at [https://repo1\.maven\.org/maven2](https://repo1.maven.org/maven2)\. - -``` - - - securecentral - - - - securecentral - - - central - https://repo1.maven.org/maven2 - - true - - - - - - central - https://repo1.maven.org/maven2 - - true - - - - - - -``` - -**Recommended solution:** Do the following: - -1. Add a `settings.xml` file to your source code\. - -1. In this `settings.xml` file, use the preceding `settings.xml` format as a guide to declare the repositories you want Maven to pull the build and plugin dependencies from instead\. - -1. In the `install` phase of your build project, instruct CodeBuild to copy your `settings.xml` file to the build environment's `/root/.m2` directory\. For example, consider the following snippet from a `buildspec.yml` file that demonstrates this behavior\. - - ``` - version 0.2 - - phases: - install: - commands: - - cp ./settings.xml /root/.m2/settings.xml - ``` - -## Build Commands Run as root by Default - -**Issue:** AWS CodeBuild runs your build commands as the root user\. This happens even if your related build image's Dockerfile sets the `USER` instruction to a different user\. - -**Cause:** CodeBuild runs all build commands as the root user by default\. - -**Recommended solution:** None\. - -## The Bourne Shell \(sh\) Must Exist in Build Images - -**Issue:** You are using a build image that is not provided by AWS CodeBuild, and your builds fail with the message "build container found dead before completing the build\." - -**Possible cause:**The Bourne shell \(`sh`\) is not included in your build image\. CodeBuild needs `sh` to run build commands and scripts\. - -**Recommended solution:** If `sh` in not present in your build image, be sure to include it before you start any more builds that use your image\. \(CodeBuild already includes `sh` in its build images\.\) - -## Error: "CodeBuild is experiencing an issue" when running a build - -**Issue:** When you try to run a build project, you receive the following error during the build's `PROVISIONING` phase: "CodeBuild is experiencing an issue\." - -**Possible cause:** Your build is using environment variables that are too large for AWS CodeBuild\. CodeBuild can raise errors once the length of all environment variables \(all names and values added together\) reach a combined maximum of around 5,500 characters\. - -**Recommended solution:** Use Amazon EC2 Systems Manager Parameter Store to store large environment variables and then retrieve them from your buildspec file\. Amazon EC2 Systems Manager Parameter Store can store an individual environment variable \(name and value added together\) that is a combined 4,096 characters or less\. To store large environment variables, see [Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and [Systems Manager Parameter Store Console Walkthrough](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-walk.html#sysman-paramstore-console) in the *Amazon EC2 Systems Manager User Guide*\. To retrieve them, see the `parameter-store` mapping in [Build Spec Syntax](build-spec-ref.md#build-spec-ref-syntax)\. - -## Error: "BUILD\_CONTAINER\_UNABLE\_TO\_PULL\_IMAGE" when using a custom build image - -**Issue:** When you try to run a build that uses a custom build image, the build fails with the error `BUILD_CONTAINER_UNABLE_TO_PULL_IMAGE`\. - - **Possible causes:** -+ The build image's overall uncompressed size is larger than the build environment compute type's available disk space\. To check your build image's size, use Docker to run the `docker images REPOSITORY:TAG` command\. For a list of available disk space by compute type, see [Build Environment Compute Types](build-env-ref-compute-types.md)\. -+ AWS CodeBuild does not have permission to pull the build image from your Amazon Elastic Container Registry \(Amazon ECR\)\. -+ The Amazon ECR image you requested is not available in the region that your AWS account is using\. - - **Recommended solutions:** -+ Use a larger compute type with more available disk space, or reduce the size of your custom build image\. -+ Update the permissions in your repository in Amazon ECR so that CodeBuild can pull your custom build image into the build environment\. For more information, see the [Amazon ECR Sample](sample-ecr.md)\. -+ Use an Amazon ECR image that is in the same region as the one your AWS account is using\. - -## Builds Might Fail When File Names Have Non\-U\.S\. English Characters - -**Issue:** When you run a build that uses files with file names containing non\-US English characters \(for example, Chinese characters\), the build fails\. - -**Possible cause:** : Build environments provided by AWS CodeBuild have their default locale set to `POSIX`\. `POSIX` localization settings are less compatible with CodeBuild and file names that contain non\-US English characters and can cause related builds to fail\. - -**Recommended solution:** Add the following commands to the `pre_build` section of your buildspec file\. These commands make the build environment use US English UTF\-8 for its localization settings, which is more compatible with CodeBuild and file names that contain non\-US English characters\. - -For build environments based on Ubuntu: - -``` -pre_build: - commands: - - export LC_ALL="en_US.UTF-8" - - locale-gen en_US en_US.UTF-8 - - dpkg-reconfigure locales -``` - -For build environments based on Amazon Linux: - -``` -pre_build: - commands: - - export LC_ALL="en_US.utf8" -``` - -## Builds Might Fail When Getting Parameters from Amazon EC2 Parameter Store - -**Issue:** When a build tries to get the value of one or more parameters stored in Amazon EC2 Parameter Store, the build fails in the `DOWNLOAD_SOURCE` phase with the following error: "Parameter does not exist\." - -**Possible cause:** The service role the build project relies on does not have permission to call the `ssm:GetParameters` action or the build project uses a service role that is generated by AWS CodeBuild and allows calling the `ssm:GetParameters` action, but the parameters have names that do not start with `/CodeBuild/`\. - - **Recommended solutions:** -+ If the service role was not generated by CodeBuild, update its definition to allow CodeBuild to call the `ssm:GetParameters` action\. For example, the following policy statement allows calling the `ssm:GetParameters` action to get parameters with names starting with `/CodeBuild/`: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Action": "ssm:GetParameters", - "Effect": "Allow", - "Resource": "arn:aws:ssm:REGION_ID:ACCOUNT_ID:parameter/CodeBuild/*" - } - ] - } - ``` -+ If the service role was generated by CodeBuild, update its definition to allow CodeBuild to access parameters in Amazon EC2 Parameter Store with names other than those starting with `/CodeBuild/`\. For example, the following policy statement allows calling the `ssm:GetParameters` action to get parameters with the specified name: - - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Action": "ssm:GetParameters", - "Effect": "Allow", - "Resource": "arn:aws:ssm:REGION_ID:ACCOUNT_ID:parameter/PARAMETER_NAME" - } - ] - } - ``` - -## Cannot Access Branch Filter in the CodeBuild Console - -**Issue:** The branch filter option is not available in the console when you create or update an AWS CodeBuild project\. - - **Possible cause:** The branch filter option is deprecated\. It has been replaced by webhook filter groups, which provide more control over the webhook events that trigger a new CodeBuild build\. - -**Recommended solution:** To migrate a branch filter created prior to the introduction of webhook filters, create a webhook filter groups with a `HEAD_REF` filter with the regular expression `^refs/heads/branchName$`\. For example, if your branch filter regular expression was `^branchName$`, then the updated regular expression you put in the `HEAD_REF` filter is `^refs/heads/branchName$`\. For more information, see [Filter BitBucket Webhook Events \(Console\)](sample-bitbucket-pull-request.md#sample-bitbucket-pull-request-filter-webhook-events-console) and [Filter GitHub Webhook Events \(Console\)](sample-github-pull-request.md#sample-github-pull-request-filter-webhook-events-console)\. - -## Procedures in This Guide Do Not Match the CodeBuild Console - -**Issue:** This guide supports procedures in the new console design\. - - **Possible cause:** You are using the old console design\. This guide supports the new consolde design\. If you choose to use the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\. To access help in the new console, choose the information icon\. - -**Recommended solution:** Use the latest console design\. - -## "Access denied" error message when attempting to download cache - -**Issue:** When attempting to download the cache on a build project that has cache enabled, you receive the following generic error: "Access denied"\. - - **Possible causes:** -+ You have just configured caching as part of your build project\. -+ The cache has recently been invalidated via the `InvalidateProjectCache` API\. -+ The service role being used by CodeBuild does not have `s3:GetObject` and `s3:PutObject` permissions to the Amazon S3 bucket that is holding the cache\. - -**Recommended solution:** For first time use, it's normal to see this immediately after updating the cache configuration\. If this error persists, then you should check to see if your service role has `s3:GetObject` and `s3:PutObject` permissions to the Amazon S3 bucket that is holding the cache\. For more information, see [Specifying S3 permissions\.](https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html) - -## Error: "Unable to download cache: RequestError: send request failed caused by: x509: failed to load system roots and no roots provided" - -**Issue:** When you try to run a build project, the build fails with the error: "RequestError: send request failed caused by: x509: failed to load system roots and no roots provided\." - - **Possible cause:** You configured caching as part of your build project and are using an older Docker image that includes an expired root certificate\. - - **Recommended solution:** Update the Docker image that is being used in your AWS CodeBuild the project\. For more information, see [Docker Images Provided by CodeBuild](build-env-ref-available.md)\. - -## Error: "Unable to download certificate from S3\. AccessDenied" - -**Issue:** When you try to run a build project, the build fails with the error "Unable to download certificate from S3\. AccessDenied"\. - - **Possible causes:** -+ You have chosen the wrong S3 bucket for your certificate\. -+ You have entered the wrong object key for your certificate\. - - **Recommended solutions:** -+ Edit your project\. For **Bucket of certificate**, choose the S3 bucket where your SSL certificate is stored\. -+ Edit your project\. For **Object key of certificate**, type the name of your S3 object key\. - -## Error: "Git Clone Failed: unable to access `'your-repository-URL'`: SSL certificate problem: self signed certificate" - -**Issue:** When you try to run a build project, the build fails with the error "Git Clone Failed: unable to access `'your-repository-URL'`: SSL certificate problem: self signed certificate\." - - **Possible cause:** Your source repository has a self\-signed certificate, but you have not chosen to install the certificate from your S3 bucket as part of your build project\. - - **Recommended solutions:** -+ Edit your project\. For **Certificate**, choose **Install certificate from S3**\. For **Bucket of certificate**, choose the S3 bucket where your SSL certificate is stored\. For **Object key of certificate**, type the name of your S3 object key\. -+ Edit your project\. Select **Insecure SSL** to ignore SSL warnings while connecting to your GitHub Enterprise project repository\. -**Note** -We recommend that you use **Insecure SSL** for testing only\. It should not be used in a production environment\. - -## Error: "The policy's default version was not created by enhanced zero click role creation or was not the most recent version created by enhanced zero click role creation\." - -**Issue:** When you try to update a project in the console, the update failed with the error: "The policy's default version was not created by enhanced zero click role creation or was not the most recent version created by enhanced zero click role creation\." - - **Possible causes:** -+ You have manually updated the policies attached to the target AWS CodeBuild service role\. -+ You have selected a previous version of a policy attached to the target CodeBuild service role\. - - **Recommended solutions:** -+ Edit your CodeBuild project, and clear **Allow CodeBuild to modify this service role so it can be used with this build project**\. Manually update the target CodeBuild service role to have sufficient permissions\. For more information, see [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. -+ Edit your CodeBuild project, and select **Create a role**\. - -## Error: "Build container found dead before completing the build\. Build container died because it was out of memory, or the Docker image is not supported\. ErrorCode: 500" - - **Issue:** When you try to use a Microsoft Windows or Linux container in AWS CodeBuild an error occurs during the PROVISIONING phase\. - - **Possible causes:** -+ The Container OS version is not supported by CodeBuild\. -+ `HTTP_PROXY`, `HTTPS_PROXY`, or both are specified in the container\. - - **Recommended solutions:** -+ For Microsoft Windows, use a Windows container with a Container OS that is version microsoft/windowsservercore:10\.0\.x\. For example, microsoft/windowsservercore:10\.0\.14393\.2125\. -+ For Linux, clear the `HTTP_PROXY` and `HTTPS_PROXY` settings in your Docker image, or specify the VPC configuration in you build project\. - -## Cannot view build success or failure - -**Issue:** You cannot see the success or failure of a retried build\. - -**Possible cause:** The option to report your build's status is not enabled\. - -**Recommended solutions:** Enable **Report build status** when you create or update a CodeBuild project\. This option tells CodeBuild to report back the status when you trigger a build\. For more information, see [reportBuildStatus](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ProjectSource.html#CodeBuild-Type-ProjectSource-reportBuildStatus)\. - -## Cannot find and select the base image of the Windows Server Core 2016 platform - -**Issue:** You cannot find or select the base image of the Windows Server Core 2016 platform\. - -**Possible cause:** You are using a region that does not support this image\. - -**Recommended solutions:** Use one of the regions that supports the base image of the Windows Server Core 2016 platform: -+ US East \(N\. Virginia\) -+ US East \(Ohio\) -+ US East \(Ohio\) -+ US West \(N\. California\) - -## RequestError timeout error when running CodeBuild in a proxy server - - **Issue:** You receive an error similar to `RequestError: send request failed caused by: Post https://logs..amazonaws.com/: dial tcp 52.46.158.105:443: i/o timeout` from CloudWatch Logs\. - - **Possible causes:** -+ `ssl-bump` is not configured properly\. -+ Your organization's security policy does not allow you to use `ssl_bump`\. - -**Recommended solutions:** -+ Make sure `ssl-bump` is configured properly\. If you use Squid for your proxy server, see [ Configure Squid as an Explicit Proxy Server](use-proxy-server.md#use-proxy-server-explicit-squid-configure)\. -+ Use private endpoints for Amazon S3 and CloudWatch Logs by doing the following: - - 1. In your private subnet routing table, remove the rule you added that routes traffic destined for the internet to your proxy server\. For information, see [Creating a Subnet in Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#AddaSubnet)\. - - 1. Create a private Amazon S3 endpoint and CloudWatch Logs endpoint and associate them with the private subnet of your Amazon VPC\. For information, see [VPC Endpoint Services \(AWS PrivateLink\)](https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html)\. - - 1. Confirm **Enable Private DNS Name** in your Amazon VPC is selected\. For more information, see [Creating an Interface Endpoint ](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint)\. - -## Error: "QUEUED: INSUFFICIENT\_SUBNET" when a build in a build queue fails - -**Issue:** A build in a build queue fails with an error similar to `QUEUED: INSUFFICIENT_SUBNET`\. - -**Possible causes:** The IPv4 CIDR block specified for your VPC uses a reserved IP address\. The first four IP addresses and the last IP address in each subnet CIDR block are not available for you to use and cannot be assigned to an instance\. For example, in a subnet with CIDR block `10.0.0.0/24`, the following five IP addresses are reserved: -+ `10.0.0.0:` Network address\. -+ `10.0.0.1`: Reserved by AWS for the VPC router\. -+ `10.0.0.2`: Reserved by AWS\. The IP address of the DNS server is always the base of the VPC network range plus two; however, we also reserve the base of each subnet range plus two\. For VPCs with multiple CIDR blocks, the IP address of the DNS server is located in the primary CIDR\. For more information, see [Amazon DNS Server](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html#AmazonDNS)\. -+ `10.0.0.3`: Reserved by AWS for future use\. -+ `10.0.0.255`: Network broadcast address\. We do not support broadcast in a VPC, therefore we reserve this address\. - -**Recommended solutions:** Check if your VPC uses a reserved IP address\. Replace any reserved IP address with an IP address that is not reserved\. For more information, see [VPC and Subnet Sizing](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing)\. \ No newline at end of file diff --git a/doc_source/use-case-based-samples.md b/doc_source/use-case-based-samples.md deleted file mode 100644 index d2bdce9..0000000 --- a/doc_source/use-case-based-samples.md +++ /dev/null @@ -1,30 +0,0 @@ -# CodeBuild Use Case\-Based Samples - -You can use these use case\-based samples to experiment with AWS CodeBuild: - - -**** - -| Name | Description | -| --- | --- | -| [Amazon ECR Sample](sample-ecr.md) | Uses a Docker image in an Amazon ECR repository to use Apache Maven to produce a single JAR file\. | -| [Private Registry with AWS Secrets Manager Sample](sample-private-registry.md) | Shows how to use a Docker image in a private registry as the runtime environment when building with CodeBuild The private registry credentials are stored in AWS Secrets Manager\. | -| [ Runtime Versions in Buildspec File Sample ](sample-runtime-versions.md) | Shows how to specify runtimes and their versions in the buildspec file\. This is a requirement when using the Ubuntu standard image version 2\.0\. | -| [Source Version Sample](sample-source-version.md) | Shows how to use a specific version of your source in a CodeBuild build project\. | -| [Docker Sample](sample-docker.md) | Uses a build image provided by CodeBuild with Docker support to produce a Docker image with Apache Maven\. Pushes the Docker image to a repository in Amazon ECR\. You can also adapt this sample to push the Docker image to Docker Hub\. | -| [Amazon EFS Sample](sample-efs.md) | Shows how to configure a buildspec file so that a CodeBuild project mounts and builds on an Amazon EFS file system\. | -| [GitHub Enterprise Sample](sample-github-enterprise.md) | Uses CodeBuild with GitHub Enterprise as the source repository, with certificates installed and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [GitHub Pull Request and Webhook Filter Sample](sample-github-pull-request.md) | Uses CodeBuild with GitHub as the source repository and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [Bitbucket Pull Request and Webhook Filter Sample](sample-bitbucket-pull-request.md) | Uses CodeBuild with Bitbucket as the source repository and webhooks enabled, to rebuild the source code every time a code change is pushed to the repository\. | -| [Use AWS Config with AWS CodeBuild Sample](how-to-integrate-config.md) | Shows how to set up AWS Config\. Lists which CodeBuild resources are tracked and describes how to look up CodeBuild projects in AWS Config\. | -| [ Host Build Output in an Amazon S3 Bucket ](sample-disable-artifact-encryption.md) | Shows how to create a static website in an Amazon S3 bucket using unencrypted build artifacts\. | -| [ Access Token Sample ](sample-access-tokens.md) | Shows how to use access tokens in CodeBuild to connect to GitHub and Bitbucket\. | -| [ Multiple Input Sources and Output Artifacts Sample ](sample-multi-in-out.md) | Shows how to use multiple input sources and multiple output artifacts in a build project\. | -| [ CodePipeline Integration with Multiple Input Sources and Output Artifacts Sample ](sample-pipeline-multi-input-output.md) | Shows how to use AWS CodePipeline to create a build with multiple input sources and multiple output artifacts\. | -| [Build Badges Sample](sample-build-badges.md) | Shows how to set up CodeBuild with build badges\. | -| [Using Semantic Versioning to Name Build Artifacts Sample](sample-buildspec-artifact-naming.md) | Shows how to use semantic versioning to create an artifact name at build time\. | -| [Build Notifications Sample](sample-build-notifications.md) | Uses Apache Maven to produce a single JAR file\. Sends a build notification to subscribers of an Amazon SNS topic\. | -| [Docker in Custom Image Sample](sample-docker-custom-image.md) | Uses a custom Docker image to produce a Docker image\. | -| [CodeDeploy Sample](sample-codedeploy.md) | Uses Apache Maven to produce a single JAR file\. Uses CodeDeploy to deploy the JAR file to an Amazon Linux instance\. You can also use CodePipeline to build and deploy the sample\. | -| [AWS Lambda Sample](sample-lambda.md) | Uses CodeBuild, Lambda, AWS CloudFormation, and CodePipeline to build and deploy a serverless application that follows the AWS Serverless Application Model \(AWS SAM\) standard\. | -| [Elastic Beanstalk Sample](sample-elastic-beanstalk.md) | Uses Apache Maven to produce a single WAR file\. Uses Elastic Beanstalk to deploy the WAR file to an Elastic Beanstalk instance\. | \ No newline at end of file diff --git a/doc_source/use-codebuild-agent.md b/doc_source/use-codebuild-agent.md deleted file mode 100644 index 5e180d4..0000000 --- a/doc_source/use-codebuild-agent.md +++ /dev/null @@ -1,63 +0,0 @@ -# Test and Debug Locally with the CodeBuild Agent - - This topic provides information about how to run the AWS CodeBuild agent and subscribe to notifications about new versions of the agent\. - -## Test and Debug on a Local Machine with the CodeBuild Agent - - You can use the AWS CodeBuild agent to test and debug builds on a local machine\. To use the agent: - -1. Download the [codebuild\.sh](https://github.com/aws/aws-codebuild-docker-images/blob/master/local_builds/codebuild_build.sh) script\. - -1. Run the script and specify your container images and output directory: - - ``` - codebuild_build.sh [-i image_name] [-a artifact_output_directory] [options] - ``` - - The CodeBuild agent is available from [https://hub\.docker\.com/r/amazon/aws\-codebuild\-local/](https://hub.docker.com/r/amazon/aws-codebuild-local/)\. Its Secure Hash Algorithm \(SHA\) signature is `2c2b0a6b3595abfb5408cfa263d91ef280a910e2a03e920f65c3ffb9a97d0550`\. You can use this to identify the version of the agent\. To see the agent's SHA signature, run the following command: - -``` -docker inspect amazon/aws-codebuild-local -``` - -## Receive Notifications for New CodeBuild Agent Versions - - Amazon SNS can notify you when new versions of the AWS CodeBuild Agent are released\. Use the following procedure to subscribe to these notifications\. - - ** To subscribe to the CodeBuild Agent notifications:** - -1. Open the Amazon SNS console at [https://console\.aws\.amazon\.com/sns/v3/home](https://console.aws.amazon.com/sns/v3/home)\. - -1. In the navigation bar, if it's not already selected, change the region to **US East \(N\. Virginia\)**, if it not already selected\. You must select this region because the SNS notifications that you are subscribing to are created in this region\. - -1. In the navigation pane, choose **Subscriptions**\. - -1. Choose **Create subscription**\. - -1. In the **Create subscription** dialog box: - - 1. For **Topic ARN**, use the following Amazon Resource Name \(ARN\): - - ``` - arn:aws:sns:us-east-1:850632864840:AWS-CodeBuild-Local-Agent-Updates - ``` - - 1. For **Protocol** choose **Email** or **SMS**\. - - 1. For **Endpoint** choose where to receive the notifications: - + If you choose **Email**, type an email address\. - + If you choose **SMS**, type a phone number, including area code\. - - 1. Choose **Create subscription**\. - -1. If you choose **Email**, you'll receive an email asking you to confirm your subscription\. Follow the directions in the email to complete your subscription\. - - When a new version of the CodeBuild agent is released, subscribers receive notifications\. If you no longer want to receive these notifications, use the following procedure to unsubscribe\. - - ** To unsubscribe from CodeBuild agent notifications:** - -1. Open the Amazon SNS console at [https://console\.aws\.amazon\.com/sns/v3/home](https://console.aws.amazon.com/sns/v3/home)\. - -1. In the navigation pane, choose **Subscriptions**\. - -1. Select the subscription and then from **Actions**, choose **Delete subscriptions**\. When you are prompted to confirm, choose **Delete**\. \ No newline at end of file diff --git a/doc_source/use-proxy-server.md b/doc_source/use-proxy-server.md deleted file mode 100644 index 16a4a9d..0000000 --- a/doc_source/use-proxy-server.md +++ /dev/null @@ -1,352 +0,0 @@ -# Use CodeBuild with a Proxy Server - - You can use AWS CodeBuild with a proxy server to regulate HTTP and HTTPS traffic to and from the internet\. To run CodeBuild with a proxy server, you install a proxy server in a public subnet and CodeBuild in a private subnet in an Amazon Virtual Private Cloud \(Amazon VPC\)\. - -There are two primary use cases for running CodeBuild in a proxy server: -+ It eliminates the use of a NAT gateway or NAT instance in your Amazon VPC\. -+ It lets you specify the URLs that instances in the proxy server can access and the URLs to which the proxy server denies access\. - - You can use CodeBuild with two types of proxy servers\. For both, the proxy server runs in a public subnet and CodeBuild runs in a private subnet\. -+ **Explicit proxy**: If you use an explicit proxy server, you must configure `NO_PROXY`, `HTTP_PROXY`, and `HTTPS_PROXY` environment variables in CodeBuild at the project level\. For more information, see [Change a Build Project's Settings in CodeBuild ](change-project.md) and [Create a Build Project in CodeBuild](create-project.md)\. -+ **Transparent proxy**: If you use a transparent proxy server, no special configuration is required\. - -**Topics** -+ [Components Required to Run CodeBuild in a Proxy Server](#use-proxy-server-transparent-components) -+ [Run CodeBuild in an Explicit Proxy Server](#run-codebuild-in-explicit-proxy-server) -+ [Run CodeBuild in a Transparent Proxy Server](#run-codebuild-in-transparent-proxy-server) -+ [Run a Package Manager and Other Tools in a Proxy Server](#use-proxy-server-tools) - -## Components Required to Run CodeBuild in a Proxy Server - - You need these components to run AWS CodeBuild in a transparent or explicit proxy server: -+ An Amazon VPC\. -+ One public subnet in your Amazon VPC for the proxy server\. -+ One private subnet in your Amazon VPC for CodeBuild\. -+ An internet gateway that allows communcation between the VPC and the internet\. - - The following diagram shows how the components interact\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/codebuild-proxy-transparent.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -### Set Up a VPC, Subnets, and a Network Gateway - - The following steps are required to run AWS CodeBuild in a transparent or explicit proxy server\. - -1. Create a VPC\. For information, see [Creating a VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#Create-VPC)\. - -1. Create two subnets in your VPC\. One is a public subnet named Public Subnet in which your proxy server runs\. The other is a private subnet named Private Subnet in which CodeBuild runs\. - - For information, see [Creating a Subnet in Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#AddaSubnet)\. - -1. Create and attach an internet gateway to your VPC\. For more information, see [Creating and Attaching an Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html#Add_IGW_Attach_Gateway)\. - -1. Add a rule to the default route table that routes outgoing traffic from the VPC \(0\.0\.0\.0/0\) to the internet gateway\. For information, see [Adding and Removing Routes from a Route Table](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#AddRemoveRoutes)\. - -1. Add a rule to the default security group of your VPC that allows ingress SSH traffic \(TCP 22\) from your VPC \(0\.0\.0\.0/0\)\. - -1. Follow the instructions in [Launching an Instance Using the Launch Instance Wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/launching-instance.html) to launch an Amazon Linux Amazon EC2 instance\. When you run the wizard, choose the following options: - + In **Choose an Instance Type**, choose an Amazon Linux Amazon Machine Image \(AMI\)\. - + In **Subnet**, choose the public subnet you created earlier in this topic\. If you used the suggested name, it is **Public Subnet**\. - + In **Auto\-assign Public IP**, choose **Enable**\. - + On the **Configure Security Group** page, for **Assign a security group**, choose **Select an existing security group**\. Next, choose the default security group\. - + After you choose **Launch**, choose an existing key pair or create one\. - - Choose the default settings for all other options\. - -1. After your Amazon EC2 instance is running, disable source/destination checks\. For information, see [Disabling Source/Destination Checks](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html#EIP_Disable_SrcDestCheck)\. - -1. Create a route table in your VPC\. Add a rule to the route table that routes traffic destined for the internet to your proxy server\. Associate this route table with your private subnet\. This is required so that outbound requests from instances in your private subnet, where CodeBuild runs, is always routed through the proxy server\. - -### Install and Configure a Proxy Server - - There are many proxy servers from which to choose\. An open\-source proxy server, Squid, is used here to demonstrate how AWS CodeBuild runs in a proxy server\. You can apply the same concepts to other proxy servers\. - - To install Squid, use a yum repo by running the following commands: - -``` -sudo yum update -y -sudo yum install -y squid -``` - - After you install Squid, you edit its `squid.conf` file\. Instructions for editing this file are included later in this topic\. - -### Configure Squid for HTTPS Traffic - - For HTTPS, the HTTP traffic is encapsulated in a Transport Layer Security \(TLS\) connection\. Squid uses a feature called [SslPeekAndSplice](https://wiki.squid-cache.org/Features/SslPeekAndSplice) to retrieve the Server Name Indication \(SNI\) from the TSL initiation that contains the requested internet host\. This is required so Squid does not need to unencrypt HTTPS traffic\. To enable SslPeekAndSplice, Squid requires a certificate\. Create this certificate using OpenSSL: - -``` -sudo mkdir /etc/squid/ssl -cd /etc/squid/ssl -sudo openssl genrsa -out squid.key 2048 -sudo openssl req -new -key squid.key -out squid.csr -subj "/C=XX/ST=XX/L=squid/O=squid/CN=squid" -sudo openssl x509 -req -days 3650 -in squid.csr -signkey squid.key -out squid.crt -sudo cat squid.key squid.crt | sudo tee squid.pem -``` - -**Note** - For HTTP, Squid does not require configuration\. From all HTTP/1\.1 request messages, it can retrieve the host header field, which specifies the internet host that is being requested\. - -## Run CodeBuild in an Explicit Proxy Server - -**Topics** -+ [Configure Squid as an Explicit Proxy Server](#use-proxy-server-explicit-squid-configure) -+ [Create a CodeBuild Project](#use-proxy-server-explicit-create-acb-project) -+ [Explicit Proxy Server Sample `Squid.conf` File](#use-proxy-server-explicit-sample-squid-conf) - - To run AWS CodeBuild with in an explicit proxy server, you must configure the proxy server to allow or deny traffic to and from external sites, and then configure the `HTTP_PROXY` and `HTTPS_PROXY` environment variables\. - -### Configure Squid as an Explicit Proxy Server - - To configure the Squid proxy server to be explicit, you must make the following modifications to its `/etc/squid/squid.conf` file: -+ Remove the following default access control list \(ACL\) rules\. - - ``` - acl localnet src 10.0.0.0/8 - acl localnet src 172.16.0.0/12 - acl localnet src 192.168.0.0/16 - acl localnet src fc00::/7 - acl localnet src fe80::/10 - ``` - - Add the following in place of the default ACL rules you removed\. The first line allows requests from your Amazon VPC\. The next two lines grant your proxy server access to destination URLs that might be used by AWS CodeBuild\. Modify the regular expression in the last line to specify Amazon S3 buckets or a CodeCommit repository in an AWS Region\. For example: - + If your source is Amazon S3, use the command acl download\_src dstdom\_regex \.\*s3\\\.us\-west\-1\\\.amazonaws\\\.comto grant access to Amazon S3 buckets in the `us-west-1` Region\. - + If your source is AWS CodeCommit, use `git-codecommit..amazonaws.com` to whitelist an AWS Region\. - - ``` - acl localnet src 10.1.0.0/16 #Only allow requests from within the VPC - acl allowed_sites dstdomain .github.amrom.workers.dev #Allows to download source from GitHub - acl allowed_sites dstdomain .bitbucket.com #Allows to download source from Bitbucket - acl download_src dstdom_regex .*\.amazonaws\.com #Allows to download source from Amazon S3 or CodeCommit - ``` -+ Replace `http_access allow localnet` with the following: - - ``` - http_access allow localnet allowed_sites - http_access allow localnet download_src - ``` -+ Before the `http_access deny all` statement, insert the following statements\. They allow CodeBuild to access CloudWatch and Amazon S3\. Access to CloudWatch is required so that CodeBuild can create CloudWatch logs\. Access to Amazon S3 is required for uploading artifacts and Amazon S3 caching\. - + - - ``` - https_port 3130 cert=/etc/squid/ssl/squid.pem ssl-bump intercept - acl SSL_port port 443 - http_access allow SSL_port - acl allowed_https_sites ssl::server_name .amazonaws.com - acl step1 at_step SslBump1 - acl step2 at_step SslBump2 - acl step3 at_step SslBump3 - ssl_bump peek step1 all - ssl_bump peek step2 allowed_https_sites - ssl_bump splice step3 allowed_https_sites - ssl_bump terminate step2 all - ``` - + After you save `squid.conf`, execute the following: - - ``` - sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 3130 - sudo service squid restart - ``` - -**Note** -If you receive a RequestError timeout error, see [ RequestError timeout error when running CodeBuild in a proxy server](troubleshooting.md#code-request-timeout-error)\. - -For more information, see [Explicit Proxy Server Sample `Squid.conf` File](#use-proxy-server-explicit-sample-squid-conf) later in this topic\. - -### Create a CodeBuild Project - - To run AWS CodeBuild with your explicit proxy server, set its `HTTP_PROXY` and `HTTPS_PROXY` environment variables with the private IP address of the Amazon EC2 instance you created for your proxy server and port 3128 at the project level\. The private IP address looks like `http://your-ec2-private-ip-address:3128`\. For more information, see [Create a Build Project in CodeBuild](create-project.md) and [Change a Build Project's Settings in CodeBuild ](change-project.md)\. - - Use the following command to view the Squid proxy access log: - -``` -sudo tail -f /var/log/squid/access.log -``` - -### Explicit Proxy Server Sample `Squid.conf` File - - The following is an example of how a `squid.conf` file that is configured for an explicit proxy server might look\. - -``` - acl localnet src 10.0.0.0/16 #Only allow requests from within the VPC - # add all URLS to be whitelisted for download source and commands to be executed in build environment - acl allowed_sites dstdomain .github.amrom.workers.dev #Allows to download source from github - acl allowed_sites dstdomain .bitbucket.com #Allows to download source from bitbucket - acl allowed_sites dstdomain ppa.launchpad.net #Allows to execute apt-get in build environment - acl download_src dstdom_regex .*\.amazonaws\.com #Allows to download source from S3 or CodeCommit - acl SSL_ports port 443 - acl Safe_ports port 80 # http - acl Safe_ports port 21 # ftp - acl Safe_ports port 443 # https - acl Safe_ports port 70 # gopher - acl Safe_ports port 210 # wais - acl Safe_ports port 1025-65535 # unregistered ports - acl Safe_ports port 280 # http-mgmt - acl Safe_ports port 488 # gss-http - acl Safe_ports port 591 # filemaker - acl Safe_ports port 777 # multiling http - acl CONNECT method CONNECT - # - # Recommended minimum Access Permission configuration: - # - # Deny requests to certain unsafe ports - http_access deny !Safe_ports - # Deny CONNECT to other than secure SSL ports - http_access deny CONNECT !SSL_ports - # Only allow cachemgr access from localhost - http_access allow localhost manager - http_access deny manager - # We strongly recommend the following be uncommented to protect innocent - # web applications running on the proxy server who think the only - # one who can access services on "localhost" is a local user - #http_access deny to_localhost - # - # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS - # - # Example rule allowing access from your local networks. - # Adapt localnet in the ACL section to list your (internal) IP networks - # from where browsing should be allowed - http_access allow localnet allowed_sites - http_access allow localnet download_src - http_access allow localhost - # Add this for CodeBuild to access CWL end point, caching and upload artifacts S3 bucket end point - https_port 3130 cert=/etc/squid/ssl/squid.pem ssl-bump intercept - acl SSL_port port 443 - http_access allow SSL_port - acl allowed_https_sites ssl::server_name .amazonaws.com - acl step1 at_step SslBump1 - acl step2 at_step SslBump2 - acl step3 at_step SslBump3 - ssl_bump peek step1 all - ssl_bump peek step2 allowed_https_sites - ssl_bump splice step3 allowed_https_sites - ssl_bump terminate step2 all - # And finally deny all other access to this proxy - http_access deny all - # Squid normally listens to port 3128 - http_port 3128 - # Uncomment and adjust the following to add a disk cache directory. - #cache_dir ufs /var/spool/squid 100 16 256 - # Leave coredumps in the first cache dir - coredump_dir /var/spool/squid - # - # Add any of your own refresh_pattern entries above these. - # - refresh_pattern ^ftp: 1440 20% 10080 - refresh_pattern ^gopher: 1440 0% 1440 - refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 - refresh_pattern . 0 20% 4320 -``` - -## Run CodeBuild in a Transparent Proxy Server - - To run AWS CodeBuild in a transparent proxy server, you must configure the proxy server with access to the websites and domains it interacts with\. - -### Configure Squid as a Transparent Proxy Server - - To configure a proxy server to be transparent, you must grant it access to the domains and websites you want it to access\. To run AWS CodeBuild with a transparent proxy server, you must grant it access to amazonaws\.com\. You must also grant access to other websites CodeBuild uses\. These vary depending on how you create your CodeBuild projects\. Example websites are those for repositories such as GitHub, Bitbucket, Yum, and Maven\. To grant Squid access to specific domains and websites, use a command similar to the following to update the `squid.conf` file\. This sample command grants access to amazonaws\.com, github\.com, and bitbucket\.com\. You can edit this sample to grant access to other websites\. - -``` -cat | sudo tee /etc/squid/squid.conf ≪EOF -visible_hostname squid -#Handling HTTP requests -http_port 3129 intercept -acl allowed_http_sites dstdomain .amazonaws.com -#acl allowed_http_sites dstdomain domain_name [uncomment this line to add another domain] -http_access allow allowed_http_sites -#Handling HTTPS requests -https_port 3130 cert=/etc/squid/ssl/squid.pem ssl-bump intercept -acl SSL_port port 443 -http_access allow SSL_port -acl allowed_https_sites ssl::server_name .amazonaws.com -acl allowed_https_sites ssl::server_name .github.amrom.workers.dev -acl allowed_https_sites ssl::server_name .bitbucket.com -#acl allowed_https_sites ssl::server_name [uncomment this line to add another website] -acl step1 at_step SslBump1 -acl step2 at_step SslBump2 -acl step3 at_step SslBump3 -ssl_bump peek step1 all -ssl_bump peek step2 allowed_https_sites -ssl_bump splice step3 allowed_https_sites -ssl_bump terminate step2 all -http_access deny all -EOF -``` - - Incoming requests from instances in the private subnet must redirect to the Squid ports\. Squid listens on port 3129 for HTTP traffic \(instead of 80\) and 3130 for HTTPS traffic \(instead of 443\)\. Use the iptables command to properly route traffic: - -``` -sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 3129 -sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 3130 -sudo service iptables save -sudo service squid start -``` - -### Create a CodeBuild Project - - After you configure your proxy server, you can use it with AWS CodeBuild in a private subnet without more configuration\. Every HTTP and HTTPS request goes through the public proxy server\. Use the following command to view the Squid proxy access log: - -``` -sudo tail -f /var/log/squid/access.log -``` - -## Run a Package Manager and Other Tools in a Proxy Server - - To execute a tool, such as a package manager, in a proxy server: - -1. Whitelist the tool in your proxy server by adding statements to your `squid.conf` file\. - -1. Add a line to your buildspec file that points to the private endpoint of your proxy server\. - - The following examples demonstrate how to do this for `apt-get`, `curl`, and `maven`\. If you use a different tool, use the same concepts by whitelisting it in the `squid.conf` file and adding a command to your buildspec file to make CodeBuild aware of your proxy server's endpoint\. - -**Run `apt-get` in a Proxy Server** - -1. Add the following statements to your `squid.conf` file to whitelist `apt-get` in your proxy server\. The first three lines allow `apt-get` to execute in the build environment\. - - ``` - acl allowed_sites dstdomain ppa.launchpad.net # Required for apt-get to execute in the build environment - acl apt_get dstdom_regex .*\.launchpad.net # Required for CodeBuild to execute apt-get in the build environment - acl apt_get dstdom_regex .*\.ubuntu.com # Required for CodeBuild to execute apt-get in the build environment - http_access allow localnet allowed_sites - http_access allow localnet apt_get - ``` - -1. Add the following statement in your buildspec file so that `apt-get` commands look for the proxy configuration in `/etc/apt/apt.conf.d/00proxy`\. - - ``` - echo 'Acquire::http::Proxy "http://:3128"; Acquire::https::Proxy "http://:3128"; Acquire::ftp::Proxy "http://:3128";' > /etc/apt/apt.conf.d/00proxy - ``` - -**Run `curl` in a Proxy Server** - -1. Add the following to your `squid.conf` file to whitelist `curl` in your build environment\. - - ``` - acl allowed_sites dstdomain ppa.launchpad.net # Required to execute apt-get in the build environment - acl allowed_sites dstdomain google.com # Required for access to a webiste. This example uses www.google.com. - http_access allow localnet allowed_sites - http_access allow localnet apt_get - ``` - -1. Add the following statement in your buildspec file so `curl` uses the private proxy server to access the website you added to the `squid.conf`\. In this example, the website is `google.com`\. - - ``` - curl -x :3128 https://www.google.com - ``` - -**Run `maven` in a Proxy Server** - -1. Add the following to your `squid.conf` file to whitelist `maven` in your build environment\. - - ``` - acl allowed_sites dstdomain ppa.launchpad.net # Required to execute apt-get in the build environment - acl maven dstdom_regex .*\.maven.org # Allows access to the maven repository in the build environment - http_access allow localnet allowed_sites - http_access allow localnet maven - ``` - -1. Add the following statement to your buildspec file\. - - ``` - maven clean install -DproxySet=true -DproxyHost= -DproxyPort=3128 - ``` \ No newline at end of file diff --git a/doc_source/use-vpc-endpoints-with-codebuild.md b/doc_source/use-vpc-endpoints-with-codebuild.md deleted file mode 100644 index 1d343fa..0000000 --- a/doc_source/use-vpc-endpoints-with-codebuild.md +++ /dev/null @@ -1,48 +0,0 @@ -# Use VPC Endpoints - - You can improve the security of your builds by configuring AWS CodeBuild to use an interface VPC endpoint\. Interface endpoints are powered by PrivateLink, a technology that enables you to privately access Amazon EC2 and CodeBuild by using private IP addresses\. PrivateLink restricts all network traffic between your managed instances, CodeBuild, and Amazon EC2 to the Amazon network\. \(Managed instances don't have access to the internet\.\) Also, you don't need an internet gateway, NAT device, or virtual private gateway\. You are not required to configure PrivateLink, but it's recommended\. For more information about PrivateLink and VPC endpoints, see [Accessing AWS Services Through PrivateLink](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Introduction.html#what-is-privatelink)\. - -## Before You Create VPC Endpoints - - Before you configure VPC endpoints for AWS CodeBuild, be aware of the following restrictions and limitations\. - -**Note** - Use an [Amazon VPC NAT Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html) if you want to use CodeBuild with AWS services that do not support Amazon VPC PrivateLink connections\. -+ VPC endpoints support Amazon\-provided DNS through Amazon Route 53 only\. If you want to use your own DNS, you can use conditional DNS forwarding\. For more information, see [DHCP Option Sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the *Amazon VPC User Guide*\. -+ VPC endpoints currently do not support cross\-region requests\. Make sure that you create your endpoint in the same region as any Amazon S3 buckets that store your build input and output\. You can use the Amazon S3 console or the [ get\-bucket\-location](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-bucket-location.html) command to find the location of your bucket\. Use a region\-specific Amazon S3 endpoint to access your bucket \(for example, `mybucket.s3-us-west-2.amazonaws.com`\)\. For more information about region\-specific endpoints for Amazon S3, see [Amazon Simple Storage Service](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in Amazon Web Services General Reference*Amazon Web Services General Reference*\. If you use the AWS CLI to make requests to Amazon S3, set your default region to the same region as your bucket, or use the `--region` parameter in your requests\. - -## Creating VPC Endpoints for CodeBuild - -Use [Creating an Interface Endpoint](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint) to create the endpoint `com.amazonaws.region.codebuild`\. This is a VPC endpoint for AWS CodeBuild\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/vpc-endpoint.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - - *region* represents the region identifier for an AWS Region supported by CodeBuild, such as `us-east-2` for the US East \(Ohio\) Region\. For a list of supported regions, see [CodeBuild](https://docs.aws.amazon.com/general/latest/gr/rande.html#codebuild_region) in the * AWS General Reference*\. The endpoint is prepopulated with the region you specified when you signed in to AWS\. If you change your region, the VPC endpoint is updated accordingly\. - -## Create a VPC Endpoint Policy for CodeBuild - - You can create a policy for Amazon VPC endpoints for AWS CodeBuild in which you can specify: -+ The principal that can perform actions\. -+ The actions that can be performed\. -+ The resources that can have actions performed on them\. - -The following example policy specifies that all principals can only start and view builds for the `project-name` project\. - -``` -{ - "Statement": [ - { - "Action": [ - "codebuild:ListBuildsForProject", - "codebuild:StartBuild", - "codebuild:BatchGetBuilds" - ], - "Effect": "Allow", - "Resource": "arn:aws:codebuild:region-ID:account-ID:project/project-name", - "Principal": "*" - } - ] -} -``` - - For more information, see [Controlling Access to Services with VPC Endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html)\. \ No newline at end of file diff --git a/doc_source/view-build-details.md b/doc_source/view-build-details.md deleted file mode 100644 index 3f0381e..0000000 --- a/doc_source/view-build-details.md +++ /dev/null @@ -1,55 +0,0 @@ -# View Build Details in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to view details about builds managed by CodeBuild\. - -**Topics** -+ [View Build Details \(Console\)](#view-build-details-console) -+ [View Build Details \(AWS CLI\)](#view-build-details-cli) -+ [View Build Details \(AWS SDKs\)](#view-build-details-sdks) -+ [Build Phase Transitions](#view-build-details-phases) - -## View Build Details \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. Do one of the following: - + In the navigation pane, choose **Build history**\. In the list of builds, in the **Build run** column, choose the link for the build\. - + In the navigation pane, choose **Build projects**\. In the list of build projects, in the **Name** column, choose the link for the name of the build project\. Then, in the list of builds, in the **Build run** column, choose the link for the build\. -**Note** -By default, only the 10 most recent builds or build projects are displayed\. To view more builds or build projects, choose the gear icon, and then choose a different value for **Builds per page** or **Projects per page** or use the back and forward arrows\. - -## View Build Details \(AWS CLI\) - -For more information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -Run the batch\-get\-builds command: - -``` -aws codebuild batch-get-builds --ids ids -``` - -Replace the following placeholder: -+ *ids*: Required string\. One or more build IDs to view details about\. To specify more than one build ID, separate each build ID with a space\. You can specify up to 100 build IDs\. To get a list of build IDs, see the following topics: - + [View a List of Build IDs \(AWS CLI\)](view-build-list.md#view-build-list-cli) - + [View a List of Build IDs for a Build Project \(AWS CLI\)](view-builds-for-project.md#view-builds-for-project-cli) - -For example, if you run this command: - -``` -aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE my-other-project:813bb6c6-891b-426a-9dd7-6d8a3EXAMPLE -``` - -If the command is successful, data similar to that described in [To view summarized build information \(AWS CLI\)](getting-started.md#getting-started-monitor-build-cli) appears in the output\. - -## View Build Details \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. - -## Build Phase Transitions - -Builds in AWS CodeBuild proceed in phases: - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/build-phases.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -**Important** -The `UPLOAD_ARTIFACTS` phase is always attempted, even if the `BUILD` phase fails\. \ No newline at end of file diff --git a/doc_source/view-build-list.md b/doc_source/view-build-list.md deleted file mode 100644 index 609bd02..0000000 --- a/doc_source/view-build-list.md +++ /dev/null @@ -1,72 +0,0 @@ -# View a List of Build IDs in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to view a list of build IDs for builds managed by CodeBuild\. - -**Topics** -+ [View a List of Build IDs \(Console\)](#view-build-list-console) -+ [View a List of Build IDs \(AWS CLI\)](#view-build-list-cli) -+ [View a List of Build IDs \(AWS SDKs\)](#view-build-list-sdks) - -## View a List of Build IDs \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build history**\. -**Note** -By default, only the 10 most recent builds are displayed\. To view more builds, choose the gear icon, and then choose a different value for **Builds per page** or use the back and forward arrows\. - -## View a List of Build IDs \(AWS CLI\) - -For more information about using the AWS CLI with CodeBuild, see the [Command Line Reference](cmd-ref.md)\. -+ Run the list\-builds command: - - ``` - aws codebuild list-builds --sort-order sort-order --next-token next-token - ``` - - In the preceding command, replace the following placeholders: - + *sort\-order*: Optional string used to indicate how to list the build IDs\. Valid values include `ASCENDING` and `DESCENDING`\. - + *next\-token*: Optional string\. During a previous run, if there were more than 100 items in the list, only the first 100 items are returned, along with a unique string called *next token*\. To get the next batch of items in the list, run this command again, adding the next token to the call\. To get all of the items in the list, keep running this command with each subsequent next token, until no more next tokens are returned\. - - For example, if you run this command: - - ``` - aws codebuild list-builds --sort-order ASCENDING - ``` - - A result similar to the following might appear in the output: - - ``` - { - "nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==", - "ids": [ - "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE" - "codebuild-demo-project:84a7f3d1-d40e-4956-b4cf-7a9d4EXAMPLE" - ... The full list of build IDs has been omitted for brevity ... - "codebuild-demo-project:931d0b72-bf6f-4040-a472-5c707EXAMPLE" - ] - } - ``` - - If you run this command again: - - ``` - aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== - ``` - - A result similar to the following might appear in the output: - - ``` - { - "ids": [ - "codebuild-demo-project:49015049-21cf-4b50-9708-df115EXAMPLE", - "codebuild-demo-project:543e7206-68a3-46d6-a4da-759abEXAMPLE", - ... The full list of build IDs has been omitted for brevity ... - "codebuild-demo-project:c282f198-4582-4b38-bdc0-26f96EXAMPLE" - ] - } - ``` - -## View a List of Build IDs \(AWS SDKs\) - -For more information about using CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/view-builds-for-project.md b/doc_source/view-builds-for-project.md deleted file mode 100644 index 060b566..0000000 --- a/doc_source/view-builds-for-project.md +++ /dev/null @@ -1,75 +0,0 @@ -# View a List of Build IDs for a Build Project in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to view a list of build IDs for a build project in CodeBuild\. - -**Topics** -+ [View a List of Build IDs for a Build Project \(Console\)](#view-builds-for-project-console) -+ [View a List of Build IDs for a Build Project \(AWS CLI\)](#view-builds-for-project-cli) -+ [View a List of Build IDs for a Build Project \(AWS SDKs\)](#view-builds-for-project-sdks) - -## View a List of Build IDs for a Build Project \(Console\) - -1. Open the CodeBuild console at [https://console\.aws\.amazon\.com/codebuild/](https://console.aws.amazon.com/codebuild/)\. - -1. In the navigation pane, choose **Build projects**\. In the list of build projects, in the **Name** column, choose the build project\. - -**Note** -By default, only the most recent 100 builds or build projects are displayed\. To view more builds or build projects, choose the gear icon, and then choose a different value for **Builds per page** or **Projects per page** or use the back and forward arrows\. - -## View a List of Build IDs for a Build Project \(AWS CLI\) - -For more information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -Run the list\-builds\-for\-project command, as follows: - -``` -aws codebuild list-builds-for-project --project-name project-name --sort-order sort-order --next-token next-token -``` - -In the preceding command, replace the following placeholders: -+ *project\-name*: Required string used to indicate the name of the build project to list builds IDs for\. To get a list of build projects, see [View a List of Build Project Names \(AWS CLI\)](view-project-list.md#view-project-list-cli)\. -+ *sort\-order*: Optional string used to indicate how to list the build IDs\. Valid values include `ASCENDING` and `DESCENDING`\. -+ *next\-token*: Optional string\. During a previous run, if there were more than 100 items in the list, only the first 100 items are returned, along with a unique string called *next token*\. To get the next batch of items in the list, run this command again, adding the next token to the call\. To get all of the items in the list, keep running this command with each subsequent next token that is returned, until no more next tokens are returned\. - -For example, if you run this command similar to this: - -``` -aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order ASCENDING -``` - -A result like the following might appear in the output: - -``` -{ - "nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==", - "ids": [ - "codebuild-demo-project:9b175d16-66fd-4e71-93a0-50a08EXAMPLE" - "codebuild-demo-project:a9d1bd09-18a2-456b-8a36-7d65aEXAMPLE" - ... The full list of build IDs has been omitted for brevity ... - "codebuild-demo-project:fe70d102-c04f-421a-9cfa-2dc15EXAMPLE" - ] -} -``` - -If you run this command again: - -``` -aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== -``` - -You might see a result like the following in the output: - -``` -{ - "ids": [ - "codebuild-demo-project:98253670-7a8a-4546-b908-dc890EXAMPLE" - "codebuild-demo-project:ad5405b2-1ab3-44df-ae2d-fba84EXAMPLE" - ... The full list of build IDs has been omitted for brevity ... - "codebuild-demo-project:f721a282-380f-4b08-850a-e0ac1EXAMPLE" - ] -} -``` - -## View a List of Build IDs for a Build Project \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/view-project-details.md b/doc_source/view-project-details.md deleted file mode 100644 index fde5b06..0000000 --- a/doc_source/view-project-details.md +++ /dev/null @@ -1,67 +0,0 @@ -# View a Build Project's Details in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to view the details of a build project in CodeBuild\. - -**Topics** -+ [View a Build Project's Details \(Console\)](#view-project-details-console) -+ [View a Build Project's Details \(AWS CLI\)](#view-project-details-cli) -+ [View a Build Project's Details \(AWS SDKs\)](#view-project-details-sdks) - -## View a Build Project's Details \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. -**Note** -By default, only the 10 most recent build projects are displayed\. To view more build projects, choose the gear icon, and then choose a different value for **Projects per page** or use the back and forward arrows\. - -1. In the list of build projects, in the **Name** column, choose the link for the build project\. - -1. On the **Build project: *project\-name*** page, choose **Build details**\. - -## View a Build Project's Details \(AWS CLI\) - -For more information about using the AWS CLI with AWS CodeBuild, see the [Command Line Reference](cmd-ref.md)\. - -Run the batch\-get\-projects command: - -``` -aws codebuild batch-get-projects --names names -``` - -In the preceding command, replace the following placeholder: -+ *names*: Required string used to indicate one or more build project names to view details about\. To specify more than one build project, separate each build project's name with a space\. You can specify up to 100 build project names\. To get a list of build projects, see [View a List of Build Project Names \(AWS CLI\)](view-project-list.md#view-project-list-cli)\. - -For example, if you run this command: - -``` -aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project -``` - -A result similar to the following might appear in the output\. Ellipses \(`...`\) are used to represent data omitted for brevity\. - -``` -{ - "projectsNotFound": [ - "my-other-demo-project" - ], - "projects": [ - { - ... - "name": codebuild-demo-project, - ... - }, - { - ... - "name": codebuild-demo-project2", - ... - } - ] -} -``` - -In the preceding output, the `projectsNotFound` array lists any build project names that were specified, but not found\. The `projects` array lists details for each build project where information was found\. Build project details have been omitted from the preceding output for brevity\. For more information, see the output of [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. - -## View a Build Project's Details \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/view-project-list.md b/doc_source/view-project-list.md deleted file mode 100644 index cdfa6ea..0000000 --- a/doc_source/view-project-list.md +++ /dev/null @@ -1,75 +0,0 @@ -# View a List of Build Project Names in CodeBuild - -You can use the AWS CodeBuild console, AWS CLI, or AWS SDKs to view a list of build projects in CodeBuild\. - -**Topics** -+ [View a List of Build Project Names \(Console\)](#view-project-list-console) -+ [View a List of Build Project Names \(AWS CLI\)](#view-project-list-cli) -+ [View a List of Build Project Names \(AWS SDKs\)](#view-project-list-sdks) - -## View a List of Build Project Names \(Console\) - -1. Open the AWS CodeBuild console at [https://console\.aws\.amazon\.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home)\. - -1. In the navigation pane, choose **Build projects**\. -**Note** -By default, only the 10 most recent build projects are displayed\. To view more build projects, choose the gear icon, and then choose a different value for **Projects per page** or use the back and forward arrows\. - -## View a List of Build Project Names \(AWS CLI\) - -Run the list\-projects command: - -``` -aws codebuild list-projects --sort-by sort-by --sort-order sort-order --next-token next-token -``` - -In the preceding command, replace the following placeholders: -+ *sort\-by*: Optional string used to indicate the criterion to be used to list build project names\. Valid values include: - + `CREATED_TIME`: List the build project names based on when each build project was created\. - + `LAST_MODIFIED_TIME`: List the build project names based on when information about each build project was last changed\. - + `NAME`: List the build project names based on each build project's name\. -+ *sort\-order*: Optional string used to indicate the order in which to list build projects, based on *sort\-by*\. Valid values include `ASCENDING` and `DESCENDING`\. -+ *next\-token*: Optional string\. During a previous run, if there were more than 100 items in the list, only the first 100 items are returned, along with a unique string called *next token*\. To get the next batch of items in the list, run this command again, adding the next token to the call\. To get all of the items in the list, keep running this command with each subsequent next token, until no more next tokens are returned\. - -For example, if you run this command: - -``` -aws codebuild list-projects --sort-by NAME --sort-order ASCENDING -``` - -A result similar to the following might appear in the output: - -``` -{ - "nextToken": "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=", - "projects": [ - "codebuild-demo-project", - "codebuild-demo-project2", - ... The full list of build project names has been omitted for brevity ... - "codebuild-demo-project99" - ] -} -``` - -If you run this command again: - -``` -aws codebuild list-projects --sort-by NAME --sort-order ASCENDING --next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8= -``` - -A result similar to the following might appear in the output: - -``` -{ - "projects": [ - "codebuild-demo-project100", - "codebuild-demo-project101", - ... The full list of build project names has been omitted for brevity ... - "codebuild-demo-project122" - ] -} -``` - -## View a List of Build Project Names \(AWS SDKs\) - -For more information about using AWS CodeBuild with the AWS SDKs, see the [AWS SDKs and Tools Reference](sdk-ref.md)\. \ No newline at end of file diff --git a/doc_source/vpc-support.md b/doc_source/vpc-support.md deleted file mode 100644 index 8d1e6a1..0000000 --- a/doc_source/vpc-support.md +++ /dev/null @@ -1,97 +0,0 @@ -# Use CodeBuild with Amazon Virtual Private Cloud - -Typically, resources in an VPC are not accessible by AWS CodeBuild\. To enable access, you must provide additional VPC\-specific configuration information as part of your CodeBuild project configuration\. This includes the VPC ID, the VPC subnet IDs, and the VPC security group IDs\. VPC\-enabled builds are then able to access resources inside your VPC\. For more information about setting up a VPC in Amazon VPC, see the [VPC User Guide](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Introduction.html)\. - -**Topics** -+ [Use Cases](#use-cases) -+ [Enabling Amazon VPC Access in Your CodeBuild Projects](#enabling-vpc-access-in-projects) -+ [Best Practices for VPCs](#best-practices-for-vpcs) -+ [Troubleshooting Your VPC Setup](#troubleshooting-vpc) -+ [Use VPC Endpoints](use-vpc-endpoints-with-codebuild.md) -+ [AWS CloudFormation VPC Template](cloudformation-vpc-template.md) -+ [Use CodeBuild with a Proxy Server](use-proxy-server.md) - -## Use Cases - -VPC connectivity from AWS CodeBuild builds makes it possible to: -+ Run integration tests from your build against data in an Amazon RDS database that's isolated on a private subnet\. -+ Query data in an Amazon ElastiCache cluster directly from tests\. -+ Interact with internal web services hosted on Amazon EC2, Amazon ECS, or services that use internal Elastic Load Balancing\. -+ Retrieve dependencies from self\-hosted, internal artifact repositories, such as PyPI for Python, Maven for Java, and npm for Node\.js\. -+ Access objects in an Amazon S3 bucket configured to allow access through an Amazon VPC endpoint only\. -+ Query external web services that require fixed IP addresses through the Elastic IP address of the NAT gateway or NAT instance associated with your subnet\(s\)\. - -Your builds can access any resource that's hosted in your VPC\. - -## Enabling Amazon VPC Access in Your CodeBuild Projects - -Include these settings in your VPC configuration: -+ For **VPC ID**, choose the VPC ID that CodeBuild uses\. -+ For **Subnets**, choose a private subnet with NAT translation that includes or has routes to the resources used CodeBuild\. -+ For **Security Groups**, choose the security groups that CodeBuild uses to allow access to resources in the VPCs\. - -**Create a build project \(console\)** - -For information about creating a build project, see [Create a Build Project \(Console\)](create-project.md#create-project-console)\. When you create or change your CodeBuild project, in **VPC**, choose your VPC ID, subnets, and security groups\. - -**Create a build project \(AWS CLI\)** - -For information about creating a build project, see [Create a Build Project \(AWS CLI\)](create-project.md#create-project-cli)\. If you are using the AWS CLI with CodeBuild, the service role used by CodeBuild to interact with services on behalf of the IAM user must have the following policy attached: [Allow CodeBuild Access to AWS Services Required to Create a VPC Network Interface](auth-and-access-control-iam-identity-based-access-control.md#customer-managed-policies-example-create-vpc-network-interface)\. - -The *vpcConfig* object should include your *vpcId*, *securityGroupIds*, and *subnets*\. -+ *vpcId*: Required value\. The VPC ID that CodeBuild uses\. To get a list of all Amazon VPC IDs in your region, run this command: - - ``` - aws ec2 describe-vpcs - ``` -+ *subnets*: Required value\. The subnet IDs that include resources used by CodeBuild\. To obtain these IDs, run this command: - - ``` - aws ec2 describe-subnets --filters "Name=vpc-id,Values=" --region us-east-1 - ``` -**Note** -Replace us\-east\-1 with your region\. -+ *securityGroupIds*: Required value\. The security group IDs used by CodeBuild to allow access to resources in the VPCs\. To obtain these IDs, run this command: - - ``` - aws ec2 describe-security-groups --filters "Name=vpc-id,Values=" --region us-east-1 - ``` -**Note** -Replace us\-east\-1 with your region\. - -## Best Practices for VPCs - -Use this checklist when setting up a VPC to work with CodeBuild\. -+ Set up your VPC with public and private subnets and a NAT gateway\. For more information, see [VPC with Public and Private Subnets \(NAT\)](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Scenario2.html)\. -**Important** -You need a NAT gateway or NAT instance in order to use CodeBuild with your Amazon VPC so that CodeBuild can reach public endpoints \(for example, to execute CLI commands when running builds\)\. You cannot use the internet gateway instead of a NAT gateway or a NAT instance because CodeBuild does not support assigning elastic IP addresses to the network interfaces that it creates, and auto\-assigning a public IP address is not supported by Amazon EC2 for any network interfaces created outside of Amazon EC2 instance launches\. -+ Include multiple Availability Zones with your VPC\. -+ Make sure that your security groups have no inbound \(ingress\) traffic allowed to your builds\. For more information, see [Security Groups Rules](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_SecurityGroups.html#SecurityGroupRules)\. -+ Set up separate subnets for your builds\. -+ When you set up your CodeBuild projects to access your VPC, choose private subnets only\. - -For more information about setting up a VPC in Amazon VPC, see the [Amazon VPC User Guide](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Introduction.html)\. - -For more information about using AWS CloudFormation to configure an Amazon VPC to use the CodeBuild VPC feature, see the [AWS CloudFormation VPC Template](cloudformation-vpc-template.md)\. - -## Troubleshooting Your VPC Setup - -When troubleshooting VPC issues, use the information that appears in the error message to help you identify, diagnose, and address issues\. - -The following are some guidelines to assist you when troubleshooting a common CodeBuild VPC error: "Build does not have internet connectivity\. Please check subnet network configuration"\. - -1. [Make sure that your internet gateway is attached to VPC](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Internet_Gateway.html#Add_IGW_Attach_Gateway)\. - -1. [Make sure that the route table for your public subnet points to the internet gateway](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Route_Tables.html#route-tables-internet-gateway)\. - -1. [Make sure that your network ACLs allow traffic to flow](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_ACLs.html#ACLRules)\. - -1. [Make sure that your security groups allow traffic to flow](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_SecurityGroups.html#SecurityGroupRules)\. - -1. [Troubleshoot your NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide//vpc-nat-gateway.html#nat-gateway-troubleshooting)\. - -1. [Make sure that the route table for private subnets points to the NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide//VPC_Route_Tables.html#route-tables-nat)\. - -1. Make sure that the service role used by CodeBuild to interact with services on behalf of the IAM user has the permissions in [ this policy](https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-create-vpc-network-interface)\. For more information, see [Create a CodeBuild Service Role](setting-up.md#setting-up-service-role)\. - - If CodeBuild is missing permissions, you might receive an error that says, "Unexpected EC2 error: UnauthorizedOperation\." This error can occur if CodeBuild does not have the Amazon EC2 permissions required to work with an Amazon VPC\. \ No newline at end of file diff --git a/doc_source/welcome.md b/doc_source/welcome.md deleted file mode 100644 index 322b1e4..0000000 --- a/doc_source/welcome.md +++ /dev/null @@ -1,46 +0,0 @@ -# What Is AWS CodeBuild? - -AWS CodeBuild is a fully managed build service in the cloud\. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy\. CodeBuild eliminates the need to provision, manage, and scale your own build servers\. It provides prepackaged build environments for popular programming languages and build tools such as Apache Maven, Gradle, and more\. You can also customize build environments in CodeBuild to use your own build tools\. CodeBuild scales automatically to meet peak build requests\. - -CodeBuild provides these benefits: -+ **Fully managed** – CodeBuild eliminates the need to set up, patch, update, and manage your own build servers\. -+ **On demand** – CodeBuild scales on demand to meet your build needs\. You pay only for the number of build minutes you consume\. -+ **Out of the box** – CodeBuild provides preconfigured build environments for the most popular programming languages\. All you need to do is point to your build script to start your first build\. - -For more information, see [AWS CodeBuild](https://aws.amazon.com/codebuild/)\. - -**Topics** -+ [How to Run CodeBuild](#welcome-quick-look) -+ [Pricing for CodeBuild](#welcome-pricing) -+ [How Do I Get Started with CodeBuild?](#welcome-getting-started) -+ [AWS CodeBuild Concepts](concepts.md) - -## How to Run CodeBuild - -You can run CodeBuild by using the CodeBuild or AWS CodePipeline console\. You can also automate the running of CodeBuild by using the AWS Command Line Interface \(AWS CLI\) or the AWS SDKs\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/overview.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -To run CodeBuild by using the CodeBuild console, AWS CLI, or AWS SDKs, see [Run AWS CodeBuild Directly](how-to-run.md)\. - -As the following diagram shows, you can add CodeBuild as a build or test action to the build or test stage of a pipeline in AWS CodePipeline\. AWS CodePipeline is a continuous delivery service that enables you to model, visualize, and automate the steps required to release your code\. This includes building your code\. A *pipeline* is a workflow construct that describes how code changes go through a release process\. - -![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/images/pipeline.png)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/)![\[Image NOT FOUND\]](http://docs.aws.amazon.com/codebuild/latest/userguide/) - -To use CodePipeline to create a pipeline and then add a CodeBuild build or test action, see [Use AWS CodePipeline with CodeBuild](how-to-create-pipeline.md)\. For more information about CodePipeline, see the [AWS CodePipeline User Guide](https://docs.aws.amazon.com/codepipeline/latest/userguide/)\. - -The CodeBuild console also provides a way to quickly search for your resources, such as repositories, build projects, deployment applications, and pipelines\. Choose **Go to resource** or press the `/` key, and then type the name of the resource\. Any matches appear in the list\. Searches are case insensitive\. You only see resources that you have permissions to view\. For more information, see [Viewing Resources in the Console](console-resources.md)\. - -## Pricing for CodeBuild - -For information, see [CodeBuild Pricing](http://aws.amazon.com/codebuild/pricing)\. - -## How Do I Get Started with CodeBuild? - -We recommend that you complete the following steps: - -1. **Learn** more about CodeBuild by reading the information in [Concepts](concepts.md)\. - -1. **Experiment** with CodeBuild in an example scenario by following the instructions in [Getting Started](getting-started.md)\. - -1. **Use** CodeBuild in your own scenarios by following the instructions in [Plan a Build](planning.md)\. \ No newline at end of file diff --git a/doc_source/working-with-build-projects.md b/doc_source/working-with-build-projects.md deleted file mode 100644 index 1242606..0000000 --- a/doc_source/working-with-build-projects.md +++ /dev/null @@ -1,15 +0,0 @@ -# Working with Build Projects - -A *build project* defines how CodeBuild runs a build\. It includes information such as where to get the source code, the build environment to use, the build commands to run, and where to store the build output\. - -You can perform these tasks when working with build projects: - -**Topics** -+ [Create a Build Project in CodeBuild](create-project.md) -+ [View a List of Build Project Names in CodeBuild](view-project-list.md) -+ [View a Build Project's Details in CodeBuild](view-project-details.md) -+ [Build Caching in CodeBuild](build-caching.md) -+ [Create CodeBuild Triggers](trigger-create.md) -+ [Edit CodeBuild Triggers](triggers-edit.md) -+ [Change a Build Project's Settings in CodeBuild](change-project.md) -+ [Delete a Build Project in AWS CodeBuild](delete-project.md) \ No newline at end of file