第4章 OpenShift Database Access API の例とスキーマ

手順

1. コマンドラインインターフェイスを使用して OpenShift にログインします。

   構文

   oc login --token=TOKEN --server=SERVER_URL_AND_PORT

   Copy to Clipboard Toggle word wrap

   例

   $ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443

   Copy to Clipboard Toggle word wrap

   注記

   コマンドラインログイントークンと URL は、OpenShift コンソールから確認できます。OpenShift コンソールにログインします。ユーザー名をクリックし、Copy login command をクリックします。ユーザー名とパスワードをもう一度入力し、Display Token をクリックしてコマンドを表示します。

2. redhat-dbaas-operator namespace でデフォルトの DBaaSPolicy オブジェクトを使用し、必要に応じて変更できます。または、プロジェクトの namespace に新しい DBaaSPolicy オブジェクトを作成できます。

3. Secret オブジェクトを作成し、OpenShift クラスターに適用します。

   構文

   apiVersion: v1
   kind: Secret
   metadata:
     name: WORKFLOW_NAME 

   1

   
     namespace: ADMIN_NAMESPACE 

   2

   
   data:
     orgId: ORGANIZATION_ID 

   3

   
     privateApiKey: PRIVATE_KEY 

   4

   
     publicApiKey: PUBLIC_KEY 

   5

   
   type: Opaque

   Copy to Clipboard Toggle word wrap

   1

   ワークフローの名前。

   2

   DBaaSPolicy が DBaaSInventory の作成を許可し、Provider Account とシークレット情報も含まれる namespace。デフォルトの namespace は redhat-dbaas-operator です。

   3

   アカウントに割り当てられた一意のクラウドでホストされるデータベースプロバイダーの組織識別子。

   4

   プライベート API キー。キーのエンコーディングには base64 を使用する必要があります。

   5

   公開 API キー。キーのエンコーディングには base64 を使用する必要があります。

   例

   $ cat <<EOF | oc apply -f -
   apiVersion: v1
   kind: Secret
   metadata:
     name: mongodb-atlas-user-secrets
     namespace: redhat-dbaas-operator
   data:
     orgId: JjA4ZGY1ZTY1MmAxOTQ0MjkzZTg45DRh
     privateApiKey: PTAzOWQyOTMtNGJhMy01ZjdkLTk2ZWEtNWQ1MzNkYWQ1OTk7
     publicApiKey: tXpkaWl3aWw=
   type: Opaque
   EOF

   Copy to Clipboard Toggle word wrap

4. DBaaSInventory オブジェクトを作成し、OpenShift クラスターに適用します。

   構文

   apiVersion: dbaas.redhat.com/v1alpha1
   kind: DBaaSInventory
   metadata:
     labels:
       related-to: dbaas-operator
       type: dbaas-vendor-service
     name: WORKFLOW_NAME 

   1

   
     namespace: ADMIN_NAMESPACE 

   2

   
   spec:
     credentialsRef:
       name: SECRET_NAME 

   3

   
     providerRef:
       name: PROVIDER_TYPE 

   4

   Copy to Clipboard Toggle word wrap

   1

   プロバイダーアカウントワークフローの名前。

   2

   DBaaSPolicy が DBaaSInventory の作成を許可し、Provider Account とシークレット情報も含まれる namespace。デフォルトの namespace は redhat-dbaas-operator です。

   3

   シークレットオブジェクトの名前。

   4

   mongodb-atlas-registration、cockroachdb-cloud-registration、または crunchy-bridge-registration などのクラウドでホストされるデータベースプロバイダー。

   例

   $ cat <<EOF | oc apply -f -
   apiVersion: dbaas.redhat.com/v1alpha1
   kind: DBaaSInventory
   metadata:
     labels:
       related-to: dbaas-operator
       type: dbaas-vendor-service
     name: mongodb-atlas-provider-account
     namespace: redhat-dbaas-operator
   spec:
     credentialsRef:
       name: mongodb-atlas-user-secrets
     providerRef:
       name: mongodb-atlas-registration
   EOF

   Copy to Clipboard Toggle word wrap

5. DBaaSConnection オブジェクトを作成し、OpenShift クラスターに適用します。

   構文

   apiVersion: dbaas.redhat.com/v1alpha1
   kind: DBaaSConnection
   metadata:
     name: CONNECTION_NAME 

   1

   
     namespace: APP_NAMESPACE 

   2

   
   spec:
     instanceRef: INSTANCE_ID 

   3

   
       name: WORKFLOW_NAME 

   4

   
       namespace: APP_NAMESPACE
     inventoryRef:
       name: WORKFLOW_NAME
       namespace: ADMIN_NAMESPACE 

   5

   Copy to Clipboard Toggle word wrap

   1

   接続オブジェクトの名前。

   2

   アプリケーションデプロイメント namespace の名前。

   3

   データベースインスタンスの一意の ID。

   4

   プロバイダーアカウントワークフローの名前。

   5

   DBaaSPolicy が DBaaSInventory の作成を許可する namespace。デフォルトの namespace は redhat-dbaas-operator です。

   例

   cat <<EOF | oc apply -f -
   apiVersion: dbaas.redhat.com/v1alpha1
   kind: DBaaSConnection
   metadata:
     name: mongodb-atlas-connection
     namespace: my-app-example
   spec:
     instanceRef: 62d95f4f02ea7712838c145a
       name: mongodb-atlas-provider-account
       namespace: my-app-example
     inventoryRef:
       name: mongodb-atlas-provider-account
       namespace: redhat-dbaas-operator
   EOF

   Copy to Clipboard Toggle word wrap

6. ServiceBinding オブジェクトを作成し、OpenShift クラスターに適用します。

   構文

   apiVersion:  binding.operators.coreos.com/v1alpha1
   kind:        ServiceBinding
   metadata:
     name:      BINDING_NAME 

   1

   
     namespace: APP_NAMESPACE 

   2

   
   spec:
     application:
       group:                   apps
       name:                    APP_DEPLOYMENT 

   3

   
       resource:                deployments
       version:                 v1
     bindAsFiles:             true
     detectBindingResources:  true
     services:
     - group:    dbaas.redhat.com
       kind:     DBaaSConnection
       name:     CONNECTION_NAME 

   4

   
       version:  v1alpha1

   Copy to Clipboard Toggle word wrap

   1

   サービスバインディングオブジェクトの名前。

   2

   アプリケーションデプロイメント namespace の名前。

   3

   接続アプリケーションの Kubernetes デプロイメントの名前。

   4

   DBaaS 接続オブジェクトの名前。

   例

   cat <<EOF | oc apply -f -
   apiVersion:  binding.operators.coreos.com/v1alpha1
   kind:        ServiceBinding
   metadata:
     name:      mongodb-atlas-service-binder
     namespace: my-app-example
   spec:
     application:
       group:                   apps
       name:                    my-app
       resource:                deployments
       version:                 v1
     bindAsFiles:             true
     detectBindingResources:  true
     services:
     - group:    dbaas.redhat.com
       kind:     DBaaSConnection
       name:     mongodb-atlas-connection
       version:  v1alpha1
   EOF

   Copy to Clipboard Toggle word wrap