1.2. CheCluster Custom Resource フィールドの参照

このセクションでは、CheCluster カスタムリソースのカスタマイズに使用できるすべての フィールド について説明します。

例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

airGapContainerRegistryHostname

omit

イメージをプルする代替コンテナーレジストリーへのオプションのホスト名または URL。この値は、CodeReady Workspaces デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されたコンテナーレジストリーのホスト名を上書きします。これは、特に CodeReady Workspaces を空欄環境でインストールする場合に便利です。

airGapContainerRegistryOrganization

omit

イメージをプルする代替コンテナーレジストリーのオプションのリポジトリー名。この値は、CodeReady Workspaces デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されたコンテナーレジストリー組織を上書きします。これは、特に CodeReady Workspaces を空欄環境でインストールする場合に便利です。

cheDebug

false

CodeReady Workspaces サーバーのデバッグモードを有効にします。

cheFlavor

codeready-workspaces

インストールのフレーバー。

cheHost

Operator は値を自動的に設定します。

インストールされた CodeReady Workspaces サーバーのパブリックホスト名。

cheImagePullPolicy

常に 夜間 または 最新 のイメージの場合、および IfNotPresent (他の場合)

CodeReady Workspaces デプロイメントで使用されるイメージプルポリシーを上書きします。

cheImageTag

omit

CodeReady Workspaces デプロイメントで使用されるコンテナーイメージのタグを上書きします。これを省略するか、または空のままにして、Operator によって提供されるデフォルトのイメージタグを使用します。

cheImage

omit

CodeReady Workspaces デプロイメントで使用されるコンテナーイメージを上書きします。これにはコンテナーイメージタグが含まれません。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

cheLogLevel

INFO

CodeReady Workspaces サーバーのログレベル: INFO または DEBUG

cheWorkspaceClusterRole

omit

CodeReady Workspaces ワークスペースのユーザーにバインドされるカスタムクラスターロール。デフォルトのロールを使用するには、空のままにするか、空のままにします。

customCheProperties

omit

CodeReady Workspaces サーバーで使用される生成された codeready-workspaces ConfigMap に適用される追加の環境変数と、CheCluster カスタム リソース(CR)の他のフィールドからすでに生成した値もマップします。customCheProperties 、他の CR フィールドから codeready-workspaces ConfigMap で通常生成されるプロパティーが含まれる場合、代わりに customCheProperties で定義された値が使用 れます。

devfileRegistryImage

omit

Devfile レジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

devfileRegistryMemoryLimit

256Mi

Devfile レジストリーのデプロイメントで使用されるメモリー制限を上書きします。

devfileRegistryMemoryRequest

16Mi

Devfile レジストリーのデプロイメントで使用されるメモリー要求を上書きします。

devfileRegistryPullPolicy

常に 夜間 または 最新 のイメージの場合、および IfNotPresent (他の場合)

Devfile レジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。

devfileRegistryUrl

Operator は値を自動的に設定します。

サンプルの ready-to-use devfile を提供する Devfile レジストリーのパブリック URL。外部 devfile レジストリーを使用する場合はこれを設定します(externalDevfileRegistry フィールドを参照 てください)。

externalDevfileRegistry

false

Operator が専用の Devfile レジストリーサーバーをデプロイするよう指示します。デフォルトでは、専用の devfile レジストリーサーバーが開始されます。externalDevfileRegistry が true設定さ れる場合、Operator は専用のレジストリーサーバーを自動的に起動しないため、devfileRegistryUrl フィールドを手動で設定する 必要 があります。

externalPluginRegistry

false

Operator が専用のプラグインレジストリーサーバーをデプロイするよう指示します。デフォルトでは、専用プラグインレジストリーサーバーが起動しています。externalPluginRegistry が true設定さ れる場合、Operator は専用サーバーを自動的にデプロイせず、pluginRegistryUrl フィールドを手動で設定する 必要 があります。

