创建构建项目 (Amazon CLI) - Amazon CodeBuild
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

创建构建项目 (Amazon CLI)

有关使用 with 的更多信息Amazon CLI CodeBuild,请参阅命令行参考

要使用创建 CodeBuild 生成项目Amazon CLI,需要创建 JSON 格式的项目结构,填写结构,然后调用create-project命令来创建项目。

创建 JSON 文件

使用以下--generate-cli-skeleton选项使用create-project命令创建骨架 JSON 文件:

aws codebuild create-project --generate-cli-skeleton > <json-file>

这将创建一个 JSON 文件,其路径和文件名由指定<json-file>。

填写这个 JSON 文件

按如下所示修改 JSON 数据并保存结果。

{ "name": "<project-name>", "description": "<description>", "source": { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>", "gitCloneDepth": "<git-clone-depth>", "buildspec": "<buildspec>", "InsecureSsl": "<insecure-ssl>", "reportBuildStatus": "<report-build-status>", "buildStatusConfig": { "context": "<context>", "targetUrl": "<target-url>" }, "gitSubmodulesConfig": { "fetchSubmodules": "<fetch-submodules>" }, "auth": { "type": "<auth-type>", "resource": "<auth-resource>" }, "sourceIdentifier": "<source-identifier>" }, "secondarySources": [ { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>", "gitCloneDepth": "<git-clone-depth>", "buildspec": "<buildspec>", "InsecureSsl": "<insecure-ssl>", "reportBuildStatus": "<report-build-status>", "auth": { "type": "<auth-type>", "resource": "<auth-resource>" }, "sourceIdentifier": "<source-identifier>" } ], "secondarySourceVersions": [ { "sourceIdentifier": "<secondary-source-identifier>", "sourceVersion": "<secondary-source-version>" } ], "sourceVersion": "<source-version>", "artifacts": { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<artifacts-location>", "path": "<artifacts-path>", "namespaceType": "<artifacts-namespacetype>", "name": "<artifacts-name>", "overrideArtifactName": "<override-artifact-name>", "packaging": "<artifacts-packaging>" }, "secondaryArtifacts": [ { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<secondary-artifact-location>", "path": "<secondary-artifact-path>", "namespaceType": "<secondary-artifact-namespaceType>", "name": "<secondary-artifact-name>", "packaging": "<secondary-artifact-packaging>", "artifactIdentifier": "<secondary-artifact-identifier>" } ], "cache": { "type": "<cache-type>", "location": "<cache-location>", "mode": [ "<cache-mode>" ] }, "environment": { "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER", "image": "<image>", "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE", "certificate": "<certificate>", "environmentVariables": [ { "name": "<environmentVariable-name>", "value": "<environmentVariable-value>", "type": "<environmentVariable-type>" } ], "registryCredential": [ { "credential": "<credential-arn-or-name>", "credentialProvider": "<credential-provider>" } ], "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE", "privilegedMode": "<privileged-mode>" }, "serviceRole": "<service-role>", "timeoutInMinutes": <timeout>, "queuedTimeoutInMinutes": <queued-timeout>, "encryptionKey": "<encryption-key>", "tags": [ { "key": "<tag-key>", "value": "<tag-value>" } ], "vpcConfig": { "securityGroupIds": [ "<security-group-id>" ], "subnets": [ "<subnet-id>" ], "vpcId": "<vpc-id>" }, "badgeEnabled": "<badge-enabled>", "logsConfig": { "cloudWatchLogs": { "status": "<cloudwatch-logs-status>", "groupName": "<group-name>", "streamName": "<stream-name>" }, "s3Logs": { "status": "<s3-logs-status>", "location": "<s3-logs-location>", "encryptionDisabled": "<s3-logs-encryption-disabled>" } }, "fileSystemLocations": [ { "type": "EFS", "location": "<EFS-DNS-name-1>:/<directory-path>", "mountPoint": "<mount-point>", "identifier": "<efs-identifier>", "mountOptions": "<efs-mount-options>" } ], "buildBatchConfig": { "serviceRole": "<batch-service-role>", "combineArtifacts": <combine-artifacts>, "restrictions": { "maximumBuildsAllowed": <max-builds>, "computeTypesAllowed": [ "<compute-type>" ] }, "timeoutInMins": <batch-timeout>, "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS" }, "concurrentBuildLimit": <concurrent-build-limit> }

