CLI での構成マップの作成

以下のいずれかの方法で、configmap create コマンドを使用して構成マップを作成します。

• --from-literal オプションを KEY=VALUE 形式で使用して、コマンド・ラインから構成マップを直接作成します。 以下に例を示します。

  ibmcloud ce configmap create --name myliteralconfigmap --from-literal TARGET=Sunshine
  

• --from-file オプションを使用してファイルを指して、構成マップを作成します。 このオプションを使用すると、ファイルのすべての内容がキーと値のペアの値になります。 この例では、colors.txt というテキストを含む、blue, green, red という名前のファイルを使用します。

  • 以下の例では、--from-file KEY=FILE コマンドで configmap create フォーマットを使用します。

    ibmcloud ce configmap create --name mycolorconfigmap --from-file TARGET=colors.txt
    

  • 以下のコマンド例では、--from-file FILE コマンドで configmap create フォーマットを使用します。 この例では、TARGET (拡張子なし) がファイルの名前です。これは、サンプルの myjob ジョブに認識されている環境変数の名前と同じです。

    ibmcloud ce configmap create --name mycolorconfigmap2  --from-file TARGET
    

• --from-env-file の形式と一致する行が 1 つ以上含まれるファイルを指す KEY=VALUE オプションを使用して、構成マップを作成します。 指定したファイルにある各行が、キー/値のペアとして追加されます。 指定されたファイル内の、空または#で始まる行はすべて無視されます。 この例では、colors_multi.txt、color1=yellow、および color2=orange のキーと値のペアを含む、color3=purple という名前のファイルを使用します。

  ibmcloud ce configmap create --name mycolorconfigmapmulti --from-env-file colors_multi.txt
  

CLI での構成マップのリスト

構成マップが作成されたら、configmap list コマンドを使用してプロジェクト内のすべての構成マップをリストするか、configmap get コマンドを使用して特定の構成マップに関する詳細を表示します。 以下に例を示します。

ibmcloud ce configmap get --name mycolorconfigmap

出力例

Getting configmap 'mycolorconfigmap'...
OK

Name:          mycolorconfigmap
ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:  myproject
Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
Age:           11s
Created:       2020-10-14 14:10:57 -0400 EDT

Data:
---
TARGET: blue, green, red

CLI を使用した既存の構成マップの参照

CLI でアプリ、ジョブ、または関数のワークロードで構成マップを使用するには、以下のコマンドで --env-from-configmap オプションを指定します。

• app create
• app update
• job create
• job update
• jobrun submit
• jobrun resubmit
• fn create
• fn update

以下の例は、CLI を使用してアプリで既存の構成マップを参照する方法を示しています。

1. configmap create コマンドを使用して、このシナリオの以下の 2 つの構成マップを作成します。

   ibmcloud ce configmap create --name myliteralconfigmap --from-literal TARGET=Sunshine
   

   ibmcloud ce configmap create --name myliteralconfigmap2 --from-literal TARGET=Stranger
   

2. アプリをデプロイし、myliteralconfigmap 構成マップを参照します。 この例では、helloイメージを使用するアプリを作成します。 このサンプル・アプリに要求を送信すると、このアプリが環境変数 TARGET を読み取り、Hello ${TARGET} を出力します。 この環境変数が空の場合は、Hello World が返されます。 myliteralconfigmap 構成マップを参照します。 この例で使用されるコードについて詳しくは、 helloを参照してください。

   ibmcloud ce app create --name myhelloapp --image icr.io/codeengine/hello --env-from-configmap myliteralconfigmap
   

3. アプリケーションを呼び出します。 Hello Sunshine 構成マップに指定されている TARGET キーの値である myliteralconfigmap がアプリによって返されます。

   curl https://myhelloapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud
   

   出力例

   Hello Sunshine
   

4. myliteralconfigmap2 構成マップを使用するように、アプリを再更新します。

   構成マップ (またはシークレット) を完全に参照して別の構成マップ (またはシークレット) を完全に参照する環境変数を使用してアプリ、ジョブ、または関数を更新すると、完全参照は、設定されている順序で他の完全参照をオーバーライドします (最後の参照セットが最初のセットをオーバーライドします)。

   ibmcloud ce app update --name myhelloapp --env-from-configmap myliteralconfigmap2
   

   出力例

   Updating application 'myhelloapp' to latest revision.
   [...]
   Run 'ibmcloud ce application get -n myhelloapp' to check the application status.
   OK
   
   https://myhelloapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud
   

5. アプリケーションを再度呼び出します。 今回は、Hello Stranger 構成マップに指定されている値である myliteralconfigmap2 がアプリによって返されます。

   curl https://myhelloapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud  
   

   出力例

   Hello Stranger
   

6. myliteralconfigmap2 を更新して、キーと値のペアを変更します。

   ibmcloud ce configmap update --name myliteralconfigmap2 --from-literal "TARGET=Happy day"
   

   ibmcloud ce configmap get -n myliteralconfigmap2 コマンドを実行して、構成マップの詳細を表示します。

   出力例

   Name:          myliteralconfigmap2
   [...]
   Data:
   ---
   TARGET: Happy day
   

7. アプリケーションを再始動して、新しいデータを反映させます。

   ibmcloud ce app update --name myhelloapp
   

