4.7. 사용자 정의 카탈로그 관리

프로세스

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 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

      Operator 또는 패키지, 이름

      2

      서브스크립션이 지정되지 않은 경우 기본값으로 설정된 채널

      3

      Operator의 README.md 또는 기타 문서 경로

      4

      Operator 아이콘 경로

      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 파일의 내용을 사양으로 수정합니다.

   중요

   번들이 카탈로그에 게시되면 사용자 중 하나가 설치되었다고 가정합니다. 해당 버전이 설치된 사용자를 방지하려면 카탈로그의 이전에 게시된 모든 번들에 현재 또는 최신 채널 헤드에 대한 업데이트 경로가 있는지 확인합니다.

   • Operator를 추가하려면 "파일 기반 카탈로그 이미지 생성" 프로세스에서 패키지, 번들 및 채널 항목을 생성하는 단계를 수행합니다.

   • Operator를 제거하려면 패키지와 관련된 olm.package,olm.channel, olm.bundle blobs 세트를 삭제합니다. 다음 예제에서는 카탈로그에서 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 파일과 동일한 디렉터리에precations.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. 업데이트된 카탈로그 이미지의 pull 사양을 사용하도록 카탈로그 소스를 추가하거나 기존 카탈로그 소스를 업데이트합니다.

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

3. 카탈로그 소스가 READY 상태인 후 Operator OperatorHub 페이지로 이동하여 수행된 변경 사항이 Operator 목록에 반영되었는지 확인합니다.

프로세스

1. 새 인덱스를 시작합니다.

   $ opm index add \
       --bundles <registry>/<namespace>/<bundle_image_name>:<tag> \1
       --tag <registry>/<namespace>/<index_image_name>:<tag> \2
       [--binary-image <registry_base_image>] 3

   1

   인덱스에 추가할 번들 이미지를 쉼표로 구분한 목록입니다.

   2

   인덱스 이미지에 포함할 이미지 태그입니다.

   3

   선택 사항: 카탈로그 제공에 사용할 대체 레지스트리 기본 이미지입니다.

2. 인덱스 이미지를 레지스트리로 내보냅니다.

   1. 필요한 경우 대상 레지스트리로 인증합니다.

      $ podman login <registry>

   2. 인덱스 이미지를 내보냅니다.

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

프로세스

1. 번들 이미지를 추가하여 기존 인덱스를 업데이트합니다.

   $ opm index add \
       --bundles <registry>/<namespace>/<new_bundle_image>@sha256:<digest> \1
       --from-index <registry>/<namespace>/<existing_index_image>:<existing_tag> \2
       --tag <registry>/<namespace>/<existing_index_image>:<updated_tag> \3
       --pull-tool podman 4

   1

   --bundles 플래그는 인덱스에 추가할 쉼표로 구분된 추가 번들 이미지 목록을 지정합니다.

   2

   --from-index 플래그는 이전에 내보낸 인덱스를 지정합니다.

   3

   --tag 플래그는 업데이트된 인덱스 이미지에 적용할 이미지 태그를 지정합니다.

   4

   --pull-tool 플래그는 컨테이너 이미지를 가져오는 데 사용되는 툴을 지정합니다.

   다음과 같습니다.

   <registry>

   quay.io 또는 mirror.example.com 과 같은 레지스트리의 호스트 이름을 지정합니다.

   <namespace>

   ocs-dev 또는 abc 와 같은 레지스트리의 네임스페이스를 지정합니다.

   <new_bundle_image>

   ocs-operator 와 같이 레지스트리에 추가할 새 번들 이미지를 지정합니다.

   <digest>

   번들 이미지의 SHA 이미지 ID 또는 다이제스트(예: c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41 )를 지정합니다.

   <existing_index_image>

   이전에 내보낸 이미지(예: abc-redhat-operator-index )를 지정합니다.

   <existing_tag>

   이전에 푸시한 이미지 태그(예: 4)를 지정합니다.

   <updated_tag>

   4.1 과 같이 업데이트된 인덱스 이미지에 적용할 이미지 태그를 지정합니다.

   명령 예

   $ opm index add \
       --bundles quay.io/ocs-dev/ocs-operator@sha256:c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41 \
       --from-index mirror.example.com/abc/abc-redhat-operator-index:4 \
       --tag mirror.example.com/abc/abc-redhat-operator-index:4.1 \
       --pull-tool podman

2. 업데이트된 인덱스 이미지를 내보냅니다.

   $ podman push <registry>/<namespace>/<existing_index_image>:<updated_tag>

3. OLM(Operator Lifecycle Manager)이 정기적으로 카탈로그 소스에서 참조하는 인덱스 이미지를 자동으로 폴링하면 새 패키지가 성공적으로 추가되었는지 확인합니다.

   $ oc get packagemanifests -n openshift-marketplace

프로세스

1. 대상 레지스트리로 인증합니다.

   $ podman login <target_registry>

