使用捆绑镜像 - 开发 Operators | Operators | Red Hat OpenShift Service on AWS

打包Operator
使用Operator Lifecycle Manager部署Operator
发布包含打包Operator的目录
测试Operator Lifecycle Manager上的Operator升级
控制Operator与AWS版本的Red Hat OpenShift Service的兼容性
附加资源

您可以使用Operator SDK打包、部署和升级bundle格式的Operator，以便在Operator Lifecycle Manager (OLM)上使用。

Red Hat支持的Operator SDK CLI工具版本（包括与Operator项目相关的脚手架和测试工具）已弃用，并计划在未来版本的Red Hat OpenShift Service on AWS中移除。Red Hat将在当前发布生命周期内为此功能提供错误修复和支持，但此功能将不再接收增强功能，并将从未来的Red Hat OpenShift Service on AWS版本中移除。

不建议使用Red Hat支持的Operator SDK版本创建新的Operator项目。拥有现有Operator项目的Operator作者可以使用随Red Hat OpenShift Service on AWS发布的Operator SDK CLI工具版本来维护其项目并创建针对更新版本的Red Hat OpenShift Service on AWS的Operator版本。

以下与Operator项目相关的基础镜像_未_被弃用。这些基础镜像的运行时功能和配置API仍然支持错误修复和解决CVE。

基于Ansible的Operator项目的基镜像
基于Helm的Operator项目的基镜像

有关不受支持的社区维护的Operator SDK版本的信息，请参阅Operator SDK (Operator Framework)。

编辑

打包Operator

Operator bundle格式是Operator SDK和Operator Lifecycle Manager (OLM)的默认打包方法。您可以使用Operator SDK将Operator项目构建并推送为bundle镜像，从而使其准备好用于OLM。

先决条件

安装在开发工作站上的Operator SDK CLI
已安装OpenShift CLI (oc) v+
使用Operator SDK初始化的Operator项目
如果您的Operator是基于Go的，则必须更新您的项目以使用支持在Red Hat OpenShift Service on AWS上运行的镜像

步骤

在您的Operator项目目录中运行以下make命令以构建和推送您的Operator镜像。修改以下步骤中的IMG参数以引用您有权访问的存储库。您可以从Quay.io等存储库站点获取用于存储容器的帐户。

构建镜像

$ make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>

SDK为Operator生成的Dockerfile明确引用了GOARCH=amd64用于go build。这可以修改为GOARCH=$TARGETARCH用于非AMD64架构。Docker将自动将环境变量设置为–platform指定的value。对于Buildah，需要使用–build-arg。更多信息，请参阅多架构。

将镜像推送到存储库

$ make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>

通过运行make bundle命令创建Operator bundle清单，该命令将调用多个命令，包括Operator SDK generate bundle和bundle validate子命令
```
$ make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>
```
Operator的bundle清单描述了如何显示、创建和管理应用程序。make bundle命令在您的Operator项目中创建以下文件和目录
- 名为bundle/manifests的bundle清单目录，其中包含ClusterServiceVersion对象
- 名为bundle/metadata的bundle元数据目录
- config/crd目录中的所有自定义资源定义(CRD)
- Dockerfile bundle.Dockerfile
然后，这些文件将使用operator-sdk bundle validate自动验证，以确保磁盘上的bundle表示正确。
通过运行以下命令构建和推送bundle镜像。OLM使用索引镜像使用Operator bundle，该索引镜像引用一个或多个bundle镜像。
1. 构建bundle镜像。使用注册表、用户命名空间和您打算推送镜像的镜像标签的详细信息设置BUNDLE_IMG
  $ make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>
2. 推送bundle镜像
  $ docker push <registry>/<user>/<bundle_image_name>:<tag>

编辑

使用Operator Lifecycle Manager部署Operator

Operator Lifecycle Manager (OLM)帮助您在Kubernetes集群上安装、更新和管理Operator及其关联服务的生命周期。OLM在Red Hat OpenShift Service on AWS上默认安装，并作为Kubernetes扩展运行，因此您可以使用Web控制台和OpenShift CLI (oc)执行所有Operator生命周期管理功能，无需任何其他工具。

Operator bundle格式是Operator SDK和OLM的默认打包方法。您可以使用Operator SDK快速在OLM上运行bundle镜像，以确保其正常运行。

