第2章 Cluster Samples Operator の設定
Cluster Samples Operator を設定することで、openshift 名前空間内の Red Hat Enterprise Linux (RHEL) ベースの OpenShift Container Platform イメージストリームとテンプレートのインストールおよび更新を管理できます。
Cluster Samples Operator は非推奨になりました。Cluster Samples Operator には、新しいテンプレート、サンプル、または非 Source-to-Image (非 S2I) イメージストリームは追加されません。ただし今後のリリースで Cluster Samples Operator が削除されるまで、既存の S2I ビルダーイメージストリームとテンプレートは引き続き更新されます。S2I イメージストリームとテンプレートには、次のものが含まれます。
- Ruby
- Python
- Node.js
- Perl
- PHP
- HTTPD
- Nginx
- EAP
- Java
- Webserver
- .NET
- Go
Cluster Samples Operator は、非 S2I サンプル (イメージストリームとテンプレート) の管理とサポートを停止します。要件や将来の計画は、イメージストリームまたはテンプレートの所有者に問い合わせてください。また、次のリンクも参照してください。
2.1. Cluster Samples Operator について リンクのコピーリンクがクリップボードにコピーされました!
Operator はインストール時に独自にデフォルト設定オブジェクトを作成し、その後にクイックスタートテンプレートを含む、サンプルのイメージストリームおよびテンプレートを作成します。
認証情報を必要とする他のレジストリーからのイメージストリームのインポートを容易にするには、クラスター管理者は、イメージのインポートに必要な Docker config.json ファイルの内容を含む追加のシークレットを openshift namespace に作成できます。
Cluster Samples Operator の設定は、クラスター全体のリソースです。この Operator は、openshift-cluster-samples-operator namespace にデプロイされます。
Cluster Samples Operator のイメージには、関連付けられている OpenShift Container Platform リリースのイメージストリームとテンプレート定義が含まれています。各サンプルが作成または更新されると、Cluster Samples Operator には OpenShift Container Platform のバージョンを示すアノテーションが含まれます。Operator はこのアノテーションを使用して、各サンプルをリリースバージョンに一致させるようにします。このインベントリーの外にあるサンプルは省略されるサンプルであるために無視されます。バージョンのアノテーションが変更または削除されると、Operator が管理するサンプルに変更が加えてもそれらの変更は自動的に元に戻されます。
Jenkins イメージはインストールからのイメージペイロードの一部であり、イメージストリームに直接タグ付けされます。
Cluster Samples Operator 設定リソースには、削除時に以下を消去するファイナライザーが含まれます。
- Operator 管理のイメージストリーム
- Operator 管理のテンプレート
- Operator が生成する設定リソース
- クラスターステータスのリソース
サンプルリソースが削除されると、Cluster Samples Operator はデフォルト設定を使用してリソースを再作成します。
インストール中に Cluster Samples Operator が削除された場合は、別のレジストリーで Cluster Samples Operator を使用することで、コンテンツをインポートできるようになります。その後、Cluster Samples Operator を Managed に設定してサンプルを取得できます。手順については、代替レジストリーでの Cluster Samples Operator の使用を参照してください。
認証情報の詳細は、「イメージプルシークレットの使用」を参照してください。
2.2. Cluster Samples Operator による管理状態の使用 リンクのコピーリンクがクリップボードにコピーされました!
Cluster Samples Operator はデフォルトで Managed としてブートストラップされるか、グローバルプロキシーが設定されている場合にブートストラップされます。
Managed 状態では、レジストリーからサンプルイメージストリームとイメージをプルし、必要なサンプルテンプレートがインストールされた状態になるように、Cluster Samples Operator がリソースを積極的に管理し、コンポーネントをアクティブな状態に維持します。
次のような特定の状況では、Cluster Samples Operator が Removed 状態でブートストラップされます。
- クリーンインストール後の最初の起動時に、Cluster Samples Operator が 3 分経過してもレジストリーにアクセスできない場合。
- Cluster Samples Operator が IPv6 ネットワーク上にあることが Operator 自身によって検出された場合。
-
イメージコントローラーの設定パラメーターにより、デフォルトのイメージレジストリーまたは
samplesRegistry設定で指定されたイメージレジストリーを使用してイメージストリームを作成できない場合。詳細は、"Image controller configuration parameters" および "Cluster Samples Operator configuration parameters" を参照してください。
OpenShift Container Platform の場合、デフォルトのイメージレジストリーは registry.redhat.io です。
ただし、Cluster Samples Operator が IPv6 ネットワーク上にあることが検出され、かつ OpenShift Container Platform グローバルプロキシーが設定されている場合は、IPv6 チェックがすべてのチェックよりも優先されます。その結果、Cluster Samples Operator はそれ自体を Removed としてブートストラップします。
現在、IPv6 インストールはレジストリーによってサポートされていません。Cluster Samples Operator は、ほとんどのサンプルイメージストリームとイメージをレジストリーからプルします。
2.2.1. ネットワークが制限されたインストール リンクのコピーリンクがクリップボードにコピーされました!
Cluster Samples Operator は、registry.redhat.io にアクセスできない場合に Removed としてブートストラップされます。これは、ネットワークの制限がすでに設定されている際にネットワークが制限されたインストールを容易にします。
クラスター管理者は、Operator がブートストラップされる際にサンプルが必要かどうかを判別する時間をさらに確保でき ます。管理状態が Removed の場合、サンプルイメージストリームのインポートが失敗しているというアラートが Cluster Samples Operator によって送信されないためです。Cluster Samples Operator の管理状態が Managed であり、Operator がサンプルイメージストリームをインストールしようとすると、最初のインストールから 2 時間後にインポート失敗のアラートが起動します。
2.2.2. 初期のネットワークアクセスが設定された状態でのネットワークが制限されたインストール リンクのコピーリンクがクリップボードにコピーされました!
最終的に制限されたネットワーク上で運用されるクラスターであっても、初期インストール時にネットワークアクセスが存在する場合、Cluster Samples Operator は registry.redhat.io からコンテンツをインストールします。
この場合、接続環境におけるインストールのデフォルト設定である Managed をオーバーライドすることで、必要なサンプルを判断するまで、サンプルのインストールを延期することができます。
インストール時にはネットワークアクセスがある環境で Cluster Samples Operator を Removed 管理状態でブートストラップする場合は、次の手順を使用して Cluster Samples Operator のデフォルト設定をオーバーライドしてください。
制限された環境でサンプルをホストするには、次の手順を使用してください。
また、openshift-install create manifest プロセスによって作成された openshift ディレクトリーに、次の追加の YAML ファイルを配置する必要があります。
managementState: Removed が設定された Cluster Samples Operator YAML ファイルのサンプル
apiVersion: samples.operator.openshift.io/v1
kind: Config
metadata:
name: cluster
spec:
architectures:
- x86_64
managementState: Removed
2.3. Cluster Samples Operator によるイメージストリームインポートの追跡およびエラー回復 リンクのコピーリンクがクリップボードにコピーされました!
サンプルイメージストリームの作成または更新後に、Cluster Samples Operator はそれぞれのイメージストリームタグのイメージインポートの進捗をモニターします。
インポートが失敗した場合、Cluster Samples Operator は、次のいずれかが発生するまで、約 15 分ごとにイメージストリームイメージインポート API を介してインポートを再試行します。
- インポートが成功する。
-
Cluster Samples Operator 設定が変更され、イメージストリームが
skippedImagestreamsリストに追加されるか、管理状態がRemovedに変更される。
2.3.1. ミラーリングの Cluster Samples Operator のサポート リンクのコピーリンクがクリップボードにコピーされました!
インストール中に、OpenShift Container Platform は、openshift-cluster-samples-operator namespace に imagestreamtag-to-image という名前の config map を作成します。
imagestreamtag-to-image config map には、各イメージストリームタグのエントリー (入力されるイメージ) が含まれています。
この config map に含まれるデータフィールドの各エントリーのキーは、<image_stream_name>_<image_stream_tag_name> という形式です。
OpenShift Container Platform の非接続インストール時に、Cluster Samples Operator のステータスは Removed に設定されます。これを Managed に変更することを選択した場合、サンプルがインストールされます。
ネットワークが制限されている環境や非接続環境でサンプルを使用するには、ネットワーク外部のサービスにアクセスする必要がある場合があります。サービスの例には、Github、Maven Central、npm、RubyGems、PyPi などがあります。場合によっては、Cluster Samples Operator オブジェクトが必要なサービスに到達できるようにするために、追加の手順を実行する必要があります。
イメージストリームによるインポート用に、どのイメージをミラーリングする必要があるかを判断する際には、次の原則を使用してください。
-
Cluster Samples Operator が
Removedに設定される場合、ミラーリングされたレジストリーを作成するか、使用する必要のある既存のミラーリングされたレジストリーを判別できます。 - 新しい config map をガイドとして使用し、ミラーリングされたレジストリーに必要なサンプルをミラーリングします。
-
Cluster Samples Operator 設定オブジェクトの
skippedImagestreamsリストに、ミラーリングされていないイメージストリームを追加します。 -
Cluster Samples Operator 設定オブジェクトの
samplesRegistryをミラーリングされたレジストリーに設定します。 -
次に、Cluster Samples Operator を
Managedに設定し、ミラーリングしたイメージストリームをインストールします。
2.4. Cluster Samples Operator の設定パラメーター リンクのコピーリンクがクリップボードにコピーされました!
サンプルリソースは以下の設定フィールドを提供します。
| パラメーター | 説明 |
|---|---|
|
|
|
|
|
イメージコンテンツについてイメージストリームがアクセスするレジストリーを指定できます。 注記
RHEL コンテンツの作成または更新は、
RHEL コンテンツの作成または更新は、 |
|
| アーキテクチャーのタイプを選択するためのプレースホルダー。 |
|
|
Cluster Samples Operator のインベントリーにあるものの、クラスター管理者が Operator に無視させるか、管理させないようにするイメージストリーム。このパラメーターにイメージストリーム名のリストを追加できます。例: |
|
| Cluster Samples Operator のインベントリーにあるものの、クラスター管理者が Operator に無視させるか、管理させないようにするテンプレート。 |
シークレット、イメージストリーム、およびテンプレート監視イベントは、初期サンプルリソースオブジェクトの作成前に追加することができ、Cluster Samples Operator はイベントを検出し、再度キューに入れます。
2.4.1. 設定の制限 リンクのコピーリンクがクリップボードにコピーされました!
Cluster Samples Operator が複数のアーキテクチャーのサポートを開始すると、Operator が Managed 状態にある間はアーキテクチャーのリストを変更できなくなります。
アーキテクチャーの値を変更するために、クラスター管理者は以下を実行する必要があります。
-
Management StateにRemovedのマークを付け、変更を保存します。 -
その後の変更では、アーキテクチャーを編集し、
Management StateをManagedに戻します。
Cluster Samples Operator は Removed 状態の場合に依然としてシークレットを処理します。Removed に切り替える前にシークレットを作成でき、Managed に切り替える前の Removed 状態で、または Managed 状態に切り替えた後にシークレットを作成できます。Managed に切り替えた後にシークレットを作成すると、シークレットイベントが処理されるまでの間、サンプルの作成に遅延が発生します。この仕組みは、レジストリーの変更作業を容易にするものであり、レジストリーを切り替える前にすべてのサンプルを削除し、まっさらな状態を確保する場合に役立ちます。切り替え前にすべてのサンプルを削除する必要はありません。
2.4.2. サンプルリソースの条件 リンクのコピーリンクがクリップボードにコピーされました!
サンプルリソースには以下の条件とそのステータスが適用されます。
| 条件 | 説明 |
|---|---|
|
|
サンプルが |
|
|
これは OpenShift Container Platform では非推奨にされています。 |
|
|
前述の制限された変更のいずれかが送信されるかどうかに応じて |
|
|
|
|
| イメージストリームのタグのいずれかについて、イメージストリームでイメージインポートフェーズにエラーがあったことを示すインジケーター。
|
|
|
バージョンが現在のサンプルセットのインストールに使用した Cluster Samples Operator のバージョンと異なることを Cluster Samples Operator が検出した場合、 これは OpenShift Container Platform では非推奨にされています。 |
2.5. Cluster Samples Operator 設定へのアクセス リンクのコピーリンクがクリップボードにコピーされました!
Cluster Samples Operator は、提供されるパラメーターでファイルを編集して設定できます。
前提条件
-
OpenShift CLI (
oc) がインストールされている。
手順
次のコマンドを実行して、Cluster Samples Operator 設定にアクセスします。
$ oc edit configs.samples.operator.openshift.io/clusterCluster Samples Operator 設定は以下の例のようになります。
apiVersion: samples.operator.openshift.io/v1 kind: Config # ...
2.6. Cluster Samples Operator から非推奨のイメージストリームタグを削除する リンクのコピーリンクがクリップボードにコピーされました!
Cluster Samples Operator は、ユーザーが非推奨のイメージストリームタグを使用するデプロイメントを持っている可能性があるため、非推奨のイメージストリームタグをイメージストリームに残します。
oc tag コマンドでイメージストリームを編集して、非推奨のイメージストリームタグを削除できます。
サンプルプロバイダーがイメージストリームから削除した非推奨のイメージストリームタグは初期インストールに含まれません。
前提条件
-
OpenShift CLI (
oc) がインストールされている。
手順
次の
oc tagコマンドを使用してイメージストリームを編集し、非推奨のイメージストリームタグを削除します。$ oc tag -d <image_stream_name:tag>出力例
Deleted tag default/<image_stream_name:tag>.