OperatorHub.io로 발행하는 방법

OperatorHub.io는 Kubernetes 커뮤니티가 Operator를 공유하는 공간입니다.

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

OperatorHub에 GitLab Operator를 발행하려면:

community-operators repository를 포크하세요.

포크한 community-operators repository를 복제하세요:

포크가 최근에 생성된 경우:

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

셸을 설정하세요:

# 발행된 Operator 이미지 태그
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"

https://gitlab.com/gitlab-org/cloud-native/gitlab-operator의 새 브랜치를 생성하세요:
```
cd ${OPERATORHUB_DIR}
git checkout -B gitlab-release-${OPERATOR_TAG}
```
config/manifests/bases/gitlab-operator-kubernetes.clusterserviceversion.yaml을 편집하여 metadata.annotations.alm-examples에 유효한 차트 버전을 참조하도록 수정하세요.

로컬 KinD 클러스터에서 Operator 번들을 테스트하세요:

BUNDLE_REGISTRY가 유효한 공개 레지스트리를 가리켜야 합니다 (그 목적으로 별도의 프로젝트/레지스트리를 만드세요):
```
export BUNDLE_REGISTRY=registry.gitlab.com/dmakovey/gitlab-operator-bundle
```
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.25.9" scripts/olm_bundle.sh step1 step2

packagemanifest가 gitlab-operator-kubernetes에 대해 사용 가능해질 때까지 기다리세요 (Community Operators를 건너뛰는 것에 유의하세요):
```
$ kubectl get packagemanifests | grep -F gitlab | grep -vF "Community Operators"
gitlab-operator-kubernetes                                       48m
```
Operator를 배포하세요 (수동으로 승인할 필요 없이 설치하기 위해 AUTO_UPGRADE="true"를 설정합니다):
```
OSDK_BASE_DIR=".build/operatortest1" AUTO_UPGRADE="true" scripts/olm_bundle.sh step3
```

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

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

KinD 클러스터를 삭제하세요:

kind delete cluster --name=${KIND_CLUSTER_NAME}

OLM 번들 업그레이드를 테스트하세요.

테스트에 사용된 변수를 재사용하세요 (위의 내용 참조):

export BUNDLE_REGISTRY=registry.gitlab.com/dmakovey/gitlab-operator-bundle
export BUNDLE_IMAGE_TAG="beta1"
export KIND_CLUSTER_NAME="optest1u"
export KIND_CONFIG="${HOME}/work/gitlab/examples/kind/kind-ssl.yaml" 
export KIND_IMAGE="kindest/node:v1.25.9"

새로운 KinD 클러스터를 생성해야 합니다:

scripts/olm_bundle.sh initialize_kind install_olm create_namespace

이 시점에서 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}

오퍼레이터 배포를 위해 CatalogSource 및 OperatorGroup을 생성하세요:

OSDK_BASE_DIR=".build/operatortest1" scripts/olm_bundle.sh deploy_catalogsource

OSDK_BASE_DIR=".build/operatortest1" scripts/olm_bundle.sh deploy_operatorgroup 

PackageManifest를 기다리세요:

kubectl get packagemanifests | grep -F gitlab | grep -vF "Community Operators"

Subscription을 배포하세요:

# 이전 릴리스를 배포하세요
OSDK_BASE_DIR=".build/operatortest1" OLM_PACKAGE_VERSION=${PREVIOUS_BUNDLE_VERSION} scripts/olm_bundle.sh deploy_subscription 

InstallPlan을 찾으세요:

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

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

업그레이드를 승인하세요:

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

KinD 클러스터를 삭제하세요:

kind delete cluster --name=${KIND_CLUSTER_NAME}

Operator 번들을 생성하세요

# 번들을 조립하세요
scripts/olm_bundle.sh build_manifests generate_bundle patch_bundle
# 번들을 유효성 검사하세요
scripts/olm_bundle.sh validate_bundle

번들 파일을 올바른 위치로 복사하세요:

mkdir -p ${OPERATORHUB_DIR}/operators/${OPERATORHUB_NAME}/${OLM_PACKAGE_VERSION}
cp -r ${OSDK_BASE_DIR}/bundle/* ${OPERATORHUB_DIR}/operators/${OPERATORHUB_NAME}/${OLM_PACKAGE_VERSION}

변경 사항을 추가하고 커밋하세요 (서명과 함께):

cd ${OPERATORHUB_DIR}
git add operators/${OPERATOR_HUB_NAME}/${OLM_PACKAGE_VERSION}
git commit -s

브랜치를 포크에 푸시하고 상류에서 풀 리퀘스트를 생성하세요. GitLab 팀 멤버 및/또는 OperatorHub 리뷰어의 승인을 기다리신 후 병합이 완료될 때까지 기다리세요.

OperatorHub.io로 발행하는 방법

도움말

기능 사용 가능성과 제품 평가판

도움받기