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

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

创建构建项目 (Amazon CLI)

有关使用Amazon CLI,请参阅命令行参考.

要 CodeBuild 用Amazon CLI中,您可以创建一个 JSON 格式的项目结构,填充结构,然后调用create-project命令创建项目。

创建 JSON 文件

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

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> }, "concurrentBuildLimit": <concurrent-build-limit> }

替换以下内容:

name

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

description

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

source

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

/Sourcetype

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

  • CODECOMMIT

  • CODEPIPELINE

  • GITHUB

  • GITHUB_ENTERPRISE

  • BITBUCKET

  • S3

  • NO_SOURCE

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

/Source位置

除非您设置了<source-type>CODEPIPELINE. 指定存储库类型的源代码的位置。

  • 对于 CodeCommit,则为指向包含源代码和构建规范文件的存储库的 HTTPS 克隆 URL 克隆 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 Enterprise Server,则为指向包含源代码和构建规范文件的存储库的 HTTP 或 HTTPS 克隆 URL。您还必须将您的 Amazon 账户连接到您的 GitHub Enterprise Server 账户。为此,请使用 CodeBuild 控制台创建构建项目。

    1. 在 GitHub Enterprise Server 中创建个人访问令牌。

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

    3. 如果您使用控制台创建 CodeBuild 项目,请在, 用于源提供商中,选择GitHub Enterprise.

    4. 对于 Personal Access Token,请粘贴已复制到剪贴板中的令牌。选择 Save Token。您的 CodeBuild 账户现在已与您的 GitHub Enterprise Server 账户连接。

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

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

  • 对于 Amazon CodePipeline,请勿为 source 指定 location 值。CodePipeline 会忽略此值,因为当您在 CodePipeline 中创建管道时,您会在管道的源阶段指定源代码位置。

/SourceGitCloneDepth

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

/SourceBuildSpec

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

/Sourceauth

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

/SourcereportBuildStatus

指定是否向源提供商发送构建的开始和完成状态。如果使用源提供商而非 GitHub、GitHub Enterprise Server 或 Bitbucket 设置此项,则会引发 invalidInputException

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

/SourceBuildStatusConfig

包含定义 CodeBuild 构建项目如何向源提供程序报告生成状态的信息。此选项仅在源类型为GITHUBGITHUB_ENTERPRISE,或者BITBUCKET.

源/构建状态配置/context

对于 Bitbucket 源代码,此参数用于name参数处于 Bitbucket 提交状态。对于 GitHub 源,此参数用于context参数中的 GitHub 提交状态。

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

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

这会导致由 Webhook 拉取请求事件触发的构建 #24 的上下文显示如下:

Amazon CodeBuild sample-project Build #24 - pr/8
源/构建状态配置/TargetUl

对于 Bitbucket 源代码,此参数用于url参数处于 Bitbucket 提交状态。对于 GitHub 源,此参数用于target_url参数中的 GitHub 提交状态。

例如,您可以将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
/SourcegitSubmodulesConfig

可选。有关 Git 子模块配置的信息。只能与 CodeCommit、GitHub、GitHub Enterprise Server 和 Bitbucket 一起使用。

源/基特子模块配置/提取子模块

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

/SourceInsecureSsl

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

/Source源标识符

用户定义的项目源标识符。对于主要源,可选。对于辅助源是必需的。

secondarySources

可选。数组项目来源对象,这些对象包含有关构建项目的辅助源的信息。最多可以添加 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 的源版本示例

artifacts

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

/Sourctype

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

  • CODEPIPELINE

  • NO_ARTIFACTS

  • S3

/Sourc位置

仅与S3对象类型。不用于其他工件类型。

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

/Sourc路径

仅与S3对象类型。不用于其他工件类型。

输出存储桶中用于放置 ZIP 文件或文件夹的路径。如果您不指定path,CodeBuild 使用namespaceType(如果已指定)和name以确定构建输出 ZIP 文件或文件夹的路径和名称。例如,如果指定MyPath对于 来说为pathMyArtifact.zip对于 来说为name,路径和名称将是MyPath/MyArtifact.zip.