nonProxyHosts

omit

設定されたプロキシーを使用しないホストの一覧。| ' を区切り文字として使用します。たとえば、localhost|my.host.com|123.42.12.32 は、プロキシーの設定時のみ 使用します(proxyURL フィールド も参照してください)。

pluginRegistryImage

omit

プラグインレジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

pluginRegistryMemoryLimit

256Mi

プラグインレジストリーのデプロイメントで使用されるメモリー制限を上書きします。

pluginRegistryMemoryRequest

16Mi

プラグインレジストリーのデプロイメントで使用されるメモリー要求を上書きします。

pluginRegistryPullPolicy

常に 夜間 または 最新 のイメージの場合、および IfNotPresent (他の場合)

プラグインレジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。

pluginRegistryUrl

Operator は値を自動的に設定します。

ready-to-use の devfile のサンプルを提供するプラグインレジストリーのパブリック URL。外部 devfile レジストリーを使用する場合にのみ設定します(externalPluginRegistry フィールドを参照 てください)。

proxyPassword

omit

プロキシーサーバーのパスワード。プロキシー設定が必要な場合にのみ使用します。

proxyPort

omit

プロキシーサーバーのポート。プロキシーの設定時のみ使用します(proxyURL フィールドも参照し ください)。

proxyURL

omit

プロキシーサーバーの URL(protocol+host name)。これにより、CodeReady Workspaces サーバーおよびワークスペースコンテナーの JAVA_OPTS および https(s)_proxy 変数の適切な変更が駆動されます。プロキシーの設定時のみ使用します。

proxyUser

omit

プロキシーサーバーのユーザー名。プロキシーの設定時のみ使用します(proxyURL フィールドも参照し ください)。

selfSignedCert

false

自己署名証明書を使用するルーターで OpenShift クラスターのサポートを有効にします。これを有効にすると、Operator は OpenShift ルートのデフォルトの自己署名証明書を取得し、CodeReady Workspaces サーバーの Java トラストストアに追加します。ルートの有効な証明書で設定されていないデモ OpenShift クラスターで tlsSupport フィールド をアクティベートする際に必要です。

serverMemoryLimit

1Gi

CodeReady Workspaces サーバーデプロイメントで使用されるメモリー制限を上書きします。

serverMemoryRequest

512Mi

CodeReady Workspaces サーバーデプロイメントで使用されるメモリー要求を上書きします。

tlsSupport

true

Operator が TLS モードで CodeReady Workspaces をデプロイするよう指示します。TLS を有効にするには、selfSignedCert フィールドを有効に する 必要があります。

表1.2 CodeReady Workspaces によって使用されるデータベースに関連する CheCluster カスタムリソースデータベース設定

propertyデフォルト値description

chePostgresDb

dbche

CodeReady Workspaces サーバーがデータベースへの接続に使用するpostgresql データベース名。

chePostgresHostName

Operator は値を自動的に設定します。