替换以下内容:

名称

必需。此构建项目的名称。此名称在您的 Amazon 账户的所有构建项目中必须是唯一的。

description

可选。此构建项目的描述。

source

必需。一个包含有关此构建项目源代码设置信息的ProjectSource对象。添加 source 对象后,可以使用 secondarySources添加最多 12 个源。这些设置包括:

来源/ 类型

必需。包含要构建的源代码的存储库的类型。有效值包括:

  • CODECOMMIT

  • CODEPIPELINE

  • GITHUB

  • GITHUB_ENTERPRISE

  • BITBUCKET

  • S3

  • NO_SOURCE

如果您使用 NO_SOURCE,则构建规范不能是一个文件,因为项目没有源。相反,您必须使用 buildspec 属性为 buildspec 指定 YAML 格式的字符串。有关更多信息,请参阅 无源项目示例

来源/ 位置

除非将设置为,否则为<source-type>必填项CODEPIPELINE。指定存储库类型的源代码的位置。

  • 对于 CodeCommit,则为指向包含源代码和构建规范文件的存储库的 HTTPS 克隆 URL(例如,https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>)。

  • 对于 Amazon S3,编译输入存储桶名称,后接包含源代码和构建规范的 ZIP 文件的路径和名称。例如:

    • 对于位于输入存储桶根目录的 ZIP 文件:<bucket-name>/<object-name>.zip

    • 对于位于输入存储桶子文件夹中的 ZIP 文件:<bucket-name>/<subfoler-path>/<object-name>.zip

  • 对于 GitHub,则为指向包含源代码和构建规范文件的存储库的 HTTPS 克隆 URL。该 URL 必须包含 github.com。您必须将您的Amazon账户连接到您的 GitHub 账户。为此,请使用 CodeBuild 控制台创建构建项目。

    1. 在 “ GitHub 授权应用程序” 页面的 “组织访问权限” 部分,在您希望 CodeBuild 能够访问的每个存储库旁边选择 “请求访问权限”。

    2. 选择 Authorize application。(在连接到 GitHub 账户后,您不需要完成构建项目的创建。 您可以关闭 CodeBuild 控制台。)

  • 对于 GitHub Enprise Server,则为指向包含源代码和构建规范文件的存储库的 HTTP 或 HTTPS 克隆 URL。您还必须将您的Amazon帐户连接到您的 GitHub企业服务器帐户。为此,请使用 CodeBuild 控制台创建构建项目。

    1. 在 GitHub 企业服务器中创建个人访问令牌。

    2. 将此令牌复制到剪贴板,以便在创建 CodeBuild 项目时使用它。有关更多信息,请参阅 GitHub 帮助网站上的为命令行创建个人访问令牌

    3. 使用控制台创建 CodeBuild 项目时,在源代码中,为源提供者选择 E GitHubnterprise

    4. 对于 Personal Access Token,请粘贴已复制到剪贴板中的令牌。选择 Save Token。您的 CodeBuild 帐户现已连接到您的 GitHub 企业服务器帐户。

  • 对于 Bitbucket,则为指向包含源代码和构建规范文件的存储库的 HTTPS 克隆 URL。该 URL 必须包含 bitbucket.org。您还必须将您的 Amazon 账户连接到您的 Bitbucket 账户。为此,请使用 CodeBuild 控制台创建构建项目。

    1. 当您使用控制台与 Bitbucket 连接 (或重新连接) 时,在 Bitbucket Confirm access to your account (确认对账户的访问) 页面上,选择 Grant access (授予访问权限)。(在连接到您的 Bitbucket 账户后,您不需要完成构建项目的创建。 您可以关闭 CodeBuild 控制台。)

  • 对于Amazon CodePipeline,请勿为指定locationsource。 CodePipeline 忽略此值,因为在中创建管道时 CodePipeline,需要在管道的 “源” 阶段指定源代码位置。

来源/ gitCloneDepth

可选。要下载的历史记录深度。最小值为 0。如果此值为 0、大于 25 或未提供,则会下载每个构建项目的完整历史记录。如果您的源类型是 Amazon S3,则不支持此值。

源代码/ 构建规范

