第8章 Operator SDK
8.1. Operator SDK CLI のインストール
Operator SDK は、Operator 開発者が Operator のビルド、テストおよびデプロイに使用できるコマンドラインインターフェイス (CLI) ツールを提供します。ワークステーションに Operator SDK CLI をインストールして、独自の Operator のオーサリングを開始する準備を整えることができます。
Operator プロジェクトの関連スキャフォールディングおよびテストツールなど、Red Hat がサポートするバージョンの Operator SDK CLI ツールは非推奨となり、OpenShift Container Platform の今後のリリースで削除される予定です。Red Hat は、現在のリリースライフサイクル中にこの機能のバグ修正とサポートを提供しますが、この機能は今後、機能拡張の提供はなく、OpenShift Container Platform リリースから削除されます。
新しい Operator プロジェクトを作成する場合、Red Hat がサポートするバージョンの Operator SDK は推奨されません。既存の Operator プロジェクトを使用する Operator 作成者は、OpenShift Container Platform 4.16 でリリースされるバージョンの Operator SDK CLI ツールを使用してプロジェクトを維持し、OpenShift Container Platform の新しいバージョンを対象とする Operator リリースを作成できます。
Operator プロジェクトの次の関連ベースイメージは 非推奨 ではありません。これらのベースイメージのランタイム機能と設定 API は、バグ修正と CVE への対応のために引き続きサポートされます。
- Ansible ベースの Operator プロジェクトのベースイメージ
- Helm ベースの Operator プロジェクトのベースイメージ
OpenShift Container Platform で非推奨となったか、削除された主な機能の最新の一覧は、OpenShift Container Platform リリースノートの 非推奨および削除された機能 セクションを参照してください。
サポートされていない、コミュニティーによって管理されているバージョンの Operator SDK は、Operator SDK (Operator Framework) を参照してください。
Kubernetes ベースのクラスター (OpenShift Container Platform など) へのクラスター管理者のアクセスのある Operator の作成者は、Operator SDK CLI を使用して Go、Ansible、Java、または Helm をベースに独自の Operator を開発できます。Kubebuilder は Go ベースの Operator のスキャフォールディングソリューションとして Operator SDK に組み込まれます。つまり、既存の Kubebuilder プロジェクトは Operator SDK でそのまま使用でき、引き続き機能します。Operator SDK の詳細は、Operator の開発 を参照してください。
OpenShift Container Platform 4.18 は Operator SDK 1.36.1 をサポートします。
8.1.1. Linux での Operator SDK CLI のインストール
OpenShift SDK CLI ツールは Linux にインストールできます。
前提条件
- Go v1.19 以降
-
docker
v17.03+、podman
v1.9.3+、またはbuildah
v1.7+
手順
- OpenShift ミラーサイト に移動します。
- 最新の 4.16 ディレクトリーから、Linux 用 tarball の最新バージョンをダウンロードします。
アーカイブを展開します。
$ tar xvf operator-sdk-v1.36.1-ocp-linux-x86_64.tar.gz
ファイルを実行可能にします。
$ chmod +x operator-sdk
デプロイメントされた
operator-sdk
バイナリーをPATH
にあるディレクトリーに移動します。ヒントPATH
を確認するには、以下を実行します。$ echo $PATH
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
検証
Operator SDK CLI のインストール後に、これが利用可能であることを確認します。
$ operator-sdk version
出力例
operator-sdk version: "v1.36.1-ocp", ...
8.1.2. macOS への Operator SDK CLI のインストール
macOS に OpenShift SDK CLI ツールをインストールできます。
前提条件
- Go v1.19 以降
-
docker
v17.03+、podman
v1.9.3+、またはbuildah
v1.7+
手順
-
amd64
およびarm64
アーキテクチャーの場合は、amd64
アーキテクチャーの OpenShift ミラーサイト およびarm64
アーキテクチャーの OpenShift ミラーサイト にそれぞれ移動します。 - 最新の 4.16 ディレクトリーから、macOS 用 tarball の最新バージョンをダウンロードします。
以下のコマンドを実行して、
amd64
アーキテクチャー用の Operator SDK アーカイブを解凍します。$ tar xvf operator-sdk-v1.36.1-ocp-darwin-x86_64.tar.gz
以下のコマンドを実行して、
arm64
アーキテクチャー用の Operator SDK アーカイブを解凍します。$ tar xvf operator-sdk-v1.36.1-ocp-darwin-aarch64.tar.gz
次のコマンドを実行して、ファイルを実行可能にします。
$ chmod +x operator-sdk
次のコマンドを実行して、抽出した
operator-sdk
バイナリーをPATH
上のディレクトリーに移動します。ヒント次のコマンドを実行して、
PATH
を確認します。$ echo $PATH
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
検証
Operator SDK CLI をインストールしたら、次のコマンドを実行して、それが使用可能であることを確認します。
$ operator-sdk version
出力例
operator-sdk version: "v1.36.1-ocp", ...