5.5. Helm ベースの Operator
5.5.1. Helm ベースの Operator の Operator SDK の使用を開始する リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトを生成するための Operator SDK には、Go コードを作成せずに Kubernetes リソースを統一されたアプリケーションとしてデプロイするために、既存の Helm チャートを使用するオプションがあります。
Operator SDK によって提供されるツールおよびライブラリーを使用して Helm ベースの Operator をセットアップし、実行するための基本を示すには、Operator 開発者は Helm ベースの Nginx Operator のサンプルをビルドし、これをクラスターへデプロイすることができます。
5.5.1.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- Operator SDK CLI がインストールされていること。
-
OpenShift CLI (
oc) v4.12 以降がインストールされている -
cluster-adminパーミッションを持つアカウントを使用して、ocで OpenShift Container Platform 4.12 クラスターにログインしている - クラスターがイメージをプルできるようにするには、イメージをプッシュするリポジトリーを public として設定するか、イメージプルシークレットを設定する必要があります。
5.5.1.2. Helm ベースの Operator の作成とデプロイ リンクのコピーリンクがクリップボードにコピーされました!
Operator SDK を使用して Nginx の単純な Helm ベースの Operator をビルドし、デプロイできます。
手順
プロジェクトを作成します。
プロジェクトディレクトリーを作成します。
mkdir nginx-operator
$ mkdir nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow プロジェクトディレクトリーに移動します。
cd nginx-operator
$ cd nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow helmプラグインを指定してoperator-sdk initコマンドを実行し、プロジェクトを初期化します。operator-sdk init \ --plugins=helm$ operator-sdk init \ --plugins=helmCopy to Clipboard Copied! Toggle word wrap Toggle overflow
API を作成します。
単純な Nginx API を作成します。
operator-sdk create api \ --group demo \ --version v1 \ --kind Nginx$ operator-sdk create api \ --group demo \ --version v1 \ --kind NginxCopy to Clipboard Copied! Toggle word wrap Toggle overflow この API は、
helm createコマンドでビルトインの Helm チャートボイラープレートを使用します。Operator イメージをビルドし、プッシュします。
デフォルトの
Makefileターゲットを使用して Operator をビルドし、プッシュします。プッシュ先となるレジストリーを使用するイメージのプル仕様を使用してIMGを設定します。make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Operator を実行します。
CRD をインストールします。
make install
$ make installCopy to Clipboard Copied! Toggle word wrap Toggle overflow プロジェクトをクラスターにデプロイします。
IMGをプッシュしたイメージに設定します。make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
SCC (Security Context Constraints) を追加します。
Nginx サービスアカウントには、OpenShift Container Platform で実行する特権アクセスが必要です。以下の SCC を
nginx-samplePod のサービスアカウントに追加します。oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sample$ oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sampleCopy to Clipboard Copied! Toggle word wrap Toggle overflow サンプルカスタムリソース (CR) を作成します。
サンプル CR を作成します。
oc apply -f config/samples/demo_v1_nginx.yaml \ -n nginx-operator-system$ oc apply -f config/samples/demo_v1_nginx.yaml \ -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow Operator を調整する CR を確認します。
oc logs deployment.apps/nginx-operator-controller-manager \ -c manager \ -n nginx-operator-system$ oc logs deployment.apps/nginx-operator-controller-manager \ -c manager \ -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow
CR を削除する
次のコマンドを実行して CR を削除します。
oc delete -f config/samples/demo_v1_nginx.yaml -n nginx-operator-system
$ oc delete -f config/samples/demo_v1_nginx.yaml -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow クリーンアップします。
以下のコマンドを実行して、この手順の一部として作成されたリソースをクリーンアップします。
make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.1.3. 次のステップ リンクのコピーリンクがクリップボードにコピーされました!
- Helm ベースの Operator のビルドに関する詳細な手順は、Helm ベースの Operator の Operator SDK チュートリアル を参照してください。
5.5.2. Helm ベースの Operator の Operator SDK チュートリアル リンクのコピーリンクがクリップボードにコピーされました!
Operator 開発者は、Operator SDK での Helm のサポートを利用して、Helm ベースの Nginx Operator のサンプルをビルドし、そのライフサイクルを管理することができます。このチュートリアルでは、以下のプロセスを説明します。
- Nginx デプロイメントの作成
-
デプロイメントのサイズが、
Nginxカスタムリソース (CR) 仕様で指定されたものと同じであることを確認します。 -
ステータスライターを使用して、
NginxCR ステータスをnginxPod の名前で更新します。
このプロセスは、Operator Framework の 2 つの重要な設定要素を使用して実行されます。
- Operator SDK
-
operator-sdkCLI ツールおよびcontroller-runtimeライブラリー API - Operator Lifecycle Manager (OLM)
- クラスター上の Operator のインストール、アップグレード、ロールベースのアクセス制御 (RBAC)
このチュートリアルでは、Helm ベースの Operator の Operator SDK の使用を開始する よりも詳細に説明します。
5.5.2.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- Operator SDK CLI がインストールされていること。
-
OpenShift CLI (
oc) v4.12 以降がインストールされている -
cluster-adminパーミッションを持つアカウントを使用して、ocで OpenShift Container Platform 4.12 クラスターにログインしている - クラスターがイメージをプルできるようにするには、イメージをプッシュするリポジトリーを public として設定するか、イメージプルシークレットを設定する必要があります。
5.5.2.2. プロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator SDK CLI を使用して nginx-operator というプロジェクトを作成します。
手順
プロジェクトのディレクトリーを作成します。
mkdir -p $HOME/projects/nginx-operator
$ mkdir -p $HOME/projects/nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーに切り替えます。
cd $HOME/projects/nginx-operator
$ cd $HOME/projects/nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow helmプラグインを指定してoperator-sdk initコマンドを実行し、プロジェクトを初期化します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記デフォルトで、
helmプラグインは、ボイラープレート Helm チャートを使用してプロジェクトを初期化します。--helm-chartフラグなどの追加のフラグを使用すると、既存の Helm チャートを使用してプロジェクトを初期化できます。initコマンドは、API バージョンexample.com/v1および KindNginxでのリソースの監視に特化したnginx-operatorプロジェクトを作成します。-
Helm ベースのプロジェクトの場合、
initコマンドは、チャートのデフォルトマニフェストによってデプロイされるリソースに基づいてconfig/rbac/role.yamlファイルに RBAC ルールを生成します。このファイルで生成されるルールが Operator のパーミッション要件を満たしていることを確認します。
5.5.2.2.1. 既存の Helm チャート リンクのコピーリンクがクリップボードにコピーされました!
ボイラープレート Helm チャートでプロジェクトを作成する代わりに、以下のフラグを使用してローカルファイルシステムまたはリモートチャートリポジトリーから既存のチャートを使用することもできます。
-
--helm-chart -
--helm-chart-repo -
--helm-chart-version
--helm-chart フラグを指定すると、--group、--version、および --kind フラグは任意となります。未設定のままにすると、以下のデフォルト値が使用されます。
| フラグ | 値 |
|---|---|
|
|
|
|
|
|
|
|
|
|
| 指定されたチャートからの推定値。 |
--helm-chart フラグがローカルチャートアーカイブ (例: example-chart-1.2.0.tgz) またはディレクトリーを指定する場合、チャートは検証され、プロジェクトにデプロイメントされるかコピーされます。そうでない場合は、Operator SDK はリモートリポジトリーからチャートの取得を試みます。
--helm-chart-repo フラグでカスタムリポジトリーの URL が指定されない場合には、以下のチャート参照形式がサポートされます。
| フォーマット | 説明 |
|---|---|
|
|
|
|
| 指定された URL で Helm チャートアーカイブを取得します。 |
カスタムリポジトリーの URL が --helm-chart-repo によって指定される場合、以下のチャート参照形式がサポートされます。
| フォーマット | 説明 |
|---|---|
|
|
|
--helm-chart-version フラグが設定されていない場合は、Operator SDK は Helm チャートの利用可能な最新バージョンを取得します。フラグが設定されている場合は、指定したバージョンを取得します。--helm-chart フラグで指定したチャートが特定のバージョンを参照する場合 (例: ローカルパスまたは URL の場合)、オプションの --helm-chart-version フラグは使用されません。
詳細と例を確認するには、以下のコマンドを実行します。
operator-sdk init --plugins helm --help
$ operator-sdk init --plugins helm --help
5.5.2.2.2. PROJECT ファイル リンクのコピーリンクがクリップボードにコピーされました!
operator-sdk init コマンドで生成されるファイルの 1 つに、Kubebuilder の PROJECT ファイルがあります。プロジェクトルートから実行される後続の operator-sdk コマンドおよび help 出力は、このファイルを読み取り、プロジェクトタイプが Helm であることを認識しています。以下に例を示します。
5.5.2.3. Operator ロジックについて リンクのコピーリンクがクリップボードにコピーされました!
この例では、nginx-operator はそれぞれの Nginx カスタムリソース (CR) で以下の調整 (reconciliation) ロジックを実行します。
- Nginx デプロイメントを作成します (ない場合)。
- Nginx サービスを作成します (ない場合)。
- Nginx Ingress を作成します (有効にされているが存在しない場合)。
-
デプロイメント、サービス、およびオプションの Ingress が
NginxCR で指定される必要な設定 (レプリカ数、イメージ、サービスタイプなど) に一致することを確認します。
デフォルトで、nginx-operator プロジェクトは、watches.yaml ファイルに示されるように Nginx リソースイベントを監視し、指定されたチャートを使用して Helm リリースを実行します。
5.5.2.3.1. Helm チャートのサンプル リンクのコピーリンクがクリップボードにコピーされました!
Helm Operator プロジェクトの作成時に、Operator SDK は、単純な Nginx リリース用のテンプレートセットが含まれる Helm チャートのサンプルを作成します。
この例では、Helm チャート開発者がリリースに関する役立つ情報を伝えるために使用する NOTES.txt テンプレートと共に、デプロイメント、サービス、および Ingress リソース用にテンプレートを利用できます。
Helm チャートの使用に慣れていない場合は、Helm 開発者用のドキュメント を参照してください。
5.5.2.3.2. カスタムリソース仕様の変更 リンクのコピーリンクがクリップボードにコピーされました!
Helm は 値 (value) という概念を使用して、values.yaml ファイルに定義される Helm チャートのデフォルトをカスタマイズします。
カスタムリソース (CR) 仕様に必要な値を設定し、これらのデフォルトを上書きすることができます。例としてレプリカ数を使用することができます。
手順
helm-charts/nginx/values.yamlファイルには、デフォルトでreplicaCountという名前の値が1に設定されています。デプロイメントに 2 つの Nginx インスタンスを設定するには、CR 仕様にreplicaCount: 2が含まれる必要があります。config/samples/demo_v1_nginx.yamlファイルを編集し、replicaCount: 2を設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 同様に、デフォルトのサービスポートは
80に設定されます。8080を使用するには、config/samples/demo_v1_nginx.yamlファイルを編集し、spec.port: 8080を設定します。これにより、サービスポートの上書きが追加されます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Helm Operator は、helm install -f ./overrides.yaml コマンドのように、仕様全体を values ファイルの内容のように適用します。
5.5.2.4. プロキシーサポートの有効化 リンクのコピーリンクがクリップボードにコピーされました!
Operator の作成者は、ネットワークプロキシーをサポートする Operator を開発できるようになりました。クラスター管理者は、Operator Lifecycle Manager (OLM) によって処理される環境変数のプロキシーサポートを設定します。Operator は以下の標準プロキシー変数の環境を検査し、値をオペランドに渡して、プロキシーされたクラスターをサポートする必要があります。
-
HTTP_PROXY -
HTTPS_PROXY -
NO_PROXY
このチュートリアルでは、HTTP_PROXY を環境変数の例として使用します。
前提条件
- クラスター全体の egress プロキシーが有効にされているクラスター。
手順
watches.yamlファイルを編集し、overrideValuesフィールドを追加して、環境変数に基づいてオーバーライドを含めます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow helm-charts/nginx/values.yamlファイルにproxy.http値を追加します。... proxy: http: "" https: "" no_proxy: ""
... proxy: http: "" https: "" no_proxy: ""Copy to Clipboard Copied! Toggle word wrap Toggle overflow チャートテンプレートで変数の使用がサポートされているようにするには、
helm-charts/nginx/templates/deployment.yamlファイルのチャートテンプレートを編集して以下を追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下を
config/manager/manager.yamlファイルに追加して、Operator デプロイメントに環境変数を設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5. Operator の実行 リンクのコピーリンクがクリップボードにコピーされました!
Operator SDK CLI を使用して Operator をビルドし、実行する方法は 3 つあります。
- クラスター外で Go プログラムとしてローカルに実行します。
- クラスター上のデプロイメントとして実行します。
- Operator をバンドルし、Operator Lifecycle Manager (OLM) を使用してクラスター上にデプロイします。
5.5.2.5.1. クラスター外でローカルに実行する。 リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトをクラスター外の Go プログラムとして実行できます。これは、デプロイメントとテストを迅速化するという開発目的において便利です。
手順
以下のコマンドを実行して、
~/.kube/configファイルに設定されたクラスターにカスタムリソース定義 (CRD) をインストールし、Operator をローカルで実行します。make install run
$ make install runCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.2. クラスター上でのデプロイメントとしての実行 リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトは、クラスター上でデプロイメントとして実行できます。
手順
以下の
makeコマンドを実行して Operator イメージをビルドし、プッシュします。以下の手順のIMG引数を変更して、アクセス可能なリポジトリーを参照します。Quay.io などのリポジトリーサイトにコンテナーを保存するためのアカウントを取得できます。イメージをビルドします。
make docker-build IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記Operator の SDK によって生成される Dockerfile は、
go buildに関するGOARCH=amd64を明示的に参照します。これは、AMD64 アーキテクチャー以外の場合はGOARCH=$TARGETARCHに修正できます。Docker は、-platformで指定された値に環境変数を自動的に設定します。Buildah では、そのために-build-argを使用する必要があります。詳細は、Multiple Architectures を参照してください。イメージをリポジトリーにプッシュします。
make docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記両方のコマンドのイメージの名前とタグ (例:
IMG=<registry>/<user>/<image_name>:<tag>) を Makefile に設定することもできます。IMG ?= controller:latestの値を変更して、デフォルトのイメージ名を設定します。
以下のコマンドを実行して Operator をデプロイします。
make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow デフォルトで、このコマンドは
<project_name>-systemの形式で Operator プロジェクトの名前で namespace を作成し、デプロイメントに使用します。このコマンドは、config/rbacから RBAC マニフェストもインストールします。以下のコマンドを実行して、Operator が実行されていることを確認します。
oc get deployment -n <project_name>-system
$ oc get deployment -n <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8m
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.3. Operator のバンドルおよび Operator Lifecycle Manager を使用したデプロイ リンクのコピーリンクがクリップボードにコピーされました!
5.5.2.5.3.1. Operator のバンドル リンクのコピーリンクがクリップボードにコピーされました!
Operator Bundle Format は、Operator SDK および Operator Lifecycle Manager (OLM) のデフォルトパッケージ方法です。Operator SDK を使用して OLM に対して Operator を準備し、バンドルイメージとして Operator プロジェクトをビルドしてプッシュできます。
前提条件
- 開発ワークステーションに Operator SDK CLI がインストールされていること。
-
OpenShift CLI (
oc) v4.12 以降がインストールされている - Operator プロジェクトが Operator SDK を使用して初期化されていること。
手順
以下の
makeコマンドを Operator プロジェクトディレクトリーで実行し、Operator イメージをビルドし、プッシュします。以下の手順のIMG引数を変更して、アクセス可能なリポジトリーを参照します。Quay.io などのリポジトリーサイトにコンテナーを保存するためのアカウントを取得できます。イメージをビルドします。
make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記Operator の SDK によって生成される Dockerfile は、
go buildに関するGOARCH=amd64を明示的に参照します。これは、AMD64 アーキテクチャー以外の場合はGOARCH=$TARGETARCHに修正できます。Docker は、-platformで指定された値に環境変数を自動的に設定します。Buildah では、そのために-build-argを使用する必要があります。詳細は、Multiple Architectures を参照してください。イメージをリポジトリーにプッシュします。
make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Operator SDK
generate bundleおよびbundle validateのサブコマンドを含む複数のコマンドを呼び出すmake bundleコマンドを実行し、Operator バンドルマニフェストを作成します。make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Operator のバンドルマニフェストは、アプリケーションを表示し、作成し、管理する方法を説明します。
make bundleコマンドは、以下のファイルおよびディレクトリーを Operator プロジェクトに作成します。-
ClusterServiceVersionオブジェクトを含むbundle/manifestsという名前のバンドルマニフェストディレクトリー -
bundle/metadataという名前のバンドルメタデータディレクトリー -
config/crdディレクトリー内のすべてのカスタムリソース定義 (CRD) -
Dockerfile
bundle.Dockerfile
続いて、これらのファイルは
operator-sdk bundle validateを使用して自動的に検証され、ディスク上のバンドル表現が正しいことを確認します。-
以下のコマンドを実行し、バンドルイメージをビルドしてプッシュします。OLM は、1 つ以上のバンドルイメージを参照するインデックスイメージを使用して Operator バンドルを使用します。
バンドルイメージをビルドします。イメージをプッシュしようとするレジストリー、ユーザー namespace、およびイメージタグの詳細で
BUNDLE_IMGを設定します。make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>
$ make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow バンドルイメージをプッシュします。
docker push <registry>/<user>/<bundle_image_name>:<tag>
$ docker push <registry>/<user>/<bundle_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.3.2. Operator Lifecycle Manager を使用した Operator のデプロイ リンクのコピーリンクがクリップボードにコピーされました!
Operator Lifecycle Manager (OLM) は、Kubernetes クラスターで Operator (およびそれらの関連サービス) をインストールし、更新し、ライフサイクルを管理するのに役立ちます。OLM はデフォルトで OpenShift Container Platform にインストールされ、Kubernetes 拡張として実行されるため、追加のツールなしにすべての Operator のライフサイクル管理機能に Web コンソールおよび OpenShift CLI (oc) を使用できます。
Operator Bundle Format は、Operator SDK および OLM のデフォルトパッケージ方法です。Operator SDK を使用して OLM でバンドルイメージを迅速に実行し、適切に実行されるようにできます。
前提条件
- 開発ワークステーションに Operator SDK CLI がインストールされている。
- ビルドされ、レジストリーにプッシュされる Operator バンドルイメージ。
-
(OpenShift Container Platform 4.12 など、
apiextensions.k8s.io/v1CRD を使用する場合は v1.16.0 以降の) Kubernetes ベースのクラスターに OLM がインストールされていること。 -
cluster-adminパーミッションのあるアカウントを使用してocでクラスターへログインしていること。
手順
以下のコマンドを入力してクラスターで Operator を実行します。
operator-sdk run bundle \ -n <namespace> \ <registry>/<user>/<bundle_image_name>:<tag>$ operator-sdk run bundle \1 -n <namespace> \2 <registry>/<user>/<bundle_image_name>:<tag>3 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
run bundleコマンドは、有効なファイルベースのカタログを作成し、OLM を使用して Operator バンドルをクラスターにインストールします。- 2
- オプション: デフォルトで、このコマンドは
~/.kube/configファイルの現在アクティブなプロジェクトに Operator をインストールします。-nフラグを追加して、インストールに異なる namespace スコープを設定できます。 - 3
- イメージを指定しない場合、コマンドは
quay.io/operator-framework/opm:latestをデフォルトのインデックスイメージとして使用します。イメージを指定した場合は、コマンドはバンドルイメージ自体をインデックスイメージとして使用します。
重要OpenShift Container Platform 4.11 の時点で、Operator カタログに関して、
run bundleコマンドはデフォルトでファイルベースのカタログ形式をサポートします。Operator カタログに関して、非推奨の SQLite データベース形式は引き続きサポートされますが、今後のリリースで削除される予定です。Operator の作成者はワークフローをファイルベースのカタログ形式に移行することが推奨されます。このコマンドにより、以下のアクションが行われます。
- バンドルイメージをインジェクトしてインデックスイメージを作成します。インデックスイメージは不透明で一時的なものですが、バンドルを実稼働環境でカタログに追加する方法を正確に反映します。
- 新規インデックスイメージを参照するカタログソースを作成します。これにより、OperatorHub が Operator を検出できるようになります。
-
OperatorGroup、Subscription、InstallPlan、および RBAC を含むその他の必要なリソースすべてを作成して、Operator をクラスターにデプロイします。
5.5.2.6. カスタムリソースの作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator のインストール後に、Operator によってクラスターに提供されるカスタムリソース (CR) を作成して、これをテストできます。
前提条件
-
クラスターにインストールされている
NginxCR を提供する Nginx Operator の例
手順
Operator がインストールされている namespace へ変更します。たとえば、
make deployコマンドを使用して Operator をデプロイした場合は、以下のようになります。oc project nginx-operator-system
$ oc project nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow config/samples/demo_v1_nginx.yamlでNginxCR マニフェストのサンプルを編集し、以下の仕様が含まれるようにします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow Nginx サービスアカウントには、OpenShift Container Platform で実行する特権アクセスが必要です。以下の SCC (Security Context Constraints) を
nginx-samplePod のサービスアカウントに追加します。oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sample$ oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sampleCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR を作成します。
oc apply -f config/samples/demo_v1_nginx.yaml
$ oc apply -f config/samples/demo_v1_nginx.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NginxOperator が、正しいサイズで CR サンプルのデプロイメントを作成することを確認します。oc get deployments
$ oc get deploymentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 8m nginx-sample 3/3 3 3 1m
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 8m nginx-sample 3/3 3 3 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow ステータスが Nginx Pod 名で更新されていることを確認するために、Pod および CR ステータスを確認します。
Pod を確認します。
oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY STATUS RESTARTS AGE nginx-sample-6fd7c98d8-7dqdr 1/1 Running 0 1m nginx-sample-6fd7c98d8-g5k7v 1/1 Running 0 1m nginx-sample-6fd7c98d8-m7vn7 1/1 Running 0 1m
NAME READY STATUS RESTARTS AGE nginx-sample-6fd7c98d8-7dqdr 1/1 Running 0 1m nginx-sample-6fd7c98d8-g5k7v 1/1 Running 0 1m nginx-sample-6fd7c98d8-m7vn7 1/1 Running 0 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR ステータスを確認します。
oc get nginx/nginx-sample -o yaml
$ oc get nginx/nginx-sample -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
デプロイメントサイズを更新します。
config/samples/demo_v1_nginx.yamlファイルを更新して、NginxCR のspec.sizeフィールドを3から5に変更します。oc patch nginx nginx-sample \ -p '{"spec":{"replicaCount": 5}}' \ --type=merge$ oc patch nginx nginx-sample \ -p '{"spec":{"replicaCount": 5}}' \ --type=mergeCopy to Clipboard Copied! Toggle word wrap Toggle overflow Operator がデプロイメントサイズを変更することを確認します。
oc get deployments
$ oc get deploymentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 10m nginx-sample 5/5 5 5 3m
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 10m nginx-sample 5/5 5 5 3mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
次のコマンドを実行して CR を削除します。
oc delete -f config/samples/demo_v1_nginx.yaml
$ oc delete -f config/samples/demo_v1_nginx.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow このチュートリアルの一環として作成したリソースをクリーンアップします。
Operator のテストに
make deployコマンドを使用した場合は、以下のコマンドを実行します。make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow Operator のテストに
operator-sdk run bundleコマンドを使用した場合は、以下のコマンドを実行します。operator-sdk cleanup <project_name>
$ operator-sdk cleanup <project_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.3. Helm ベースの Operator のプロジェクトレイアウト リンクのコピーリンクがクリップボードにコピーされました!
operator-sdk CLI は、各 Operator プロジェクトに多数のパッケージおよびファイルを生成、または スキャフォールディング することができます。
5.5.3.1. Helm ベースのプロジェクトレイアウト リンクのコピーリンクがクリップボードにコピーされました!
operator-sdk init --plugins helm コマンドを使用して生成される Helm ベースの Operator プロジェクトには、以下のディレクトリーおよびファイルが含まれます。
| ファイル/フォルダー | 目的 |
|---|---|
|
| Kubernetes クラスターへの Operator のデプロイに使用する Kustomize マニフェスト。 |
|
|
|
|
|
|
|
| group/version/kind (GVK) および Helm チャートの場所。 |
|
| プロジェクトの管理に使用するターゲット。 |
|
| Operator のメタデータ情報が含まれる YAML ファイル。 |
5.5.4. Helm ベースのプロジェクトを新しい Operator SDK バージョン用に更新する リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform 4.12 は Operator SDK 1.25.4 をサポートします。ワークステーションにすでに 1.36.1 CLI がインストールされている場合は、最新バージョンをインストール して CLI を 1.38.0 に更新できます。
ただし、既存の Operator プロジェクトが Operator SDK 1.25.4 との互換性を維持するには、1.22.2 以降に導入された関連する重大な変更に対し、更新手順を実行する必要があります。アップグレードの手順は、以前は 1.22.2 で作成または維持されている Operator プロジェクトのいずれかで手動で実行する必要があります。
5.5.4.1. Operator SDK 1.25.4 の Helm ベースの Operator プロジェクトの更新 リンクのコピーリンクがクリップボードにコピーされました!
次の手順では、1.25.4 との互換性を確保するため、既存の Helm ベースの Operator プロジェクトを更新します。
前提条件
- Operator SDK 1.25.4 がインストールされている
- Operator SDK 1.22.2 で作成または保守されている Operator プロジェクト
手順
config/default/manager_auth_proxy_patch.yamlファイルに以下の変更を加えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- タグバージョンを
v4.11からv4.12に更新します。
Makefileに以下の変更を加えます。マルチアーキテクチャービルドサポートを有効にするには、
docker-buildxターゲットをプロジェクトのMakefileに追加します。Makefileの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow Operator プロジェクトで 64 ビットのアーキテクチャーのサポートを有効にするには、
Makefileに以下の変更を加えます。古い
MakefileOS := $(shell uname -s | tr '[:upper:]' '[:lower:]') ARCH := $(shell uname -m | sed 's/x86_64/amd64/')
OS := $(shell uname -s | tr '[:upper:]' '[:lower:]') ARCH := $(shell uname -m | sed 's/x86_64/amd64/')Copy to Clipboard Copied! Toggle word wrap Toggle overflow 新しい
MakefileOS := $(shell uname -s | tr '[:upper:]' '[:lower:]') ARCH := $(shell uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/')
OS := $(shell uname -s | tr '[:upper:]' '[:lower:]') ARCH := $(shell uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/')Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次の例に示すように、Kustomize のバージョンを
v4.5.5に更新します。古い
MakefileCopy to Clipboard Copied! Toggle word wrap Toggle overflow 新しい
MakefileCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- バージョン
v3.8.7をv4.5.5に更新します。
重要Kustomize バージョン
4.0.0では、go-getterプラグインが削除され、以前のバージョンとの下位互換性がない重大な変更が導入されました。古いバージョンの Kustomize に依存する Operator プロジェクトは、新しいリリースでは機能しない可能性があります。Makefileに変更を適用し、Operator を再構築するには、次のコマンドを入力します。make
$ makeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
次の例のとおり、Operator の Dockerfile 内のイメージタグを更新します。
Dockerfile の例
FROM registry.redhat.io/openshift4/ose-helm-operator:v4.12
FROM registry.redhat.io/openshift4/ose-helm-operator:v4.121 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- バージョンタグを
v4.12に更新します。
次の例に示すように、
config/default/kustomizations.yamlファイルを更新します。kustomizations.yamlファイルの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.5. Operator SDK での Helm サポート リンクのコピーリンクがクリップボードにコピーされました!
5.5.5.1. Helm チャート リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトを生成するための Operator SDK のオプションの 1 つとして、Go コードを作成せずに既存の Helm チャートを使用して Kubernetes リソースを統一されたアプリケーションとしてデプロイするオプションがあります。このような Helm ベースの Operator では、変更はチャートの一部として生成される Kubernetes オブジェクトに適用されるため、ロールアウト時にロジックをほとんど必要としないステートレスなアプリケーションを使用する際に適しています。いくらか制限があるような印象を与えるかもしれませんが、Kubernetes コミュニティーがビルドする Helm チャートが急速に増加していることからも分かるように、この Operator は数多くのユーザーケースに対応することができます。
Operator の主な機能として、アプリケーションインスタンスを表すカスタムオブジェクトから読み取り、必要な状態を実行されている内容に一致させることができます。Helm ベースの Operator の場合、オブジェクトの spec フィールドは、通常 Helm の values.yaml ファイルに記述される設定オプションのリストです。Helm CLI を使用してフラグ付きの値を設定する代わりに (例: helm install -f values.yaml)、これらをカスタムリソース (CR) 内で表現することができます。これにより、ネイティブ Kubernetes オブジェクトとして、適用される RBAC および監査証跡の利点を活用できます。
Tomcat という単純な CR の例:
この場合の replicaCount 値、2 は以下が使用されるチャートのテンプレートに伝播されます。
{{ .Values.replicaCount }}
{{ .Values.replicaCount }}
Operator のビルドおよびデプロイ後に、CR の新規インスタンスを作成してアプリケーションの新規インスタンスをデプロイしたり、oc コマンドを使用してすべての環境で実行される異なるインスタンスをリスト表示したりすることができます。
oc get Tomcats --all-namespaces
$ oc get Tomcats --all-namespaces
Helm CLI を使用したり、Tiller をインストールしたりする必要はありません。Helm ベースの Operator はコードを Helm プロジェクトからインポートします。Operator のインスタンスを実行状態にし、カスタムリソース定義 (CRD) で CR を登録することのみが必要になります。これは RBAC に準拠するため、実稼働環境の変更を簡単に防止することができます。
5.5.6. Hybrid Helm Operator 向けの Operator SDK チュートリアル リンクのコピーリンクがクリップボードにコピーされました!
Operator SDK における標準の Helm ベースの Operator サポートは、Operator の Operator 成熟度モデル で Auto Pilot 機能 (レベル V) に達した Go ベースおよび Ansible ベースの Operator サポートよりも機能が限定されています。
Hybrid Helm Operator は、Go API を使用して既存の Helm ベースのサポート機能を強化します。Helm と Go のこのハイブリッドアプローチでは、Operator SDK により、Operator の作成者は次のプロセスを使用できます。
- Helm と同じプロジェクトで Go API のデフォルト構造またはscaffoldを生成します。
-
Hybrid Helm Operator が提供するライブラリーを使用して、プロジェクトの
main.goファイルで Helm reconciler を設定します。
Hybrid Helm Operator は、テクノロジープレビュー機能のみとしてご利用いただけます。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
このチュートリアルでは、Hybrid Helm Operator を使用して、次のプロセスを説明していきます。
-
Memcachedデプロイメントがない場合には、Helm チャートを使用して作成する -
デプロイメントのサイズが、
Memcachedカスタムリソース (CR) 仕様で指定されたものと同じであることを確認する -
Go API を使用して
MemcachedBackupデプロイメントを作成する
5.5.6.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- Operator SDK CLI がインストールされていること。
-
OpenShift CLI (
oc) v4.12 以降がインストールされている -
cluster-adminパーミッションを持つアカウントを使用して、ocで OpenShift Container Platform 4.12 クラスターにログインしている - クラスターがイメージをプルできるようにするには、イメージをプッシュするリポジトリーを public として設定するか、イメージプルシークレットを設定する必要があります。
5.5.6.2. プロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator SDK CLI を使用して memcached-operator というプロジェクトを作成します。
手順
プロジェクトのディレクトリーを作成します。
mkdir -p $HOME/github.com/example/memcached-operator
$ mkdir -p $HOME/github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーに切り替えます。
cd $HOME/github.com/example/memcached-operator
$ cd $HOME/github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow operator-sdk initコマンドを実行してプロジェクトを初期化します。この例では、my.domainというドメインを使用しているため、すべての API グループが<group>.my.domainになります。operator-sdk init \ --plugins=hybrid.helm.sdk.operatorframework.io \ --project-version="3" \ --domain my.domain \ --repo=github.com/example/memcached-operator$ operator-sdk init \ --plugins=hybrid.helm.sdk.operatorframework.io \ --project-version="3" \ --domain my.domain \ --repo=github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow initコマンドは、チャートのデフォルトのマニフェストでデプロイされるリソースをもとに、config/rbac/role.yamlファイルに RBAC ルールを生成します。config/rbac/role.yamlファイルで生成されたルールが、Operator のパーミッション要件を満たしていることを確認します。
関連情報
- この手順では、Helm API と Go API の両方と互換性のあるプロジェクト構造を作成します。プロジェクトディレクトリー構造の詳細は、プロジェクトレイアウトを参照してください。
5.5.6.3. Helm API の作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator SDKCLI を使用して Helm API を作成します。
手順
以下のコマンドを実行して、グループ
cache、バージョンv1、および種類Memcachedを指定して Helm API を作成します。operator-sdk create api \ --plugins helm.sdk.operatorframework.io/v1 \ --group cache \ --version v1 \ --kind Memcached$ operator-sdk create api \ --plugins helm.sdk.operatorframework.io/v1 \ --group cache \ --version v1 \ --kind MemcachedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
この手順では、API バージョン v1 を使用して Memcached リソースを監視し、定型的な Helm チャートをスキャフォールドするように Operator プロジェクトも設定します。Operator SDK によってスキャフォールドされた定型 Helm チャートからプロジェクトを作成する代わりに、ローカルファイルシステムまたはリモートチャートリポジトリーからの既存のチャートを使用することもできます。
既存または新規のチャートをもとに Helm API を作成する方法と例は、次のコマンドを実行してください。
operator-sdk create api --plugins helm.sdk.operatorframework.io/v1 --help
$ operator-sdk create api --plugins helm.sdk.operatorframework.io/v1 --help
関連情報
5.5.6.3.1. Helm API の Operator ロジック リンクのコピーリンクがクリップボードにコピーされました!
デフォルトでは、スキャフォールディングされた Operator プロジェクトは、watches.yamlファイルに示されているようにMemcachedリソースイベントを監視し、指定されたチャートを使用して Helm リリースを実行します。
例5.2 watches.yaml ファイルの例
関連情報
- チャートを介した Helm Operator ロジックのカスタマイズに関する詳細なドキュメントは、Operator ロジックを参照してください。
5.5.6.3.2. 指定のライブラリー API を使用したカスタム Helm reconciler 設定 リンクのコピーリンクがクリップボードにコピーされました!
既存の Helm ベースの Operator の欠点は、ユーザーから抽象化されているため、Helm reconciler を設定できないことです。Helm ベースの Operator が既存の Helm チャートを再利用するシームレスアップグレード機能 (レベル II 以降) に到達する場合には、Go タイプと Helm Operator タイプのハイブリッドが付加価値をもたらします。
helm-operator-pluginsライブラリーで提供される API を使用すると、Operator の作成者は以下の設定が可能です。
- クラスターの状態に基づいて値のマッピングをカスタマイズする
- reconciler のイベントレコーダーを設定して、特定のイベントでコードを実行する
- reconciler のロガーをカスタマイズする
-
Install、Upgrade、Uninstallアノテーションを設定して Helm のアクションを、reconciler が監視するカスタムリソースにあるアノテーションを元に設定されるようにする -
PreフックとPostフックで実行するように reconciler を設定する
reconciler に対する上記の設定は、main.goファイルで実行できます。
main.goファイルの例
5.5.6.4. Go API の作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator SDKCLI を使用して Go API を作成します。
手順
以下のコマンドを実行して、グループ
cache、バージョンv1、および種類MemcachedBackupを指定して Go API を作成します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow プロンプトが表示されたら
yを入力し、リソースとコントローラーの両方を作成します。Create Resource [y/n]
$ Create Resource [y/n] y Create Controller [y/n] yCopy to Clipboard Copied! Toggle word wrap Toggle overflow
この手順では、MemcachedBackup リソース API を api/v1/memcachedbackup_types.go に生成し、コントローラーを controllers/memcachedbackup_controller.go に生成します。
5.5.6.4.1. API の定義 リンクのコピーリンクがクリップボードにコピーされました!
MemcachedBackupカスタムリソース (CR) の API を定義します。
デプロイする Memcached バックアップインスタンス (CR) の数を設定するMemcachedBackupSpec.Sizeフィールドと、CR の Pod 名を格納する MemcachedBackupStatus.Nodes フィールドがある MemcachedBackup タイプを定義して、この Go API を表します。
Nodeフィールドは、Statusフィールドの例を示すために使用されます。
手順
api/v1/memcachedbackup_types.goファイルの Go タイプ定義を次のspecとstatusに変更して、MemcachedBackupCR の API を定義します。例5.3
api/v1/memcachedbackup_types.goファイルの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow リソースタイプ用に生成されたコードを更新します。
make generate
$ make generateCopy to Clipboard Copied! Toggle word wrap Toggle overflow ヒント*_types.goファイルの変更後は、make generateコマンドを実行し、該当するリソースタイプ用に生成されたコードを更新する必要があります。API を
specフィールドとstatusフィールドおよび CRD 検証マーカーで定義した後に、CRD マニフェストを生成および更新します。make manifests
$ make manifestsCopy to Clipboard Copied! Toggle word wrap Toggle overflow
この Makefile ターゲットは controller-gen ユーティリティーを呼び出し、config/crd/bases/cache.my.domain_memcachedbackups.yaml ファイルに CRD マニフェストを生成します。
5.5.6.4.2. コントローラーの実装 リンクのコピーリンクがクリップボードにコピーされました!
このチュートリアルのコントローラーは、次のアクションを実行します。
-
Memcachedデプロイメントを作成します (ない場合)。 -
デプロイメントのサイズが、
MemcachedCR 仕様で指定されたものと同じであることを確認します。 -
MemcachedCR ステータスをmemcachedPod の名前に置き換えます。
上記のアクションを実行するようにコントローラーを設定する方法は、標準の Go ベースの Operator の Operator SDK チュートリアルで、コントローラーの実装を参照してください。
5.5.6.4.3. main.go の違い リンクのコピーリンクがクリップボードにコピーされました!
標準の Go ベースの Operator と Hybrid Helm Operator の場合には、main.goファイルは、Go API のManagerプログラムの初期化と実行のスキャフォールディングを処理します。ただし、Hybrid Helm Operator の場合には、main.goファイルは、watches.yamlファイルをロードして Helm reconciler を設定するためのロジックも公開します。
例5.4 main.goファイルの例
マネージャーは、Helm と Go reconciler の両方で初期化されます。
例5.5 Helm および Go reconciler の例
5.5.6.4.4. パーミッションおよび RBAC マニフェスト リンクのコピーリンクがクリップボードにコピーされました!
コントローラーは、マネージドリソースの操作に、特定のロールベースのアクセス制御 (RBAC) 権限を必要とします。Go API の場合には、標準の Go ベースの Operator の Operator SDK チュートリアルに示されているように、RBAC マーカーで指定されます。
Helm API の場合、権限はデフォルトでroles.yamlにスキャフォールディングされます。ただし、現在、Go API がスキャフォールディングされている場合の既知の問題が原因で、Helm API の権限が上書きされます。このような問題があるので、roles.yamlで定義された権限が要件に一致することを確認してください。
この既知の問題は、https://github.com/operator-framework/helm-operator-plugins/issues/142で追跡されています。
以下は、Memcached Operator のrole.yamlの例です。
例5.6 Helm および Go reconciler の例
5.5.6.5. クラスター外でローカルに実行する。 リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトをクラスター外の Go プログラムとして実行できます。これは、デプロイメントとテストを迅速化するという開発目的において便利です。
手順
以下のコマンドを実行して、
~/.kube/configファイルに設定されたクラスターにカスタムリソース定義 (CRD) をインストールし、Operator をローカルで実行します。make install run
$ make install runCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.6. クラスター上でのデプロイメントとしての実行 リンクのコピーリンクがクリップボードにコピーされました!
Operator プロジェクトは、クラスター上でデプロイメントとして実行できます。
手順
以下の
makeコマンドを実行して Operator イメージをビルドし、プッシュします。以下の手順のIMG引数を変更して、アクセス可能なリポジトリーを参照します。Quay.io などのリポジトリーサイトにコンテナーを保存するためのアカウントを取得できます。イメージをビルドします。
make docker-build IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記Operator の SDK によって生成される Dockerfile は、
go buildに関するGOARCH=amd64を明示的に参照します。これは、AMD64 アーキテクチャー以外の場合はGOARCH=$TARGETARCHに修正できます。Docker は、-platformで指定された値に環境変数を自動的に設定します。Buildah では、そのために-build-argを使用する必要があります。詳細は、Multiple Architectures を参照してください。イメージをリポジトリーにプッシュします。
make docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記両方のコマンドのイメージの名前とタグ (例:
IMG=<registry>/<user>/<image_name>:<tag>) を Makefile に設定することもできます。IMG ?= controller:latestの値を変更して、デフォルトのイメージ名を設定します。
以下のコマンドを実行して Operator をデプロイします。
make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow デフォルトで、このコマンドは
<project_name>-systemの形式で Operator プロジェクトの名前で namespace を作成し、デプロイメントに使用します。このコマンドは、config/rbacから RBAC マニフェストもインストールします。以下のコマンドを実行して、Operator が実行されていることを確認します。
oc get deployment -n <project_name>-system
$ oc get deployment -n <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8m
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.7. カスタムリソースの作成 リンクのコピーリンクがクリップボードにコピーされました!
Operator のインストール後に、Operator によってクラスターに提供されるカスタムリソース (CR) を作成して、これをテストできます。
手順
Operator がインストールされている namespace へ変更します。
oc project <project_name>-system
$ oc project <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow replicaCountフィールドを3に変更して、config/samples/cache_v1_memcached.yamlファイルにあるサンプルMemcached CRマニフェストを更新します。例5.7
config/samples/cache_v1_memcached.yamlファイルの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedCR を作成します。oc apply -f config/samples/cache_v1_memcached.yaml
$ oc apply -f config/samples/cache_v1_memcached.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Memcached Operator が、正しいサイズで CR サンプルのデプロイメントを作成することを確認します。
oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY STATUS RESTARTS AGE memcached-sample-6fd7c98d8-7dqdr 1/1 Running 0 18m memcached-sample-6fd7c98d8-g5k7v 1/1 Running 0 18m memcached-sample-6fd7c98d8-m7vn7 1/1 Running 0 18m
NAME READY STATUS RESTARTS AGE memcached-sample-6fd7c98d8-7dqdr 1/1 Running 0 18m memcached-sample-6fd7c98d8-g5k7v 1/1 Running 0 18m memcached-sample-6fd7c98d8-m7vn7 1/1 Running 0 18mCopy to Clipboard Copied! Toggle word wrap Toggle overflow sizeを2に更新して、config/samples/cache_v1_memcachedbackup.yamlファイルにあるサンプルMemcachedBackupCR マニフェストを更新します。例5.8
config/samples/cache_v1_memcachedbackup.yamlファイルの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedBackupCR を作成します。oc apply -f config/samples/cache_v1_memcachedbackup.yaml
$ oc apply -f config/samples/cache_v1_memcachedbackup.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow memcachedbackupPod の数が CR で指定されているものと同じであることを確認してください。oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
NAME READY STATUS RESTARTS AGE memcachedbackup-sample-8649699989-4bbzg 1/1 Running 0 22m memcachedbackup-sample-8649699989-mq6mx 1/1 Running 0 22m
NAME READY STATUS RESTARTS AGE memcachedbackup-sample-8649699989-4bbzg 1/1 Running 0 22m memcachedbackup-sample-8649699989-mq6mx 1/1 Running 0 22mCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
上記の各 CR の
specを更新してから、再度適用できます。コントローラーは再度調整し、Pod のサイズがそれぞれの CR の仕様で指定されているとおりであることを確認します。 このチュートリアルの一環として作成したリソースをクリーンアップします。
Memcachedリソースを削除します。oc delete -f config/samples/cache_v1_memcached.yaml
$ oc delete -f config/samples/cache_v1_memcached.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedBackupリソースを削除します。oc delete -f config/samples/cache_v1_memcachedbackup.yaml
$ oc delete -f config/samples/cache_v1_memcachedbackup.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Operator のテストに
make deployコマンドを使用した場合は、以下のコマンドを実行します。make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.8. プロジェクトのレイアウト リンクのコピーリンクがクリップボードにコピーされました!
Hybrid Helm Operator スキャフォールディングは、Helm API と Go API の両方と互換性があるようにカスタマイズされています。
| ファイル/フォルダー | 目的 |
|---|---|
|
|
|
|
| プロジェクトでの操作に役立つヘルパーターゲットを使用してファイルをビルドします。 |
|
| Operator のメタデータ情報が含まれる YAML ファイル。プロジェクトの設定を表し、CLI およびプラグインの有用な情報の追跡に使用されます。 |
|
|
プロジェクトのローカル実行に使用される |
|
| クラスターで Operator プロジェクト起動するための全Kustomizeマニフェストなど、設定ファイルが含まれています。プラグインはこのファイルを使用して機能を提供する場合があります。たとえば、Operator SDK が Operator バンドルの作成に役立つように、CLI はこのディレクトリーにスキャフォールディングされている CRD と CR を検索します。
|
|
| Go API 定義が含まれています。 |
|
| Go API のコントローラーが含まれています。 |
|
| プロジェクトファイルのライセンスヘッダーのスキャフォールディングに使用されるファイルなどのユーティリティーファイルが含まれています。 |
|
|
Operator のメインプログラム。 |
|
|
Helm プラグインで |
|
| group/version/kind (GVK) および Helm チャートの場所が含まれます。Helm ウォッチの設定に使用されます。 |
5.5.7. Hybrid Helm ベースのプロジェクトを新しい Operator SDK バージョン用に更新する リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform 4.12 は Operator SDK 1.25.4 をサポートします。ワークステーションにすでに 1.36.1 CLI がインストールされている場合は、最新バージョンをインストール して CLI を 1.38.0 に更新できます。
ただし、既存の Operator プロジェクトが Operator SDK 1.25.4 との互換性を維持するには、1.22.2 以降に導入された関連する重大な変更に対し、更新手順を実行する必要があります。アップグレードの手順は、以前は 1.22.2 で作成または維持されている Operator プロジェクトのいずれかで手動で実行する必要があります。
5.5.7.1. Operator SDK 1.25.4 のハイブリッドの Helm ベースの Operator プロジェクトの更新 リンクのコピーリンクがクリップボードにコピーされました!
次の手順では、1.25.4 との互換性を確保するため、既存のハイブリッドの Helm ベースの Operator プロジェクトを更新します。
前提条件
- Operator SDK 1.25.4 がインストールされている
- Operator SDK 1.22.2 で作成または保守されている Operator プロジェクト
手順
config/default/manager_auth_proxy_patch.yamlファイルに以下の変更を加えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- タグバージョンを
v4.11からv4.12に更新します。
Makefileに以下の変更を加えます。マルチアーキテクチャービルドサポートを有効にするには、
docker-buildxターゲットをプロジェクトのMakefileに追加します。Makefileの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow Makefileに変更を適用し、Operator を再構築するには、次のコマンドを入力します。make
$ makeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Go とその依存関係を更新するには、
go.modファイルに次の変更を加えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 更新されたバージョンをダウンロードし、依存関係をクリーンアップして、
go.modファイルの変更を適用するには、次のコマンドを実行します。go mod tidy
$ go mod tidyCopy to Clipboard Copied! Toggle word wrap Toggle overflow