先决条件

安装在开发工作站上的Operator SDK CLI
已构建并推送到注册表的Operator bundle镜像
安装在基于Kubernetes的集群上的OLM（如果您使用apiextensions.k8s.io/v1 CRD，例如Red Hat OpenShift Service on AWS，则版本为1.16.0或更高版本）
使用具有dedicated-admin权限的帐户使用oc登录到集群
如果您的Operator是基于Go的，则必须更新您的项目以使用支持在Red Hat OpenShift Service on AWS上运行的镜像

步骤

输入以下命令在集群上运行Operator

$ operator-sdk run bundle \(1)
    -n <namespace> \(2)
    <registry>/<user>/<bundle_image_name>:<tag> (3)

1	`run bundle`命令创建一个有效的基于文件的目录，并使用OLM在您的集群上安装Operator bundle。
2	可选：默认情况下，该命令会将Operator安装在您`~/.kube/config`文件中的当前活动项目中。您可以添加`-n`标志以设置安装的不同命名空间范围。
3	如果您没有指定镜像，则该命令使用`quay.io/operator-framework/opm:latest`作为默认索引镜像。如果您指定镜像，则该命令使用bundle镜像本身作为索引镜像。

从Red Hat OpenShift Service on AWS 4.11开始，run bundle命令默认支持Operator目录的基于文件的目录格式。Operator目录的已弃用的SQLite数据库格式继续受支持；但是，它将在未来的版本中删除。建议Operator作者将其工作流程迁移到基于文件的目录格式。

此命令执行以下操作

创建一个引用您的bundle镜像的索引镜像。索引镜像是不透明且短暂的，但准确地反映了如何在生产环境中将bundle添加到目录。
创建一个指向新的索引镜像的目录源，这使OperatorHub能够发现您的Operator。
通过创建OperatorGroup、Subscription、InstallPlan和所有其他必需的资源（包括RBAC）将您的Operator部署到您的集群。

附加资源

在 Operator Framework 打包格式中使用基于文件的目录
在管理自定义目录中使用基于文件的目录
Bundle 格式

编辑

发布包含捆绑 Operator 的目录

为了安装和管理 Operator，Operator Lifecycle Manager (OLM) 要求 Operator bundle 列在一个索引镜像中，该镜像由集群上的目录引用。作为 Operator 作者，您可以使用 Operator SDK 创建一个包含您的 Operator 及其所有依赖项 bundle 的索引。这对于在远程集群上进行测试和发布到容器注册表非常有用。

Operator SDK 使用opm CLI 来促进索引镜像的创建。不需要opm 命令的经验。对于高级用例，可以直接使用opm 命令而不是 Operator SDK。

先决条件

安装在开发工作站上的Operator SDK CLI
已构建并推送到注册表的Operator bundle镜像
安装在基于Kubernetes的集群上的OLM（如果您使用apiextensions.k8s.io/v1 CRD，例如Red Hat OpenShift Service on AWS，则版本为1.16.0或更高版本）
使用具有dedicated-admin权限的帐户使用oc登录到集群

步骤

在您的 Operator 项目目录中运行以下make 命令以构建包含您的 Operator bundle 的索引镜像
```
$ make catalog-build CATALOG_IMG=<registry>/<user>/<index_image_name>:<tag>
```
其中CATALOG_IMG 参数引用您有权访问的存储库。您可以在 Quay.io 等存储库站点获取存储容器的帐户。

将构建的索引镜像推送到存储库

$ make catalog-push CATALOG_IMG=<registry>/<user>/<index_image_name>:<tag>

如果您希望一次连续执行多个操作，则可以一起使用 Operator SDK make 命令。例如，如果您尚未为您的 Operator 项目构建 bundle 镜像，您可以使用以下语法构建和推送 bundle 镜像和索引镜像

$ make bundle-build bundle-push catalog-build catalog-push \
    BUNDLE_IMG=<bundle_image_pull_spec> \
    CATALOG_IMG=<index_image_pull_spec>

或者，您可以将Makefile中的IMAGE_TAG_BASE字段设置为现有存储库

IMAGE_TAG_BASE=quay.io/example/my-operator