/SourcnamespaceType

仅与S3对象类型。不用于其他工件类型。

构建输出 ZIP 文件或文件夹的命名空间。有效值包括 BUILD_IDNONE。使用 BUILD_ID 将构建 ID 插入到构建输出 ZIP 文件或文件夹的路径中。否则,请使用 NONE。如果您不指定namespaceType,CodeBuild 使用path(如果已指定)和name以确定构建输出 ZIP 文件或文件夹的路径和名称。例如,如果指定MyPath对于 来说为pathBUILD_ID对于 来说为namespaceType, 和MyArtifact.zip对于 来说为name,路径和名称将是MyPath/build-ID/MyArtifact.zip.

artifacts/name

仅与S3对象类型。不用于其他工件类型。

构建输出 ZIP 文件或文件夹的名称。location. 例如,如果指定MyPath对于 来说为pathMyArtifact.zip对于 来说为name,路径和名称将是MyPath/MyArtifact.zip.

构件/覆盖项目名称

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

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

构件/包装

仅与S3对象类型。不用于其他工件类型。

可选。指定如何打包对象。允许的值包括:

NONE

创建包含构建对象的文件夹。这是默认值。

ZIP

创建包含构建工件的 ZIP 文件。

secondaryArtifacts

可选。数组项目事实对象,其中包含有关生成项目的辅助工件设置的信息。最多可以添加 12 个辅助构件。secondaryArtifacts 使用的许多设置与 artifacts 对象相同。

cache

必填项。AProjectCache对象,该对象包含有关此构建项目的缓存设置的信息。有关更多信息,请参阅构建缓存

environment

必填项。A项目对象,该对象包含有关此项目的构建环境设置的信息。这些设置包括:

环境/type

必填项。构建环境的类型。有关更多信息,请参阅 。type中的CodeBuild API 参考.

环境/映像

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

环境/computeType

必填项。指定此构建环境使用的计算资源。有关更多信息,请参阅 。computeType中的CodeBuild API 参考.

环境/证书

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

环境/环境变量

可选。数组EnvironmentVariable对象,其中包含您要为此构建环境指定的环境变量。每个环境变量都以包含namevalue, 和typenamevalue, 和type.

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

我们建议您存储具有敏感值的环境变量,例如Amazon访问密钥 ID,Amazon私有访问密钥或密码,作为 Amazon EC2 Systems Manager Parameter Store 中的参数,或Amazon Secrets Manager. 适用于name对于该存储的参数,请为 CodeBuild 设置一个标识符以供 CodeBuild 引用。

如果您使用 Amazon EC2 Systems Manager Parameter Store,对于value中,按照 Parameter Store 中存储的参数名称设置参数名称。将 type 设置为 PARAMETER_STORE。使用名为/CodeBuild/dockerLoginPassword例如,设置nameLOGIN_PASSWORD. 将 value 设置为 /CodeBuild/dockerLoginPassword。将 type 设置为 PARAMETER_STORE

重要

如果您使用 Amazon EC2 Systems Manager Parameter Store,我们建议您使用以开头的参数名称来存储参数。/CodeBuild/(例如,/CodeBuild/dockerLoginPassword)。您可以使用 CodeBuild 控制台在 Amazon EC2 Systems Manager Parameter Manager Parameter 中创建参数。选择 Create parameter (创建参数),然后按照对话框中的说明操作。(在该对话框中,对于KMS 密钥中,您可以指定Amazon KMS密钥。 Amazon EC2 Systems Manager 使用此密钥在存储过程中加密参数的值并在检索过程中解密参数的值。) 如果您使用 CodeBuild 控制台创建参数,控制台将以/CodeBuild/,因为它正在存储。有关更多信息,请参阅 。Systems Manager Parameter StoreSystems Manager Parameter Store 控制台演练中的Amazon EC2 Systems Manager 用户指南.

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

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

