6.6. ボリュームポピュレーター

手順

1. 次のサンプル YAML ファイルを使用して、ポピュレーターおよび関連リソースの論理グループと操作の namespace を作成します。

   namespace YAML ファイルの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: hello

   Copy to Clipboard Toggle word wrap

2. 次のサンプル YAML ファイルを使用して、データソースの CRD を作成します。

   CRD YAML ファイルの例

   apiVersion: apiextensions.k8s.io/v1
   kind: CustomResourceDefinition
   metadata:
     name: hellos.hello.example.com
   spec:
     group: hello.example.com
     names:
       kind: Hello
       listKind: HelloList
       plural: hellos
       singular: hello
     scope: Namespaced
     versions:
     - name: v1alpha1
       schema:
         openAPIV3Schema:
           description: Hello is a specification for a Hello resource
           properties:
             apiVersion:
               description: 'APIVersion defines the versioned schema of this representation
                 of an object. Servers should convert recognized schemas to the latest
                 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
               type: string
             kind:
               description: 'Kind is a string value representing the REST resource this
                 object represents. Servers may infer this from the endpoint the client
                 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
               type: string
             spec:
               description: HelloSpec is the spec for a Hello resource
               properties:
                 fileContents:
                   type: string
                 fileName:
                   type: string
               required:
               - fileContents
               - fileName
               type: object
           required:
           - spec
           type: object
       served: true
       storage: true

   Copy to Clipboard Toggle word wrap

3. ServiceAccount、ClusterRole、ClusterRoleBindering、および Deployment を作成してコントローラーをデプロイし、データの事前投入を実装するロジックを実行します。

   1. 次のサンプル YAML ファイルを使用して、ポピュレーターのサービスアカウントを作成します。

      サービスアカウント YAML ファイルの例

      apiVersion: v1
      kind: ServiceAccount
      metadata:
        name: hello-account
        namespace: hello 

      1

      Copy to Clipboard Toggle word wrap

      1

      先ほど作成した namespace を参照します。

   2. 次のサンプル YAML ファイルを使用して、ポピュレーターのクラスターロールを作成します。

      クラスターロールの YAML ファイルの例

      kind: ClusterRole
      apiVersion: rbac.authorization.k8s.io/v1
      metadata:
        name: hello-role
      rules:
        - apiGroups: [hello.example.com]
          resources: [hellos]
          verbs: [get, list, watch]

      Copy to Clipboard Toggle word wrap

   3. 次のサンプル YAML ファイルを使用して、クラスターロールバインディングを作成します。

      クラスターロールバインディングの YAML ファイルの例

      kind: ClusterRoleBinding
      apiVersion: rbac.authorization.k8s.io/v1
      metadata:
        name: hello-binding 

      1

      
      subjects:
        - kind: ServiceAccount
          name: hello-account 

      2

      
          namespace: hello 

      3

      
      roleRef:
        kind: ClusterRole
        name: hello-role 

      4

      
        apiGroup: rbac.authorization.k8s.io

      Copy to Clipboard Toggle word wrap

      1

      ロールバインディングの名前。

      2

      先ほど作成したサービスアカウントの名前を参照します。

      3

      先ほど作成したサービスアカウントの namespace の名前を参照します。

      4

      先ほど作成したクラスターロールを参照します。

   4. 次のサンプル YAML ファイルを使用して、ポピュレーターのデプロイメントを作成します。

      デプロイメント YAML ファイルの例

      kind: Deployment
      apiVersion: apps/v1
      metadata:
        name: hello-populator
        namespace: hello 

      1

      
      spec:
        selector:
          matchLabels:
            app: hello
        template:
          metadata:
            labels:
              app: hello
          spec:
            serviceAccount: hello-account 

      2

      
            containers:
              - name: hello
                image: registry.k8s.io/sig-storage/hello-populator:v1.0.1
                imagePullPolicy: IfNotPresent
                args:
                  - --mode=controller
                  - --image-name=registry.k8s.io/sig-storage/hello-populator:v1.0.1
                  - --http-endpoint=:8080
                ports:
                  - containerPort: 8080
                    name: http-endpoint
                    protocol: TCP

      Copy to Clipboard Toggle word wrap

      1

      先ほど作成した namespace を参照します。

      2

      先ほど作成したサービスアカウントを参照します。

