2.8. CRD

手順

1. 以下の例のようなフィールドタイプを含む YAML ファイルを作成します。

   CRD の YAML ファイルの例

   apiVersion: apiextensions.k8s.io/v1
   kind: CustomResourceDefinition
   metadata:
     name: crontabs.stable.example.com
   spec:
     group: stable.example.com
     versions:
       - name: v1
         served: true
         storage: true
         schema:
           openAPIV3Schema:
             type: object
             properties:
               spec:
                 type: object
                 properties:
                   cronSpec:
                     type: string
                   image:
                     type: string
                   replicas:
                     type: integer
     scope: Namespaced
     names:
       plural: crontabs
       singular: crontab
       kind: CronTab
       shortNames:
       - ct

   ここでは、以下のようになります。

   apiVersion

   apiextensions.k8s.io/v1 API パラメーターを指定します。

   metadata.name

   定義の名前を指定します。これは group および plural フィールドの値を使用する <plural-name>.<group> 形式である必要があります。

   spec.group

   API のグループ名を指定します。API グループは、論理的に関連付けられるオブジェクトのコレクションです。たとえば、Job または ScheduledJob などのすべてのバッチオブジェクトはバッチ API グループ (batch.api.example.com など) である可能性があります。組織の完全修飾ドメイン名 (FQDN) を使用することが奨励されます。

   spec.versions.name

   URL で使用されるバージョン名を指定します。それぞれの API グループは複数バージョンに存在させることができます (例: v1alpha、v1beta、v1)。

   spec.scope

   カスタムオブジェクトがプロジェクト(Namespaced)で利用できるか、クラスター内のすべてのプロジェクト（クラスター）で使用可能であるかを指定します。

   spec.names.plural

   URL で使用される複数形の名前を指定します。plural フィールドは API URL のリソースと同じになります。

   spec.names.singular

   CLI および表示用にエイリアスとして使用される単数形の名前を指定します。

   spec.names.kind

   作成できるオブジェクトの種類を指定します。type はキャメルケースにすることができます。

   spec.names.shortNames

   CLI のリソースに一致する短い文字列を指定します。

   注記

   デフォルトで、CRD のスコープはクラスターで設定され、すべてのプロジェクトで利用可能です。

2. CRD オブジェクトを作成します。

   $ oc create -f <file_name>.yaml

   新規の RESTful API エンドポイントは以下のように作成されます。

   /apis/<spec:group>/<spec:version>/<scope>/*/<names-plural>/...

   たとえば、サンプルファイルを使用すると、以下のエンドポイントが作成されます。

   /apis/stable.example.com/v1/namespaces/*/crontabs/...

   このエンドポイント URL を使用して CR を作成し、管理できます。オブジェクト kind は、作成した CRD オブジェクトの spec.kind フィールドに基づいています。

手順