可选。要使用的构建规范定义或文件。如果此值未提供或设置为空字符串,源代码必须在其根目录中包含 buildspec.yml 文件。如果设置了此值,则它可以是内联构建规范文件的路径,也可以是相对于主源目录的替代生成规范文件的路径,也可以是 S3 存储桶的路径。存储桶必须与构建项目位于同一 Amazon 区域中。使用其 ARN 指定构建规范文件(例如,arn:aws:s3:::my-codebuild-sample2/buildspec.yml)。有关更多信息,请参阅 构建规范文件名称和存储位置

来源/ 身份验证

不使用。此对象仅供 CodeBuild 控制台使用。

来源/ reportBuildStatus

指定是否向源提供商发送构建的开始和完成状态。如果您使用 GitHub 企业服务器或 Bitbucket 以外的 GitHub源提供商设置了此设置,invalidInputException则会抛出。

为了能够向源提供者报告构建状态,与源提供者关联的用户必须具有存储库的写入权限。如果用户没有写入权限,则无法更新生成状态。有关更多信息,请参阅 源提供者访问权限

来源/ buildStatusConfig

包含定义 CodeBuild 生成项目如何向源提供程序报告生成状态的信息。此选项仅在源类型为GITHUBGITHUB_ENTERPRISE、或时使用BITBUCKET

来源/buildStatusConfig/上下文

对于 Bitbucket 来源,则为指向处于 Bitbucket 提交状态的name参数。对于 GitHub 源信息,则为指向处于 GitHub 提交状态的context参数。

例如,您可以使用 CodeBuild环境变量来context包含内部版本号和 webhook 触发器:

Amazon CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER

这会导致由 webhook 拉取请求事件触发的 build #24 的上下文如下所示:

Amazon CodeBuild sample-project Build #24 - pr/8
sourcebuildStatusConfig//targetURL

对于 Bitbucket 来源,则为指向处于 Bitbucket 提交状态的url参数。对于 GitHub 源信息,则为指向处于 GitHub 提交状态的target_url参数。

例如,您可以将设置为targetUrlhttps://aws.amazon.com/codebuild/<path to build>,提交状态将链接到此 URL。

您还可以在中包含 CodeBuild 环境变量,targetUrl以便向 URL 添加其他信息。例如,要将构建区域添加到 URL,请将设置targetUrl为:

"targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"

如果构建区域是us-east-2,它将扩展到:

https://aws.amazon.com/codebuild/<path to build>?region=us-east-2
来源/ gitSubmodulesConfig

可选。有关 Git 子模块配置的信息。仅与 CodeCommit、 GitHub、 GitHub 企业服务器和 Bitbucket 一起使用。

sourcegitSubmodulesConfig//fetchSubMod u

如果您希望在存储库中包含 Git 子模块,请将 fetchSubmodules 设置为 true。包含的 Git 子模块必须配置为 HTTPS。

来源/ InsecureSsl

可选。仅与 GitHub 企业服务器一起使用。将此值设置为可在连接true到 E GitHub nterprise Server 项目存储库时忽略 TLS 警告。默认值为 false。只应将 InsecureSsl 用于测试目的。它不应在生产环境中使用。

来源/ 源标识符

用户定义的项目源的标识符。对于主要源来说是可选的。次要来源是必需的。

secondarySources

可选。包含有关构建项目辅助源信息的ProjectSource对象数组。您最多可以添加 12 个辅助来源。这些secondarySources对象使用的属性与source对象使用的属性相同。在辅助源对象中,sourceIdentifier是必填的。

secondarySourceVersions

可选。ProjectSourceVersion 对象数组。如果在构建级别指定 secondarySourceVersions,则它们优先于此对象。

sourceVersion

可选。要为此项目构建的版本。如果未指定,则使用最新版本。如果已指定,则它必须是下列项之一:

  • 对于 CodeCommit,要使用的提交 ID、分支或 Git 标签。

  • 对于 GitHub,提交 ID、拉取请求 ID、分支名称或与要构建的源代码版本相对应的标签名称。如果指定了拉取请求 ID,则它必须使用格式 pr/pull-request-ID(例如,pr/25)。如果指定了分支名称,则将使用分支的 HEAD 提交 ID。如果未指定,则使用默认分支的 HEAD 提交 ID。

  • 对于 Bitbucket,指定提交 ID、分支名称或与您要构建的源代码版本相对应的标签名称。如果指定了分支名称,则将使用分支的 HEAD 提交 ID。如果未指定,则使用默认分支的 HEAD 提交 ID。

  • 对于 Amazon S3,为表示要使用的构建输入 ZIP 文件的对象的版本 ID。

