6.2. opm CLI リファレンス
opm コマンドラインインターフェイス (CLI) は、Operator カタログを作成して保守するためのツールです。
opm CLI 構文
$ opm <command> [<subcommand>] [<argument>] [<flags>]
opm CLI には前方互換性がありません。カタログコンテンツの生成に使用される opm CLI のバージョンは、クラスター上でコンテンツを提供するために使用されるバージョンと同じかそれより前である必要があります。
| フラグ | 説明 |
|---|---|
|
| バンドルまたはインデックスをプルする時に、コンテナーイメージレジストリーの TLS 証明書の検証を省略します。 |
|
| バンドルをプルするときは、コンテナーイメージレジストリーにプレーン HTTP を使用します。 |
関連する CLI コマンドを含む、SQLite ベースのカタログ形式は非推奨の機能です。非推奨の機能は依然として OpenShift Dedicated に含まれており、引き続きサポートされますが、この製品の今後のリリースで削除されるため、新規デプロイメントでの使用は推奨されません。
6.2.1. generate
宣言型設定インデックスのさまざまなアーティファクトを生成します。
コマンド構文
$ opm generate <subcommand> [<flags>]
| サブコマンド | 説明 |
|---|---|
|
| 宣言型設定インデックスの Dockerfile を生成します。 |
| フラグ | 説明 |
|---|---|
|
| generate のヘルプ｡ |
6.2.1.1. dockerfile
宣言型設定インデックスの Dockerfile を生成します。
このコマンドは、インデックスの構築に使用される Dockerfile を <dcRootDir> と同じディレクトリーに作成します (<dcDirName>.Dockerfile という名前)。同じ名前の Dockerfile がすでに存在する場合、このコマンドは失敗します。
追加のラベルを指定するときに重複キーが存在する場合、各重複キーの最後の値のみが生成された Dockerfile に追加されます。
コマンド構文
$ opm generate dockerfile <dcRootDir> [<flags>]
| フラグ | 説明 |
|---|---|
|
|
カタログを作成するイメージ。デフォルト値は |
|
|
生成された Dockerfile に含める追加のラベル。ラベルの形式は |
|
| Dockerfile のヘルプ。 |
公式 Red Hat イメージを使用してビルドするには、registry.redhat.io/openshift4/ose-operator-registry:v4 値と -i フラグを使用します。
6.2.2. index
既存の Operator バンドルから SQLite データベース形式のコンテナーイメージに Operator インデックスを生成します。
OpenShift Dedicated 4.11 以降、デフォルトの Red Hat 提供の Operator カタログはファイルベースのカタログ形式でリリースされます。OpenShift Dedicated 4.6 ~ 4.10 用のデフォルトの Red Hat 提供 Operator カタログは、非推奨の SQLite データベース形式でリリースされました。
opm サブコマンド、フラグ、および SQLite データベース形式に関連する機能も非推奨となり、今後のリリースで削除されます。機能は引き続きサポートされており、非推奨の SQLite データベース形式を使用するカタログに使用する必要があります。
opm index prune などの SQLite データベース形式を使用する opm サブコマンドおよびフラグの多くは、ファイルベースのカタログ形式では機能しません。
コマンド構文
$ opm index <subcommand> [<flags>]
| サブコマンド | 説明 |
|---|---|
|
| Operator バンドルをインデックスに追加します。 |
|
| 指定されたパッケージ以外の全パッケージのインデックスをプルーニングします。 |
|
| 特定のイメージに関連付けられていない標準バンドルのインデックスをプルーニングします。 |
|
| Operator 全体をインデックスから削除します。 |
6.2.2.1. add
Operator バンドルをインデックスに追加します。
コマンド構文
$ opm index add [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
コンテナーイメージをビルドするツール: |
|
| 追加するバンドルのコンマ区切りのリスト。 |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| 追加する以前のインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
|
チャネルグラフの更新方法を定義するグラフ更新モード: |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
|
コンテナーイメージをプルするツール: |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.2.2. prune
指定されたパッケージ以外の全パッケージのインデックスをプルーニングします。
コマンド構文
$ opm index prune [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| プルーニングするインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.2.3. prune-stranded
特定のイメージに関連付けられていない標準バンドルのインデックスをプルーニングします。
コマンド構文
$ opm index prune-stranded [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| プルーニングするインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.2.4. rm
Operator 全体をインデックスから削除します。
コマンド構文
$ opm index rm [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
コンテナーイメージをビルドするツール: |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| 削除する以前のインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| 削除する Operator のコンマ区切りのリスト。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
|
コンテナーイメージをプルするツール: |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.3. init
olm.package 宣言型設定 blob を生成します。
コマンド構文
$ opm init <package_name> [<flags>]
| フラグ | 説明 |
|---|---|
|
| 指定されていない場合に、サブスクリプションがデフォルトで設定されるチャネル。 |
|
|
Operator の |
|
| パッケージのアイコンへのパス。 |
|
|
出力形式: |
6.2.4. migrate
SQLite データベース形式のインデックスイメージまたはデータベースファイルをファイルベースのカタログに移行します。
関連する CLI コマンドを含む、SQLite ベースのカタログ形式は非推奨の機能です。非推奨の機能は依然として OpenShift Dedicated に含まれており、引き続きサポートされますが、この製品の今後のリリースで削除されるため、新規デプロイメントでの使用は推奨されません。
コマンド構文
$ opm migrate <index_ref> <output_dir> [<flags>]
| フラグ | 説明 |
|---|---|
|
|
出力形式: |
6.2.5. render
提供されるインデックスイメージ、バンドルイメージ、および SQLite データベースファイルから宣言型の設定 Blob を生成します。
コマンド構文
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| フラグ | 説明 |
|---|---|
|
|
出力形式: |
6.2.6. serve
GRPC サーバーを介して宣言型の設定を提供します。
宣言的な config ディレクトリーは、起動時に serve コマンドで読み込まれます。このコマンド開始後に宣言型設定に加えられた変更は、提供されるコンテンツには反映されません。
コマンド構文
$ opm serve <source_path> [<flags>]
| フラグ | 説明 |
|---|---|
|
| このフラグが設定されている場合、サーバーキャッシュディレクトリーを同期して永続化します。 |
|
|
キャッシュが存在しないか無効化されている場合、エラーで終了します。 |
|
| サービスキャッシュを同期し、サービスを提供せずに終了します。 |
|
| デバッグロギングを有効にします。 |
|
| serve のヘルプ｡ |
|
|
サービスのポート番号。デフォルト値は |
|
|
起動プロファイリングエンドポイントのアドレス。形式は |
|
|
コンテナー終了ログファイルへのパス。デフォルト値は |
6.2.7. validate
指定されたディレクトリーの宣言型設定 JSON ファイルを検証します。
コマンド構文
$ opm validate <directory> [<flags>]
