2.2. Operator Framework パッケージ形式

バンドルマニフェストは、Operator のデプロイメントおよびロールベースのアクセス制御(RBAC)モデルを定義する Operator バンドルの Kubernetes オブジェクトです。バンドルには 1 つのクラスターサービスバージョン(CSV)が含まれ、通常はその CSV が /manifests ディレクトリーにある API のカスタムリソース定義(CRD)が含まれます。

etcd
├── manifests
│   ├── etcdcluster.crd.yaml
│   └── etcdoperator.clusterserviceversion.yaml
│   └── secret.yaml
│   └── configmap.yaml
└── metadata
    └── annotations.yaml
    └── dependencies.yaml

metadata/annotations.yaml ファイルの Operator バンドルアノテーションは、バンドルのインデックス化方法を記述する集約メタデータを定義します。これらのアノテーションは、カタログ登録用のメディアタイプ、マニフェストパス、パッケージ名、チャネル、およびデフォルトチャネルを指定します。

バンドルには、その metadata ディレクトリーに annotations.yaml ファイルが含まれます。

annotations:
  operators.operatorframework.io.bundle.mediatype.v1: "registry+v1"
  operators.operatorframework.io.bundle.manifests.v1: "manifests/"
  operators.operatorframework.io.bundle.metadata.v1: "metadata/"
  operators.operatorframework.io.bundle.package.v1: "test-operator"
  operators.operatorframework.io.bundle.channels.v1: "beta,stable"
  operators.operatorframework.io.bundle.channel.default.v1: "stable"

ここでは、以下のようになります。

Operator 依存関係は、Operator Lifecycle Manager (OLM)が OpenShift Container Platform でのインストール時に解決する必要のある Operator 間の関係を定義します。これらの依存関係は、バンドルの metadata/ フォルダー内のオプションの dependencies.yaml ファイルに一覧表示できます。

依存関係の一覧には、依存関係の内容を指定するために各項目の type フィールドが含まれます。次のタイプの Operator 依存関係がサポートされています。

以下の例では、依存関係は Prometheus Operator および etcd CRD に指定されます。

dependencies:
  - type: olm.package
    value:
      packageName: prometheus
      version: ">0.27.0"
  - type: olm.gvk
    value:
      group: etcd.database.coreos.com
      kind: EtcdCluster
      version: v1beta2

opm CLI は、OpenShift Container Platform でバンドルイメージから Operator カタログを作成し、維持するための Operator Framework ツールです。これを使用して、カタログソースを使用して Operator Lifecycle Manager (OLM)が参照するカタログコンテナーイメージをビルドできます。

カタログには、コンテナーイメージの実行時に提供される組み込まれた API を使用してクエリーできる、Operator マニフェストコンテンツへのポインターのデータベースが含まれます。OpenShift Container Platform では、Operator Lifecycle Manager (OLM) は、CatalogSource オブジェクトが定義したカタログソース内のイメージ参照できます。これにより、クラスター上にインストールされた Operator への頻度の高い更新を可能にするためにイメージを一定の間隔でポーリングできます。