如果在构建级别指定 sourceVersion,则该版本将优先于此 sourceVersion(在对象级别)。有关更多信息,请参阅 使用 Amazon CodeBuild 的源版本示例

文物

必需。一个包含有关此构建项目的输出工件设置信息的ProjectArtifacts对象。添加 artifacts 对象后,可以使用 secondaryArtifacts添加最多 12 个构件。这些设置包括:

文物/ 类型

必需。生成输出构件的类型。有效值为:

  • CODEPIPELINE

  • NO_ARTIFACTS

  • S3

文物/ 地点

仅与S3工件类型一起使用。不用于其他工件类型。

您在先决条件中创建或确定的输出存储桶的名称。

工件/ 路径

仅与S3工件类型一起使用。不用于其他工件类型。

输出存储桶中存放 ZIP 文件或文件夹的路径。如果未指定值,则 CodeBuild 使用namespaceType(如果已指定)和name来确定生成输出 ZIP 文件或文件夹的路径和名称。path例如,如果您指定 fMyPath orpath 和 fMyArtifact.zip orname,则路径和名称将为MyPath/MyArtifact.zip

artifacts/ namespaceTy pe e

仅与S3工件类型一起使用。不用于其他工件类型。

生成输出 ZIP 文件或文件夹的命名空间。有效值包括 BUILD_IDNONE。使用 BUILD_ID 将构建 ID 插入到构建输出 ZIP 文件或文件夹的路径中。否则,请使用 NONE。如果未指定值,则 CodeBuild 使用path(如果已指定)和name来确定生成输出 ZIP 文件或文件夹的路径和名称。namespaceType例如,如果您指定 fMyPath orpath、fBUILD_ID ornamespaceType 和 fMyArtifact.zip orname,则路径和名称将为MyPath/build-ID/MyArtifact.zip

artifacts/name

仅与S3工件类型一起使用。不用于其他工件类型。

内部编译输出 ZIP 文件或文件夹的名称location。例如,如果您指定 fMyPath orpath 和 fMyArtifact.zip orname,则路径和名称将为MyPath/MyArtifact.zip

文物/ overrideArtifactName

仅与 S3 构件类型一起使用。不用于其他工件类型。

可选。如果设置为true,则为指向在 buildspec 文件artifacts块中指定的名称name。有关更多信息,请参阅 适用于 CodeBuild 的构建规范参考

文物/ 包装

仅与S3工件类型一起使用。不用于其他工件类型。

可选。指定如何打包工件。允许的值包括:

NONE

创建一个包含生成工件的文件夹。这是默认值。

ZIP

创建一个包含构建构件的 ZIP 文件。

secondaryArtifacts

可选。包含有关构建项目辅助工件设置信息的ProjectArtifacts对象数组。最多可以添加 12 个辅助构件。secondaryArtifacts 使用的许多设置与 文物 对象相同。

缓存

必需。一个包含有关此构建项目缓存设置信息的ProjectCache对象。有关更多信息,请参阅 构建缓存

环境

必需。一个包含有关该项目构建环境设置的信息的ProjectEnvironment对象。这些设置包括:

环境/ 类型

必需。构建环境的类型。有关更多信息,请参阅输入CodeBuild API 参考

环境/ 图像

必需。此构建环境使用的 Docker 映像标识符。通常,此标识符以 image-name:tag 的形式表示。例如,在 CodeBuild 用于管理其 Docker 存储库中,这可能是aws/codebuild/standard:4.0。在 Docker Hub 中,为 maven:3.3.9-jdk-8。在亚马逊 ECR 中,account-id.dkr.ecr.region-id.amazonaws.com/your-Amazon-ECR-repo-name:tag。有关更多信息,请参阅 提供的 Docker 映像 CodeBuild

环境/ computeType

必需。指定此构建环境使用的计算资源。有关更多信息,请参阅《CodeBuild API 参考》中的 computeTy pe。

