このページでは、Config リソースの作成方法について説明します。Config リソースは Key-Value ペアが変数として保存されている API オブジェクトです。変数を設定および取得するには、事前に Config リソースが必要となります。Config リソースを作成すると、任意の変数を作成し、その変数を使用してデータを格納できるようになります。
構成、変数、および Runtime Configurator サービスの詳細については、Runtime Configurator Fundamentals をご覧ください。
始める前に
- このガイドのコマンドラインの例を使用する場合、gcloud コマンドライン ツールをインストールします。
- このガイドの API の例を使用する場合は、API アクセスを設定します。
- Runtime Configurator の基礎知識を読みます。
- Runtime Configurator API を有効化します。
コンフィグの作成
Deployment Manager や gcloud
コマンドライン ツールで、または Runtime Configurator API を直接使用して、Config リソースを作成できます。
Deployment Manager
Deployment Manager で Config を作成するには、RuntimeConfig タイプを指定します。
runtimeconfig.v1beta1.config
リソースの properties
で、name
と必要に応じてその他のオプションのプロパティを指定します。
resources:
- name: [CONFIG_NAME]
type: runtimeconfig.v1beta1.config
properties:
config: [CONFIG_NAME]
description: [DESCRIPTION]
ここで
[CONFIG_NAME]
は、この Config の名前です。[DESCRIPTION]
は、この Config の説明です(任意)。
gcloud
Google Cloud CLI で、次のように gcloud beta runtime-config configs create
コマンドを使用します。
gcloud beta runtime-config configs create [CONFIG_NAME] --description [DESCRIPTION]
ここで
[CONFIG_NAME]
は、この Config の名前です。[DESCRIPTION]
は、この Config の説明です(任意)。
gcloud
から次のようなレスポンスが返されます。
Created [https://runtimeconfig.googleapis.com/v1beta1/projects/[PROJECT_ID]/configs/[CONFIG_NAME]].
この gcloud
コマンドの詳細については、runtime-config configs create
のリファレンス ドキュメントをご覧ください。
API
REST API では、次の URI に POST
リクエストを行います。
https://runtimeconfig.googleapis.com/v1beta1/projects/[PROJECT_ID]/configs/
ここでは、[PROJECT_ID]
がこのリクエストのプロジェクト ID です。リクエストのペイロードは以下のようになります。
{
"name": "projects/[PROJECT_ID]/configs/[CONFIG_NAME]",
"description": "[DESCRIPTION]"
}
ここで
[PROJECT_ID]
はこのリクエストのプロジェクト ID です。[CONFIG_NAME]
は、この RuntimeConfig の名前です。[DESCRIPTION]
は、この Config の説明です(任意)。このメソッドの詳細については、
configs().create
のドキュメントをご覧ください。
RuntimeConfig リソースを削除する
RuntimeConfig リソースを削除すると、すべての変数とウェイターを含む、すべてのリソースが削除されます。
Deployment Manager
次のいずれかの方法を使用して、デプロイの一部である RuntimeConfig リソースを削除します。
- デプロイのアップデートにより、構成を省略して、デプロイを再デプロイします。
- デプロイとその中のリソースを削除します。
gcloud
Google Cloud CLI で、次のように gcloud beta runtime-config configs delete
コマンドを使用します。
gcloud beta runtime-config configs delete [CONFIG_NAME]
ここで、[CONFIG_NAME]
は構成オブジェクトの名前です。
gcloud CLI から次のようなレスポンスが返されます。
Deleted [https://runtimeconfig.googleapis.com/v1beta1/projects/[PROJECT_ID]/configs/[CONFIG_NAME]].
gcloud
の詳細については、runtime-config configs delete
のリファレンス ドキュメントをご覧ください。
API
REST API では、次の URI に DELETE
リクエストを行います。
https://runtimeconfig.googleapis.com/v1beta1/projects/[PROJECT_ID]/configs/[CONFIG_NAME]
ここで
[PROJECT_ID]
はこのリクエストのプロジェクト ID です。[CONFIG_NAME]
は、この構成の名前です。このメソッドの詳細については、
configs().delete
のドキュメントをご覧ください。
次のステップ
- 次は、いくつかの変数を作成して、データの設定と取得方法を学習します。
- 特定の変数における Watcher の設定方法を学習します。
- ウェイターを作成します。ウェイターは、変数が基数条件に達したときに返されます。
- v1beta1 リファレンスを参照します。
- Runtime Configurator の割り当てを参照します。
- Runtime Configurator について学習します。