4. 次のサンプル YAML ファイルを使用して、ボリュームポピュレーターを作成し、kind:Hello リソースをボリュームの有効なデータソースとして登録します。

   ボリュームポピュレーターの YAML ファイルの例

   kind: VolumePopulator
   apiVersion: populator.storage.k8s.io/v1beta1
   metadata:
     name: hello-populator 

   1

   
   sourceKind:
     group: hello.example.com
     kind: Hello

   Copy to Clipboard Toggle word wrap

   1

   ボリュームポピュレーターの名前。

   未登録のポピュレーターを使用する PVC は、"The datasource for this PVC does not match any registered VolumePopulator" というイベントを作成します。これは、未知 (未登録) ポピュレーターを使用しているため、PVC がプロビジョニングされない可能性があることを示します。

手順

1. 次のコマンドを実行して、fileContents パラメーターとして渡された "Hello, World!" というテキストが含まれる Hello CRD のカスタムリソース (CR) インスタンスを作成します。

   $ oc apply -f  - <<EOF
   apiVersion: hello.example.com/v1alpha1
   kind: Hello
   metadata:
     name: example-hello
   spec:
     fileName: example.txt
     fileContents: Hello, world!
   EOF

   Copy to Clipboard Toggle word wrap

2. 次のサンプルファイルのような、Hello CR を参照する PVC を作成します。

   PVC YAML ファイルの例

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: example-pvc
   spec:
     accessModes:
     - ReadWriteOnce
     resources:
       requests:
         storage: 10Mi
     dataSourceRef: 

   1

   
       apiGroup: hello.example.com
       kind: Hello
       name: example-hello 

   2

   
     volumeMode: Filesystem

   Copy to Clipboard Toggle word wrap

   1

   dataSourceRef フィールドは、PVC のデータソースを指定します。

   2

   データソースとして使用している CR の名前。この例では、'example-hello' です。

検証

1. 数分経過したら、次のコマンドを実行して、PVC が作成され、ステータスが Bound になっていることを確認します。

   $ oc get pvc example-pvc -n hello 

   1

   Copy to Clipboard Toggle word wrap

   1

   この例では、PVC の名前は example-pvc です。

   出力例

   NAME          STATUS    VOLUME        CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
   example-pvc   Bound     my-pv         10Mi       ReadWriteOnce  gp3-csi        <unset>                 14s

   Copy to Clipboard Toggle word wrap

2. 次のサンプルファイルを使用して、PVC を読み取ってデータソース情報が適用されたことを検証するジョブを作成します。

   ジョブ YAML ファイルの例

   apiVersion: batch/v1
   kind: Job
   metadata:
     name: example-job
   spec:
     template:
       spec:
         containers:
           - name: example-container
             image: busybox:latest
             command:
               - cat
               - /mnt/example.txt 

   1

   
             volumeMounts:
               - name: vol
                 mountPath: /mnt
         restartPolicy: Never
         volumes:
           - name: vol
             persistentVolumeClaim:
               claimName: example-pvc 

   2

   Copy to Clipboard Toggle word wrap

   1

   "Hello, world!" テキストが含まれるファイルの場所と名前。

   2

   ステップ 2 で作成した PVC の名前。この例では、example-pvc です。

3. 次のコマンドを実行してジョブを開始します。

   $ oc run example-job --image=busybox --command -- sleep 30 --restart=OnFailure

   Copy to Clipboard Toggle word wrap

   出力例

   pod/example-job created

   Copy to Clipboard Toggle word wrap

4. 次のコマンドを実行して、ジョブとそのすべての依存関係が完了するまで待機します。

   $ oc wait --for=condition=Complete pod/example-job

   Copy to Clipboard Toggle word wrap

5. 次のコマンドを実行して、ジョブが収集したコンテンツを検証します。

   $ oc logs job/example-job

   Copy to Clipboard Toggle word wrap

   予想される出力

   Hello, world!

   Copy to Clipboard Toggle word wrap

1. ボリュームポピュレーターを使用してデータが事前投入されたボリュームを作成する セクション。

2. ボリュームポピュレーターの CRD の作成 セクション。

   必ず VolumePopulator インスタンスを削除してください。