环境/ 证书

可选。Amazon S3 存储桶的 ARN、路径前缀和包含 PEM 编码证书的对象密钥。对象键可以仅为 .pem 文件,也可以为包含 PEM 编码的证书的 .zip 文件。例如,如果您的 Amazon S3 存储桶名称为my-bucket,路径前缀为cert,对象密钥名称为certificate.pem,则可接受的格式为certificatemy-bucket/cert/certificate.pemarn:aws:s3:::my-bucket/cert/certificate.pem

环境/ 环境变量

可选。包含要为此构建环境指定的环境变量的EnvironmentVariable对象数组。每个环境变量都表示为一个包含name、、value、和、namevaluetype的对象type

控制台和Amazon CLI用户可以看到所有环境变量。如果您不担心环境变量的可见性,请设置namevalue,然后设置typePLAINTEXT

我们建议您将具有敏感值的环境变量(例如访问密钥 ID、私有Amazon访问Amazon密钥或密码)作为参数存储在 Amazon EC2 Systems Manager 参数存储中或Amazon Secrets Manager。对于name,对于该存储的参数,将标识符设置 CodeBuild 为引用。

如果您使用 Amazon EC2 Systems Manager 参数存储value,请将参数的名称设置为存储在参数存储中。将 type 设置为 PARAMETER_STORE。使用名为的参数/CodeBuild/dockerLoginPassword作为示例,设置nameLOGIN_PASSWORD。将 value 设置为 /CodeBuild/dockerLoginPassword。将 type 设置为 PARAMETER_STORE

重要

如果您使用 Amazon EC2 Systems Manager 参数存储,我们建议您存储参数名称以开头/CodeBuild/(例如,/CodeBuild/dockerLoginPassword)。您可以使用 CodeBuild 控制台在 Amazon EC2 Systems Manager 中创建参数。选择 Create parameter (创建参数),然后按照对话框中的说明操作。(在该对话框中,对于 KMS 密钥,您可以指定账户中Amazon KMS密钥的 ARN。 Amazon EC2 Systems Manager 使用此密钥在存储期间加密参数的值,并在检索期间对其进行解密。) 如果您使用 CodeBuild 控制台创建参数,则控制台将以参数名称/CodeBuild/的存储方式开头。有关更多信息,请参阅 Amazon EC2 系统管理器用户指南中的系统管理器参数存储和系统管理器参数存储控制台演练

如果您的构建项目引用存储在 Amazon EC2 Systems Manager 参数存储中的参数,则构建项目的服务角色必须允许该ssm:GetParameters操作。如果您之前选择了 “新建服务角色”,则将此操作 CodeBuild 包含在生成项目的默认服务角色中。但是,如果您选择了 Existing service role (现有服务角色),必须单独将此操作添加到您的服务角色中。

如果您的构建项目引用了存储在 Amazon EC2 Systems Manager 参数存储中的参数,且参数名称不以开头,并且您选择了建服务角色,则必须更新该服务角色以允许访问不以开头的参数名称/CodeBuild//CodeBuild/这是因为该服务角色仅允许访问以 /CodeBuild/ 开头的参数名称。

如果您选择 “新建服务角色”,则该服务角色包含对 Amazon EC2 Systems Manager 参数存储中/CodeBuild/命名空间下的所有参数进行解密的权限。

您设置的环境变量将替换现有的环境变量。例如,如果 Docker 映像已经包含一个名为 MY_VAR 的环境变量 (值为 my_value),并且您设置了一个名为 MY_VAR 的环境变量 (值为 other_value),那么 my_value 将被替换为 other_value。同样,如果 Docker 映像已经包含一个名为 PATH 的环境变量 (值为 /usr/local/sbin:/usr/local/bin),并且您设置了一个名为 PATH 的环境变量 (值为 $PATH:/usr/share/ant/bin),那么/usr/local/sbin:/usr/local/bin 将被替换为文本值 $PATH:/usr/share/ant/bin

请勿使用以 CODEBUILD_ 打头的名称设置任何环境变量。此前缀是专为 内部使用预留的。

如果具有相同名称的环境变量在多处都有定义,则应按照如下方式确定其值:

  • 构建操作调用开始时的值优先级最高。

  • 构建项目定义中的值优先级次之。

  • 构建规范声明中的值优先级最低。

