查看、修改和删除政策编排程序

本页面介绍如何查看和删除文件夹或组织中的政策编排程序。

准备工作

  • 查看操作系统政策和操作系统政策分配任务。
  • 查看 OS Config 配额。
  • 确保您满足使用政策编排程序的前提条件。
  • 如果您尚未设置身份验证，请进行设置。身份验证是通过其进行身份验证以访问 Google Cloud 服务和 API 的过程。如需从本地开发环境运行代码或示例，您可以通过选择以下选项之一向 Compute Engine 进行身份验证：

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. 安装 Google Cloud CLI。 安装完成后，运行以下命令来初始化 Google Cloud CLI： 

      gcloud init

      如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

    2. Set a default region and zone.

    REST

    如需在本地开发环境中使用本页面上的 REST API 示例，请使用您提供给 gcloud CLI 的凭证。

      安装 Google Cloud CLI。 安装完成后，运行以下命令来初始化 Google Cloud CLI： 

      gcloud init

      如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

    如需了解详情，请参阅 Google Cloud 身份验证文档中的使用 REST 时进行身份验证。

列出操作系统政策编排程序

如需查看项目、文件夹或组织中的所有政策编排程序，请完成以下步骤：

控制台

如需列出政策编排程序，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往操作系统政策页面。

    转到“操作系统政策”

  2. 点击 Google Cloud 控制台操作栏中的项目选择器，然后选择要在其中创建政策编排程序的文件夹。

  3. 点击全局编排程序。

gcloud

如需查看在文件夹中创建的政策编排程序的详细信息，请运行 os-config policy-orchestrators list 命令：

  gcloud --billing-project=QUOTA_PROJECT_ID compute os-config policy-orchestrators list \
    --folder=FOLDER_NUMBER \

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
  • FOLDER_NUMBER：您在其中创建政策编排程序的文件夹的数字 ID。

示例

  gcloud compute os-config policy-orchestrators list \
    --folder=123456 \

REST

如需查看文件夹中的所有政策编排程序，请向 folders.locations.global.policyOrchestrators.list 方法发送 GET 请求：

GET https://osconfig.googleapis.com/v2/folders/FOLDER_NUMBER/locations/global/policyOrchestrators
-H "x-goog-user-project: QUOTA_PROJECT_ID"

将 FOLDER_NUMBER 替换为您在其中创建政策编排程序的文件夹的数字 ID。

查看政策编排程序的详细信息

如需查看文件夹中的政策编排程序的详细信息，请完成以下步骤：

控制台

如需查看政策编排程序，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往操作系统政策页面。

    转到“操作系统政策”

  2. 点击 Google Cloud 控制台操作栏中的项目选择器，然后选择包含政策编排程序的项目、文件夹或组织。

  3. 点击全局编排程序。

  4. 选择要查看的政策编排程序的名称。系统会打开编排器详情页面。

  5. 如需查看应用于虚拟机的操作系统政策的详细信息，请前往已分配的操作系统政策部分，然后点击查看。

gcloud

如需查看在文件夹中创建的政策编排程序的详细信息，请运行 os-config policy-orchestrators describe 命令：

gcloud --billing-project=QUOTA_PROJECT_ID compute os-config policy-orchestrators describe ORCHESTRATOR_NAME \
  --folder=FOLDER_NUMBER \

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
  • ORCHESTRATOR_NAME：政策编排程序的名称。
  • FOLDER_NUMBER：您在其中创建政策编排程序的文件夹的数字 ID。

示例

  gcloud --billing-project=my-quota-project compute os-config policy-orchestrators describe my-os-policy-orchestrator \
      --folder=123456 \

REST

如需查看政策编排程序的详细信息，请向 folders.locations.global.policyOrchestrators.get 方法发送 GET 请求，

GET https://osconfig.googleapis.com/v2/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
-H "x-goog-user-project: QUOTA_PROJECT_ID"

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
  • FOLDER_NUMBER：政策编排程序所在文件夹的数字 ID。
  • ORCHESTRATOR_NAME：您要删除的政策编排程序的名称。

请求正文必须为空。

修改操作系统政策编排程序

您可以修改政策编排程序，以添加或更新操作系统政策分配、编排程序范围和资源。

控制台

