4.5. 카탈로그 만들기

프로세스

1. 카탈로그를 초기화합니다.

   1. 다음 명령을 실행하여 카탈로그에 대한 디렉토리를 만듭니다.

      $ mkdir <catalog_dir>

   2. opm generate dockerfile 명령을 실행하여 카탈로그 이미지를 빌드할 수 있는 Dockerfile을 생성합니다.

      $ opm generate dockerfile <catalog_dir> \
          -i registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4.19 

      1

      1

      -i 플래그를 사용하여 공식 Red Hat 기본 이미지를 지정하세요. 그렇지 않으면 Dockerfile은 기본 업스트림 이미지를 사용합니다.

      Dockerfile은 이전 단계에서 생성한 카탈로그 디렉터리와 동일한 상위 디렉터리에 있어야 합니다.

      디렉터리 구조의 예

      . 

      1

      
      ├── <catalog_dir> 

      2

      
      └── <catalog_dir>.Dockerfile 

      3

      1

      상위 디렉토리

      2

      카탈로그 디렉토리

      3

      opm generate dockerfile 명령으로 생성된 Dockerfile

   3. opm init 명령을 실행하여 카탈로그를 Operator의 패키지 정의로 채웁니다.

      $ opm init <operator_name> \ 

      1

      
          --default-channel=preview \ 

      2

      
          --description=./README.md \ 

      3

      
          --icon=./operator-icon.svg \ 

      4

      
          --output yaml \ 

      5

      
          > <catalog_dir>/index.yaml 

      6

      1

      운영자 또는 패키지 이름

      2

      지정되지 않은 경우 구독이 기본적으로 적용되는 채널

      3

      운영자의 README.md 또는 기타 문서에 대한 경로

      4

      운영자 아이콘으로 가는 경로

      5

      출력 형식: JSON 또는 YAML

      6

      카탈로그 구성 파일을 생성하기 위한 경로

      이 명령은 지정된 카탈로그 구성 파일에 olm.package 선언적 구성 blob을 생성합니다.

2. opm render 명령을 실행하여 카탈로그에 번들을 추가합니다.

   $ opm render <registry>/<namespace>/<bundle_image_name>:<tag> \ 

   1

   
       --output=yaml \
       >> <catalog_dir>/index.yaml 

   2

   1

   번들 이미지에 대한 풀 스펙

   2

   카탈로그 구성 파일 경로

   참고

   채널에는 하나 이상의 번들이 포함되어야 합니다.

3. 번들에 채널 항목을 추가합니다. 예를 들어, 다음 예를 귀하의 사양에 맞게 수정하고 <catalog_dir>/index.yaml 파일에 추가하세요.

   채널 항목 예

   ---
   schema: olm.channel
   package: <operator_name>
   name: preview
   entries:
     - name: <operator_name>.v0.1.0 

   1

   1

   <operator_name> 뒤의 마침표(.)를 버전 v 앞에 포함해야 합니다. 그렇지 않으면 해당 항목은 opm validate 명령을 통과하지 못합니다.

4. 파일 기반 카탈로그를 확인합니다.

   1. 카탈로그 디렉터리에 대해 opm validate 명령을 실행합니다.

      $ opm validate <catalog_dir>

   2. 오류 코드가 0인지 확인합니다.

      $ echo $?

      출력 예

      0

5. podman build 명령을 실행하여 카탈로그 이미지를 빌드합니다.

   $ podman build . \
       -f <catalog_dir>.Dockerfile \
       -t <registry>/<namespace>/<catalog_image_name>:<tag>

6. 카탈로그 이미지를 레지스트리로 푸시합니다.

   1. 필요한 경우 podman login 명령을 실행하여 대상 레지스트리에 인증합니다.

      $ podman login <registry>

   2. podman push 명령을 실행하여 카탈로그 이미지를 푸시합니다.

      $ podman push <registry>/<namespace>/<catalog_image_name>:<tag>

프로세스

