2.7. CRD

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

   CRD の YAML ファイルの例

   apiVersion: apiextensions.k8s.io/v1 1
   kind: CustomResourceDefinition
   metadata:
     name: crontabs.stable.example.com 2
   spec:
     group: stable.example.com 3
     versions:
       name: v1 4
     scope: Namespaced 5
     names:
       plural: crontabs 6
       singular: crontab 7
       kind: CronTab 8
       shortNames:
       - ct 9

   1

   apiextensions.k8s.io/v1 API を使用します。

   2

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

   3

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

   4

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

   5

   カスタムオブジェクトがクラスター (Cluster) の 1 つのプロジェクト (Namespaced) またはすべてのプロジェクトで利用可能であるかどうかを指定します。

   6

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

   7

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

   8

   作成できるオブジェクトの種類を指定します。タイプは CamelCase にすることができます。

   9

   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 1
   metadata:
     name: aggregate-cron-tabs-admin-edit 2
     labels:
       rbac.authorization.k8s.io/aggregate-to-admin: "true" 3
       rbac.authorization.k8s.io/aggregate-to-edit: "true" 4
   rules:
   - apiGroups: ["stable.example.com"] 5
     resources: ["crontabs"] 6
     verbs: ["get", "list", "watch", "create", "update", "patch", "delete", "deletecollection"] 7
   ---
   kind: ClusterRole
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: aggregate-cron-tabs-view 8
     labels:
       # Add these permissions to the "view" default role.
       rbac.authorization.k8s.io/aggregate-to-view: "true" 9
       rbac.authorization.k8s.io/aggregate-to-cluster-reader: "true" 10
   rules:
   - apiGroups: ["stable.example.com"] 11
     resources: ["crontabs"] 12
     verbs: ["get", "list", "watch"] 13

   1

   rbac.authorization.k8s.io/v1 API を使用します。

   2 8

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

   3

   パーミッションを管理のデフォルトロールに付与するためにこのラベルを指定します。

   4

   パーミッションを編集のデフォルトロールに付与するためにこのラベルを指定します。

   5 11

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

   6 12

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

   7 13

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

   9

   このラベルを指定して、パーミッションを view デフォルトロールに付与します。

   10

   このラベルを指定して、パーミッションを cluster-reader デフォルトロールに付与します。

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" 1
   kind: CronTab 2
   metadata:
     name: my-new-cron-object 3
     finalizers: 4
     - finalizer.stable.example.com
   spec: 5
     cronSpec: "* * * * /5"
     image: my-awesome-cron-image

   1

   CRD からグループ名および API バージョン (name/version) を指定します。

   2

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

   3

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

   4

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

   5

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

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' 1
       image: my-awesome-cron-image 2

   1 2

   オブジェクトの作成に使用した YAML からのカスタムデータが表示されます。

手順

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

   CR の YAML ファイルサンプル

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

   1

   CRD からグループ名および API バージョン (name/version) を指定します。

   2

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

   3

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

   4

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

   5

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

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' 1
       image: my-awesome-cron-image 2

   1 2

   オブジェクトの作成に使用した YAML からのカスタムデータが表示されます。