如果您使用 Secrets Managervalue,则将参数的名称设置为存储在 Secrets Manager 中。将 type 设置为 SECRETS_MANAGER。以名为的密钥/CodeBuild/dockerLoginPassword为例,设置nameLOGIN_PASSWORD。将 value 设置为 /CodeBuild/dockerLoginPassword。将 type 设置为 SECRETS_MANAGER

重要

如果您使用 Secrets Manager,我们建议您存储名称以开头的密钥/CodeBuild/(例如,/CodeBuild/dockerLoginPassword)。有关更多信息,请参阅什么是Amazon Secrets Manager? 在《Amazon Secrets Manager用户指南》中。

如果您的生成项目引用存储在 Secrets Manager 中的密钥,则生成项目的服务角色必须允许该secretsmanager:GetSecretValue操作。如果您之前选择了 “新建服务角色”,则将此操作 CodeBuild 包含在生成项目的默认服务角色中。但是,如果您选择了 Existing service role (现有服务角色),必须单独将此操作添加到您的服务角色中。

如果您的构建项目引用了存储在 Secrets Manager 中的密钥,且密钥名称不以开头,并且您选择了建服务角色,则必须更新服务角色以允许访问不以开头的密钥名称/CodeBuild//CodeBuild/这是因为服务角色仅允许访问以开头的机密名称/CodeBuild/

如果选择 “新建服务角色”,则服务角色将包含解密密钥管理器中/CodeBuild/命名空间下所有密钥的权限。

环境/ 注册表/证书

可选。一个RegistryCredential对象,用于指定提供私有 Docker 注册表访问权限的凭证。

环境/注册表/凭 /证书

指定使用创建的凭证的 ARN 或名称Amazon Managed Services。仅当凭证存在于您当前的区域中时,您才能使用凭证的名称。

环境/注册表/凭证/ 证书提供者

唯一有效值为 SECRETS_MANAGER

当设置此属性时:

  • imagePullCredentials 必须设置为 SERVICE_ROLE

  • 映像不能是辅助映像或 Amazon ECR 映像。

环境/ imagePullCredentials类型

可选。 CodeBuild 用于在您的构建中拉取映像的类型。有两个有效值:

代码构建

CODEBUILD指定 CodeBuild 使用其自己的凭证。您必须编辑 Amazon ECR 存储库策略才能信任 CodeBuild 服务主体。

服务角色

指定 CodeBuild 使用您的生成项目的服务角色。

当您使用跨账户或专用镜像仓库镜像时,必须使用 SERVICE_ROLE 凭证。当您使用辅助 CodeBuild 映像时,必须使用CODEBUILD凭证。

环境/ PrivilegedMod e

true仅在计划使用此构建项目构建 Docker 映像时设置为。否则,尝试与 Docker 守护程序交互的所有关联的构建都将失败。您还必须启动 Docker 守护程序,以便您的构建与其交互。执行此操作的一种方法是通过运行以下构建命令在您的构建规范文件的 install 阶段初始化 Docker 守护程序。如果您指定了由 Docker 支持提供的构建环境映像 CodeBuild ,请不要运行这些命令。

注意

默认情况下,Docker 容器不允许访问任何设备。特权模式将授予构建项目的 Docker 容器访问所有设备的权限。有关更多信息,请参阅 Docker 文档网站上的运行时权限和 Linux 功能

- 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"

serviceRole

必需。服务角色的 ARN CodeBuild 用于代表 IAM 用户与服务进行交互(例如,arn:aws:iam::account-id:role/role-name)。

timeoutInMinutes

可选。5 到 480 分钟 (8 个小时) 之间的一个分钟数,在此时间后,如果构建未完成, CodeBuild 会将其停止。如果未指定,则使用默认值 60。要确定是否以及何时由于超时而 CodeBuild 停止构建,请运行batch-get-builds命令。要确定构建是否已停止,请在输出中查看 buildStatus 的值是否为 FAILED。要确定构建何时超时,请在输出中查看与 TIMED_OUTphaseStatus 值关联的 endTime 值。

queuedTimeoutInmint

可选。介于 5 到 480(8 小时)之间的分钟数,在此之后如果构建仍在排队中,则 CodeBuild会停止构建。如果未指定,则使用默认值 60。

