4.4. Generating a cluster service version (CSV)

• operator.yaml
• *_{crd,cr}.yaml
• RBAC role files, for example role.yaml

• Creates a new CSV, with the same location and naming convention as exists currently, using available data in YAML manifests and source files.

  1. The update mechanism checks for an existing CSV in deploy/. When one is not found, it creates a ClusterServiceVersion object, referred to here as a cache, and populates fields easily derived from Operator metadata, such as Kubernetes API ObjectMeta.
  2. The update mechanism searches deploy/ for manifests that contain data a CSV uses, such as a Deployment resource, and sets the appropriate CSV fields in the cache with this data.
  3. After the search completes, every cache field populated is written back to a CSV YAML file.

• Updates an existing CSV at the currently pre-defined location, using available data in YAML manifests and source files.

  1. The update mechanism checks for an existing CSV in deploy/. When one is found, the CSV YAML file contents are marshaled into a CSV cache.
  2. The update mechanism searches deploy/ for manifests that contain data a CSV uses, such as a Deployment resource, and sets the appropriate CSV fields in the cache with this data.
  3. After the search completes, every cache field populated is written back to a CSV YAML file.

Additional resources

• Operator maturity model

Prerequisites

• An Operator project generated using the Operator SDK

• List any related images, or other container images that your Operator might require to perform their functions.
• Reference all specified images by a digest (SHA) and not by a tag.

• in spec.relatedImages:

  ...
  spec:
    relatedImages: 1
      - name: etcd-operator 2
        image: quay.io/etcd-operator/operator@sha256:d134a9865524c29fcf75bbc4469013bc38d8a15cb5f41acfddb6b9e492f556e4 3
      - name: etcd-image
        image: quay.io/etcd-operator/etcd@sha256:13348c15263bd8838ec1d5fc4550ede9860fcbb0f843e48cbccec07810eebb68
  ...

  1

  Create a relatedImages section and set the list of related images.

  2

  Specify a unique identifier for the image.

  3

  Specify each image by a digest (SHA), not by an image tag.

• in the env section of the Operators Deployments when declaring environment variables that inject the image that the Operator should use:

  spec:
    install:
      spec:
        deployments:
        - name: etcd-operator-v3.1.1
          spec:
            replicas: 1
            selector:
              matchLabels:
                name: etcd-operator
            strategy:
              type: Recreate
            template:
              metadata:
                labels:
                  name: etcd-operator
              spec:
                containers:
                - args:
                  - /opt/etcd/bin/etcd_operator_run.sh
                  env:
                  - name: WATCH_NAMESPACE
                    valueFrom:
                      fieldRef:
                        fieldPath: metadata.annotations['olm.targetNamespaces']
                  - name: ETCD_OPERATOR_DEFAULT_ETCD_IMAGE 1
                    value: quay.io/etcd-operator/etcd@sha256:13348c15263bd8838ec1d5fc4550ede9860fcbb0f843e48cbccec07810eebb68 2
                  - name: ETCD_LOG_LEVEL
                    value: INFO
                  image: quay.io/etcd-operator/operator@sha256:d134a9865524c29fcf75bbc4469013bc38d8a15cb5f41acfddb6b9e492f556e4 3
                  imagePullPolicy: IfNotPresent
                  livenessProbe:
                    httpGet:
                      path: /healthy
                      port: 8080
                    initialDelaySeconds: 10
                    periodSeconds: 30
                  name: etcd-operator
                  readinessProbe:
                    httpGet:
                      path: /ready
                      port: 8080
                    initialDelaySeconds: 10
                    periodSeconds: 30
                  resources: {}
                serviceAccountName: etcd-operator
      strategy: deployment

  1

  Inject the images referenced by the Operator by using environment variables.

  2

  Specify each image by a digest (SHA), not by an image tag.

  3

  Also reference the Operator container image by a digest (SHA), not by an image tag.

  注意

  When configuring probes, the timeoutSeconds value must be lower than the periodSeconds value. The timeoutSeconds default value is 1. The periodSeconds default value is 10.

• Look for the Disconnected annotation, which indicates that the Operator works in a disconnected environment:

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

  Operators can be filtered in OperatorHub by this infrastructure feature.

Prerequisites

• An Operator project with a CSV.
• To support listing multiple architectures and operating systems, your Operator image referenced in the CSV must be a manifest list image.
• For the Operator to work properly in restricted network, or disconnected, environments, the image referenced must also be specified using a digest (SHA) and not by a tag.

Procedure

• Add a label in the metadata.labels of your CSV for each supported architecture and operating system that your Operator supports:

  labels:
    operatorframework.io/arch.s390x: supported
    operatorframework.io/os.zos: supported
    operatorframework.io/os.linux: supported 1
    operatorframework.io/arch.amd64: supported 2

  1 2

  After you add a new architecture or operating system, you must also now include the default os.linux and arch.amd64 variants explicitly.

Additional resources

• See the Image Manifest V 2, Schema 2 specification for more information on manifest lists.

Procedure

• In your CSV, set the operatorframework.io/suggested-namespace annotation to your suggested namespace:

  metadata:
    annotations:
      operatorframework.io/suggested-namespace: <namespace> 1

  1

  Set your suggested namespace.