5.7. クラスターサービスバージョン (CSV) の定義

1. generate kustomize manifests
2. generate bundle
3. bundle validate

手順

1. config/manager/manager.yamlファイルで、Operator が使用する追加のイメージ参照の環境変数を設定します。

   例5.10 config/manager/manager.yaml ファイル例

   ...
   spec:
     ...
       spec:
         ...
         containers:
         - command:
           - /manager
           ...
           env:
           - name: <related_image_environment_variable> 1
             value: "<related_image_reference_with_tag>" 2

   1

   RELATED_IMAGE_MEMCACHEDなどの環境変数を定義します。

   2

   docker.io/memcached:1.4.36-alpineなどの関連するイメージ参照とタグを設定します。

2. ハードコードされたイメージ参照は、Operator プロジェクトタイプに関連するファイルの環境変数に置き換えます。

   • Go ベースの Operator プロジェクトの場合には、次の例に示すように、環境変数を controllers/memcached_controller.go ファイルに追加します。

     例5.11 controllers/memcached_controller.go ファイルの例

       // deploymentForMemcached returns a memcached Deployment object
     
     ...
     
     	Spec: corev1.PodSpec{
             	Containers: []corev1.Container{{
     -			Image:   "memcached:1.4.36-alpine", 1
     +			Image:   os.Getenv("<related_image_environment_variable>"), 2
     			Name:    "memcached",
     			Command: []string{"memcached", "-m=64", "-o", "modern", "-v"},
     			Ports: []corev1.ContainerPort{{
     
     ...

     1

     イメージ参照とタグを削除します。

     2

     os.Getenv関数を使用して、<related_image_environment_variable>を呼び出します。

     注記

     変数が設定されていない場合、os.Getenv関数は空の文字列を返します。ファイルを変更する前に、<related_image_environment_variable>を設定してください。

   • Ansible ベースの Operator プロジェクトの場合には、次の例に示すように、環境変数をroles/memcached/tasks/main.ymlファイルに追加します。

     例5.12 roles/memcached/tasks/main.ymlファイルの例

     spec:
       containers:
       - name: memcached
         command:
         - memcached
         - -m=64
         - -o
         - modern
         - -v
     -   image: "docker.io/memcached:1.4.36-alpine" 1
     +   image: "{{ lookup('env', '<related_image_environment_variable>') }}" 2
         ports:
           - containerPort: 11211
     
     ...

     1

     イメージ参照とタグを削除します。

     2

     lookup 関数を使用して、<related_image_environment_variable>を呼び出します。

   • Helm ベースの Operator プロジェクトの場合、以下の例のように overrideValues フィールドを watches.yaml ファイルに追加します。

     例5.13 watches.yaml ファイルの例

     ...
     - group: demo.example.com
       version: v1alpha1
       kind: Memcached
       chart: helm-charts/memcached
       overrideValues: 1
         relatedImage: ${<related_image_environment_variable>} 2

     1

     overrideValues フィールドを追加します。

     2

     <related_image_environment_variable> を使用して overrideValues フィールドを定義します (例: RELATED_IMAGE_MEMCACHED)。

     1. 以下の例のように、overrideValues フィールドの値を helm-charts/memchached/values.yaml ファイルに追加します。

        helm-charts/memchached/values.yaml ファイルの例

        ...
        relatedImage: ""

     2. 以下の例のように、helm-charts/memcached/templates/deployment.yaml ファイルのチャートテンプレートを編集します。

        例5.14 helm-charts/memcached/templates/deployment.yaml ファイルの例

        containers:
          - name: {{ .Chart.Name }}
            securityContext:
              - toYaml {{ .Values.securityContext | nindent 12 }}
            image: "{{ .Values.image.pullPolicy }}
            env: 1
              - name: related_image 2
                value: "{{ .Values.relatedImage }}" 3

        1

        env フィールドを追加します。

        2

        環境変数に名前を付けます。

        3

        環境変数の値を定義します。

3. 次の変更を加えて、BUNDLE_GEN_FLAGS変数定義をMakefileに追加します。

   Makefile の例

      BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
   
      # USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
      # You can enable this value if you would like to use SHA Based Digests
      # To enable set flag to true
      USE_IMAGE_DIGESTS ?= false
      ifeq ($(USE_IMAGE_DIGESTS), true)
            BUNDLE_GEN_FLAGS += --use-image-digests
      endif
   
   ...
   
   -  $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS) 1
   +  $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS) 2
   
   ...

   1

   Makefileでこの行を削除します。

   2

   上記の行は、この行に置き換えます。

4. タグではなくダイジェスト (SHA) を使用するように Operator イメージを更新するには、make bundleコマンドを実行し、USE_IMAGE_DIGESTSをtrueに設定します。

   $ make bundle USE_IMAGE_DIGESTS=true

5. disconnected アノテーションを追加します。これは、Operator が非接続環境で機能することを示します。

   metadata:
     annotations:
       operators.openshift.io/infrastructure-features: '["disconnected"]'

   Operator は、このインフラストラクチャー機能によって OperatorHub でフィルターされます。

1. Operator プロジェクトの go.mod ファイルで、operator-framework/operator-lib を必要なライブラリーとして追加します。

   module github.com/example-inc/memcached-operator
   
   go 1.15
   
   require (
     k8s.io/apimachinery v0.19.2
     k8s.io/client-go v0.19.2
     sigs.k8s.io/controller-runtime v0.7.0
     operator-framework/operator-lib v0.3.0
   )

2. Operator ロジックに独自のコンストラクターを作成すると、次の結果が得られます。

   • controller-runtime クライアントを許可します。
   • conditionType を受け入れます。
   • 条件を更新または追加する Condition インターフェイスを返します。

   現時点で OLM は Upgradeable 状態をサポートするため、Upgradeable 条件にアクセスするためのメソッドを持つインターフェイスを作成できます。以下に例を示します。

   import (
     ...
     apiv1 "github.com/operator-framework/api/pkg/operators/v1"
   )
   
   func NewUpgradeable(cl client.Client) (Condition, error) {
     return NewCondition(cl, "apiv1.OperatorUpgradeable")
   }
   
   cond, err := NewUpgradeable(cl);

   この例では、NewUpgradeable コンストラクターが、タイプ Condition の変数 cond を使用するためにさらに使用されます。cond 変数には、OLM の Upgradeable 条件を処理するために使用できる Get および Set メソッドが含まれます。