1. 카탈로그 이미지의 내용을 YAML 형식으로 추출하여 카탈로그 디렉토리의 index.yaml 파일에 저장합니다.

   $ opm render <registry>/<namespace>/<catalog_image_name>:<tag> \
       -o yaml > <catalog_dir>/index.yaml

   참고

   또는 -o json 플래그를 사용하여 JSON 형식으로 출력할 수 있습니다.

2. 결과 index.yaml 파일의 내용을 사양에 맞게 수정하세요.

   중요

   카탈로그에 번들이 게시된 후 사용자 중 한 명이 해당 번들을 설치했다고 가정합니다. 해당 버전을 설치한 사용자가 고립되는 것을 방지하기 위해 카탈로그에 게시된 모든 번들에 현재 또는 최신 채널 헤드에 대한 업데이트 경로가 있는지 확인하세요.

   • 운영자를 추가하려면 "파일 기반 카탈로그 이미지 만들기" 절차에서 패키지, 번들 및 채널 항목을 만드는 단계를 따르세요.

   • 운영자를 제거하려면 패키지와 관련된 olm.package , olm.channel , olm.bundle 블롭 세트를 삭제합니다. 다음 예에서는 카탈로그에서 example-operator 패키지를 제거하기 위해 삭제해야 하는 세트를 보여줍니다.

     예 4.9. 제거된 항목의 예

     ---
     defaultChannel: release-2.7
     icon:
       base64data: <base64_string>
       mediatype: image/svg+xml
     name: example-operator
     schema: olm.package
     ---
     entries:
     - name: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.0'
     - name: example-operator.v2.7.1
       replaces: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.1'
     - name: example-operator.v2.7.2
       replaces: example-operator.v2.7.1
       skipRange: '>=2.6.0 <2.7.2'
     - name: example-operator.v2.7.3
       replaces: example-operator.v2.7.2
       skipRange: '>=2.6.0 <2.7.3'
     - name: example-operator.v2.7.4
       replaces: example-operator.v2.7.3
       skipRange: '>=2.6.0 <2.7.4'
     name: release-2.7
     package: example-operator
     schema: olm.channel
     ---
     image: example.com/example-inc/example-operator-bundle@sha256:<digest>
     name: example-operator.v2.7.0
     package: example-operator
     properties:
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyObject
         version: v1alpha1
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyOtherObject
         version: v1beta1
     - type: olm.package
       value:
         packageName: example-operator
         version: 2.7.0
     - type: olm.bundle.object
       value:
         data: <base64_string>
     - type: olm.bundle.object
       value:
         data: <base64_string>
     relatedImages:
     - image: example.com/example-inc/example-related-image@sha256:<digest>
       name: example-related-image
     schema: olm.bundle
     ---

   • Operator에 대한 사용 중단 메시지를 추가하거나 업데이트하려면 패키지의 index.yaml 파일과 같은 디렉토리에 deprecations.yaml 파일이 있는지 확인하세요. deprecations.yaml 파일 형식에 대한 자세한 내용은 "olm.deprecations 스키마"를 참조하세요.
3. 변경 사항을 저장하십시오.

4. 카탈로그 검증:

   $ opm validate <catalog_dir>

5. 카탈로그를 다시 작성하세요:

   $ podman build . \
       -f <catalog_dir>.Dockerfile \
       -t <registry>/<namespace>/<catalog_image_name>:<tag>

6. 업데이트된 카탈로그 이미지를 레지스트리에 푸시합니다.

   $ podman push <registry>/<namespace>/<catalog_image_name>:<tag>

검증

1. 웹 콘솔에서 관리 클러스터 설정 구성 페이지에 있는 OperatorHub 구성 리소스로 이동합니다.

2. 업데이트된 카탈로그 이미지에 대한 풀 사양을 사용하도록 카탈로그 소스를 추가하거나 기존 카탈로그 소스를 업데이트합니다.

   자세한 내용은 이 섹션의 "추가 리소스"에서 "클러스터에 카탈로그 소스 추가"를 참조하세요.

3. 카탈로그 소스가 준비 상태가 되면 운영자 운영자 허브 페이지로 이동하여 변경 사항이 운영자 목록에 반영되었는지 확인하세요.