如果选择新服务角色,该服务角色将拥有解密下的所有参数的权限。/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 Manager,则对于value中,按照存储在 Secrets Manager 中的参数名称设置参数名称。将 type 设置为 SECRETS_MANAGER。使用名为/CodeBuild/dockerLoginPassword例如,设置nameLOGIN_PASSWORD. 将 value 设置为 /CodeBuild/dockerLoginPassword。将 type 设置为 SECRETS_MANAGER

重要

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

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

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

如果选择新服务角色,服务角色包含解密/CodeBuild/命名空间。

环境/注册资格认证

可选。ARegistryCredential对象,该对象指定提供对私有 Docker 注册表的访问权的凭证。

环境/注册机构证书/凭证

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

环境/注册机构证书/凭据提供程序

唯一有效值为 SECRETS_MANAGER

当设置此属性时:

  • imagePullCredentials 必须设置为 SERVICE_ROLE

  • 该映像不能为精选映像或 Amazon ECR 映像。

环境/imagePullCredentialsType

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

CODEBUILD

CODEBUILD指定 CodeBuild 使用其自己的凭证。您必须编辑 Amazon ECR 存储库策略以信任 CodeBuild 服务委托人。

服务角色

指定 CodeBuild 使用您的构建项目的服务角色。

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

环境/privilegedMode

设置设置true仅当您计划使用此构建项目来构建 Docker 映像,并且您指定的构建环境映像不是由具有 Docker 支持的 CodeBuild 提供时,才会使用此构建项目来构建 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

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

timeoutInMinutes

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

queuedTimeoutInMinutes

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

encryptionKey

可选。的别名或 ARNAmazon KMS用来加密 CodeBuild 输出的客户托管密钥 (CMK)。如果您指定别名,请使用格式 arn:aws:kms:region-ID:account-ID:key/key-ID,或者,如果存在别名,请使用格式 alias/key-alias。如果未指定,Amazon使用适用于 Amazon S3 的托管 CMK。

tags

可选。数组标记对象,这些对象提供您希望与此构建项目关联的标签。您最多可指定 50 个标签。这些标签可由任何Amazon服务,它支持 CodeBuild 生成项目标签。每个标签都表示为一个具有key和一个value.

vpcConfig

可选。AVpcConfig对象,其中包含有关您的项目的 VPC 配置的信息。这些属性包括:

vpcId

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

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

必填项。包含 CodeBuild 使用的资源的子网 ID 的数组。运行以下命令获取这些 ID:

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

必填项。CodeBuild 使用的一组安全组 ID,以支持对 VPC 中的资源的访问的数组。运行以下命令获取这些 ID:

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

badgeEnabled

可选。指定何时在您的 CodeBuild 项目中包含构建标志。设置设置true启用构建徽章,或者false听觉。有关更多信息,请参阅使用 CodeBuild 构建来构建徽章示例

logsConfig

ALogsConfig对象,该对象包含有关此构建的日志所在位置的信息。

LogsConfig/CloudLogs

ACloudWatchLogsConfig对象,该对象包含有关将日志推送到 CloudWatch Logs 的信息。

LogsConfig/S3Logs

网络 ACL 和安全组都允许 (因此可到达您的实例) 的发起 ping 的S3LogsConfig对象,该对象包含有关将日志推送到 Amazon S3 的信息。

fileSystemLocations

可选。数组项目文件系统位置对象,其中包含有关您的 Amazon EFS 配置的信息。

buildBatchConfig

可选。这些区域有:buildBatchConfig对象为ProjectBuildBatchConfig结构,该结构包含项目的批量构建配置信息。

BuildBatchConfig/serviceRole

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

BuildBatchConfig/组合工件

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

建筑批配置/限制/MaximumBuildAllowed

允许的最大构建数。

建筑批配置/限制/允许的计算类型

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

BuildBatchConfig/timeoutInMinutes

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

concurrentBuildLimit

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

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

创建项目

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

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

如果成功,项目对象显示在控制台输出中。请参阅CreateProject 响应语法以获取此数据的示例。

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

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

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