Skip to content

Commit cafe527

Browse files
author
Mark Iverson
committed
Added a new sample that demonstrates how to mount an Amazon EFS file system with AWS CodeBuild, plus minor updates.
1 parent 92ac8e9 commit cafe527

File tree

81 files changed

+630
-25
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+630
-25
lines changed

doc_source/advanced-topics.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Advanced Topics<a name="advanced-topics"></a>
28

39
This section includes several advanced topics that are useful to more experienced AWS CodeBuild users\.

doc_source/auth-and-access-control-iam-access-control-identity-based.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Overview of Managing Access Permissions to Your AWS CodeBuild Resources<a name="auth-and-access-control-iam-access-control-identity-based"></a>
28

39
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\)\.

doc_source/auth-and-access-control-iam-identity-based-access-control.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Using Identity\-Based Policies \(IAM Policies\) for AWS CodeBuild<a name="auth-and-access-control-iam-identity-based-access-control"></a>
28

39
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\.

doc_source/auth-and-access-control-permissions-reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# AWS CodeBuild Permissions Reference<a name="auth-and-access-control-permissions-reference"></a>
28

39
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\)\.

doc_source/auth-and-access-control.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Authentication and Access Control for AWS CodeBuild<a name="auth-and-access-control"></a>
28

39
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 AWS CodeBuild to help secure access to your resources:

doc_source/build-env-ref-available.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Docker Images Provided by AWS CodeBuild<a name="build-env-ref-available"></a>
28

39
AWS CodeBuild manages the following Docker images that are available in the AWS CodeBuild and AWS CodePipeline consoles\.

doc_source/build-env-ref-background-tasks.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Background Tasks in Build Environments<a name="build-env-ref-background-tasks"></a>
28

39
You can run background tasks in build environments\. To do this, in your build spec, 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\.

doc_source/build-env-ref-cmd.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Shells and Commands in Build Environments<a name="build-env-ref-cmd"></a>
28

39
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:

doc_source/build-env-ref-compute-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Build Environment Compute Types<a name="build-env-ref-compute-types"></a>
28

39
AWS CodeBuild provides build environments with the following available memory, vCPUs, and available disk space:

doc_source/build-env-ref-env-vars.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
--------
2+
3+
A new console design is available for this service\. Although the procedures in this guide were written for the older version of the console, you will find many of the concepts and basic procedures in this guide still apply\.
4+
5+
--------
6+
17
# Environment Variables in Build Environments<a name="build-env-ref-env-vars"></a>
28

39
AWS CodeBuild provides several environment variables that you can use in your build commands:
@@ -10,9 +16,10 @@ AWS CodeBuild provides several environment variables that you can use in your bu
1016
+ `CODEBUILD_INITIATOR`: The entity that started the build\. If AWS 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 AWS CodeBuild started the build, this is the string `CodeBuild-Jenkins-Plugin`\.
1117
+ `CODEBUILD_KMS_KEY_ID`: The identifier of the AWS KMS key that AWS 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`\)\.
1218
+ `CODEBUILD_LOG_PATH`: The log stream name in CloudWatch Logs for the build\.
13-
+ `CODEBUILD_RESOLVED_SOURCE_VERSION`: For builds run by AWS CodePipeline, the commit ID or Amazon S3 version ID of the source code to be built\. Note that this value is available only if the pipeline's related Source action is based on an Amazon S3, AWS CodeCommit, or GitHub repository\.
14-
**Note**
15-
The CODEBUILD\_RESOLVED\_SOURCE\_VERSION environment variable may not always be available\.
19+
+ `CODEBUILD_RESOLVED_SOURCE_VERSION`: An identifier for the version of a build's source code\. Its format depends on the source code repository:
20+
+ For AWS 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\.
21+
+ For AWS CodePipeline, it is the source revision is provided by AWS CodePipeline\. For AWS CodePipeline, the `CODEBUILD_RESOLVED_SOURCE_VERSION` environment variable may not always be available\.
22+
+ For Amazon S3, this does not apply\.
1623
+ `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 AWS CodeCommit and GitHub, this is the repository's clone URL\. If a build originates from AWS CodePipeline then this may be empty\.
1724
+ `CODEBUILD_SOURCE_VERSION`: For Amazon S3, the version ID associated with the input artifact\. For AWS CodeCommit, the commit ID or branch name associated with the version of the source code to be built\. For GitHub, the commit ID, branch name, or tag name associated with the version of the source code to be built\.
1825
+ `CODEBUILD_SRC_DIR`: The directory path that AWS CodeBuild uses for the build \(for example, `/tmp/src123456789/src`\)\.

0 commit comments

Comments
 (0)