如需更改政策编排程序的设置，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往操作系统政策页面。

    转到“操作系统政策”

  2. 点击 Google Cloud 控制台操作栏中的项目选择器，然后选择政策编排程序所在的项目、文件夹或组织。

  3. 点击全局编排程序。

  4. 选择要修改的政策编排程序的名称。系统会打开编排器详情页面。

  5. 点击修改。

  6. 在操作系统政策部分中，上传操作系统政策文件。

  7. 可选：在状态部分中，选择以下选项之一以指定政策编排程序的行为：

    • ACTIVE：创建后，政策编排程序会立即执行操作。
    • STOPPED：采用此状态创建的政策编排程序不会立即执行任何操作。您以后可以修改政策编排程序以更改其状态。

  8. 在编排范围部分中，指定要在其中部署操作系统政策的文件夹和项目。您只能在这些字段中输入项目编号和文件夹编号。例如 123456、7654321。

  9. 可选：选择包含您要应用操作系统政策的虚拟机的可用区。

  10. 在目标虚拟机实例部分中，指定要应用操作系统政策的目标虚拟机。

    • 选择操作系统系列。

    • 您可以通过指定包含和排除标签来进一步过滤虚拟机。

      例如，您可以在测试环境中选择全部 Ubuntu 虚拟机，并通过指定以下内容来排除运行 Google Kubernetes Engine 的虚拟机：

      • 操作系统系列：ubuntu
      • 包含：env:test、env:staging
      • 排除：goog-gke-node

  11. 指定发布计划。

    • 指定波次规模（也称为中断预算）。例如：10%。
    • 指定等待时间。例如，15 分钟。

  12. 点击保存。

gcloud

如需更新政策编排程序，请使用 os-config policy-orchestrators update 命令。

   gcloud --billing-project=QUOTA_PROJECT_ID compute os-config policy-orchestrators update ORCHESTRATOR_NAME \
   --folder=FOLDER_NUMBER
   --state=stopped

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
  • ORCHESTRATOR_NAME：政策编排程序的名称。

  • FOLDER_NUMBER：政策编排程序所在文件夹的数字文件夹 ID。

    示例

      gcloud --billing-project=my-quota-project compute os-config policy-orchestrators update my-os-policy-orchestrator \
    --folder=123456 \
    --include-projects=5432134,4567890

REST

如需更新文件夹中的政策编排程序，请向 folders.locations.global.policyOrchestrators.patch 方法发送 PATCH 请求。

在请求正文中，修改操作系统政策分配指定内容。

    PATCH https://osconfig.googleapis.com/v2/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
    -H "x-goog-user-project: QUOTA_PROJECT_ID"

      {
        JSON_OS_POLICY_ORCHESTRATOR
      }

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID
  • FOLDER_NUMBER：政策编排程序所在文件夹的数字 ID。
  • ORCHESTRATOR_NAME：您要修改的政策编排程序的名称。
  • JSON_OS_POLICY_ORCHESTRATOR：JSON 格式的政策编排程序对象，用于定义编排程序范围、编排的资源和编排状态。如需详细了解参数和格式，请参阅 Resource: folders.locations.global.policyOrchestrators。

删除政策编排程序

如需删除政策编排程序并取消所有正在进行的发布操作，请完成以下步骤：

控制台

如需删除政策编排程序，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往操作系统政策页面。

    转到“操作系统政策”

  2. 点击 Google Cloud 控制台操作栏中的项目选择器，然后选择要从中删除政策编排程序的项目、文件夹或组织。

  3. 点击全局编排程序。

  4. 选择要删除的政策编排程序的名称。系统会打开编排器详情页面。

  5. 点击删除。

gcloud

如需从文件夹中删除政策编排程序，请执行以下操作：

  1. 使用 os-config policy-orchestrators delete 命令：

      gcloud --billing-project=QUOTA_PROJECT_IDcompute os-config policy-orchestrators delete ORCHESTRATOR_NAME \
    --folder=FOLDER_NUMBER \
    --policy-id=POLICY_ID

    替换以下内容：

    • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
    • ORCHESTRATOR_NAME：政策编排程序的名称。
    • FOLDER_NUMBER：您在其中创建政策编排程序的文件夹的数字 ID。
    • POLICY_ID：为政策编排程序分配的 ID。

    示例

      gcloud --billing-project=my-quota-project compute os-config policy-orchestrators create my-os-policy-orchestrator \
    --folder=123456 \
    --policy-id=my-policy

REST

如需删除文件夹中的政策编排程序，请向 folders.locations.global.policyOrchestrators.delete 方法发送 DELETE 请求：

DELETE https://osconfig.googleapis.com/v2/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
-H "x-goog-user-project: QUOTA_PROJECT_ID"

替换以下内容：

  • QUOTA_PROJECT_ID：配额或结算项目的项目 ID。
  • FOLDER_NUMBER：政策编排程序所在文件夹的数字 ID。
  • ORCHESTRATOR_NAME：您要删除的政策编排程序的名称。

后续步骤