1. CRD のクラスターロール定義ファイルを作成します。クラスターロール定義は、各クラスターロールに適用されるルールが含まれる YAML ファイルです。OpenShift Container Platform Controller はデフォルトクラスターロールに指定するルールを追加します。

   カスタムロール定義の YAML ファイルの例

   kind: ClusterRole
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: aggregate-cron-tabs-admin-edit
     labels:
       rbac.authorization.k8s.io/aggregate-to-admin: "true"
       rbac.authorization.k8s.io/aggregate-to-edit: "true"
   rules:
   - apiGroups: ["stable.example.com"]
     resources: ["crontabs"]
     verbs: ["get", "list", "watch", "create", "update", "patch", "delete", "deletecollection"]
   ---
   kind: ClusterRole
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: aggregate-cron-tabs-view
     labels:
       # Add these permissions to the "view" default role.
       rbac.authorization.k8s.io/aggregate-to-view: "true"
       rbac.authorization.k8s.io/aggregate-to-cluster-reader: "true"
   rules:
   - apiGroups: ["stable.example.com"]
     resources: ["crontabs"]
     verbs: ["get", "list", "watch"]

   ここでは、以下のようになります。

   apiVersion

   rbac.authorization.k8s.io/v1 API を指定します。

   metadata.name

   定義の名前を指定します。

   metadata.labels.rbac.authorization.k8s.io/aggregate-to-admin

   "true" を指定して、admin ロールにクラスターロールの集計を有効にします。

   metadata.labels.rbac.authorization.k8s.io/aggregate-to-edit

   パーミッション を edit デフォルトロールに付与するために true を指定します。

   rules.apiGroups

   CRD のグループ名を指定します。

   rules.resources

   これらのルールが適用される CRD の複数形の名前を指定します。

   rules.verbs

   ロールに付与されるパーミッションを表す動詞を指定します。たとえば、読み取りおよび書き込みパーミッションを admin および edit ロールに適用し、読み取り専用パーミッションを view ロールに適用します。

   metadata.labels.rbac.authorization.k8s.io/aggregate-to-view

   パーミッションを view のデフォルトロールに付与するために true を指定します。

   metadata.labels."rbac.authorization.k8s.io/aggregate-to-cluster-reader"

   cluster-reader のデフォルトロールにパーミッションを付与するために true を指定します。

2. クラスターロールを作成します。

   $ oc create -f <file_name>.yaml

手順

1. CR の YAML ファイルを作成します。以下の定義例では、cronSpec と image のカスタムフィールドが Kind: CronTab の CR に設定されます。この Kind は、CRD オブジェクトの spec.kind フィールドから取得されます。

   CR の YAML ファイルサンプル

   apiVersion: "stable.example.com/v1"
   kind: CronTab
   metadata:
     name: my-new-cron-object
     finalizers:
     - finalizer.stable.example.com
   spec:
     cronSpec: "* * * * /5"
     image: my-awesome-cron-image

   ここでは、以下のようになります。

   apiVersion

   CRD からグループ名および API バージョン（名前/バージョン）を指定します。

   kind

   CRD のタイプを指定します。

   metadata.name

   オブジェクトの名前を指定します。

   metadata.Finalizers

   オブジェクトのファイナライザーを指定します（ある場合）。ファイナライザーは、コントローラーがオブジェクトの削除前に完了する必要のある条件を実装できるようにします。

   spec

   オブジェクトのタイプに固有の条件を指定します。

2. ファイルの作成後に、オブジェクトを作成します。

   $ oc create -f <file_name>.yaml

手順

1. CR の特定の kind に関する情報を取得するには、以下を実行します。

   $ oc get <kind>

   以下に例を示します。

   $ oc get crontab

   出力例

   NAME                 KIND
   my-new-cron-object   CronTab.v1.stable.example.com

   リソース名では大文字と小文字が区別されず、CRD で定義される単数形または複数形のいずれか、および任意の短縮名を指定できます。以下に例を示します。

   $ oc get crontabs

   $ oc get crontab

   $ oc get ct

2. CR の未加工の YAML データを確認することもできます。

   $ oc get <kind> -o yaml

   以下に例を示します。

   $ oc get ct -o yaml

   出力例

   apiVersion: v1
   items:
   - apiVersion: stable.example.com/v1
     kind: CronTab
     metadata:
       clusterName: ""
       creationTimestamp: 2017-05-31T12:56:35Z
       deletionGracePeriodSeconds: null
       deletionTimestamp: null
       name: my-new-cron-object
       namespace: default
       resourceVersion: "285"
       selfLink: /apis/stable.example.com/v1/namespaces/default/crontabs/my-new-cron-object
       uid: 9423255b-4600-11e7-af6a-28d2447dc82b
     spec:
       cronSpec: '* * * * /5'
       image: my-awesome-cron-image

   出力の spec セクションには、オブジェクトの作成時に定義した cronSpec や image などのカスタム設定が表示されます。