8. アプリケーションを再度呼び出します。 今回は、Hello Happy day 構成マップに指定されている値である myliteralconfigmap2 がアプリによって返されます。

   curl https://myhelloapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud  
   

   出力例

   Hello Happy day
   

CLI を使用した現時点で定義されていない構成マップの参照

参照される前に configmap が存在しない場合、アプリ、ジョブ、または関数のワークロードは正常にデプロイされず、参照される configmap が作成されるまでジョブまたは関数は正常に実行されません。

アプリケーション、ジョブ、または関数のワークロードを処理していて、参照されている configmap がまだ定義されていない場合は、 --force オプションを使用して、参照されている configmap の存在の検証を回避できます。 --force オプションは、以下のコマンドで使用できます。

• app create
• app update
• job create
• job update
• jobrun submit
• jobrun resubmit
• fn create
• fn update

これらのコマンドで --force オプションを使用すると、ワークロードを作成、更新、または実行するアクションは完了しますが、参照されている configmap が存在するまで、アプリケーション、ジョブ、またはワークロードは正常に実行されません。 コマンドに --force オプションに加えて --no-wait オプションを追加すると、システムはアクションを完了し、ワークロードが正常に実行されるのを待機しません。

以下の例は、CLI を使用してアプリでまだ定義されていない構成マップを参照する方法を示しています。

1. アプリを作成し、定義されていない myliteralconfigmap3 構成マップを参照します。 この例では、icr.io/codeengine/hello イメージを使用するCode Engineアプリを作成します。 このサンプル・アプリに要求を送信すると、このアプリが環境変数 TARGET を読み取り、Hello ${TARGET} を出力します。 この環境変数が空の場合は、Hello World が返されます。 myliteralconfigmap3 構成マップを参照します。 この例で使用されるコードについて詳しくは、 helloを参照してください。

   **app create**コマンドで--no-waitオプションを使用すると、アプリが作成され、アプリの準備ができるまで待機しません。

   ibmcloud ce app create --name myapp --image icr.io/codeengine/hello --env-from-configmap myliteralconfigmap3 --force --no-wait
   

2. app get コマンドを使用して、環境変数の情報など、ジョブ実行の詳細を表示します。 アプリは作成されますが、まだ完全にデプロイされていないことに注意してください。

   ibmcloud ce app get --name myapp
   

   出力例

   Name:            myapp
   [...]
   Status Summary:  Application is deploying
   
   Environment Variables:
       Type                      Name                 Value
       ConfigMap full reference  myliteralconfigmap3
   Image:                  icr.io/codeengine/hello
   Resource Allocation:
       CPU:                1
       Ephemeral Storage:  400M
       Memory:             4G
   
   Runtime:
       Concurrency:    100
       Maximum Scale:  10
       Minimum Scale:  0
       Timeout:        300
   
   Conditions:
       Type                 OK     Age  Reason
       ConfigurationsReady  false  10s
       Ready                false  10s  RevisionMissing : Configuration "myapp" is waiting for a Revision to become ready.
       RoutesReady          false  10s  RevisionMissing : Configuration "myapp" is waiting for a Revision to become ready.
   
   Events:
       Type    Reason   Age  Source              Messages
       Normal  Created  12s  service-controller  Created Configuration "myapp"
       Normal  Created  12s  service-controller  Created Route "myapp"
   
   Instances:
       Name                                      Revision      Running  Status   Restarts  Age
       myapp-00001-deployment-566d5c79b9-wttqs  myapp-00001  0/2      Pending  0         11s
   

3. 構成マップを作成します。

   ibmcloud ce configmap create --name myliteralconfigmap3 --from-literal TARGET=Everyone
   

4. アプリケーションを再始動して、新しいデータを反映させます。

   ibmcloud ce app update --name myapp
   

5. アプリケーションを呼び出します。 Hello Everyone 構成マップに指定されている値である myliteralconfigmap3 がアプリによって返されます。

   curl https://myapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud  
   

   出力例

   Hello Everyone
   

6. myliteralconfigmap2 構成マップを参照するように、アプリを更新します。 myliteralconfigmap2 が値 TARGET=Stranger で定義されます。 アプリを更新すると、アプリが再始動され、新しいデータが反映されます。

   構成マップ (またはシークレット) 全体を参照する環境変数が設定されたアプリケーションまたはジョブを更新して、別の構成マップ (またはシークレット) 全体を参照するように設定すると、参照先全体は設定された順に他の参照先全体をオーバーライドします (後に設定された参照先が、先に設定された参照先をオーバーライドします)。

   ibmcloud ce app update --name myapp --env-from-configmap myliteralconfigmap2
   

7. アプリケーションを再度呼び出します。 今回は、Hello Stranger 構成マップに指定されている値である myliteralconfigmap2 がアプリによって返されます。

   curl https://myapp.d484a5d6-d10d.us-south.codeengine.appdomain.cloud  
   

   出力例

   Hello Stranger
   

CLI でシークレットおよび構成マップの全体を環境変数として参照したり、参照先データをオーバーライドしたり、参照先データを削除したりすることに関する、より詳細なシナリオについては、シークレットおよび構成マップの参照 (Referencing secrets and configmaps) を参照してください。