encryptionKey

可选。Amazon KMS key用于加密生成输出的别名或 ARN。 CodeBuild 如果您指定别名,请使用格式 arn:aws:kms:region-ID:account-ID:key/key-ID,或者,如果存在别名,请使用格式 alias/key-alias。如果未指定,则使用 Amazon S3 的Amazon-managed KMS 密钥。

标签

可选。一组 T ag 对象,提供您想要与此构建项目关联的标签。您最多可指定 50 个标签。任何支持 CodeBuild 构建项目标签的Amazon服务都可以使用这些标签。每个标签都表示为带有 akey 和 a 的对象value

vpcConfig

可选。一个包含有关您的项目 VPC 配置的信息的VpcConfig对象。有关更多信息,请参阅 使用Amazon CodeBuild使用 Amazon Virtual Private Cloud

这些属性包括:

vpcId

必需。 CodeBuild 使用的 VPC ID。运行此命令获取您的区域中的所有 VPC ID 的列表:

aws ec2 describe-vpcs --region <region-ID>
子网

必需。一组子网 ID,包括所使用的资源 CodeBuild。运行以下命令获取这些 ID:

aws ec2 describe-subnets --filters "Name=vpc-id,Values=<vpc-id>" --region <region-ID>
securityGroupIds

必需。一组安全组 ID,用于 CodeBuild 允许访问 VPC 中的资源。运行以下命令获取这些 ID:

aws ec2 describe-security-groups --filters "Name=vpc-id,Values=<vpc-id>" --<region-ID>

badgeEnabled

可选。指定是否在 CodeBuild 项目中包含构建徽章。设置true为启用构建徽章,或者设置为false其他方式。有关更多信息,请参阅 使用以下方法制作徽章示例 CodeBuild

Logsfig

一个包含有关此版本日志所在位置的信息的LogsConfig对象。

logsConfig/ cloudWatchLogs

一个包含有关将日志推送到 CloudWatch 日志的信息的CloudWatchLogsConfig对象。

logsConfig/ s3Logs

一个 S3LogsConfig 对象,其中包含有关将日志推送到 Amazon S3 的信息。

fileSystemLocations

可选。包含有关您的 Amazon EFS 配置信息的ProjectFileSystemsLocation对象数组。

buildBatchConfig

可选。该buildBatchConfig对象是一个包含项目批量生成配置信息的ProjectBuildBatchConfig结构。

buildBatchConfig/s erviceRole

批量构建项目的服务角色 ARN。

buildBatchConfig/组合神器

一个布尔值,用于指定是否将批量构建的构件合并到单个构件位置。

buildBatchConfig/限制/ maximumBuildsAllowed

允许的最大构建数。

buildBatchConfig/限制/ computeTypesAllowed

指定批量构建允许的计算类型的字符串数组。请参阅构建环境计算类型以了解这些值。

buildBatchConfig/timeoutInMinutes

必须完成批量构建的最长时间(以分钟为单位)。

buildBatchConfig/batchReportMode

指定如何将构建状态报告发送到源提供程序以进行批量生成。有效值包括:

REPORT_AGGREGATED_BATCH

(默认)将所有构建状态聚合到单个状态报告中。

REPORT_INDIVIDUAL_BUILDS

为每个单独的构建发送单独的状态报告。

concurrentBuildLimit

此项目允许的并发构建的最大数量。

仅当当前构建数量小于或等于此限值时,才会启动新构建。如果当前构建计数达到此限值,则新构建将受到限制且不会运行。

创建项目

要创建项目,请再次运行create-project命令,传递您的 JSON 文件:

aws codebuild create-project --cli-input-json file://<json-file>

如果成功,项目对象的 JSON 表示形式将出现在控制台输出中。有关此数据的示例,请参阅CreateProject 响应语法

您稍后可以更改构建项目的任何设置,但构建项目名称除外。有关更多信息,请参阅 更改构建项目的设置 (Amazon CLI)

要开始运行构建,请参阅 运行构建 (Amazon CLI)

如果您的源代码存储 GitHub 库中存储源代码,并且您想要 CodeBuild 在每次代码更改推送到存储库时重新构建源代码,请参阅开始自动运行构建 (Amazon CLI)