然后，您可以使用以下语法构建和推送具有自动生成的名称的镜像，例如 bundle 镜像的quay.io/example/my-operator-bundle:v0.0.1 和索引镜像的quay.io/example/my-operator-catalog:v0.0.1

$ make bundle-build bundle-push catalog-build catalog-push

定义一个引用您刚刚生成的索引镜像的CatalogSource 对象，然后使用oc apply 命令或 Web 控制台创建该对象

CatalogSource YAML 示例

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: cs-memcached
  namespace: <operator_namespace>
spec:
  displayName: My Test
  publisher: Company
  sourceType: grpc
  grpcPodConfig:
    securityContextConfig: <security_mode> (1)
  image: quay.io/example/memcached-catalog:v0.0.1 (2)
  updateStrategy:
    registryPoll:
      interval: 10m

1	指定`legacy` 或`restricted` 的值。如果未设置该字段，则默认值为`legacy`。计划在未来的 Red Hat OpenShift Service on AWS 版本中，默认值为`restricted`。如果您的目录无法使用`restricted` 权限运行，建议您手动将此字段设置为`legacy`。
2	将`image` 设置为之前使用`CATALOG_IMG` 参数的镜像拉取规范。

检查目录源

$ oc get catalogsource

示例输出

NAME           DISPLAY     TYPE   PUBLISHER   AGE
cs-memcached   My Test     grpc   Company     4h31m

验证

使用您的目录安装 Operator

定义一个OperatorGroup 对象，并使用oc apply 命令或 Web 控制台创建它

OperatorGroup YAML 示例

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: my-test
  namespace: <operator_namespace>
spec:
  targetNamespaces:
  - <operator_namespace>

定义一个Subscription 对象，并使用oc apply 命令或 Web 控制台创建它

Subscription YAML 示例

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: catalogtest
  namespace: <catalog_namespace>
spec:
  channel: "alpha"
  installPlanApproval: Manual
  name: catalog
  source: cs-memcached
  sourceNamespace: <operator_namespace>
  startingCSV: memcached-operator.v0.0.1

验证已安装的 Operator 是否正在运行

检查 Operator 组

$ oc get og

示例输出

NAME             AGE
my-test           4h40m

检查集群服务版本 (CSV)

$ oc get csv

示例输出

NAME                        DISPLAY   VERSION   REPLACES   PHASE
memcached-operator.v0.0.1   Test      0.0.1                Succeeded

检查 Operator 的 Pod

$ oc get pods

示例输出

NAME                                                              READY   STATUS      RESTARTS   AGE
9098d908802769fbde8bd45255e69710a9f8420a8f3d814abe88b68f8ervdj6   0/1     Completed   0          4h33m
catalog-controller-manager-7fd5b7b987-69s4n                       2/2     Running     0          4h32m
cs-memcached-7622r                                                1/1     Running     0          4h33m

附加资源

有关更高级用例中opm CLI 的直接用法的详细信息，请参见管理自定义目录。

编辑

在 Operator Lifecycle Manager 上测试 Operator 升级

您可以通过使用 Operator SDK 中的 Operator Lifecycle Manager (OLM) 集成快速测试升级您的 Operator，而无需手动管理索引镜像和目录源。

run bundle-upgrade 子命令通过为更高版本指定 bundle 镜像来自动触发已安装的 Operator 升级到更高版本。

先决条件

使用run bundle 子命令或使用传统 OLM 安装方法安装的 OLM Operator
代表已安装 Operator 的更高版本的 bundle 镜像

步骤

如果您的 Operator 尚未使用 OLM 安装，请使用run bundle 子命令或使用传统 OLM 安装方法安装早期版本。

如果使用 OLM 以传统方式安装了早期版本的 bundle，则您打算升级到的较新 bundle 不得存在于目录源引用的索引镜像中。否则，运行run bundle-upgrade 子命令将导致注册表 Pod 失败，因为较新的 bundle 已由提供包和集群服务版本 (CSV) 的索引引用。

例如，您可以通过指定早期 bundle 镜像为 Memcached Operator 使用以下run bundle 子命令

$ operator-sdk run bundle <registry>/<user>/memcached-operator:v0.0.1

示例输出

