このページでは、フォルダまたは組織内のポリシー オーケストレーターを表示および削除する方法について説明します。
始める前に
- OS ポリシーとその割り当てを確認します。
- OS Config の割り当てを確認します。
- ポリシー オーケストレーターの使用に関する前提条件を満たしていることを確認します。
-
まだ設定していない場合は、認証を設定します。認証とは、サービスと API にアクセスするために ID を確認するプロセスです。 Google Cloud ローカル開発環境からコードまたはサンプルを実行するには、次のいずれかのオプションを選択して Compute Engine に対する認証を行います。
Select the tab for how you plan to use the samples on this page:
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
- Set a default region and zone.
REST
このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。
-
フォルダ内のすべてのポリシー オーケストレーターを一覧表示する
フォルダ内のすべてのポリシー オーケストレーターを表示する手順は次のとおりです。
フォルダ内のポリシー オーケストレーターを一覧表示するには、次の操作を行います。
Google Cloud コンソールで、[OS ポリシー] ページに移動します。
Google Cloud コンソールのアクションバーで [プロジェクト セレクタ] をクリックし、ポリシー オーケストレーターを作成するフォルダを選択します。
[Policy Orchestrators] をクリックします。
フォルダに作成されたポリシー オーケストレーターの詳細を表示するには、beta os-config policy-orchestrators list
コマンドを実行します。
gcloud --billing-project=QUOTA_PROJECT_ID beta compute os-config policy-orchestrators list \ --folder=FOLDER_NUMBER \
次のように置き換えます。
QUOTA_PROJECT_ID
: 割り当てまたは課金プロジェクトのプロジェクト ID。FOLDER_NUMBER
: ポリシー オーケストレーターを作成したフォルダの数値 ID。
例
gcloud beta compute os-config policy-orchestrators list \ --folder=123456 \
フォルダ内のすべてのポリシー オーケストレーターを表示するには、folders.locations.global.policyOrchestrators.list
メソッドに GET
リクエストを送信します。
GET https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER /locations/global/policyOrchestrators -H "x-goog-user-project:QUOTA_PROJECT_ID "
FOLDER_NUMBER
は、ポリシー オーケストレーターを作成したフォルダの数値 ID に置き換えます。
ポリシー オーケストレーターの詳細を表示する
フォルダ内のポリシー オーケストレーターの詳細を表示する手順は次のとおりです。
ポリシー オーケストレーターを表示する手順は次のとおりです。
Google Cloud コンソールで、[OS ポリシー] ページに移動します。
Google Cloud コンソールのアクションバーで [プロジェクト セレクタ] をクリックし、ポリシー オーケストレーターを作成するフォルダを選択します。
[Policy Orchestrators] をクリックします。
表示するポリシー オーケストレーターの名前を選択します。[オーケストレーターの詳細] ページが開きます。
VM に適用されている OS ポリシーの詳細を表示するには、[OS ポリシー テンプレート] をクリックします。
フォルダに作成されたポリシー オーケストレーターの詳細を表示するには、beta os-config policy-orchestrators describe
コマンドを実行します。
gcloud --billing-project=QUOTA_PROJECT_ID beta compute os-config policy-orchestrators describeORCHESTRATOR_NAME \ --folder=FOLDER_NUMBER \
次のように置き換えます。
QUOTA_PROJECT_ID
: 割り当てまたは課金プロジェクトのプロジェクト ID。ORCHESTRATOR_NAME
: ポリシー オーケストレーターの名前。FOLDER_NUMBER
: ポリシー オーケストレーターを作成したフォルダの数値 ID。
例
gcloud --billing-project=my-quota-project beta compute os-config policy-orchestrators describe my-os-policy-orchestrator \ --folder=123456 \
ポリシー オーケストレーターの詳細を表示するには、folders.locations.global.policyOrchestrators.get
メソッドに GET
リクエストを送信します。
GET https://osconfig.googleapis.com/v2beta/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 ポリシーの割り当て、オーケストレーター スコープ、リソースを追加または更新できます。
ポリシー オーケストレーターの設定を変更する手順は次のとおりです。
Google Cloud コンソールで、[OS ポリシー] ページに移動します。
Google Cloud コンソールのアクションバーで [プロジェクト セレクタ] をクリックし、ポリシー オーケストレーターを作成するフォルダを選択します。
[Policy Orchestrators] をクリックします。
編集するポリシー オーケストレーターの名前を選択します。[オーケストレーターの詳細] ページが開きます。
[編集] をクリックします。
[OS ポリシー] セクションで、OS ポリシー ファイルをアップロードします。
省略可: [状態] セクションで、次のいずれかのオプションを選択して、ポリシー オーケストレーターの動作を指定します。
ACTIVE
: 作成されると、ポリシー オーケストレーターはすぐにアクションを実行します。STOPPED
: この状態のポリシー オーケストレーターは、すぐにアクションを実行しません。ポリシー オーケストレーターは後で編集して状態を変更できます。
[オーケストレーション スコープ] セクションで、OS ポリシーをロールアウトするフォルダとプロジェクトを指定します。これらのフィールドには、プロジェクト番号とフォルダ番号のみを入力する必要があります。例: 123456、7654321。
省略可: OS ポリシーを適用する VM を含むゾーンを選択します。
省略可: [ターゲット VM インスタンス] セクションで、OS ポリシーを適用するターゲット VM を指定します。
- OS ファミリーを選択します。
対象ラベルまたは除外ラベルを指定して、VM をさらにフィルタリングできます。
たとえば、次のように指定すると、テスト環境のすべての Ubuntu VM を対象にし、Google Kubernetes Engine を実行している VM を除外できます。
- OS ファミリー:
ubuntu
- 対象:
env:test
、env:staging
- 除外:
goog-gke-node
- OS ファミリー:
ロールアウト プランを指定します。
- ウェーブサイズ(停止予算)を指定します。例: 10%。
- 待ち時間を指定します。例: 15 分。
[保存] をクリックします。
フォルダ内のポリシー オーケストレーターを更新する手順は次のとおりです。
beta os-config policy-orchestrators update
コマンドを使用して、指定したフォルダのポリシー オーケストレーターを編集します。gcloud --billing-project=
QUOTA_PROJECT_ID beta compute os-config policy-orchestrators updateORCHESTRATOR_NAME \ --folder=FOLDER_NUMBER \ --state=stopped次のように置き換えます。
QUOTA_PROJECT_ID
: 割り当てまたは課金プロジェクトのプロジェクト ID。ORCHESTRATOR_NAME
: ポリシー オーケストレーターの名前。リソースの命名規則をご覧ください。FOLDER_NUMBER
: ポリシー オーケストレーターが存在するフォルダの数値フォルダ ID。
例
gcloud --billing-project=my-quota-project beta compute os-config policy-orchestrators update my-os-policy-orchestrator \ --folder=123456 \ --include-projects=5432134,4567890
フォルダ内のポリシー オーケストレーターを更新するには、次の手順に沿って、folders.locations.global.policyOrchestrators.patch
メソッドに PATCH
リクエストを送信します。
リクエスト本文で、OS ポリシーの割り当て仕様を編集します。
PATCH https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER /locations/global/policyOrchestrators/ORCHESTRATOR_NAME -H "x-goog-user-project:QUOTA_PROJECT_ID " {JSON_OS_POLICY_ORCHESTRATOR }
次のように置き換えます。
QUOTA_PROJECT_ID
: 割り当てまたは課金プロジェクトのプロジェクト IDFOLDER_NUMBER
: ポリシー オーケストレーターが存在するフォルダの数値 ID。ORCHESTRATOR_NAME
: 編集するポリシー オーケストレーターの名前。JSON_OS_POLICY_ORCHESTRATOR
: オーケストレーター スコープ、オーケストレートされたリソース、オーケストレーションの状態を定義する JSON 形式のポリシー オーケストレーター オブジェクト。パラメータと形式の詳細については、Resource: folders.locations.global.policyOrchestrators
をご覧ください。
ポリシー オーケストレーターを削除する
ポリシー オーケストレーターを削除し、進行中のロールアウトをすべてキャンセルするには、次の操作を行います。
ポリシー オーケストレーターを削除する手順は次のとおりです。
Google Cloud コンソールで、[OS ポリシー] ページに移動します。
Google Cloud コンソールのアクションバーで [プロジェクト セレクタ] をクリックし、ポリシー オーケストレーターを作成するフォルダを選択します。
[Policy Orchestrators] をクリックします。
削除するポリシー オーケストレーターの名前を選択します。[オーケストレーターの詳細] ページが開きます。
[削除] をクリックします。
フォルダからポリシー オーケストレーターを削除する手順は次のとおりです。
beta os-config policy-orchestrators delete
コマンドを使用します。gcloud --billing-project=
QUOTA_PROJECT_ID beta compute os-config policy-orchestrators deleteORCHESTRATOR_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 beta compute os-config policy-orchestrators create my-os-policy-orchestrator \ --folder=123456 \ --policy-id=my-policy
フォルダ内のポリシー オーケストレーターを削除するには、folders.locations.global.policyOrchestrators.delete
メソッドに DELETE
リクエストを送信します。
DELETE https://osconfig.googleapis.com/v2beta/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
: 削除するポリシー オーケストレーターの名前。