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

절차

1. 파일 기반 카탈로그에 대한 카탈로그를 초기화합니다.

   1. 카탈로그의 디렉터리를 생성합니다.

      $ mkdir <operator_name>-index

   2. 카탈로그 이미지를 빌드할 수 있는 Dockerfile을 생성합니다.

      예: <operator_name>-index.Dockerfile

      # The base image is expected to contain
      # /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
      FROM registry.redhat.io/openshift4/ose-operator-registry:v4.9
      
      # Configure the entrypoint and command
      ENTRYPOINT ["/bin/opm"]
      CMD ["serve", "/configs"]
      
      # Copy declarative config root into image at /configs
      ADD <operator_name>-index /configs
      
      # Set DC-specific label for the location of the DC root directory
      # in the image
      LABEL operators.operatorframework.io.index.configs.v1=/configs

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

      디렉터리 구조의 예

      .
      ├── <operator_name>-index
      └── <operator_name>-index.Dockerfile

   3. 카탈로그를 패키지 정의로 채웁니다.

      $ opm init <operator_name> \ 1
          --default-channel=preview \ 2
          --description=./README.md \ 3
          --icon=./operator-icon.svg \ 4
          --output yaml \ 5
          > <operator_name>-index/index.yaml 6

      1

      Operator 또는 패키지, 이름입니다.

      2

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

      3

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

      4

      Operator 아이콘 경로입니다.

      5

      출력 형식: JSON 또는 YAML.

      6

      카탈로그 구성 파일을 만드는 경로입니다.

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

2. 카탈로그에 번들을 추가합니다.

   $ opm render <registry>/<namespace>/<bundle_image_name>:<tag> \ 1
       --output=yaml \
       >> <operator_name>-index/index.yaml 2

   1

   번들 이미지에 대한 가져오기 사양입니다.

   2

   카탈로그 구성 파일의 경로입니다.

   opm render 명령은 제공된 카탈로그 이미지 및 번들 이미지에서 선언적 구성 Blob을 생성합니다.

   참고

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

3. 번들에 채널 항목을 추가합니다. 예를 들어 다음 예제를 사양에 맞게 수정하고 <operator_name>-index/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 <operator_name>-index

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

      $ echo $?

      출력 예

      0

5. 카탈로그 이미지를 빌드합니다.

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

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

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

      $ podman login <registry>

   2. 카탈로그 이미지를 내보냅니다.

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

절차

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.9 ).

   <updated_tag>

   업데이트된 인덱스 이미지에 적용할 이미지 태그를 지정합니다(예: 4.9.1 ).

   명령 예

   $ opm index add \
       --bundles quay.io/ocs-dev/ocs-operator@sha256:c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41 \
       --from-index mirror.example.com/abc/abc-redhat-operator-index:4.9 \
       --tag mirror.example.com/abc/abc-redhat-operator-index:4.9.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.9

      출력 예

      Trying to pull registry.redhat.io/redhat/redhat-operator-index:v4.9...
      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.9 \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.9 4

   1

   정리할 인덱스입니다.

   2

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

   3

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

   4

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

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

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

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