CE_SERVICES環境変数

CE_SERVICES 環境変数には、サービス・インスタンスと対話するために使用できる情報が格納されます。 この環境変数は、キー/値のペアを格納した JSON オブジェクトを指しています。 これらのキー値のペアは、アプリケーション、ジョブ、または関数にバインドされた各サービスのタイプを表します。 keyは、サービス・タイプの名前 (cloud-object-storage など) です。valueは、バインドされているそのタイプのサービス・インスタンスの資格情報の配列です。

次の例は、 CE_SERVICES 変数を示しています。

{
  "appid": [
    {
      "credentials": {
        "apikey": "xxxxxx",
        "appidServiceEndpoint": "https://us-south.appid.cloud.ibm.com",
        "clientId": "abcdabcd-xxxxxxxx",
        "discoveryEndpoint": "https://us-south.appid.cloud.ibm.com/oauth/v4/xxxxxxxx/.well-known/openid-configuration",
        "iam_apikey_description": "Auto-generated for key crn:v1:bluemix:public:appid:us-south:a/abcdabcd719f45b98a931f6e20db1bd8:xxxxxxxx:resource-key:abcdabcd-xxxxxxxx",
        "iam_apikey_name": "ce-service-access-abcd",
        "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer",
        "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/abcdabcd719f45b98a931f6e20db1bd8::serviceid:ServiceId-6d7087e5-0611-4240-9e46-af8a4c15cba4",
        "managementUrl": "https://us-south.appid.cloud.ibm.com/management/v4/xxxxxxxx",
        "oauthServerUrl": "https://us-south.appid.cloud.ibm.com/oauth/v4/xxxxxxxx",
        "profilesUrl": "https://us-south.appid.cloud.ibm.com",
        "secret": "abcdabcdYTAtZmU0MC00YTQ1LTliY2YtMDk0ODg0NDMyNDgw",
        "tenantId": "xxxxxxxx",
        "version": 4
      },
      "name": "App ID-yn",
      "plan": "c0258a22-160a-403b-845d-1588ad61204c",
      "resourcekey_name": "ce-service-access-abcd",
      "resourcekey_id": "abcdabcd-xxxxxxxx"
    }
  ],
  "cloud-object-storage": [
    {
      "credentials": {
        "apikey": "xxxxxx",
        "endpoints": "https://control.cloud-object-storage.cloud.ibm.com/v2/endpoints",
        "iam_apikey_description": "Auto-generated for key crn:v1:bluemix:public:cloud-object-storage:global:a/abcdabcd719f45b98a931f6e20db1bd8:abcdabcd-34b3-4edf-95b7-abcdabcdabcd:resource-key:abcdabcd-96e0-46ef-b805-31288524f194",
        "iam_apikey_name": "ce-service-access-c5yn1",
        "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer",
        "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/abcdabcd719f45b98a931f6e20db1bd8::serviceid:ServiceId-ee6394cb-f203-4c3c-9152-ac886a3f66bb",
        "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/abcdabcd719f45b98a931f6e20db1bd8:abcdabcd-34b3-4edf-95b7-abcdabcdabcd::"
      },
      "name": "Cloud Object Storage-56",
      "plan": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8",
      "resourcekey_name": "ce-service-access-c5yn1",
      "resourcekey_id": "abcdabcd-96e0-46ef-b805-31288524f194"
    }
  ]
}

接頭部方式

接頭部方式では、サービスの資格情報オブジェクトに含まれている資格情報変数ごとに、下線で区切られた大文字で構成される共通の環境変数構文 (VARIABLE_NAME など) を使用して、変数が個々に環境に提供されます。

デフォルトでは、変数名は、サービスの名前に資格情報変数の名前が付いたものになります。 例えば、 apikey という名前の IBM Cloud Object Storage サービス認証変数は、 CLOUD_OBJECT_STORAGE_APIKEY という環境変数で利用可能です。 以下の例は、IBM Cloud Object Storage のサービス・インスタンス・バインディングで作成された環境変数を示しています。

CLOUD_OBJECT_STORAGE_APIKEY=xxxxxx
CLOUD_OBJECT_STORAGE_ENDPOINTS=https://control.cloud-object-storage.cloud.ibm.com/v2/endpoints
CLOUD_OBJECT_STORAGE_IAM_APIKEY_DESCRIPTION=Auto-generated for key abcdabcd-abcd-abcd-abcd-abcdabcdabcd
CLOUD_OBJECT_STORAGE_IAM_APIKEY_NAME=my-object-storage-codeengine-credential
CLOUD_OBJECT_STORAGE_IAM_ROLE_CRN=crn:v1:bluemix:public:iam::::serviceRole:Manager
CLOUD_OBJECT_STORAGE_IAM_SERVICEID_CRN=crn:v1:bluemix:public:iam-identity::a/1176a104ad4441e6b0aa92ed0b60b15c::serviceid:ServiceId-abcdabcd-abcd-abcd-8b41-531fc64e640e
CLOUD_OBJECT_STORAGE_RESOURCE_INSTANCE_ID=crn:v1:bluemix:public:cloud-object-storage:global:a/1176a104ad4441e6b0aa92ed0b60b15c:11179ac4-abcd-4887-abcd-d330a430abcd::
CLOUD_OBJECT_STORAGE_SERVICENAME=my-object-storage

