2.8. CRDs

1. Créez un fichier YAML contenant les types de champs suivants :

   Exemple de fichier YAML pour un CRD

   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

   Utilisez l'API apiextensions.k8s.io/v1.

   2

   Indiquez un nom pour la définition. Ce nom doit être au format <plural-name>.<group> en utilisant les valeurs des champs group et plural.

   3

   Spécifiez un nom de groupe pour l'API. Un groupe API est une collection d'objets logiquement liés. Par exemple, tous les objets de lot tels que Job ou ScheduledJob pourraient se trouver dans le groupe API de lot (tel que batch.api.example.com). Une bonne pratique consiste à utiliser le nom de domaine entièrement qualifié (FQDN) de votre organisation.

   4

   Spécifiez un nom de version à utiliser dans l'URL. Chaque groupe d'API peut exister dans plusieurs versions, par exemple v1alpha, v1beta, v1.

   5

   Indiquez si les objets personnalisés sont disponibles pour un projet (Namespaced) ou pour tous les projets du cluster (Cluster).

   6

   Spécifiez le nom pluriel à utiliser dans l'URL. Le champ plural est identique à celui d'une ressource dans une URL d'API.

   7

   Spécifiez un nom singulier à utiliser comme alias dans le CLI et pour l'affichage.

   8

   Spécifie le type d'objets qui peuvent être créés. Le type peut être en CamelCase.

   9

   Spécifiez une chaîne plus courte pour faire correspondre votre ressource à la CLI.

   Note

   Par défaut, un CRD est géré en grappe et accessible à tous les projets.

2. Créer l'objet CRD :

   oc create -f <nom_du_fichier>.yaml

   Un nouveau point d'accès à l'API RESTful est créé à l'adresse :

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

   Par exemple, en utilisant le fichier d'exemple, le point final suivant est créé :

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

   Vous pouvez maintenant utiliser cette URL pour créer et gérer des CR. Le type d'objet est basé sur le champ spec.kind de l'objet CRD que vous avez créé.

Procédure

1. Créer un fichier de définition des rôles de cluster pour le CRD. La définition du rôle de cluster est un fichier YAML qui contient les règles qui s'appliquent à chaque rôle de cluster. Un contrôleur OpenShift Container Platform ajoute les règles que vous spécifiez aux rôles de cluster par défaut.

   Exemple de fichier YAML pour la définition d'un rôle de cluster

   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

   Utilisez l'API rbac.authorization.k8s.io/v1.

   2 8

   Spécifiez un nom pour la définition.

   3

   Spécifiez cette étiquette pour accorder des autorisations au rôle par défaut d'administrateur.

   4

   Spécifiez cette étiquette pour accorder des autorisations au rôle d'édition par défaut.

   5 11

   Indiquez le nom du groupe du CRD.

   6 12

   Indiquez le nom pluriel du CRD auquel ces règles s'appliquent.

   7 13

   Spécifiez les verbes qui représentent les autorisations accordées au rôle. Par exemple, appliquer les autorisations de lecture et d'écriture aux rôles admin et edit et uniquement l'autorisation de lecture au rôle view.

   9

   Spécifiez cette étiquette pour accorder des autorisations au rôle par défaut view.

   10

   Spécifiez cette étiquette pour accorder des autorisations au rôle par défaut cluster-reader.

2. Créer le rôle de cluster :

   oc create -f <nom_du_fichier>.yaml

Procédure

1. Créez un fichier YAML pour le CR. Dans l'exemple de définition suivant, les champs personnalisés cronSpec et image sont définis dans un CR de Kind: CronTab. Le Kind provient du champ spec.kind de l'objet CRD :

   Exemple de fichier YAML pour un CR

   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

   Spécifiez le nom du groupe et la version de l'API (nom/version) à partir du CRD.

   2

   Spécifier le type dans le CRD.

   3

   Spécifiez un nom pour l'objet.

   4

   Spécifier les finaliseurs de l'objet, s'il y en a. Les finaliseurs permettent aux contrôleurs de mettre en œuvre des conditions qui doivent être remplies avant que l'objet puisse être supprimé.

   5

   Spécifier les conditions spécifiques au type d'objet.

2. Après avoir créé le fichier, créez l'objet :

   oc create -f <nom_du_fichier>.yaml

Procédure

1. Pour obtenir des informations sur un type spécifique de CR, exécutez :

   oc get <kind> $ oc get <kind>

   Par exemple :

   $ oc get crontab

   Exemple de sortie

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

   Les noms de ressources ne sont pas sensibles à la casse et vous pouvez utiliser les formes singulières ou plurielles définies dans le CRD, ainsi que n'importe quel nom court. Par exemple :

   $ oc get crontabs

   $ oc get crontab

   $ oc get ct

2. Vous pouvez également consulter les données YAML brutes d'un CR :

   oc get <kind> -o yaml

   Par exemple :

   $ oc get ct -o yaml

   Exemple de sortie

   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

   Les données personnalisées du fichier YAML que vous avez utilisé pour créer l'objet s'affichent.

Procédure

1. Créez un fichier YAML pour le CR. Dans l'exemple de définition suivant, les champs personnalisés cronSpec et image sont définis dans un CR de Kind: CronTab. Le Kind provient du champ spec.kind de l'objet CRD :

   Exemple de fichier YAML pour un CR

   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

   Spécifiez le nom du groupe et la version de l'API (nom/version) à partir du CRD.

   2

   Spécifier le type dans le CRD.

   3

   Spécifiez un nom pour l'objet.

   4

   Spécifier les finaliseurs de l'objet, s'il y en a. Les finaliseurs permettent aux contrôleurs de mettre en œuvre des conditions qui doivent être remplies avant que l'objet puisse être supprimé.

   5

   Spécifier les conditions spécifiques au type d'objet.

2. Après avoir créé le fichier, créez l'objet :

   oc create -f <nom_du_fichier>.yaml

Procédure

1. Pour obtenir des informations sur un type spécifique de CR, exécutez :

   oc get <kind> $ oc get <kind>

   Par exemple :

   $ oc get crontab

   Exemple de sortie

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

   Les noms de ressources ne sont pas sensibles à la casse et vous pouvez utiliser les formes singulières ou plurielles définies dans le CRD, ainsi que n'importe quel nom court. Par exemple :

   $ oc get crontabs

   $ oc get crontab

   $ oc get ct

2. Vous pouvez également consulter les données YAML brutes d'un CR :

   oc get <kind> -o yaml

   Par exemple :

   $ oc get ct -o yaml

   Exemple de sortie

   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

   Les données personnalisées du fichier YAML que vous avez utilisé pour créer l'objet s'affichent.