ポリシー オーケストレーターの表示、編集、削除

このページでは、フォルダまたは組織内のポリシー オーケストレーターを表示および削除する方法について説明します。

始める前に

  • OS ポリシーとその割り当てを確認します。
  • OS Config の割り当てを確認します。
  • ポリシー オーケストレーターの使用に関する前提条件を満たしていることを確認します。
  • まだ設定していない場合は、認証を設定します。認証とは、 Google Cloud サービスと API にアクセスするために ID を確認するプロセスです。ローカル開発環境からコードまたはサンプルを実行するには、次のいずれかのオプションを選択して 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. After installing the Google Cloud CLI, initialize it by running the following command: 

        gcloud init

        If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      2. Set a default region and zone.

        3. REST

        このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

          After installing the Google Cloud CLI, initialize it by running the following command: 

          gcloud init

          If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

        詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

OS ポリシー オーケストレーターを一覧表示する

プロジェクト、フォルダ、または組織内のすべてのポリシー オーケストレーターを表示する手順は次のとおりです。

コンソール

ポリシー オーケストレーターを一覧表示する手順は次のとおりです。

  1. Google Cloud コンソールで、[OS ポリシー] ページに移動します。

    [OS ポリシー] に移動

  2. Google Cloud コンソールのアクションバーでプロジェクト セレクタをクリックし、ポリシー オーケストレーターを作成するフォルダを選択します。

  3. [OS ポリシー オーケストレーター] をクリックします。

gcloud

フォルダに作成されたポリシー オーケストレーターの詳細を表示するには、os-config policy-orchestrators list コマンドを実行します。

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

次のように置き換えます。

例

  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 コンソールで、[OS ポリシー] ページに移動します。

    [OS ポリシー] に移動

  2. Google Cloud コンソールのアクションバーでプロジェクト セレクタをクリックし、ポリシー オーケストレーターを含むプロジェクト、フォルダ、または組織を選択します。

  3. [OS ポリシー オーケストレーター] をクリックします。

  4. 表示するポリシー オーケストレーターの名前を選択します。[オーケストレーターの詳細] ページが開きます。

  5. VM に適用されている OS ポリシーの詳細を表示するには、[割り当てられた OS ポリシー] セクションに移動して、[表示] をクリックします。

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: 削除するポリシー オーケストレーターの名前。

リクエストの本文は空にする必要があります。

OS ポリシー オーケストレーターを編集する

ポリシー オーケストレーターを変更して、OS ポリシーの割り当て、オーケストレーター スコープ、リソースを追加または更新できます。

コンソール

ポリシー オーケストレーターの設定を変更する手順は次のとおりです。

  1. Google Cloud コンソールで、[OS ポリシー] ページに移動します。

    [OS ポリシー] に移動

  2. Google Cloud コンソールのアクションバーでプロジェクト セレクタをクリックし、ポリシー オーケストレーターが存在するプロジェクト、フォルダ、または組織を選択します。

  3. [OS ポリシー オーケストレーター] をクリックします。

  4. 編集するポリシー オーケストレーターの名前を選択します。[オーケストレーターの詳細] ページが開きます。

  5. [編集] をクリックします。

  6. [OS ポリシー] セクションで、OS ポリシー ファイルをアップロードします。

  7. 省略可: [状態] セクションで、次のいずれかのオプションを選択して、ポリシー オーケストレーターの動作を指定します。

    • ACTIVE: ポリシー オーケストレーターは作成後すぐにアクションを実行します。
    • STOPPED: この状態のポリシー オーケストレーターは、すぐにアクションを実行しません。ポリシー オーケストレーターは後で編集して状態を変更できます。

  8. [オーケストレーション スコープ] セクションで、OS ポリシーをロールアウトするフォルダとプロジェクトを指定します。これらのフィールドには、プロジェクト番号とフォルダ番号のみを入力する必要があります。例: 123456、7654321

  9. 省略可: OS ポリシーを適用する VM を含むゾーンを選択します。

  10. 省略可: [ターゲット VM インスタンス] セクションで、OS ポリシーを適用するターゲット VM を指定します。

    • OS ファミリーを選択します。

    • 対象ラベルまたは除外ラベルを指定して、VM をさらにフィルタリングできます。

      たとえば、次のように指定すると、テスト環境のすべての Ubuntu VM を対象にし、Google Kubernetes Engine を実行している VM を除外できます。

      • OS ファミリー: 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 リクエストを送信します。

リクエスト本文で、OS ポリシーの割り当て仕様を編集します。

    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 コンソールで、[OS ポリシー] ページに移動します。

    [OS ポリシー] に移動

  2. Google Cloud コンソールのアクションバーでプロジェクト セレクタをクリックし、ポリシー オーケストレーターを削除するプロジェクト、フォルダ、または組織を選択します。

  3. [OS ポリシー オーケストレーター] をクリックします。

  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: 削除するポリシー オーケストレーターの名前。

次のステップ