本文說明如何設定建構作業,以使用使用者自行管理的服務帳戶。
如未指定使用者自行管理的服務帳戶,Cloud Build 會自動使用預設的 Cloud Build 服務帳戶。這個預設服務帳戶可能具備不必要的廣泛權限,例如存取 Cloud Source Repositories 和專案中任何 Cloud Storage bucket 的權限。
建議您遵循最小權限原則,根據服務帳戶執行的工作,指派權限和角色。舉例來說,您可以使用一個服務帳戶建構映像檔並推送至 Artifact Registry,如Cloud de Confiance by S3NS 網誌所示。
事前準備
-
啟用 Cloud Build 和 IAM API (如果尚未啟用)。
啟用 API 所需的角色
您必須具備
serviceusage.services.enable權限,才能啟用 API。如果您建立了專案,可能已透過擁有者角色 (roles/owner) 取得這項權限。否則,您可以透過 Service Usage 管理員角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。 如果您打算使用這個帳戶建立及管理憑證,例如建立短期憑證,請啟用 IAM Service Account Credentials API。
啟用 API 所需的角色
您必須具備
serviceusage.services.enable權限,才能啟用 API。如果您建立了專案,可能已透過擁有者角色 (roles/owner) 取得這項權限。否則,您可以透過 Service Usage 管理員角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。如果您尚未建立服務帳戶,請立即建立。
設定服務帳戶
將 IAM 角色授予使用者自行管理的服務帳戶,讓帳戶具備執行建構作業所需的權限。您也可以設定 Cloud Build,讓系統自動為新觸發條件選擇這個服務帳戶。
-
前往 Cloud de Confiance 控制台的 settings Cloud Build「Permissions」(權限) 頁面:
前往「Service Account」(服務帳戶) 選單,選取服務帳戶。如要選擇其他專案中的服務帳戶,請按一下「Switch project」(切換專案)。
如要將選取的服務帳戶設為新觸發條件的服務帳戶,請開啟「Set as pre-selected for new triggers」(設為新觸發條件的預先選取服務帳戶)。
在 Cloud de Confiance 服務清單中,啟用要授予服務帳戶的 IAM 角色。
如果建構管道所需的角色未列於此處,您可以在 IAM 設定頁面授予其他角色。
如果您選取其他專案中的服務帳戶,請完成「跨專案設定」中的步驟。
如要進一步瞭解建構作業通常需要的 IAM 角色,請參閱下列資訊:
設定建構作業記錄
為建構作業指定自己的服務帳戶時,必須將建構記錄儲存在下列其中一種 bucket 類型:
使用者專案中的 Cloud Storage bucket。這些可以是使用者建立的值區,或Cloud de Confiance建立且由使用者擁有的值區。
建立記錄檔 bucket 時,請確認該 bucket 沒有保留政策,因為政策可能會阻止 Cloud Build 將建構作業記錄檔寫入 bucket。
您無法將記錄檔儲存在 Cloud de Confiance擁有的記錄檔 bucket。
如要進一步瞭解建構記錄的儲存位置,請參閱「建構記錄儲存選項」。
使用設定檔執行建構作業
如要使用設定檔手動執行建構作業,請按照下列步驟操作:
在專案根目錄中,建立名為
cloudbuild.yaml或cloudbuild.json的 Cloud Build 建構設定檔。新增
serviceAccount欄位和偏好的記錄設定。如果您將建構記錄儲存在 Cloud Logging,請新增
logging欄位,並將欄位值設為CLOUD_LOGGING_ONLY。如要將建構記錄儲存在使用者建立的 Cloud Storage bucket,請按照下列步驟操作:
- 新增
logging欄位,並將值設為GCS_ONLY。 - 新增
logsBucket欄位,並將值設為 Cloud Storage bucket 位置。
- 新增
下列範例會設定 Cloud Build,使用使用者自行管理的服務帳戶執行建構作業,並將建構記錄儲存在使用者建立的 Cloud Storage bucket 中:
YAML
steps: - name: 'bash' args: ['echo', 'Hello world!'] logsBucket: 'LOGS_BUCKET_LOCATION' serviceAccount: 'projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT' options: logging: GCS_ONLYJSON
{ "steps": [ { "name": "bash", "args": [ "echo", "Hello world!" ] } ], "logsBucket": "LOGS_BUCKET_LOCATION", "serviceAccount": "projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT", "options": { "logging": "GCS_ONLY" } }將建構設定檔中的變數替換為下列內容:
LOGS_BUCKET_LOCATION是用於儲存建構記錄的 Cloud Storage bucket。例如:gs://mylogsbucket。PROJECT_ID是執行建構作業的 Cloud de Confiance 專案 ID。SERVICE_ACCOUNT是要為建構作業指定的服務帳戶電子郵件地址或專屬 ID。例如,服務帳戶的電子郵件地址如下所示:service-account-name@project-id.s3ns.iam.gserviceaccount.com。
使用建構設定檔展開建構作業:
gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY將指令中的變數替換為下列值:
CONFIG_FILE_PATH是建構設定檔的路徑。SOURCE_DIRECTORY是原始碼的路徑或網址。
如果您未在
gcloud builds submit指令中指定 CONFIG_FILE_PATH 和 SOURCE_DIRECTORY,Cloud Build 會假設建構設定檔和原始碼位於目前使用的目錄。
使用觸發條件執行建構作業
如要使用自己的服務帳戶,透過 Cloud Build 自動建構觸發條件執行建構作業,請設定偏好的記錄選項,並在建立觸發條件時選取偏好的服務帳戶。
如要為所有新觸發條件使用相同的服務帳戶,可以設定 Cloud Build 自動選取服務帳戶。
在建構設定檔中:
如要將建構記錄儲存在 Cloud Logging,請新增
logging欄位,並將欄位值設為CLOUD_LOGGING_ONLY。如要將建構記錄儲存在使用者建立的 Cloud Storage bucket,請按照下列步驟操作:
- 新增
logging欄位,並將值設為GCS_ONLY。 - 新增
logsBucket欄位,並將值設為 Cloud Storage bucket 位置。
- 新增
以下範例會設定將建構記錄儲存在使用者建立的 Cloud Storage bucket 中:
YAML
steps: - name: 'bash' args: ['echo', 'Hello world!'] logsBucket: 'LOGS_BUCKET_LOCATION' options: logging: GCS_ONLYJSON
{ "steps": [ { "name": "bash", "args": [ "echo", "Hello world!" ] } ], "logsBucket": "LOGS_BUCKET_LOCATION", "options": { "logging": "GCS_ONLY" } }將
LOGS_BUCKET_LOCATION替換為要儲存建構記錄的 Cloud Storage bucket。例如:gs://mylogsbucket。指定要與自動建構觸發條件搭配使用的服務帳戶:
控制台
在「Service account」(服務帳戶) 欄位中,指定服務帳戶。如要選擇其他專案中的服務帳戶,請按一下「Switch project」(切換專案)。
如未指定服務帳戶,Cloud Build 會使用預設服務帳戶。
按一下「Create」(建立),儲存自動建構觸發條件。
gcloud
建立自動建構觸發條件時,請使用
--service-account旗標指定服務帳戶。在下列範例中,gcloud指令會建立自動建構觸發條件,從 Git 存放區提取程式碼:gcloud builds triggers create github \ --name=TRIGGER_NAME \ --repo-name=REPO_NAME \ --repo-owner=REPO_OWNER \ --branch-pattern=BRANCH_PATTERN --build-config=BUILD_CONFIG_FILE --service-account=SERVICE_ACCOUNT --project=BUILD_PROJECT將建構設定檔中的變數替換為下列值:
TRIGGER_NAME是自動建構觸發條件的名稱。REPO_NAME是存放區名稱。REPO_OWNER是存放區擁有者的使用者名稱。BRANCH_PATTERN是存放區中要叫用建構作業的分支版本名稱。TAG_PATTERN是存放區中要叫用建構作業的標記名稱。BUILD_CONFIG_FILE是建構設定檔的路徑。SERVICE_ACCOUNT是您的服務帳戶,格式為/projects/PROJECT_ID/serviceAccounts/ACCOUNT_ID_OR_EMAIL。BUILD_PROJECT是您要啟動建構作業的專案。
跨專案設定
只有在未強制執行 iam.disableCrossProjectServiceAccountUsage 組織政策限制的情況下,您才能使用使用者自行管理的服務帳戶,在與建立服務帳戶的專案不同的專案中執行建構作業。這項限制預設會強制執行。瞭解詳情。
下列指令會停用該限制的強制執行,並授予必要存取權。在組織政策中設定限制之前,貴組織必須瞭解相關的安全折衷方案:
gcloud resource-manager org-policies disable-enforce \ iam.disableCrossProjectServiceAccountUsage \ --project=SERVICE_ACCOUNT_PROJECT_ID在這個指令中,SERVICE_ACCOUNT_PROJECT_ID 是包含使用者自行管理服務帳戶的專案
在使用者自行管理的服務帳戶所在專案中,將
roles/iam.serviceAccountTokenCreator角色授予執行建構作業的專案 Cloud Build 服務代理:gcloud projects add-iam-policy-binding SERVICE_ACCOUNT_PROJECT_ID \ --member="serviceAccount:BUILD_SERVICE_AGENT" \ --role="roles/iam.serviceAccountTokenCreator"將指令中的變數替換為下列內容:
SERVICE_ACCOUNT_PROJECT_ID:使用者自行管理的服務帳戶所在專案的專案 ID。BUILD_SERVICE_AGENT:服務代理的電子郵件 ID,格式為service-BUILD_PROJECT_NUMBER@gcp-sa-cloudbuild.s3ns-system.iam.gserviceaccount.com,其中BUILD_PROJECT_NUMBER是執行建構作業的專案編號。您可以前往專案設定頁面查看專案編號。
限制:
您的 Cloud de Confiance 專案必須位於 Cloud de Confiance by S3NS 組織中。
您必須使用
gcloud builds submit或gcloud builds triggers create,在指令列中啟動建構作業。如果在授予 IAM 角色時收到
service account not found錯誤,可能需要手動建立服務代理。
後續步驟
- 進一步瞭解 Cloud Build IAM 角色和權限。
- 瞭解服務帳戶異動對執行建構作業的方式有何影響。