6.2. opm CLI リファレンス
opm コマンドラインインターフェイス (CLI) は、Operator カタログを作成して保守するためのツールです。
opm CLI 構文
$ opm <command> [<subcommand>] [<argument>] [<flags>]
| フラグ | 説明 |
|---|---|
|
| バンドルまたはインデックスをプルする時に、コンテナーイメージレジストリーの TLS 証明書の検証を省略します。 |
関連する CLI コマンドを含む、SQLite ベースのカタログ形式は非推奨の機能です。非推奨の機能は依然として OpenShift Container Platform に含まれており、引き続きサポートされますが、本製品の今後のリリースで削除されるため、新規デプロイメントでの使用は推奨されません。
OpenShift Container Platform で非推奨となったか、削除された主な機能の最新の一覧については、OpenShift Container Platform リリースノートの 非推奨および削除された機能セクションを参照してください。
6.2.1. index
既存の Operator バンドルから Operator インデックスコンテナーイメージを生成します。
コマンド構文
$ opm index <subcommand> [<flags>]
| サブコマンド | 説明 |
|---|---|
|
| Operator バンドルをインデックスに追加します。 |
|
| 指定されたパッケージ以外の全パッケージのインデックスをプルーニングします。 |
|
| 特定のイメージに関連付けられていない標準バンドルのインデックスをプルーニングします。 |
|
| Operator 全体をインデックスから削除します。 |
6.2.1.1. add
Operator バンドルをインデックスに追加します。
コマンド構文
$ opm index add [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
コンテナーイメージをビルドするツール: |
|
| 追加するバンドルのコンマ区切りの一覧。 |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| 追加する以前のインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
|
チャネルグラフの更新方法を定義するグラフ更新モード: |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
|
コンテナーイメージをプルするツール: |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.1.2. prune
指定されたパッケージ以外の全パッケージのインデックスをプルーニングします。
コマンド構文
$ opm index prune [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| プルーニングするインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.1.3. prune-stranded
特定のイメージに関連付けられていない標準バンドルのインデックスをプルーニングします。
コマンド構文
$ opm index prune-stranded [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| プルーニングするインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.1.4. rm
Operator 全体をインデックスから削除します。
コマンド構文
$ opm index rm [<flags>]
| フラグ | 説明 |
|---|---|
|
|
on-image |
|
|
コンテナーイメージをビルドするツール: |
|
|
保存およびビルドなど、コンテナーイメージと対話するためのツール: |
|
| 削除する以前のインデックス。 |
|
| 有効な場合には、Dockerfile のみを作成してローカルディスクに保存します。 |
|
| 削除する Operator のコンマ区切りの一覧。 |
|
| オプション: Dockerfile を生成する場合は、ファイル名を指定します。 |
|
| 保持するパッケージのコンマ区切りリスト。 |
|
| レジストリーの読み込みエラーを許可します。 |
|
|
コンテナーイメージをプルするツール: |
|
| ビルドするコンテナーイメージのカスタムタグ。 |
6.2.2. init
olm.package 宣言型設定 blob を生成します。
コマンド構文
$ opm init <package_name> [<flags>]
| フラグ | 説明 |
|---|---|
|
| 指定されていない場合に、サブスクリプションがデフォルトで設定されるチャネル。 |
|
|
Operator の |
|
| パッケージのアイコンへのパス。 |
|
|
出力形式: |
6.2.3. render
提供されるインデックスイメージ、バンドルイメージ、および SQLite データベースファイルから宣言型の設定 Blob を生成します。
コマンド構文
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| フラグ | 説明 |
|---|---|
|
|
出力形式: |
6.2.4. validate
指定されたディレクトリーの宣言型設定 JSON ファイルを検証します。
コマンド構文
$ opm validate <directory> [<flags>]
6.2.5. serve
GRPC サーバーを介して宣言型の設定を提供します。
宣言的な config ディレクトリーは、起動時に serve コマンドで読み込まれます。このコマンド開始後に宣言型設定に加えられた変更は、提供されるコンテンツには反映されません。
コマンド構文
$ opm serve <source_path> [<flags>]
| フラグ | 説明 |
|---|---|
|
| デバッグロギングを有効にします。 |
|
|
提供するポート番号。デフォルト: |
|
|
コンテナー終了ログファイルへのパス。デフォルト: |