INFO[0006] Creating a File-Based Catalog of the bundle "quay.io/demo/memcached-operator:v0.0.1"
INFO[0008] Generated a valid File-Based Catalog
INFO[0012] Created registry pod: quay-io-demo-memcached-operator-v1-0-1
INFO[0012] Created CatalogSource: memcached-operator-catalog
INFO[0012] OperatorGroup "operator-sdk-og" created
INFO[0012] Created Subscription: memcached-operator-v0-0-1-sub
INFO[0015] Approved InstallPlan install-h9666 for the Subscription: memcached-operator-v0-0-1-sub
INFO[0015] Waiting for ClusterServiceVersion "my-project/memcached-operator.v0.0.1" to reach 'Succeeded' phase
INFO[0015] Waiting for ClusterServiceVersion ""my-project/memcached-operator.v0.0.1" to appear
INFO[0026] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Pending
INFO[0028] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Installing
INFO[0059] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Succeeded
INFO[0059] OLM has successfully installed "memcached-operator.v0.0.1"

通过指定更高 Operator 版本的 bundle 镜像来升级已安装的 Operator

$ operator-sdk run bundle-upgrade <registry>/<user>/memcached-operator:v0.0.2

示例输出

INFO[0002] Found existing subscription with name memcached-operator-v0-0-1-sub and namespace my-project
INFO[0002] Found existing catalog source with name memcached-operator-catalog and namespace my-project
INFO[0008] Generated a valid Upgraded File-Based Catalog
INFO[0009] Created registry pod: quay-io-demo-memcached-operator-v0-0-2
INFO[0009] Updated catalog source memcached-operator-catalog with address and annotations
INFO[0010] Deleted previous registry pod with name "quay-io-demo-memcached-operator-v0-0-1"
INFO[0041] Approved InstallPlan install-gvcjh for the Subscription: memcached-operator-v0-0-1-sub
INFO[0042] Waiting for ClusterServiceVersion "my-project/memcached-operator.v0.0.2" to reach 'Succeeded' phase
INFO[0019] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.2" phase: Pending
INFO[0042] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.2" phase: InstallReady
INFO[0043] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.2" phase: Installing
INFO[0044] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.2" phase: Succeeded
INFO[0044] Successfully upgraded to "memcached-operator.v0.0.2"

清理已安装的 Operators

$ operator-sdk cleanup memcached-operator

附加资源

使用 OLM 的传统 Operator 安装

编辑

控制 Operator 与 Red Hat OpenShift Service on AWS 版本的兼容性

Kubernetes 定期弃用某些将在后续版本中删除的 API。如果您的 Operator 正在使用已弃用的 API，则在将 Red Hat OpenShift Service on AWS 集群升级到已删除该 API 的 Kubernetes 版本后，它可能无法再工作。

作为 Operator 作者，强烈建议您查看 Kubernetes 文档中的已弃用 API 迁移指南并使您的 Operator 项目保持最新，以避免使用已弃用和已删除的 API。理想情况下，您应该在发布未来版本的 Red Hat OpenShift Service on AWS 之前更新您的 Operator，这将使 Operator 不兼容。

当从 Red Hat OpenShift Service on AWS 版本中删除 API 时，仍在该集群版本上运行并仍在使用已删除 API 的 Operator 将无法正常工作。作为 Operator 作者，您应该计划更新您的 Operator 项目以适应 API 的弃用和删除，以避免用户使用您的 Operator 时出现中断。

您可以检查 Operator 的事件警报，以查找是否存在关于当前正在使用的 API 的任何警告。当检测到当前正在使用但在下一个版本中将被删除的 API 时，会触发以下警报

APIRemovedInNextReleaseInUse: 将在下一个 Red Hat OpenShift Service on AWS 版本中删除的 API。
APIRemovedInNextEUSReleaseInUse: 将在下一个 Red Hat OpenShift Service on AWS 扩展更新支持 (EUS) 版本中删除的 API。

如果集群管理员已安装您的 Operator，则在他们升级到下一个版本的 Red Hat OpenShift Service on AWS 之前，他们必须确保安装了与下一个集群版本兼容的 Operator 版本。虽然建议您更新您的 Operator 项目以不再使用已弃用或已删除的 API，但如果您仍然需要发布包含已删除 API 的 Operator bundle 以继续在早期版本的 Red Hat OpenShift Service on AWS 上使用，请确保相应地配置该 bundle。