CodeReady Workspaces サーバーが接続先に使用する postgresql データベースのホスト名。デフォルトは postgres です。この値は、外部データベースを使用する場合にのみ上書きします。(externalDb フィールドを参照してください

chePostgresPassword

自動生成される値

CodeReady Workspaces サーバーがデータベースへの接続に使用する postgresql パスワード。

chePostgresPort

5432

CodeReady Workspaces サーバーが接続に使用する postgresql データベースポート。外部データベースを使用する場合のみ、この値を上書きします(externalDb フィールド 参照)。

chePostgresUser

pgche

CodeReady Workspaces サーバーがデータベースへの接続に使用するpostgresql ユーザー。

externalDb

false

Operator が専用のデータベースをデプロイするよう指示します。デフォルトでは、専用の PostgreSQL データベースは CodeReady Workspaces インストールの一部としてデプロイされます。true に設定した場合、Operator は専用のデータベースを自動的にデプロイしません。chePostgres で始まるすべてのフィールドを参照して ください

postgresImagePullPolicy

always: 夜間 または 最新 イメージの場合、および他のケースでは IfNotPresent

PostgreSQL データベースのデプロイメントで使用されるイメージプルポリシーを上書きします。

postgresImage

omit

PostgreSQL データベースのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

表1.3 CodeReady Workspaces インストールによって使用される認証に関連する CheClusterカスタム リソース認証 設定

propertyデフォルト値description

externalIdentityProvider

false

デフォルトでは、CodeReady Workspaces インストールの一環として、専用の Identity Provider サーバーがデプロイされます。ただし、externalIdentityProvidertrue の場合、Operator によって専用のアイデンティティープロバイダーがデプロイされず、使用する外部アイデンティティープロバイダーの詳細を提供する必要がある場合があります。「 identityProvider で始まる他のフィールドすべて」も参照して ください

identityProviderAdminUserName

admin

Identity Provider の管理者ユーザーを上書きします。

identityProviderClientId

omit

CodeReady Workspaces に使用する必要があるアイデンティティープロバイダー(Keycloak / RH SSO) client-id の名前。これは、外部のアイデンティティープロバイダーを使用する場合に ONLY をオーバーライドするのに便利です(externalIdentityProvider フィールドを参照 てください)。省略または空白のままにすると、-public という接尾辞が付いた flavor フィールドの値に設定されます。

identityProviderImagePullPolicy

常に 夜間 または 最新 のイメージの場合、および IfNotPresent (他の場合)

Identity Provider(Keycloak / RH SSO)デプロイメントで使用されるイメージプルポリシーを上書きします。

identityProviderImage

omit

Identity Provider(Keycloak / RH SSO)デプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

identityProviderPassword

omit

Keycloak 管理ユーザーのパスワードを上書きします。外部アイデンティティープロバイダーを使用する場合のみ上書きします(externalIdentityProvider フィールドを参照 てください)。自動生成されたパスワードを設定する場合は、空のままにするか、空のままにします。

identityProviderPostgresPassword

Operator は値を自動的に設定します。

データベースに接続するための ID プロバイダー(Keycloak / RH SSO)のパスワードこれは、外部のアイデンティティープロバイダーを使用する場合に ONLY をオーバーライドするのに便利です(externalIdentityProvider フィールドを参照 てください)。

identityProviderRealm

omit

アイデンティティープロバイダー(Keycloak / RH SSO)レルムの名前。外部アイデンティティープロバイダーを使用する場合のみ上書きします(externalIdentityProvider フィールドを参照 てください)。flavor フィールドの値に設定するには、空欄のままにするか、空欄のままにします。

identityProviderURL

Operator は値を自動的に設定します。

Operator は専用のアイデンティティープロバイダー(Keycloak または RH SSO インスタンス)をデプロイするよう指示します。Identity Provider サーバーのパブリック URL(Keycloak / RH SSO サーバー)。外部アイデンティティープロバイダーを使用する場合のみ設定します(externalIdentityProvider フィールド 参照)。

oAuthClientName

Operator は値を自動的に設定します。

OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift OAuthClient リソースの名前。OpenShiftoAuth フィールドも参照 てください。

oAuthSecret

Operator は値を自動的に設定します。

OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift OAuthClient リソースでシークレットセットの名前。OAuthClientName フィールドも参照 てください。

openShiftoAuth

OpenShift でのtrue

アイデンティティープロバイダー(Keycloak / RHSSO)と OpenShift OAuth の統合を有効にします。これにより、ユーザーは OpenShift ログインとログインでき、独自の OpenShift プロジェクトでワークスペースを作成できます。kubeadmin ユーザーにはサポートされず、ロギングによって CodeReady Workspaces Dashboard へのアクセスが許可されません。

updateAdminPassword

false

デフォルトの 管理者 CodeReady Workspaces ユーザーに、初回ログイン時にパスワードを更新するように強制します。

表1.4 CodeReady Workspaces によって使用される永続ストレージに関連する CheCluster カスタムリソースストレージ設定

propertyデフォルト値description

postgresPVCStorageClassName

omit

PostgreSQL データベース専用の Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラス。デフォルトのストレージクラスを使用するには、省略するか、空のままにします。

preCreateSubPaths

false

CodeReady Workspaces サーバーに特別な Pod を起動し、永続ボリュームのサブパスを事前作成するよう指示します。K8S クラスターの設定に応じて有効にします。

pvcClaimSize

1Gi

ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のサイズ。

pvcJobsImage

omit

永続ボリュームにサブパスを作成するために使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。preCreateSubPaths フィールドも参照 てください。

pvcStrategy

common

利用可能なオプション: 'common'(すべてのワークスペース PVC を 1 つのボリュームに)、ワークス ペースごと に(宣言されたすべてのボリュームについて 1 つのワークスペースにつき 1 つ)、一意 のオプション(宣言されたボリュームごとに 1 つの PVC)。

workspacePVCStorageClassName

omit

CodeReady Workspaces ワークスペース専用の Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラス。デフォルトのストレージクラスを使用するには、空のままにするか、空のままにします。

表1.5 OpenShift での CodeReady Workspaces インストールに固有する CheClusterカスタム リソース k8s 設定

propertyデフォルト値description

ingressClass

nginx

Ingress クラス。どのコントローラーが Ingress を管理するかを定義します。

ingressDomain

omit

K8S クラスターのグローバル Ingress ドメイン。このフィールドは明示的に指定する必要があります。これにより、CodeReady Workspaces 関連の Ingress の kubernetes.io/ingress.class アノテーションが 駆動されます。

ingressStrategy

multi-host

Ingress 作成のストラテジー。これは、マルチホスト (Ingress でホストを明示的に指定)、単一ホスト(ホスト が提供され、パスベースのルール)および default-host.*(ホストは指定されず、パスベースのルール)にすることができます。

securityContextFsGroup,omitempty

1724

fsGroup CodeReady Workspaces Pod および Workspace Pod コンテナーが実行される。

securityContextRunAsUser

1724

CodeReady Workspaces Pod および Workspace Pod コンテナーが実行されるユーザーの ID。

tlsSecretName

omit

TLS が有効な場合に Ingress TLS 終端を設定するために使用されるシークレットの名前。tlsSupport フィールドも参照 てください。

表1.6 CheCluster カスタムリソースの ステータス は、CodeReady Workspaces インストールの状態を定義します。

propertydescription

cheClusterRunning

CodeReady Workspaces インストールのステータス。AvailableUnavailable、または Available、Rolling Update in Progress を使用できます。

cheURL

CodeReady Workspaces サーバーのパブリック URL。

cheVersion

CodeReady Workspaces バージョンが現在インストールされています。

dbProvisioned

PostgreSQL インスタンスが正しくプロビジョニングされたかどうかを示します。

devfileRegistryURL

Devfile レジストリーへのパブリック URL。

helpLink

現在の Operator ステータスに関連するヘルプを検索する場所の URL。

keycloakProvisioned

Identity Provider インスタンス(Keycloak / RH SSO)がレルム、クライアント、およびユーザーでプロビジョニングされているかどうかを示します。

keycloakURL

Identity Provider サーバーへのパブリック URL(Keycloak / RH SSO)

message

Pod がこの状態にある理由を示す、人間が判読できるメッセージ。

openShiftoAuthProvisioned

アイデンティティープロバイダーインスタンス(Keycloak / RH SSO)が OpenShift OAuth と統合するように設定されているかどうかを示します。

pluginRegistryURL

プラグインレジストリーへのパブリック URL。

reason

Pod がこの状態にある理由についての詳細を示す CamelCase メッセージ。