オペレーター・ユーティリティの概要

オペレータ ユーティリティは、オペレータのインストール、アンインストール、およびイメージ ミラーリング プロセスを管理するツールを提供するコマンドライン スクリプトです。

このユーティリティは、 IBM® Sterling Order Management System Operator、 IBM Sterling Intelligent Promising Operator、 IBM OMS Gateway Operator. IBM のレジストリやカスタムレジストリからイメージを取得し、ミラーリングするなどの作業を自動化します。 このスクリプトは、インストールとアンインストールのプロセスを合理化し、オンラインとエアギャップ（オフライン）の両方の環境をサポートします。

機能

  • 旧バージョンのロールバックをオプションでサポートするオペレータをインストールします。
  • 特定のネームスペースからオペレータをアンインストールします。
  • IBM Sterling Order Management System Operator、 IBM Sterling Intelligent Promising Operator、 IBM OMS Gateway Operator の上位バージョンにアップグレードする。 このスクリプトは、アップグレードを進める前に、まずアップグレードのパスが正しいかどうかを検証します。
  • 必要に応じて、Operatorイメージとアプリケーションイメージの両方を含むイメージをターゲットレジストリにミラーリングします。

台本の有無

IBM Sterling Intelligent Promising 用の Operator インストールスクリプトは、最新のケースで利用可能であり、以下のリポジトリからダウンロードできます。 このケースおよび対応するオペレーターのバージョンに関する詳細については、 「オンプレミス コンテナ機能の強化に関する新機能」 を参照してください。

使用可能なコマンド

Operator インストールスクリプトには、 install、 uninstall、 mirror-images の 3 つのコマンドがあります。
注記： オペレーターは現在、 amd64 アーキテクチャ上の Linux オペレーティングシステムのみをサポートしています。 したがって、以下のコマンドは linux_amd64 を使用する。
install コマンド (command)
install コマンドを使用して、環境に Operator を展開します。 IBM のレジストリとカスタムレジストリの両方をサポートしています。 デフォルトでは、スクリプトは IBM、デプロイメントに icr.io 。 インストールプロセス中に何らかの問題が発生した場合、スクリプトは自動的に以前の変更を元に戻し、システムの整合性を維持します。 Operator Utilityを使用する際は、以下のパラメータを確認してください。
  • 画像登録
    • デフォルトでは、イメージは icr.io にある IBM のレジストリから取得される。
    • カスタムレジストリの場合は、レジストリおよびリポジトリの詳細と認証情報を指定します。 カスタムレジストリが認証を持っていない場合、認証情報は無視される。
    • カ ス タ ムレジ ス ト リ を使用す る と、 skip-mirror-images オプシ ョ ンが設定 さ れていない限 り、 ス ク リ プ ト は自動的に画像を ミ ラ ーシ ョ ン し ます。
  • 設置の背景
    • スクリプトが抽出されたケース内で実行されると、ケースのメタデータからバージョンとエディションが自動的に判断され、展開に使用されます。
    • ケース内部ではなく、解凍またはアーカイブされたケース・ファイルが作業ディレク トリに存在する場合、スクリプトはそれを使用する。
    • ローカルのケースが見つからない場合、スクリプトは IBM リポジトリから必要なファイルをダウンロードしようとする。
    • インターネットにアクセスできないエアギャップ環境では、ローカルのケースファイルが存在しなければ、インストールに失敗します。
  • インストール名前空間
    • --namespace オプションを使用してネームスペースが指定されている場合、オペレー ターはそのネームスペースにインストールされます。
    • 名前空間が指定されていない場合、スクリプトのデフォルトは現在の Kubernetes コンテキストの名前空間になります。
  • 製品別エディション
    • IBM Sterling Intelligent Promising Operatorと IBM OMS Gateway Operator はEnterpriseエディションでのみ利用可能なため、エディションは必要ありません。 したがって、これら2つの演算子では、 --edition オプションは無視される。
  • ロールバックとアップグレード
    • 新しいバージョンにアップグレードするには、インストール時に必要なケースのバージョンを指定してください。
    • このスクリプトは、 IBM Sterling Order Management System の以前のバージョンへのロールバックをサポートしています。
    • ロールバックアクションを実行するには、ユーザーの確認が必要です。
    • 本番環境にデプロイする前に、より低い環境でインストールをテストすることをお勧めします。
      注意 IBM Sterling Intelligent Promising および IBM OMS Gateway Operator は、特定のバージョンへのロールバックをサポートしていません。 上位バージョンへのアップグレードはサポートされている。
