2.8. 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
         served: true
         storage: true
         schema:
           openAPIV3Schema:
             type: object
             properties:
               spec:
                 type: object
                 properties:
                   cronSpec:
                     type: string
                   image:
                     type: string
                   replicas:
                     type: integer
     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

   특정 프로젝트(Namespaced) 또는 클러스터의 모든 프로젝트(Cluster)에서 사용자 정의 오브젝트를 사용할 수 있는지 지정합니다.

   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을 생성하고 관리할 수 있습니다. 오브젝트 종류는 생성한 CRD 오브젝트의 spec.kind 필드를 기반으로 합니다.

프로세스

1. CRD의 클러스터 역할 정의 파일을 생성합니다. 클러스터 역할 정의는 각 클러스터 역할에 적용되는 규칙이 포함된 YAML 파일입니다. OpenShift Container Platform 컨트롤러는 지정하는 규칙을 기본 클러스터 역할에 추가합니다.

   클러스터 역할 정의에 대한 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 버전(이름/버전)을 지정합니다.

   2

   CRD에 유형을 지정합니다.

   3

   오브젝트의 이름을 지정합니다.

   4

   해당하는 경우 오브젝트의 종료자를 지정합니다. 종료자를 사용하면 컨트롤러에서 오브젝트를 삭제하기 전에 완료해야 하는 조건을 구현할 수 있습니다.

   5

   오브젝트 유형별 조건을 지정합니다.

2. 파일을 생성한 후 오브젝트를 생성합니다.

   $ oc create -f <file_name>.yaml

프로세스

1. 특정 종류의 CR에 대한 정보를 얻으려면 다음을 실행합니다.

   $ 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 버전(이름/버전)을 지정합니다.

   2

   CRD에 유형을 지정합니다.

   3

   오브젝트의 이름을 지정합니다.

   4

   해당하는 경우 오브젝트의 종료자를 지정합니다. 종료자를 사용하면 컨트롤러에서 오브젝트를 삭제하기 전에 완료해야 하는 조건을 구현할 수 있습니다.

   5

   오브젝트 유형별 조건을 지정합니다.

2. 파일을 생성한 후 오브젝트를 생성합니다.

   $ oc create -f <file_name>.yaml

프로세스

1. 특정 종류의 CR에 대한 정보를 얻으려면 다음을 실행합니다.

   $ 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의 사용자 정의 데이터가 표시됩니다.