10.7. Object Bucket Claim

手順

1. 以下の行をアプリケーション YAML に追加します。

   apiVersion: objectbucket.io/v1alpha1
   kind: ObjectBucketClaim
   metadata:
     name: <obc-name>
   spec:
     generateBucketName: <obc-bucket-name>
     storageClassName: openshift-storage.noobaa.io

   Copy to Clipboard Toggle word wrap

   これらの行は OBC 自体になります。

   1. <obc-name> を、一意の OBC の名前に置き換えます。
   2. <obc-bucket-name> を、OBC の一意のバケット名に置き換えます。

2. YAML ファイルにさらに行を追加して、OBC の使用を自動化します。

   以下に例を示します。

   apiVersion: batch/v1
   kind: Job
   metadata:
     name: testjob
   spec:
     template:
       spec:
         restartPolicy: OnFailure
         containers:
           - image: <your application image>
             name: test
             env:
               - name: BUCKET_NAME
                 valueFrom:
                   configMapKeyRef:
                     name: <obc-name>
                     key: BUCKET_NAME
               - name: BUCKET_HOST
                 valueFrom:
                   configMapKeyRef:
                     name: <obc-name>
                     key: BUCKET_HOST
               - name: BUCKET_PORT
                 valueFrom:
                   configMapKeyRef:
                     name: <obc-name>
                     key: BUCKET_PORT
               - name: AWS_ACCESS_KEY_ID
                 valueFrom:
                   secretKeyRef:
                     name: <obc-name>
                     key: AWS_ACCESS_KEY_ID
               - name: AWS_SECRET_ACCESS_KEY
                 valueFrom:
                   secretKeyRef:
                     name: <obc-name>
                     key: AWS_SECRET_ACCESS_KEY

   Copy to Clipboard Toggle word wrap

   以下は、バケット要求の結果のマッピングの例になります。これは、データを含む Config Map および認証情報を含むシークレットです。この特定のジョブは NooBaa からオブジェクトバケットを要求し、バケットとアカウントを作成します。

   1. <obc-name> のすべてのインスタンスを、OBC の名前に置き換えます。
   2. <your application image> をアプリケーションイメージに置き換えます。

3. 更新された YAML ファイルを適用します。

   # oc apply -f <yaml.file>

   Copy to Clipboard Toggle word wrap

   <yaml.file> を YAML ファイルの名前に置き換えます。

4. 新しい Config Map を表示するには、以下を実行します。

   # oc get cm <obc-name> -o yaml

   Copy to Clipboard Toggle word wrap

   obc-name を OBC の名前に置き換えます。

   出力には、以下の環境変数が表示されることが予想されます。

   • BUCKET_HOST: アプリケーションで使用するエンドポイント

   • BUCKET_PORT: アプリケーションで利用できるポート

     • ポートは BUCKET_HOST に関連します。たとえば、BUCKET_HOST が https://my.example.com で、BUCKET_PORT が 443 の場合、オブジェクトサービスのエンドポイントは https://my.example.com:443 になります。
   • BUCKET_NAME: 要求されるか、生成されるバケット名
   • AWS_ACCESS_KEY_ID: 認証情報の一部であるアクセスキー
   • AWS_SECRET_ACCESS_KEY: 認証情報の一部であるシークレットのアクセスキー

手順

1. コマンドラインインターフェイスを使用して、新規バケットおよび認証情報の詳細を生成します。

   以下のコマンドを実行します。

   # noobaa obc create <obc-name> -n openshift-storage

   Copy to Clipboard Toggle word wrap

   <obc-name> を一意の OBC 名に置き換えます (例: myappobc)。

   さらに、--app-namespace オプションを使用して、OBC Config Map およびシークレットが作成される namespace を指定できます (例: myapp-namespace)。

   以下に例を示します。

   INFO[0001] ✅ Created: ObjectBucketClaim "test21obc"

   Copy to Clipboard Toggle word wrap

   MCG コマンドラインインターフェイスが必要な設定を作成し、新規 OBC について OpenShift に通知します。

2. 以下のコマンドを実行して OBC を表示します。

   # oc get obc -n openshift-storage

   Copy to Clipboard Toggle word wrap

   以下に例を示します。

   NAME        STORAGE-CLASS                 PHASE   AGE
   test21obc   openshift-storage.noobaa.io   Bound   38s

   Copy to Clipboard Toggle word wrap

3. 以下のコマンドを実行して、新規 OBC の YAML ファイルを表示します。

   # oc get obc test21obc -o yaml -n openshift-storage

   Copy to Clipboard Toggle word wrap

   以下に例を示します。

   apiVersion: objectbucket.io/v1alpha1
   kind: ObjectBucketClaim
   metadata:
     creationTimestamp: "2019-10-24T13:30:07Z"
     finalizers:
     - objectbucket.io/finalizer
     generation: 2
     labels:
       app: noobaa
       bucket-provisioner: openshift-storage.noobaa.io-obc
       noobaa-domain: openshift-storage.noobaa.io
     name: test21obc
     namespace: openshift-storage
     resourceVersion: "40756"
     selfLink: /apis/objectbucket.io/v1alpha1/namespaces/openshift-storage/objectbucketclaims/test21obc
     uid: 64f04cba-f662-11e9-bc3c-0295250841af
   spec:
     ObjectBucketName: obc-openshift-storage-test21obc
     bucketName: test21obc-933348a6-e267-4f82-82f1-e59bf4fe3bb4
     generateBucketName: test21obc
     storageClassName: openshift-storage.noobaa.io
   status:
     phase: Bound

   Copy to Clipboard Toggle word wrap

