Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1
本页介绍了如何使用客户管理的加密密钥 (CMEK) 来保护 Cloud Composer 环境。客户管理的加密密钥用于加密/解密环境中的用户数据。
准备工作
您只能在创建环境时配置 CMEK。无法为现有环境启用 CMEK。
Cloud Composer 支持使用存储在外部密钥管理器中的密钥进行 CMEK 加密。
您必须在环境所在的区域中创建 CMEK 密钥。您不能使用多区域密钥或全球密钥。
如果您希望您的环境在 VPC Service Controls 边界内运行,则必须将 Cloud Key Management Service API 和 Artifact Registry API 添加到边界。
启用 Artifact Registry API。
控制台
Enable the Artifact Registry API.
gcloud
Enable the Artifact Registry API:
gcloud services enable artifactregistry.googleapis.com
用户信息未受 CMEK 加密保护
Cloud Monitoring 不支持 CMEK 加密。您的环境名称和 DAG 名称会使用 Google-owned and Google-managed encryption keys以加密形式存储在 Monitoring 数据库中。
Cloud Composer 会存储以下受Google-owned and Google-managed encryption keys(而非客户管理的密钥)保护的信息:
- 环境名称
- Airflow 配置替换
- 环境变量
- 允许的 IP 地址范围的说明
- IP 范围
- 标签
- Cloud Composer 存储的某些参数的名称可以包含环境名称的子字符串。
为您的环境使用客户管理的加密密钥
第 1 步:创建客户管理的加密密钥
按照创建对称加密密钥中介绍的步骤,在环境所在的区域创建密钥。
第 2 步:向服务代理授予角色
控制台
gcloud
以下服务代理必须对您为环境使用的密钥拥有 Cloud KMS CryptoKey Encrypter/Decrypter 角色。
将 PROJECT_NUMBER
替换为您的项目编号。
服务代理名称 | 服务账号电子邮件地址 | API 服务名称 |
---|---|---|
Cloud Composer Service Agent | service-PROJECT_NUMBER@cloudcomposer-accounts.iam.gserviceaccount.com | composer.googleapis.com |
Artifact Registry Service Agent | service-PROJECT_NUMBER@gcp-sa-artifactregistry.iam.gserviceaccount.com | artifactregistry.googleapis.com |
Kubernetes Engine Service Agent | service-PROJECT_NUMBER@container-engine-robot。iam.gserviceaccount.com | container.googleapis.com |
Pub/Sub 服务代理 | service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com | pubsub.googleapis.com |
Compute Engine Service Agent | service-PROJECT_NUMBER@compute-system.iam.gserviceaccount.com | compute.googleapis.com |
Cloud Storage Service Agent | service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com | 使用 gcloud storage service-agent --authorize-cmek 授予加密/解密权限 |
(如有需要)如果您的项目中不存在其中某些服务账号,则表示尚未为此服务创建身份。例如,如果您尚未在项目中创建任何 Cloud Composer 环境,就可能会发生这种情况。
如需添加这些服务账号,请使用以下命令为所列服务创建身份:
gcloud beta services identity create \ --service=API_SERVICE_NAME
将
API_SERVICE_NAME
替换为项目中没有服务账号的服务的 API 服务名称。示例:
gcloud beta services identity create \ --service=composer.googleapis.com
向服务代理授予权限:
向 Cloud Composer 服务代理授予该角色:
gcloud kms keys add-iam-policy-binding KEY_NAME \ --location KEY_LOCATION \ --keyring KEY_RING_NAME \ --member=serviceAccount:service-PROJECT_NUMBER@cloudcomposer-accounts.iam.gserviceaccount.com \ --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \ --project KEY_PROJECT_ID
向 Artifact Registry Service Agent 授予该角色:
gcloud kms keys add-iam-policy-binding KEY_NAME \ --location KEY_LOCATION \ --keyring KEY_RING_NAME \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-artifactregistry.iam.gserviceaccount.com \ --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \ --project KEY_PROJECT_ID
向 GKE 服务代理授予该角色:
gcloud kms keys add-iam-policy-binding KEY_NAME \ --location KEY_LOCATION \ --keyring KEY_RING_NAME \ --member=serviceAccount:service-PROJECT_NUMBER@container-engine-robot.iam.gserviceaccount.com \ --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \ --project KEY_PROJECT_ID
向 Pub/Sub 服务代理授予该角色:
gcloud kms keys add-iam-policy-binding KEY_NAME \ --location KEY_LOCATION \ --keyring KEY_RING_NAME \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \ --project KEY_PROJECT_ID
向 Compute Engine 服务账号授予该角色:
gcloud kms keys add-iam-policy-binding KEY_NAME \ --location KEY_LOCATION \ --keyring KEY_RING_NAME \ --member=serviceAccount:service-PROJECT_NUMBER@compute-system.iam.gserviceaccount.com \ --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \ --project KEY_PROJECT_ID
向 Cloud Storage 服务代理授予加密/解密权限。 如果您使用的是自定义环境的存储分区,则可以跳过此步骤。
gcloud storage service-agent \ --authorize-cmek=projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
您需要进行如下替换:
- 将
PROJECT_ID
替换为您的项目 ID。 KEY_PROJECT_ID
替换为存储客户管理的密钥的项目的 ID。如果您使用的是其他项目中的密钥,则此值与您项目的 ID 不同。如果您使用的是同一项目中的密钥,则此值为项目的 ID。- 将
PROJECT_NUMBER
替换为您的项目编号。 KEY_LOCATION
替换为您的客户管理的密钥位置。此位置必须与您的环境位置相同。- 将
KEY_NAME
替换为您的客户管理的密钥名称。 KEY_RING_NAME
与存储客户管理的密钥的密钥串。
如需获取这些值,您可以运行
gcloud projects describe
、gcloud kms keyrings list
和gcloud kms keys describe
命令。
第 3 步:创建使用 CMEK 的环境
创建客户管理的加密密钥后,您可以使用该密钥创建 Cloud Composer 环境。
控制台
创建环境时:
在数据加密部分中,选择客户管理的加密密钥 (CMEK)。
在选择客户管理的密钥下拉列表中,选择您的密钥。
如果需要更多设置,系统就会显示一条消息,通知您。在本例中:
点击打开向导。
在 Prepare CMEK key for usage in Cloud Composer 对话框中,查看必须对密钥具有 Cloud KMS CryptoKey Encrypter/Decrypter 角色的服务代理列表。
如需授予所需的角色和权限,请点击授予。
gcloud
--kms-key
参数为您的环境指定客户管理的加密密钥。
如需详细了解如何创建环境,请参阅创建环境。例如,您可能需要为环境指定其他参数。
gcloud composer environments create ENVIRONMENT_NAME \
--location LOCATION \
--image-version IMAGE_VERSION \
--kms-key projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
您需要进行如下替换:
ENVIRONMENT_NAME
替换为环境的名称。- 将
IMAGE_VERSION
替换为 Cloud Composer 映像的名称。 - 将
KEY_PROJECT_ID
替换为密钥所在的项目的 ID。如果您使用的是其他项目的密钥,此值将不同于您项目的 ID。如果您使用的是同一项目中的密钥,则此值为该项目的 ID。 LOCATION
替换为环境所在的区域。- 将
KEY_LOCATION
替换为客户管理的密钥的位置。此位置必须与您的环境位置相同。 - 将
KEY_NAME
替换为您的客户管理的密钥名称。 KEY_RING_NAME
与存储客户管理的密钥的密钥串。
示例:
gcloud composer environments create example-environment \
--location us-central1 \
--image-version composer-2.11.1-airflow-2.10.2 \
--kms-key projects/example-project/locations/us-central1/keyRings/example-key-ring/cryptoKeys/example-key
查看环境的加密配置
您可以查看现有环境的加密配置:
控制台
在 Google Cloud 控制台中,前往环境页面。
在环境列表中,点击您的环境名称。环境详情页面会打开。
转到环境配置标签页。
数据加密密钥项中列出了有关加密的详细信息。
gcloud
运行以下 gcloud
命令以查看加密配置
gcloud composer environments describe \
ENVIRONMENT_NAME \
--location LOCATION \
--format="value(config.encryptionConfig)"
您需要进行如下替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。
示例:
gcloud composer environments describe \
example-environment \
--location us-central1 \
--format="value(config.encryptionConfig)"
对 Cloud Composer 日志使用 CMEK
Cloud Logging 支持使用 CMEK 密钥加密日志存储空间。我们建议您使用标准 CMEK 流程通过 CMEK 密钥加密日志。
如需使用 CMEK 密钥加密日志,请按照管理用于保护 Logging 存储数据的密钥中的说明操作。
将 Cloud Composer 日志重定向到 CMEK 加密的 Cloud Storage 存储分区
如果您预计日志中包含敏感数据,则可能需要使用日志路由器将 Cloud Composer 日志重定向到 CMEK 加密的 Cloud Storage 存储分区。这样可防止日志发送到 Monitoring。
如果您需要 Cloud Customer Care 的支持,则可能需要向 Google 支持工程师授予对存储在 Cloud Storage 中的 Cloud Composer 日志的访问权限。
gcloud
创建一个新的 Cloud Storage 存储分区来存储日志。
gcloud storage buckets create gs://BUCKET_NAME --location=LOCATION
您需要进行如下替换:
LOCATION
替换为环境所在的区域。- 将
BUCKET_NAME
替换为存储分区的名称。
示例:
gcloud storage buckets create gs://composer-logs-us-central1-example-environment --location=us-central1
使用您的 CMEK 密钥对存储分区进行加密。
gcloud storage buckets update gs://BUCKET_NAME \ --default-encryption-key=projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
您需要进行如下替换:
- 将
KEY_PROJECT_ID
替换为密钥所在的项目的 ID。如果您使用的是其他项目中的密钥,此值与项目的 ID 不同。如果您使用的是同一项目中的密钥,则此值为项目的 ID。 - 将
KEY_LOCATION
替换为客户管理的密钥的位置。此位置必须与您的环境位置相同。 KEY_RING_NAME
与存储客户管理的密钥的密钥串。- 将
KEY_NAME
替换为您的客户管理的密钥名称。 BUCKET_NAME
替换为存储桶的名称。
示例:
gcloud storage buckets update gs://composer-logs-us-central1-example-environment \ --default-encryption-key=projects/example-project/locations/us-central1/keyRings/example-key-ring/cryptoKeys/example-key
- 将
创建新的日志接收器。
gcloud logging sinks create \ composer-log-sink-ENVIRONMENT_NAME \ storage.googleapis.com/BUCKET_NAME \ --log-filter "resource.type=cloud_composer_environment AND resource.labels.environment_name=ENVIRONMENT_NAME AND resource.labels.location=LOCATION"
替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。BUCKET_NAME
替换为存储桶的名称。
示例:
gcloud logging sinks create \ composer-log-sink-example-environment \ storage.googleapis.com/composer-logs-us-central1-example-environment \ --log-filter "resource.type=cloud_composer_environment AND resource.labels.environment_name=example-environment AND resource.labels.location=us-central1"
向此存储分区的服务账号授予 Storage Object Creator 角色。服务账号显示在上一个命令的结果中)。
gcloud projects add-iam-policy-binding \ PROJECT_ID \ --member="serviceAccount:LOGGING_SERVICE_AGENT" \ --role="roles/storage.objectCreator" \ --condition=None
您需要进行如下替换:
- 将
PROJECT_ID
替换为项目 ID。 LOGGING_SERVICE_AGENT
替换为此存储分区的 Logging 服务代理账号。此账号的名称在上一步中获取。
示例:
gcloud projects add-iam-policy-binding \ example-project \ --member="serviceAccount:example-sa@gcp-sa-logging.iam.gserviceaccount.com" \ --role="roles/storage.objectCreator" \ --condition=None
- 将
从 Monitoring 中排除新环境的日志。
gcloud beta logging sinks update _Default \ --add-exclusion name=ENVIRONMENT_NAME-exclusion,filter="resource.type=cloud_composer_environment AND resource.labels.environment_name=ENVIRONMENT_NAME AND resource.labels.location=LOCATION"
您需要进行如下替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。
示例:
gcloud beta logging sinks update _Default \ --add-exclusion name=example-environment-exclusion,filter="resource.type=cloud_composer_environment AND resource.labels.environment_name=example-environment AND resource.labels.location=us-central1"
为日志路由器添加组织级 CMEK 加密。
gcloud logging cmek-settings describe \ --organization=ORGANIZATION_ID
gcloud kms keys add-iam-policy-binding \ --project=KEY_PROJECT_ID \ --member LOGGING_SERVICE_AGENT \ --role roles/cloudkms.cryptoKeyEncrypterDecrypter \ --location=KEY_LOCATION \ --keyring=KEY_RING_NAME \ KEY_NAME
gcloud logging cmek-settings update \ --organization=ORGANIZATION_ID \ --kms-project=KEY_PROJECT_ID \ --kms-keyring=KEY_RING_NAME \ --kms-location=KEY_LOCATION \ --kms-key-name=KEY_NAME
您需要进行如下替换:
- 将
ORGANIZATION_ID
替换为您的组织 ID。 - 将
KEY_PROJECT_ID
替换为密钥所在的项目的 ID。如果您使用的是其他项目中的密钥,此值与项目的 ID 不同。如果您使用的是同一项目中的密钥,则此值为项目的 ID。 KEY_RING_NAME
与存储客户管理的密钥的密钥串。- 将
KEY_LOCATION
替换为客户管理的密钥的位置。此位置必须与您的环境位置相同。 - 将
KEY_NAME
替换为您的客户管理的密钥名称。
- 将
Cloud Composer 的 CMEK 密钥轮替
使用 CMEK 密钥在环境中配置加密后,您可能还需要考虑定期轮替这些密钥,如 KMS 文档中所述。
轮替 CMEK 密钥时,使用之前的密钥版本加密的数据不会自动重新加密,而是使用新的密钥版本加密。如需了解详情,请参阅重新加密数据。
具体而言,这适用于:
- 存储在环境存储分区中的对象。
- 存储在 Airflow 数据库中的 Cata。
- 存储在 Artifact Registry 仓库中的容器映像。
- 在 Cloud Composer 环境中使用 CMEK 加密的所有其他数据对象。