デフォルトでは、同じタイプの複数のインスタンスを 1 つのアプリケーションにバインドすると、Code Engine が、CLOUD_OBJECT_STORAGE_2_APIKEY のように、サービス名にインデックスを追加します。

各サービス・バインディングは、カスタム環境変数接頭部を使用するように構成できます。 コンソールを使用している場合は、サービス・バインディングの作成時にオプションで接頭部を指定できます。 CLI を使用する場合は、 app bind、 job bind、または function bind コマンドで --prefix オプションを使用します。

以前の実装を使用するサービス・バインディングを置き換えるにはどうすればよいでしょうか?

アプリケーションまたはジョブに以前のインプリメンテーションを使用するサービスバインディングがあり、アプリケーションまたはジョブに新しいサービスバインディングを追加したい場合は、新しいバインディングを作成する前に、まず以前のインプリメンテーションを使用するバインディングを削除する必要があります。 必要に応じて、これらの既存のサービス・バインディングを再作成できます。

アンバインドおよび再バインドの処理中に、アプリケーションが完全に機能していない可能性があります。

1. アプリケーションまたはジョブが以前のサービスバインディング実装を使用しているかどうかを確認するには、 app get または job get コマンドを実行してください。 以前のサービスバインド実装を使用している場合、このコマンドの出力から、別のサービスをアプリケーションまたはジョブにバインドするために使用すべきコマンドに関する情報が得られます。 以下に例を示します。

   ibmcloud ce app get --name myapp
   

   出力例

   Run 'ibmcloud ce application events -n myapp' to get the system events of the application instances.
   Run 'ibmcloud ce application logs -f -n myapp' to follow the logs of the application instances.
   OK
   
   This application uses a previous service binding implementation.
   Your application will continue to function normally.
   To bind an additional service to this application, delete and re-create those service bindings with the improved implementation.
   Your application might not be fully functional during the process of unbinding and rebinding.
   Re-create the existing service bindings by issuing the following commands:
   (1) Remove all existing service bindings from this application.
   ibmcloud ce application unbind --name myapp -all
   (2) Bind the services again.
   ibmcloud ce application bind --name myapp --service-instance myobjectstorage --prefix CLOUD_OBJECT_STORAGE
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   Project ID:         01234567-abcd-abcd-abcd-abcdabcd1111
   Age:                2m4s
   Created:            2021-09-09T14:01:02-04:00
   URL:                https://myapp.abcdabcdabc.us-south.codeengine.appdomain.cloud
   Cluster Local URL:  http://myapp.abcdabcdabc.svc.cluster.local
   Console URL:        https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
   Status Summary:     Application deployed successfully
   [...]
   Service Bindings:
   Service Instance    Service Type           Environment Variable Prefix
   myobjectstorage     cloud-object-storage   CLOUD_OBJECT_STORAGE
   

   同様に、ジョブを操作している場合は、ibmcloud ce job get --name JOB_NAMEコマンドを実行して、非推奨のバインディングがジョブで使用されているかどうかを検出します。

2. 前の実装を使用する既存のサービス・バインディングをアンバインドします。 --allオプションは、このアプリケーションのすべてのサービス・インスタンスをアンバインドすることを指定します。

   ibmcloud ce app unbind --name APP_NAME --all
   

   同様に、ジョブを処理している場合は、ibmcloud ce job unbind --name JOB_NAME --allコマンドを実行して、ジョブのすべてのサービス・インスタンスをアンバインドします。

3. 新規バインディングを作成します。 新規バインディングを作成するには、ibmcloud ce app bindまたはibmcloud ce job bindコマンドを実行します。 以前の実装を使用していたサービス・バインディングを置き換えるには、app getコマンドまたはjob getコマンドの出力で提供されているコマンドを使用します。 例えば、Code Engineアプリケーション myappからIBM Cloud Object Storageサービス・インスタンスmyobjectstorageへの既存のバインディングを再作成するには、以下のようにします。

   ibmcloud ce app bind --name myapp --service-instance myobjectstorage --prefix CLOUD_OBJECT_STORAGE
   

   同様に、ジョブを処理する場合は、ibmcloud ce job bind --name JOB_NAME ---service-instance SERVICE_INSTANCE --prefix PREFIXコマンドを実行します。

   再作成するバインディングごとに、このステップを繰り返します。

4. (オプション) **app getコマンドまたはjob get**コマンドを再度実行します。 今回は、コマンドの出力に、以前の実装でのサービス・バインディングに関する情報が表示されないことに注意してください。 以下に例を示します。

   ibmcloud ce app get --name myapp
   

   出力例

   Run 'ibmcloud ce application events -n myapp' to get the system events of the application instances.
   Run 'ibmcloud ce application logs -f -n myapp' to follow the logs of the application instances.
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   Project ID:         01234567-abcd-abcd-abcd-abcdabcd1111
   Age:                2m4s
   Created:            2021-09-09T14:01:02-04:00
   URL:                https://myapp.abcdabcdabc.us-south.codeengine.appdomain.cloud
   Cluster Local URL:  http://myapp.abcdabcdabc.svc.cluster.local
   Console URL:        https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
   Status Summary:     Application deployed successfully
   [...]
   
   Service Bindings:
   Name                                         ID                                    Service Instance      Service Type          Role / Credential  Environment Variable Prefix
   myapp-app-ce-service-binding-abcde          abcde5d3-dfc3-4f52-b133-b869b5eabcde   my-object-storage    cloud-object-storage   Writer             CLOUD_OBJECT_STORAGE