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