OperatorHub.io로 발행하는 방법

OperatorHub.io는 Kubernetes 커뮤니티가 오퍼레이터를 공유하는 공간입니다.

참고: 다음 프로세스는 scripts/tools/publish.sh에서 부분적으로 자동화됩니다. 이 프로세스를 실행하려면 publish.sh ${VERSION} operatorhub `을 사용할 수 있습니다. 자세한 내용은 스크립트 문서를 참조하십시오.

GitLab 오퍼레이터를 OperatorHub에 발행하려면:

  1. community-operators 저장소를 포크하십시오.
  2. 포크된 community-operators 저장소를 클론하십시오:
    • 포크가 최근에 생성된 경우:

      git clone -o mine git@github.com:<your_github_username>/community-operators.git
      cd community-operators
      git remote add upstream https://github.com/k8s-operatorhub/community-operators.git
      
    • 이미 생성된 포크에 대한 이후 업데이트인 경우:

      cd community-operators
      git fetch --all
      git checkout main
      git rebase -i upstream/main
      
  3. 셸을 설정하십시오:

    # 발행된 오퍼레이터 이미지 태그
    export OPERATOR_TAG="0.3.1"
    # OLM에 적용할 버전
    export OLM_PACKAGE_VERSION=${OPERATOR_TAG}
    export OPERATORHUB_DIR="${HOME}/work/community-operators"
    export OPERATORHUB_NAME="gitlab-operator-kubernetes"
    export OSDK_BASE_DIR=".build/operatorhub-io"
    # 옵션
    # 로컬 "yq" 바이너리를 가리키도록 지정:
    export YQ="yq-go"
    
  4. https://gitlab.com/gitlab-org/cloud-native/gitlab-operator의 새 브랜치를 만드십시오:

    cd ${OPERATORHUB_DIR}
    git checkout -B gitlab-release-${OPERATOR_TAG}
    
  5. config/manifests/bases/gitlab-operator-kubernetes.clusterserviceversion.yaml을 편집하여 해당 버전의 오퍼레이터가 함께 제공되는 유효한 차트 버전을 나타내도록 metadata.annotations.alm-examples를 수정하십시오.

  6. 로컬 KinD 클러스터에서 오퍼레이터 번들을 테스트하십시오:

    1. BUNDLE_REGISTRY를 유효한 공개 레지스트리로 지정해야 합니다 (이를 위해 본인의 프로젝트/레지스트리를 만드세요):

      export BUNDLE_REGISTRY=registry.gitlab.com/dmakovey/gitlab-operator-bundle
      
    2. podman (또는 docker)이 BUNDLE_REGISTRY에 로그인해 있어야 합니다.

    이전에 설정한 값을 일시적으로 덮어쓰기하여 Kind-Specific 번들 등이 제대로 설정되도록 주의하십시오.

    OSDK_BASE_DIR=".build/operatortest1" KIND_CLUSTER_NAME="optest1" BUNDLE_IMAGE_TAG="beta1" DOCKER="podman" OPERATOR_TAG=0.6.0 KIND_CONFIG="${HOME}/work/gitlab/examples/kind/kind-ssl.yaml" KIND_IMAGE="kindest/node:v1.22.4" scripts/olm_bundle.sh step1 step2
    
    1. gitlab-operator-kubernetes에 대한 packagemanifest가 사용 가능해질 때까지 기다리십시오 (Community Operators를 건너뛸 것입니다):

      $ kubectl get packagemanifests | grep -F gitlab | grep -vF "Community Operators"
      gitlab-operator-kubernetes                                       48m
      
    2. 오퍼레이터를 배포하십시오 (수동으로 승인을 피하기 위해 AUTO_UPGRADE="true"로 설정하겠습니다):

      OSDK_BASE_DIR=".build/operatortest1" AUTO_UPGRADE="true" scripts/olm_bundle.sh step3
      
    3. IngressClass 생성:

      cat << EOF | kubectl apply -f -
      apiVersion: networking.k8s.io/v1
      kind: IngressClass
      metadata:
        # 다음 단계의 GitLab CR의 `spec.chart.values.global.ingress.class`와 일치하는지 확인하십시오.
        name: gitlab-nginx
      spec:
        controller: k8s.io/ingress-nginx
      EOF
      
    4. GitLab 배포 (값은 본인 설정에 맞게 사용자화해야 합니다):

      KIND_CLUSTER_NAME="optest1" GITLAB_CR_DEPLOPOY_MODE="ss" LOCAL_IP=192.168.3.194 GITLAB_CHART_DIR=~/work/gitlab GITLAB_OPERATOR_DOMAIN=192.168.3.194.nip.io GITLAB_OPERATOR_DIR=. scripts/provision_and_deploy.sh  deploy_gitlab
      
    5. KinD 클러스터 삭제:

      kind delete cluster --name=${KIND_CLUSTER_NAME}
      
  7. OLM 번들 업그레이드 테스트

    1. 테스트에 사용된 변수를 재사용하십시오 (위 참고).

    2. 새로운 KinD 클러스터를 만드십시오:

      scripts/olm_bundle.sh initialize_kind install_olm create_namespace
      
    3. 이 시점에서 “테스트” 버전의 번들을 ${BUNDLE_REGISTRY}:${BUNDLE_IMAGE_TAG}에 게시한 것으로 가정하겠습니다 (그렇지 않은 경우 “로컬 KinD 클러스터에서 오퍼레이터 번들을 테스트하십시오”를 따르세요). 이전 릴리스가 0.3.1인 경우 테스트를 위해 카탈로그를 만들겠습니다 (카탈로그 태그 beta1u는 이전에 게시된 카탈로그 태그 beta1과 다릅니다):

      export CATALOG_IMAGE_TAG="beta1u"
      PREVIOUS_BUNDLE_VERSION="0.3.1"
      
      opm index add -p docker \
         --bundles registry.gitlab.com/gitlab-org/cloud-native/gitlab-operator/bundle:${PREVIOUS_BUNDLE_VERSION},${BUNDLE_REGISTRY}:${BUNDLE_IMAGE_TAG} \
         --mode semver \
         --tag ${BUNDLE_REGISTRY}/gitlab-operator-catalog:${CATALOG_IMAGE_TAG}
      
      podman push ${BUNDLE_REGISTRY}/gitlab-operator-catalog:${CATALOG_IMAGE_TAG}
      
    4. 연산자 배포를 준비하기 위해 CatalogSourceOperatorGroup를 배포합니다:

      OSDK_BASE_DIR=".build/operatortest1" scripts/olm_bundle.sh deploy_catalogsource
      
      OSDK_BASE_DIR=".build/operatortest1" scripts/olm_bundle.sh deploy_operatorgroup 
      
    5. PackageManifest를 기다리십시오:

      kubectl get packagemanifests | grep -F gitlab | grep -vF "Community Operators"
      
    6. Subscription을 배포하십시오:

      # 이전 릴리스 배포
      OSDK_BASE_DIR=".build/operatortest1" OLM_PACKAGE_VERSION=${PREVIOUS_BUNDLE_VERSION} scripts/olm_bundle.sh deploy_subscription 
      
    7. InstallPlan 찾기:

      $ kubectl get installplans -A
      NAMESPACE       NAME            CSV                                 APPROVAL   APPROVED
      gitlab-system   install-jfqrb   gitlab-operator-kubernetes.v0.3.1   Manual     false
      
    8. InstallPlan 승인:

      kubectl -n gitlab-system patch installplan install-jfqrb -p '{"spec":{"approved":true}}' --type merge
      

      이 작업은 자동으로 현재 버전 (0.6.1)의 새로운 설치 계획을 생성해야 합니다:

      $ kubectl get installplans -A
      NAMESPACE       NAME            CSV                                 APPROVAL   APPROVED
      gitlab-system   install-4dvgh   gitlab-operator-kubernetes.v0.6.1   Manual     false
      gitlab-system   install-jfqrb   gitlab-operator-kubernetes.v0.3.1   Manual     true
      
    9. 업그레이드 승인:

      kubectl -n gitlab-system patch installplan install-4dvgh -p '{"spec":{"approved":true}}' --type merge
      
    10. KinD 클러스터 삭제:

      kind delete cluster --name=${KIND_CLUSTER_NAME}
      
  8. 오퍼레이터 번들 생성

    # 번들 조립
    scripts/olm_bundle.sh build_manifests generate_bundle patch_bundle
    # 번들 유효성 검사
    scripts/olm_bundle.sh validate_bundle
    
  9. 번들 파일을 올바른 위치로 복사하십시오:

    mkdir -p ${OPERATORHUB_DIR}/operators/${OPERATORHUB_NAME}/${OLM_PACKAGE_VERSION}
    cp -r ${OSDK_BASE_DIR}/bundle/* ${OPERATORHUB_DIR}/operators/${OPERATORHUB_NAME}/${OLM_PACKAGE_VERSION}
    
  10. 변경 사항을 추가하고 커밋하십시오(서명과 함께):

    cd ${OPERATORHUB_DIR}
    git add operators/${OPERATOR_HUB_NAME}/${OLM_PACKAGE_VERSION}
    git commit -s
    
  11. 본인의 포크에 브랜치를 푸시하고 상류에서의 pull request를 생성하십시오. GitLab 팀 멤버 및 OperatorHub 리뷰어의 승인을 기다렸다가 병합을 완료하셔야 합니다.