Amazon ECR sample for CodeBuild

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 Publish Docker image to an Amazon ECR image repository sample.

2. Create a Go project:

   1. Create the files as described in the Go project structure and Go project files sections of this topic, and then upload them to an S3 input bucket or an Amazon 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 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).

   2. Create a build project, run the build, and view related build information.

      If you use the Amazon 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:5.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"
      }

   3. To get the build output artifact, open your S3 output bucket.

   4. 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.

3. If one of the following is true, you must add permissions to your image repository in Amazon ECR so that Amazon 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.amazonaws.cn/ecr/.

   2. In the list of repository names, choose the name of the repository you created or selected.

   3. From the navigation pane, choose Permissions, choose Edit, and then choose Add statement.

   4. For Statement name, enter an identifier (for example, CodeBuildAccess).

   5. For Effect, leave Allow selected. This indicates that you want to allow access to another Amazon account.

   6. 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 Amazon account IDs, enter IDs of the Amazon accounts that you want to give access.

   7. Skip the All IAM entities list.

   8. For Action, select the pull-only actions: ecr:GetDownloadUrlForLayer, ecr:BatchGetImage, and ecr:BatchCheckLayerAvailability.

   9. For Conditions, add the following:

      {
         "StringEquals":{
            "aws:SourceAccount":"<AWS-account-ID>",
            "aws:SourceArn":"arn:aws:codebuild:<region>:<AWS-account-ID>:project/<project-name>"
         }
      }
      

   10. Choose Save.

       This policy is displayed in Permissions. The principal is what you entered for Principal in step 3 of this procedure:

       • If your project uses CodeBuild credentials to pull an Amazon ECR image, "codebuild.amazonaws.com" appears under Service principals.

       • If your project uses a cross-account Amazon ECR image, the ID of the Amazon account that you want to give access appears under Amazon Account IDs.

         The following sample policy uses both CodeBuild credentials and a cross-account Amazon ECR image.

       {
          "Version":"2012-10-17",
          "Statement":[
             {
                "Sid":"CodeBuildAccessPrincipal",
                "Effect":"Allow",
                "Principal":{
                   "Service":"codebuild.amazonaws.com"
                },
                "Action":[
                   "ecr:GetDownloadUrlForLayer",
                   "ecr:BatchGetImage",
                   "ecr:BatchCheckLayerAvailability"
                ],
                "Condition":{
                   "StringEquals":{
                      "aws:SourceArn":"arn:aws:codebuild:<region>:<aws-account-id>:project/<project-name>",
                      "aws:SourceAccount":"<aws-account-id>"
                   }
                }
             },
             {
                "Sid":"CodeBuildAccessCrossAccount",
                "Effect":"Allow",
                "Principal":{
                   "AWS":"arn:aws:iam::<AWS-account-ID>:root"
                },
                "Action":[
                   "ecr:GetDownloadUrlForLayer",
                   "ecr:BatchGetImage",
                   "ecr:BatchCheckLayerAvailability"
                ]
             }
          ]
       }

       • If your projects use CodeBuild credentials and you would like your CodeBuild projects to have open access to the Amazon ECR repository, you can omit the Condition keys and add the following sample policy.

       {
         "Version":"2012-10-17",
         "Statement":[
           {
             "Sid":"CodeBuildAccessPrincipal",
             "Effect":"Allow",
             "Principal":{
               "Service":"codebuild.amazonaws.com"
             },
             "Action":[
               "ecr:GetDownloadUrlForLayer",
               "ecr:BatchGetImage",
               "ecr:BatchCheckLayerAvailability"
             ]
           },
           {
             "Sid":"CodeBuildAccessCrossAccount",
             "Effect":"Allow",
             "Principal":{
               "AWS":"arn:aws:iam::<AWS-account-ID>:root"
             },
             "Action":[
               "ecr:GetDownloadUrlForLayer",
               "ecr:BatchGetImage",
               "ecr:BatchCheckLayerAvailability"
             ]
           }
         ]
       }

4. Create a build project, run the build, and view build information.

   If you use the Amazon 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:tag",
       "computeType": "BUILD_GENERAL1_SMALL"
     },
     "serviceRole": "arn:aws:iam::account-ID:role/role-name",
     "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID"
   }

5. To get the build output artifact, open your S3 output bucket.

6. 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.