以下过程有助于防止管理员在不兼容版本的 Red Hat OpenShift Service on AWS 上安装您的 Operator 版本。这些步骤还可防止管理员升级到与当前在其集群上安装的 Operator 版本不兼容的较新版本的 Red Hat OpenShift Service on AWS。

当您知道当前版本的 Operator 出于任何原因在特定 Red Hat OpenShift Service on AWS 版本上无法正常工作时，此过程也很有用。通过定义应分发 Operator 的集群版本，您可以确保 Operator 不会出现在超出允许范围的集群版本的目录中。

使用已弃用 API 的 Operator 在集群管理员升级到不再支持该 API 的未来版本的 Red Hat OpenShift Service on AWS 时，可能会对关键工作负载产生不利影响。如果您的 Operator 正在使用已弃用的 API，则应尽快在您的 Operator 项目中配置以下设置。

先决条件

现有的 Operator 项目

步骤

如果您知道您的 Operator 的特定 bundle 在特定集群版本之后的 Red Hat OpenShift Service on AWS 上不受支持且无法正常工作，请配置您的 Operator 兼容的 Red Hat OpenShift Service on AWS 的最大版本。在您的 Operator 项目的集群服务版本 (CSV) 中，设置olm.maxOpenShiftVersion 注解以防止管理员在将已安装的 Operator 升级到兼容版本之前升级其集群。

只有当您的 Operator bundle 版本无法在更高版本中工作时，才必须使用olm.maxOpenShiftVersion 注解。请注意，在安装您的解决方案的情况下，集群管理员无法升级其集群。如果您未提供更高版本和有效的升级路径，管理员可能会卸载您的 Operator 并升级集群版本。

包含olm.maxOpenShiftVersion 注解的 CSV 示例

apiVersion: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
  annotations:
    "olm.properties": '[{"type": "olm.maxOpenShiftVersion", "value": "<cluster_version>"}]' (1)

1	指定您的 Operator 兼容的 Red Hat OpenShift Service on AWS 的最大集群版本。例如，将`value`设置为`4.9` 可防止在将此 bundle 安装到集群后，将集群升级到高于 4.9 版本的 Red Hat OpenShift Service on AWS。

如果您的 bundle 旨在在 Red Hat 提供的 Operator 目录中分发，请通过设置以下属性来配置您的 Operator 兼容的 Red Hat OpenShift Service on AWS 版本。此配置可确保您的 Operator 仅包含在针对兼容版本的 Red Hat OpenShift Service on AWS 的目录中。

此步骤仅在 Red Hat 提供的目录中发布 Operator 时有效。如果您的 bundle 仅用于在自定义目录中分发，则可以跳过此步骤。有关更多详细信息，请参阅“Red Hat 提供的 Operator 目录”。

在您项目的bundle/metadata/annotations.yaml文件中设置com.redhat.openshift.versions 注解。
包含兼容版本的bundle/metadata/annotations.yaml文件示例
```
com.redhat.openshift.versions: "v4.7-v4.9" (1)
```
1 设置为范围或单个版本。
为防止您的 bundle 被迁移到与 Red Hat OpenShift Service on AWS 不兼容的版本，请确保使用正确的com.redhat.openshift.versions标签生成索引镜像，在您的 Operator 的 bundle 镜像中。例如，如果您的项目是使用 Operator SDK 生成的，请更新bundle.Dockerfile文件。
包含兼容版本的bundle.Dockerfile示例
```
LABEL com.redhat.openshift.versions="<versions>" (1)
```
1 设置为范围或单个版本，例如v4.7-v4.9。此设置定义了应分发 Operator 的集群版本，并且 Operator 不会出现在范围之外的集群版本的目录中。

您现在可以打包 Operator 的新版本并将更新的版本发布到目录以进行分发。

附加资源

编辑

其他资源

有关 bundle 格式的详细信息，请参阅Operator Framework 打包格式。
有关使用opm命令将 bundle 镜像添加到索引镜像的详细信息，请参阅管理自定义目录。
有关已安装 Operator 的升级工作方式的详细信息，请参阅Operator 生命周期管理器工作流程。