4. openshift-storage namespace 内で、Config Map およびシークレットを見つけ、この OBC を使用することができます。CM とシークレットの名前はこの OBC の名前と同じです。

   以下のコマンドを実行してシークレットを表示します。

   # oc get -n openshift-storage secret test21obc -o yaml

   Copy to Clipboard Toggle word wrap

   以下に例を示します。

   apiVersion: v1
   data:
     AWS_ACCESS_KEY_ID: c0M0R2xVanF3ODR3bHBkVW94cmY=
     AWS_SECRET_ACCESS_KEY: Wi9kcFluSWxHRzlWaFlzNk1hc0xma2JXcjM1MVhqa051SlBleXpmOQ==
   kind: Secret
   metadata:
     creationTimestamp: "2019-10-24T13:30:07Z"
     finalizers:
     - objectbucket.io/finalizer
     labels:
       app: noobaa
       bucket-provisioner: openshift-storage.noobaa.io-obc
       noobaa-domain: openshift-storage.noobaa.io
     name: test21obc
     namespace: openshift-storage
     ownerReferences:
     - apiVersion: objectbucket.io/v1alpha1
       blockOwnerDeletion: true
       controller: true
       kind: ObjectBucketClaim
       name: test21obc
       uid: 64f04cba-f662-11e9-bc3c-0295250841af
     resourceVersion: "40751"
     selfLink: /api/v1/namespaces/openshift-storage/secrets/test21obc
     uid: 65117c1c-f662-11e9-9094-0a5305de57bb
   type: Opaque

   Copy to Clipboard Toggle word wrap

   シークレットは S3 アクセス認証情報を提供します。

5. 以下のコマンドを実行して Config Map を表示します。

   # oc get -n openshift-storage cm test21obc -o yaml

   Copy to Clipboard Toggle word wrap

   以下に例を示します。

   apiVersion: v1
   data:
     BUCKET_HOST: 10.0.171.35
     BUCKET_NAME: test21obc-933348a6-e267-4f82-82f1-e59bf4fe3bb4
     BUCKET_PORT: "31242"
     BUCKET_REGION: ""
     BUCKET_SUBREGION: ""
   kind: ConfigMap
   metadata:
     creationTimestamp: "2019-10-24T13:30:07Z"
     finalizers:
     - objectbucket.io/finalizer
     labels:
       app: noobaa
       bucket-provisioner: openshift-storage.noobaa.io-obc
       noobaa-domain: openshift-storage.noobaa.io
     name: test21obc
     namespace: openshift-storage
     ownerReferences:
     - apiVersion: objectbucket.io/v1alpha1
       blockOwnerDeletion: true
       controller: true
       kind: ObjectBucketClaim
       name: test21obc
       uid: 64f04cba-f662-11e9-bc3c-0295250841af
     resourceVersion: "40752"
     selfLink: /api/v1/namespaces/openshift-storage/configmaps/test21obc
     uid: 651c6501-f662-11e9-9094-0a5305de57bb

   Copy to Clipboard Toggle word wrap

   Config Map には、アプリケーションの S3 エンドポイント情報が含まれます。

手順

1. OpenShift Web コンソールにログインします。

2. 左側のナビゲーションバーで Storage Object Bucket Claims Create Object Bucket Claim をクリックします。

   1. Object Bucket Claim(オブジェクトバケット要求) の名前を入力し、ドロップダウンメニューから、内部または外部かのデプロイメントに応じて適切なストレージクラスとバケットクラスを選択します。

      内部モード

      デプロイメント後に作成された以下のストレージクラスを使用できます。

      • ocs-storagecluster-ceph-rgw は Ceph Object Gateway (RGW) を使用します。
      • openshift-storage.noobaa.io は Multicloud Object Gateway (MCG) を使用します。

      外部モード

      デプロイメント後に作成された以下のストレージクラスを使用できます。

      • ocs-external-storagecluster-ceph-rgw は RGW を使用します。

      • openshift-storage.noobaa.io は MCG を使用します。

        注記

        RGW OBC ストレージクラスは、OpenShift Data Foundation バージョン 4.5 の新規インストールでのみ利用できます。これは、以前の OpenShift Data Foundation リリースからアップグレードされたクラスターには適用されません。

   2. Create をクリックします。

      OBC を作成すると、その詳細ページにリダイレクトされます。

手順

1. 左側のナビゲーションバーで Storage Object Bucket Claims をクリックします。

2. 作成した OBC の横にあるアクションメニュー (⋮) をクリックします。

   1. ドロップダウンメニューで、Attach to Deployment を選択します。
   2. Deployment Name リストから必要なデプロイメントを選択し、Attach をクリックします。

手順

1. OpenShift Web コンソールにログインします。

2. 左側のナビゲーションバーで Storage Object Buckets をクリックします。

   オプション: 特定の OBC の詳細ページに移動し、Resource リンクをクリックして、その OBC のオブジェクトバケットを表示することもできます。

3. 詳細を表示するオブジェクトバケットを選択します。選択すると、Object Bucket Details ページに移動します。

手順

1. 左側のナビゲーションバーで Storage Object Bucket Claims をクリックします。

2. 削除する Object Bucket Claim(オブジェクトバケット要求) の横にあるアクションメニュー (⋮) をクリックします。

   1. Delete Object Bucket Claim を選択します。
   2. Delete をクリックします。