2. 정리된 인덱스에 포함하려는 패키지 목록을 결정합니다.

   1. 컨테이너에서 정리하려는 소스 인덱스 이미지를 실행합니다. 예를 들면 다음과 같습니다.

      $ podman run -p50051:50051 \
          -it registry.redhat.io/redhat/redhat-operator-index:v4

      출력 예

      Trying to pull registry.redhat.io/redhat/redhat-operator-index:v4...
      Getting image source signatures
      Copying blob ae8a0c23f5b1 done
      ...
      INFO[0000] serving registry                              database=/database/index.db port=50051

   2. 별도의 터미널 세션에서 grpcurl 명령을 사용하여 인덱스에서 제공하는 패키지 목록을 가져옵니다.

      $ grpcurl -plaintext localhost:50051 api.Registry/ListPackages > packages.out

   3. packages.out 파일을 검사하고 정리된 인덱스에 보관할 이 목록에 있는 패키지 이름을 확인합니다. 예를 들면 다음과 같습니다.

      패키지 목록 조각의 예

      ...
      {
        "name": "advanced-cluster-management"
      }
      ...
      {
        "name": "jaeger-product"
      }
      ...
      {
      {
        "name": "quay-operator"
      }
      ...

   4. podman run 명령을 실행한 터미널 세션에서 Ctrl 및 C를 눌러 컨테이너 프로세스를 중지합니다.

3. 다음 명령을 실행하여 지정된 패키지를 제외한 소스 인덱스를 모두 정리합니다.

   $ opm index prune \
       -f registry.redhat.io/redhat/redhat-operator-index:v4 \1
       -p advanced-cluster-management,jaeger-product,quay-operator \2
       [-i registry.redhat.io/openshift4/ose-operator-registry:v4.9] \3
       -t <target_registry>:<port>/<namespace>/redhat-operator-index:v4 4

   1

   정리할 인덱스입니다.

   2

   쉼표로 구분된 보관할 패키지 목록입니다.

   3

   IBM Power® 및 IBM Z® 이미지에만 필요합니다. 대상 OpenShift Dedicated 클러스터 메이저 및 마이너 버전과 일치하는 태그가 있는 Operator 레지스트리 기본 이미지입니다.

   4

   빌드 중인 새 인덱스 이미지에 대한 사용자 정의 태그입니다.

4. 다음 명령을 실행하여 새 인덱스 이미지를 대상 레지스트리로 내보냅니다.

   $ podman push <target_registry>:<port>/<namespace>/redhat-operator-index:v4

   <namespace>는 레지스트리의 기존 네임스페이스입니다.

프로세스

1. 다음 명령을 실행하여 SQLite 데이터베이스 카탈로그를 파일 기반 카탈로그로 마이그레이션합니다.

   $ opm migrate <registry_image> <fbc_directory>

2. 다음 명령을 실행하여 파일 기반 카탈로그에 대한 Dockerfile을 생성합니다.

   $ opm generate dockerfile <fbc_directory> \
     --binary-image \
     registry.redhat.io/openshift4/ose-operator-registry:v4

프로세스

1. 다음 예와 같이 spec.grpcPodConfig.securityContextConfig 레이블을 legacy 로 설정하여 CatalogSource 정의를 편집합니다.

   CatalogSource 정의의 예

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: my-catsrc
     namespace: my-ns
   spec:
     sourceType: grpc
     grpcPodConfig:
       securityContextConfig: legacy
     image: my-image:latest

   작은 정보

   OpenShift Dedicated 4에서 spec.grpcPodConfig.securityContextConfig 필드는 기본적으로 legacy 로 설정됩니다. 향후 OpenShift Dedicated 릴리스에서는 기본 설정이 restricted 로 변경될 예정입니다. 제한된 적용으로 카탈로그를 실행할 수 없는 경우 이 필드를 기존으로 수동으로 설정하는 것이 좋습니다.

2. 다음 예와 같이 <namespace>.yaml 파일을 편집하여 카탈로그 소스 네임스페이스에 승격된 Pod 보안 승인 표준을 추가합니다.

   &lt ;namespace>.yaml 파일 예

   apiVersion: v1
   kind: Namespace
   metadata:
   ...
     labels:
       security.openshift.io/scc.podSecurityLabelSync: "false" 1
       openshift.io/cluster-monitoring: "true"
       pod-security.kubernetes.io/enforce: baseline 2
     name: "<namespace_name>"

   1

   네임스페이스에 security.openshift.io/scc.podSecurityLabelSync=false 라벨을 추가하여 Pod 보안 레이블 동기화를 끕니다.

   2

   Pod 보안 승인 pod-security.kubernetes.io/enforce 레이블을 적용합니다. 레이블을 baseline 또는 privileged 로 설정합니다. 네임스페이스의 다른 워크로드에 권한 있는 프로필이 필요하지 않는 한 기준 Pod 보안 프로필을 사용합니다.