1.2. CheCluster Custom Resource フィールドの参照
このセクションでは、CheCluster カスタムリソースのカスタマイズに使用できるすべての フィールド
について説明します。
-
例1.2「CheCluster カスタム
リソース
の最小例。」 -
表1.3「CodeReady Workspaces インストールによって使用される認証に関連する CheCluster
カスタム
リソース認証設定
」 -
表1.2「CodeReady Workspaces によって使用されるデータベースに関連する CheCluster カスタムリソースデータベース
設定
」
-
表1.1「CodeReady
Workspaces
サーバー
コンポーネントに関連する CheCluster カスタムリソースサーバー設定。」 -
表1.4「CodeReady Workspaces によって使用される永続ストレージに関連する CheCluster カスタムリソースストレージ
設定
」
-
表1.5「OpenShift での CodeReady Workspaces インストールに固有する CheCluster
カスタム
リソースk8s
設定」 -
表1.6「
CheCluster
カスタムリソースのステータス
は、CodeReady Workspaces インストールの状態を定義します。」
例1.2 CheCluster カスタム リソース
の最小例。
apiVersion: org.eclipse.che/v1 kind: CheCluster metadata: name: codeready-workspaces spec: auth: externalIdentityProvider: false database: externalDb: false server: selfSignedCert: false gitSelfSignedCert: false tlsSupport: true storage: pvcStrategy: 'common' pvcClaimSize: '1Gi'
表1.1 CodeReadyWorkspaces
サーバー
コンポーネントに関連する CheCluster カスタムリソースサーバー設定。
property | デフォルト値 | description |
---|---|---|
| omit | イメージをプルする代替コンテナーレジストリーへのオプションのホスト名または URL。この値は、CodeReady Workspaces デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されたコンテナーレジストリーのホスト名を上書きします。これは、特に CodeReady Workspaces を空欄環境でインストールする場合に便利です。 |
| omit | イメージをプルする代替コンテナーレジストリーのオプションのリポジトリー名。この値は、CodeReady Workspaces デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されたコンテナーレジストリー組織を上書きします。これは、特に CodeReady Workspaces を空欄環境でインストールする場合に便利です。 |
|
| CodeReady Workspaces サーバーのデバッグモードを有効にします。 |
|
| インストールのフレーバー。 |
| Operator は値を自動的に設定します。 | インストールされた CodeReady Workspaces サーバーのパブリックホスト名。 |
|
| CodeReady Workspaces デプロイメントで使用されるイメージプルポリシーを上書きします。 |
| omit | CodeReady Workspaces デプロイメントで使用されるコンテナーイメージのタグを上書きします。これを省略するか、または空のままにして、Operator によって提供されるデフォルトのイメージタグを使用します。 |
| omit | CodeReady Workspaces デプロイメントで使用されるコンテナーイメージを上書きします。これにはコンテナーイメージタグが含まれません。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。 |
|
|
CodeReady Workspaces サーバーのログレベル: |
| omit | CodeReady Workspaces ワークスペースのユーザーにバインドされるカスタムクラスターロール。デフォルトのロールを使用するには、空のままにするか、空のままにします。 |
| omit |
CodeReady Workspaces サーバーで使用される生成された |
| omit | Devfile レジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。 |
|
| Devfile レジストリーのデプロイメントで使用されるメモリー制限を上書きします。 |
|
| Devfile レジストリーのデプロイメントで使用されるメモリー要求を上書きします。 |
|
| Devfile レジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。 |
| Operator は値を自動的に設定します。 |
サンプルの ready-to-use devfile を提供する Devfile レジストリーのパブリック URL。外部 devfile レジストリーを使用する場合はこれを設定します(externalDevfileRegistry フィールドを参照 |
|
|
Operator が専用の Devfile レジストリーサーバーをデプロイするよう指示します。デフォルトでは、専用の devfile レジストリーサーバーが開始されます。externalDevfileRegistry が |
|
|
Operator が専用のプラグインレジストリーサーバーをデプロイするよう指示します。デフォルトでは、専用プラグインレジストリーサーバーが起動しています。externalPluginRegistry が |
| omit |
設定されたプロキシーを使用しないホストの一覧。| |
| omit | プラグインレジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。 |
|
| プラグインレジストリーのデプロイメントで使用されるメモリー制限を上書きします。 |
|
| プラグインレジストリーのデプロイメントで使用されるメモリー要求を上書きします。 |
|
| プラグインレジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。 |
| Operator は値を自動的に設定します。 |
ready-to-use の devfile のサンプルを提供するプラグインレジストリーのパブリック URL。外部 devfile レジストリーを使用する場合にのみ設定します(externalPluginRegistry フィールドを参照 |
| omit | プロキシーサーバーのパスワード。プロキシー設定が必要な場合にのみ使用します。 |
| omit |
プロキシーサーバーのポート。プロキシーの設定時のみ使用します(proxyURL フィールドも参照し |
| omit |
プロキシーサーバーの URL(protocol+host name)。これにより、CodeReady Workspaces サーバーおよびワークスペースコンテナーの |
| omit |
プロキシーサーバーのユーザー名。プロキシーの設定時のみ使用します(proxyURL フィールドも参照し |
|
|
自己署名証明書を使用するルーターで OpenShift クラスターのサポートを有効にします。これを有効にすると、Operator は OpenShift ルートのデフォルトの自己署名証明書を取得し、CodeReady Workspaces サーバーの Java トラストストアに追加します。ルートの有効な証明書で設定されていないデモ OpenShift クラスターで tlsSupport |
|
| CodeReady Workspaces サーバーデプロイメントで使用されるメモリー制限を上書きします。 |
|
| CodeReady Workspaces サーバーデプロイメントで使用されるメモリー要求を上書きします。 |
|
|
Operator が TLS モードで CodeReady Workspaces をデプロイするよう指示します。TLS を有効にするには、selfSignedCert フィールドを有効に |
表1.2 CodeReady Workspaces によって使用されるデータベースに関連する CheCluster カスタムリソースデータベース設定
property | デフォルト値 | description |
---|---|---|
|
| CodeReady Workspaces サーバーがデータベースへの接続に使用するpostgresql データベース名。 |
| Operator は値を自動的に設定します。 |
CodeReady Workspaces サーバーが接続先に使用する postgresql データベースのホスト名。デフォルトは |
| 自動生成される値 | CodeReady Workspaces サーバーがデータベースへの接続に使用する postgresql パスワード。 |
|
|
CodeReady Workspaces サーバーが接続に使用する postgresql データベースポート。外部データベースを使用する場合のみ、この値を上書きします(externalDb フィールド |
|
| CodeReady Workspaces サーバーがデータベースへの接続に使用するpostgresql ユーザー。 |
|
|
Operator が専用のデータベースをデプロイするよう指示します。デフォルトでは、専用の PostgreSQL データベースは CodeReady Workspaces インストールの一部としてデプロイされます。 |
|
always: | PostgreSQL データベースのデプロイメントで使用されるイメージプルポリシーを上書きします。 |
| omit | PostgreSQL データベースのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。 |
表1.3 CodeReady Workspaces インストールによって使用される認証に関連する CheClusterカスタム
リソース認証 設定
property | デフォルト値 | description |
---|---|---|
|
|
デフォルトでは、CodeReady Workspaces インストールの一環として、専用の Identity Provider サーバーがデプロイされます。ただし、 |
|
| Identity Provider の管理者ユーザーを上書きします。 |
| omit |
CodeReady Workspaces に使用する必要があるアイデンティティープロバイダー(Keycloak / RH SSO) |
|
| Identity Provider(Keycloak / RH SSO)デプロイメントで使用されるイメージプルポリシーを上書きします。 |
| omit | Identity Provider(Keycloak / RH SSO)デプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。 |
| omit |
Keycloak 管理ユーザーのパスワードを上書きします。外部アイデンティティープロバイダーを使用する場合のみ上書きします(externalIdentityProvider フィールドを参照 |
| Operator は値を自動的に設定します。 |
データベースに接続するための ID プロバイダー(Keycloak / RH SSO)のパスワードこれは、外部のアイデンティティープロバイダーを使用する場合に ONLY をオーバーライドするのに便利です(externalIdentityProvider フィールドを参照 |
| omit |
アイデンティティープロバイダー(Keycloak / RH SSO)レルムの名前。外部アイデンティティープロバイダーを使用する場合のみ上書きします(externalIdentityProvider フィールドを参照 |
| Operator は値を自動的に設定します。 |
Operator は専用のアイデンティティープロバイダー(Keycloak または RH SSO インスタンス)をデプロイするよう指示します。Identity Provider サーバーのパブリック URL(Keycloak / RH SSO サーバー)。外部アイデンティティープロバイダーを使用する場合のみ設定します(externalIdentityProvider フィールド |
| Operator は値を自動的に設定します。 |
OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift |
| Operator は値を自動的に設定します。 |
OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift |
|
OpenShift での |
アイデンティティープロバイダー(Keycloak / RHSSO)と OpenShift OAuth の統合を有効にします。これにより、ユーザーは OpenShift ログインとログインでき、独自の OpenShift プロジェクトでワークスペースを作成できます。 |
|
|
デフォルトの |
表1.4 CodeReady Workspaces によって使用される永続ストレージに関連する CheCluster カスタムリソースストレージ設定
property | デフォルト値 | description |
---|---|---|
| omit | PostgreSQL データベース専用の Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラス。デフォルトのストレージクラスを使用するには、省略するか、空のままにします。 |
|
| CodeReady Workspaces サーバーに特別な Pod を起動し、永続ボリュームのサブパスを事前作成するよう指示します。K8S クラスターの設定に応じて有効にします。 |
|
| ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のサイズ。 |
| omit |
永続ボリュームにサブパスを作成するために使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。preCreateSubPaths フィールドも参照 |
|
|
利用可能なオプション: 'common'(すべてのワークスペース PVC を 1 つのボリュームに)、ワークス |
| omit | CodeReady Workspaces ワークスペース専用の Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラス。デフォルトのストレージクラスを使用するには、空のままにするか、空のままにします。 |
表1.5 OpenShift での CodeReady Workspaces インストールに固有する CheClusterカスタム
リソース k8s
設定
property | デフォルト値 | description |
---|---|---|
|
| Ingress クラス。どのコントローラーが Ingress を管理するかを定義します。 |
| omit |
K8S クラスターのグローバル Ingress ドメイン。このフィールドは明示的に指定する必要があります。これにより、CodeReady Workspaces 関連の Ingress の |
|
|
Ingress 作成のストラテジー。これは、 |
|
| fsGroup CodeReady Workspaces Pod および Workspace Pod コンテナーが実行される。 |
|
| CodeReady Workspaces Pod および Workspace Pod コンテナーが実行されるユーザーの ID。 |
| omit |
TLS が有効な場合に Ingress TLS 終端を設定するために使用されるシークレットの名前。tlsSupport フィールドも参照 |
表1.6 CheCluster
カスタムリソースの ステータス
は、CodeReady Workspaces インストールの状態を定義します。
property | description |
---|---|
|
CodeReady Workspaces インストールのステータス。 |
| CodeReady Workspaces サーバーのパブリック URL。 |
| CodeReady Workspaces バージョンが現在インストールされています。 |
| PostgreSQL インスタンスが正しくプロビジョニングされたかどうかを示します。 |
| Devfile レジストリーへのパブリック URL。 |
| 現在の Operator ステータスに関連するヘルプを検索する場所の URL。 |
| Identity Provider インスタンス(Keycloak / RH SSO)がレルム、クライアント、およびユーザーでプロビジョニングされているかどうかを示します。 |
| Identity Provider サーバーへのパブリック URL(Keycloak / RH SSO) |
| Pod がこの状態にある理由を示す、人間が判読できるメッセージ。 |
| アイデンティティープロバイダーインスタンス(Keycloak / RH SSO)が OpenShift OAuth と統合するように設定されているかどうかを示します。 |
| プラグインレジストリーへのパブリック URL。 |
| Pod がこの状態にある理由についての詳細を示す CamelCase メッセージ。 |