install 使用
op_util_linux_amd64 install [Options]
install オプション
--case-version VERSION
そのバージョンである。 スクリプトが抽出された症例内で実行される場合、または抽出された症例やアーカ イブされた症例がカレントディレクトリに存在する場合は、省略可能です。
--edition EDITION
IBM Sterling Intelligent Promising Operator および IBM OMS Gateway Operator は Enterprise エディションでのみ利用可能なため、このオプションは無視されます。
--registry レジストリー
これはカスタムイメージレジストリで、デフォルトは icr.io （ IBM Entitled Registry）です。
--repository REPO
これはカスタムイメージリポジトリで、デフォルトは cpopen。
--registry-user ユーザー
レジストリのユーザー名である。 カスタムレジストリの場合は必須で、提供されない場合はプロンプトが表示される。
--registry-pass 合格
レジストリのパスワードである。 カスタムレジストリの場合は必須で、提供されない場合はプロンプトが表示される。
--namespace NAMESPACE
これは、オペレータがインストールされる Kubernetes 名前空間です。 デフォルトは現在の Kubernetes コンテキストの名前空間である。
--skip-mirror-images
このオプションは、ターゲット・レジストリにすでに利用可能なイメージがある場合、イメージのミラーリングをスキップします。 自動ミラーリングをバイパスするには、これを true に設定する。 デフォルトは false です。
--force
このオプションは、新しいバージョンがすでにインストールされている場合でも、古いバージョンのインストールやロールバックを可能にする。 続行する前にユーザーの確認が必要。 デフォルトはfalseです。
インストール例
  • 例 3: IBM Sterling Intelligent Promising オペレータを特定のケースバージョンでインストールする
    op_util_linux_amd64 install sip --case-version 3.0.25
  • 例4: IBM OMS Gateway Operator を特定のケースバージョンでインストールする。
    op_util_linux_amd64 install oms-gateway --case-version 3.0.25
インストール手順の詳細については、 「 Operator Lifecycle Manager を使用しないオペレーターのインストール」 を参照してください。
uninstall コマンド (command)
uninstall コマンドは、ターゲット Kubernetes 環境から指定された Operator を削除します。 このスクリプトは、指定された名前空間内のすべての関連リソースをきれいに削除する。
uninstall 使用
op_util_linux_amd64 uninstall [Options]
uninstall オプション
--namespace NAMESPACE
オペレータをアンインストールする Kubernetes 名前空間を指定します。 デフォルトは現在の Kubernetes コンテキストの名前空間である。
--force
依存関係が存在する場合でも、オペレータのアンインストールを強制する場合に指定します。 したがって、このオプションの使用には注意が必要である。
uninstall 例
  • 例 1： IBM Sterling Order Management System オペレータを現在のネームスペースからアンインストールする
    op_util_linux_amd64 uninstall sip
  • 例 2 : 特定のネームスペースから IBM Sterling Intelligent Promising オペレータをアンインストールする
    op_util_linux_amd64 uninstall sip --namespace custom-namespace
mirror-images コマンド (command)
mirror-images コマンドは、 icr.io である IBM 名のレジストリから、カスタムターゲットレジストリに Operator イメージをコピーします。 このコマンドは、インターネットへのアクセスが制限されている環境や、プライベートなレジストリがある環境でも、必要なイメージが利用できるようにする。 install モードと同様に、ケース内でスクリプトが実行されているか、カレント・ディレクト リにケースが存在する場合、ケースのバージョンとエディションは省略可能である。

デフォルトでは、スクリプトはOperatorイメージのみをミラーリングします。 この動作をオーバーライドするには、 --include-app-images オプションを指定して、すべてのアプリケーション・イメージをミラーリングします。 このオプションを渡すと、 icr.io からアプリケーション・イメージを引き出すための認証情報を提供する必要があります。

mirror-images 使用
op_util_linux_amd64 mirror-images [Options]
mirror-images オプション

mirror-images オプションを以下のリストに従って定義する。

--case-version VERSION
ケースのバージョンを指定する。 スクリプトが抽出された症例内で実行される場合、または抽出された症例やアーカ イブされた症例がカレントディレクトリに存在する場合は、省略可能です。
--edition EDITION
このオプションは IBM Sterling Intelligent Promising と IBM OMS Gateway Operator では無視されます。
--src-registry-user ユーザー
IBM エンタイトルメント・レジストリのユーザーを指定する。
--src-registry-pass 合格
IBM エンタイトルメント・レジストリのパスワードを指定する。
--tgt-registry レジストリー
カスタム・ターゲット・レジストリを指定する。
--tgt-repository REPO
カスタムターゲットリポジトリの指定
--tgt-registry-user ユーザー
カスタム・ターゲット・レジストリのユーザー名を指定する。
--tgt-registry-pass 合格
カスタムターゲットレジストリのパスワードを指定する。
--include-app-images
アプリケーション・イメージをミラーリング処理に含めるには、このオプションを指定します。 デフォルトはfalseです。
ミラーイメージの例
  • 例 1： icr.io である IBM エンタイトルメントレジストリからターゲットレジストリへの Enterprise ケース 3.0.25 の Operator イメージをミラーリングする。 my.registry.com
    op_util_linux_amd64 mirror-images \
        --case-version 3.0.25 \
        --edition ent \
        --tgt-registry my.registry.com \
        --tgt-repository sip \
        --tgt-registry-user sipuser
  • 例 2： IBM のエンタイトルメントレジストリから icr.io のターゲットレジストリ my.registry.com に、プロフェッショナルケース 3.0.25 のオペレーターとアプリケーションイメージをミラーリングする。 --include-app-images オプションを渡す場合は、 --src-registry-user と --src-registry-pass を指定しなければならない。
    op_util_linux_amd64 mirror-images \
      --case-version 3.0.25 \
      --edition ent \
      --tgt-registry my.registry.com \
      --tgt-repository sip \
      --tgt-registry-user sipuser \
      --src-registry-user iamapikey \
      --src-registry-pass <my-api-key> \
      --include-app-images

OLM から OLM 以外のインストールへの移行

OLM、または OLM を使用しないインストールを選択できますが、一度選択したら同じ方法を使用し続けなければなりません。

Operator Utilityスクリプトを使用して、既存の OLM 管理環境を OLM 以外のインストール環境へ移行する方法については、 「 OLM から OLM 以外のインストール環境への移行」 を参照してください。