2.2. CheCluster カスタムリソースフィールドの参照
このセクションでは、CheCluster
カスタムリソースのカスタマイズに使用できるすべてのフィールドについて説明します。
-
例2.2「最小の
CheCluster
カスタムリソースの例。」 -
表2.1「CodeReady Workspaces サーバーコンポーネントに関連する
CheCluster
カスタムリソースのserver
設定。」 -
表2.2「CodeReady Workspaces で使用されるデータベースに関連する
CheCluster
カスタムリソースdatabase
設定。」 -
表2.3「CodeReady Workspaces で使用される認証に関連するカスタムリソース
auth
設定。」 -
表2.4「CodeReady Workspaces で使用される永続ストレージに関連する
CheCluster
カスタムリソースstorage
設定。」 -
表2.5「OpenShift の CodeReady Workspaces インストールに固有の
CheCluster
カスタムリソースk8s
設定。」 -
表2.6「CodeReady Workspaces によって使用される CodeReady Workspaces メトリクス収集に関連する
CheCluster
カスタムリソースmetrics
設定。」 -
表2.7「
CheCluster
カスタムリソースstatus
は、CodeReady Workspaces インストールの観察される状態を定義します。」
例2.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'
表2.1 CodeReady Workspaces サーバーコンポーネントに関連する CheCluster
カスタムリソースの server
設定。
プロパティー | 説明 |
---|---|
airGapContainerRegistryHostname | イメージのプルに使用する別のコンテナーレジストリーに対する、オプションのホスト名または URL。この値は、Che デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されるコンテナーレジストリーのホスト名を上書きします。これは、制限された環境で Che をインストールする場合にとくに便利です。 |
airGapContainerRegistryOrganization | イメージのプルに使用する別のコンテナーレジストリーのオプションのリポジトリー名。この値は、Che デプロイメントに関連するすべてのデフォルトコンテナーイメージで定義されるコンテナーレジストリーの組織を上書きします。これは、制限された環境で CodeReady Workspaces をインストールする場合にとくに便利です。 |
allowUserDefinedWorkspaceNamespaces |
非推奨。このフラグの値は無視されます。ユーザーが OpenShift プロジェクトまたはデフォルトとは異なる OpenShift プロジェクトを指定できるように定義します。OpenShift OAuth を設定せずに |
cheClusterRoles | Che ServiceAccount に割り当てられる ClusterRole のコンマ区切りの一覧。Che Operator には、これらの ClusterRole のすべてのパーミッションがすでにあり、これらを付与できる必要があることに注意してください。 |
cheDebug |
Che サーバーのデバッグモードを有効にします。デフォルトは |
cheFlavor |
インストールのバリエーションを指定します。このオプションは、アップストリームの Che インストールの場合は |
cheHost |
インストールされた Che サーバーのパブリックホスト名。値を省略すると、値は Operator によって自動的に設定されます。 |
cheHostTLSSecret |
インストールされた Che サーバーのカスタムホスト名の Ingress またはルートのセキュリティーを保護するための証明書が含まれるシークレットの名前。 |
cheImage | Che デプロイメントで使用されるコンテナーイメージを上書きします。これには、コンテナーイメージタグは含まれません。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
cheImagePullPolicy |
Che デプロイメントで使用されるイメージプルポリシーを上書きします。デフォルト値は、 |
cheImageTag | Che デプロイメントで使用されるコンテナーイメージのタグを上書きします。Operator によって提供されるデフォルトのイメージタグを使用するには、これを省略するか、または空のままにします。 |
cheLogLevel |
Che サーバーのログレベル: |
cheServerIngress | Che サーバー Ingress のカスタム設定。 |
cheServerRoute | Che サーバールートのカスタム設定。 |
cheWorkspaceClusterRole | Che ワークスペースのユーザーにバインドされるカスタムロール。デフォルトのロールは、省略されているか、または空白のままの場合に使用されます。 |
customCheProperties |
|
dashboardCpuLimit | ダッシュボードのデプロイメントで使用される CPU 制限を上書きします。コア(500m = .5 コア)。デフォルトは 500m に設定されます。 |
dashboardCpuRequest | ダッシュボードのデプロイメントで使用される CPU 要求を上書きします。コア(500m = .5 コア)。デフォルトは 100m に設定されます。 |
dashboardImage | ダッシュボードのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
dashboardImagePullPolicy |
ダッシュボードのデプロイメントで使用されるイメージプルポリシーを上書きします。デフォルト値は、 |
dashboardIngress | ダッシュボード Ingress のカスタム設定。 |
dashboardMemoryLimit | ダッシュボードのデプロイメントで使用されるメモリー制限を上書きします。デフォルトは 256Mi に設定されます。 |
dashboardMemoryRequest | ダッシュボードのデプロイメントで使用されるメモリー要求を上書きします。デフォルトは 16Mi に設定されます。 |
dashboardRoute | ダッシュボードルートのカスタム設定。 |
devfileRegistryCpuLimit | devfile レジストリーのデプロイメントで使用される CPU 制限を上書きします。コア(500m = .5 コア)。デフォルトは 500m に設定されます。 |
devfileRegistryCpuRequest | devfile レジストリーのデプロイメントで使用される CPU 要求を上書きします。コア(500m = .5 コア)。デフォルトは 100m に設定されます。 |
devfileRegistryImage | devfile レジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
devfileRegistryIngress | devfile レジストリー Ingress のカスタム設定。 |
devfileRegistryMemoryLimit | devfile レジストリーのデプロイメントで使用されるメモリー制限を上書きします。デフォルトは 256Mi に設定されます。 |
devfileRegistryMemoryRequest | devfile レジストリーのデプロイメントで使用されるメモリー要求を上書きします。デフォルトは 16Mi に設定されます。 |
devfileRegistryPullPolicy |
devfile レジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。デフォルト値は、 |
devfileRegistryRoute | devfile レジストリールートのカスタム設定。 |
devfileRegistryUrl |
|
disableInternalClusterSVCNames | 内部クラスターの SVC 名の使用を無効にして、トラフィックを高速化し、プロキシーの問題を回避します。 |
externalDevfileRegistries |
外部 devfile レジストリーで、すぐに使用可能な devfiles を提供します。( |
externalDevfileRegistry |
専用の devfile レジストリーサーバーをデプロイするかどうかについて Operator に指示します。デフォルトでは、専用の devfile レジストリーサーバーが起動します。 |
externalPluginRegistry |
専用のプラグインレジストリーサーバーをデプロイするかどうかについて Operator に指示します。デフォルトでは、専用のプラグインレジストリーサーバーが起動します。 |
gitSelfSignedCert |
|
nonProxyHosts |
プロキシーをバイパスして、直接到達されるホストの一覧。ワイルドカードのドメインを指定するには、以下の |
pluginRegistryCpuLimit | プラグインレジストリーのデプロイメントで使用される CPU 制限を上書きします。コア(500m = .5 コア)。デフォルトは 500m に設定されます。 |
pluginRegistryCpuRequest | プラグインレジストリーのデプロイメントで使用される CPU 要求を上書きします。コア(500m = .5 コア)。デフォルトは 100m に設定されます。 |
pluginRegistryImage | プラグインレジストリーのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
pluginRegistryIngress | プラグインレジストリー Ingress のカスタム設定。 |
pluginRegistryMemoryLimit | プラグインレジストリーのデプロイメントで使用されるメモリー制限を上書きします。デフォルトは 256Mi に設定されます。 |
pluginRegistryMemoryRequest | プラグインレジストリーのデプロイメントで使用されるメモリー要求を上書きします。デフォルトは 16Mi に設定されます。 |
pluginRegistryPullPolicy |
プラグインレジストリーのデプロイメントで使用されるイメージプルポリシーを上書きします。デフォルト値は、 |
pluginRegistryRoute | プラグインレジストリールートのカスタム設定。 |
pluginRegistryUrl |
サンプルのすぐに使できる devfile を提供するプラグインレジストリーの公開 URL。外部 devfile レジストリーを使用する必要がある場合は、この ONLY を設定します。 |
proxyPassword |
プロキシーサーバーのパスワード。プロキシー設定が必要である場合にのみ使用します。 |
proxyPort |
プロキシーサーバーのポート。プロキシーの設定が必要な場合にのみ使用します。 |
proxySecret |
プロキシーサーバーの |
proxyURL |
プロキシーサーバーの URL (プロトコル+ホスト名)。これにより、Che サーバーおよびワークスペースコンテナーの |
proxyUser |
プロキシーサーバーのユーザー名。プロキシーの設定が必要な場合にのみ使用します。 |
selfSignedCert | 非推奨。このフラグの値は無視されます。Che Operator は、ルーター証明書が自己署名されているかどうかを自動的に検知し、これを Che サーバーなどの他のコンポーネントに伝播します。 |
serverCpuLimit | Che サーバーのデプロイメントで使用される CPU 制限を上書きします (コア単位)。(500m = .5 コア)。デフォルトは 1 に設定されます。 |
serverCpuRequest | Che サーバーのデプロイメントで使用される CPU 要求を上書きします (コア単位)。(500m = .5 コア)。デフォルトは 100m に設定されます。 |
serverExposureStrategy |
サーバーおよびワークスペースの公開タイプを設定します。設定可能な値は、 |
serverMemoryLimit | Che サーバーのデプロイメントで使用されるメモリー制限を上書きします。デフォルトは 1Gi に設定されます。 |
serverMemoryRequest | Che サーバーのデプロイメントで使用されるメモリー要求を上書きします。デフォルトは 512Mi に設定されます。 |
serverTrustStoreConfigMapName | Che サーバーの Java トラストストアに追加するパブリック証明書のある ConfigMap の名前。これは、HTTPS エンドポイントが自己署の証明書で署名されている OpenShift OAuth プロバイダーを追加する際に必要になります。Che サーバーは、要求できるように CA 証明書を認識できる必要があります。これはデフォルトで無効にされます。 |
singleHostGatewayConfigMapLabels | ゲートウェイ設定を表す ConfigMap に存在する必要があるラベル。 |
singleHostGatewayConfigSidecarImage | ゲートウェイに設定を提供するゲートウェイサイドカーに使用されるイメージ。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
singleHostGatewayImage | 単一ホストモードでゲートウェイに使用されるイメージ。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
tlsSupport | 非推奨。Operator に対して Che を TLS モードでデプロイするように指示します。これはデフォルトで有効になっています。TLS を無効にすると、Che コンポーネントが正しく機能しないことがあります。 |
useInternalClusterSVCNames |
|
workspaceNamespaceDefault |
ユーザーが上書きしない場合に、ユーザーのワークスペースが作成されるデフォルトの OpenShift プロジェクトを定義します。 |
表2.2 CodeReady Workspaces で使用されるデータベースに関連する CheCluster
カスタムリソース database
設定。
プロパティー | 説明 |
---|---|
chePostgresContainerResources | PostgreSQL コンテナーのカスタム設定 |
chePostgresDb |
Che サーバーが DB への接続に使用する PostgreSQL データベース名。デフォルトは |
chePostgresHostName |
Che サーバーが接続する PostgreSQL データベースのホスト名。デフォルトは |
chePostgresPassword | Che サーバーが DB への接続に使用する PostgreSQL パスワード。これは、省略されるか、または空のままの場合は、自動的に生成される値に設定されます。 |
chePostgresPort |
Che サーバーが接続する PostgreSQL データベースのポート。デフォルトは 5432 に設定されます。外部データベースを使用する場合、この値のみを上書きします。 |
chePostgresSecret |
Che サーバーが DB への接続に使用する PosgreSQL の `user` および |
chePostgresUser |
Che サーバーが DB への接続に使用する PostgreSQL ユーザー。デフォルトは |
externalDb |
専用のデータベースをデプロイするかどうかについて Operator に指示します。デフォルトでは、専用の PostgreSQL データベースは Che インストールの一部としてデプロイされます。 |
postgresImage | PostgreSQL データベースのデプロイメントで使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
postgresImagePullPolicy |
PostgreSQL データベースのデプロイメントで使用されるイメージプルポリシーを上書きします。デフォルト値は、 |
表2.3 CodeReady Workspaces で使用される認証に関連するカスタムリソース auth
設定。
プロパティー | 説明 |
---|---|
externalIdentityProvider |
専用のアイデンティティープロバイダー (Keycloak または RH SSO インスタンス) をデプロイするかどうかについて Operator に指示します。専用のアイデンティティープロバイダー (Keycloak または RH-SSO インスタンス) をデプロイするかどうかについて Operator に指示します。デフォルトで、専用のアイデンティティープロバイダーサーバーは Che インストールの一部としてデプロイされます。 |
gatewayAuthenticationSidecarImage | NativeUserMode が有効な場合に認証を行うゲートウェイサイドカー。oauth2-proxy または openshift/oauth-proxy を参照してください。 |
gatewayAuthorizationSidecarImage | NativeUserMode が有効な場合に承認を行うゲートウェイサイドカー。kube-rbac-proxy または openshift/kube-rbac-proxyを参照してください。 |
gatewayHeaderRewriteSidecarImage | 非推奨。このフラグの値は無視されます。サイドカー機能が Traefik プラグインに実装されるようになりました。 |
identityProviderAdminUserName |
アイデンティティープロバイダーの管理者ユーザーの名前を上書きします。デフォルトは |
identityProviderClientId |
Che に使用されるアイデンティティープロバイダー、Keycloak、または RH-SSO の |
identityProviderContainerResources | アイデンティティープロバイダーコンテナーのカスタム設定。 |
identityProviderImage | アイデンティティープロバイダー、Keycloak、または RH-SSO デプロイメントで使用するコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
identityProviderImagePullPolicy |
アイデンティティープロバイダー、Keycloak、または RH-SSO デプロイメントで使用するイメージプルポリシーを上書きします。デフォルト値は、 |
identityProviderIngress | Ingress のカスタム設定。 |
identityProviderPassword |
Keycloak 管理者ユーザーのパスワードを上書きします。外部アイデンティティープロバイダーが使用されている場合にこれを上書きします。 |
identityProviderPostgresPassword |
データベースに接続するために使用するアイデンティティープロバイダー、Keycloak、または RH-SSO のパスワード外部アイデンティティープロバイダーが使用されている場合にこれを上書きします。 |
identityProviderPostgresSecret |
データベースに接続するために使用するアイデンティティープロバイダー、Keycloak、または RH-SSO の |
identityProviderRealm |
Che に使用されるアイデンティティープロバイダー、Keycloak、または RH-SSO のレルムの名前。外部アイデンティティープロバイダーが使用されている場合にこれを上書きします。 |
identityProviderRoute | ルートのカスタム設定。 |
identityProviderSecret |
アイデンティティープロバイダーの |
identityProviderURL |
アイデンティティープロバイダーサーバー (Keycloak/RH-SSO サーバー) の公開 URL。外部アイデンティティープロバイダーを使用する必要がある場合は、これのみを設定します。 |
initialOpenShiftOAuthUser |
OpenShift OAuth 認証の操作には、kubeadmin を使用できないため、新規ユーザーアカウントを作成します。値が true の場合には、HTPasswd アイデンティティープロバイダーに新しい OpenShift OAuth ユーザーが作成されます。値が false で、ユーザーがすでに作成されている場合は、削除されます。値が空白の場合は何も実行されません。ユーザーの認証情報は、Operator によって 'openshift-config' namespace にある |
nativeUserMode | ネイティブユーザーモードを有効にします。現在、OpenShift および DevWorkspace エンジンでのみ動作します。ネイティブユーザーモードは、Keycloak なしで OpenShift OAuth を直接アイデンティティープロバイダーとして使用します。 |
oAuthClientName |
OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift |
oAuthSecret |
OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift |
openShiftoAuth |
アイデンティティープロバイダー (Keycloak/RHSSO) と OpenShift OAuth の統合を有効にします。デフォルトでは OpenShift の値は空になります。これにより、ユーザーは OpenShift ログインで OpenShift ユーザーとして直接ログインでき、独自のワークスペースを個人の OpenShift namespace の下に作成できます。警告: |
updateAdminPassword |
デフォルトの |
表2.4 CodeReady Workspaces で使用される永続ストレージに関連する CheCluster
カスタムリソース storage
設定。
プロパティー | 説明 |
---|---|
postgresPVCStorageClassName | PostgreSQL データベース専用の Persistent Volume Claim (永続ボリューム要求、PVC) のストレージクラス。省略されるか、または空のままの場合は、デフォルトのストレージクラスが使用されます。 |
preCreateSubPaths |
Che サーバーに対し、永続ボリュームでサブパスを事前に作成するために特別な Pod を起動するように指示します。デフォルトは |
pvcClaimSize |
ワークスペースの永続ボリューム要求 (PVC) のサイズ。デフォルトは |
pvcJobsImage |
永続ボリュームでサブパスを作成するために使用されるコンテナーイメージを上書きします。これには、イメージタグが含まれます。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、または空のままにします。 |
pvcStrategy |
Che サーバーの永続ボリューム要求ストラテジー。これには、'common' (1 つのボリュームにすべてのワークスペース PVC)、 |
workspacePVCStorageClassName | Che ワークスペース専用の Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラス。省略されるか、または空のままの場合は、デフォルトのストレージクラスが使用されます。 |
表2.5 OpenShift の CodeReady Workspaces インストールに固有の CheCluster
カスタムリソース k8s
設定。
プロパティー | 説明 |
---|---|
ingressClass |
Ingress を管理するコントローラーを定義する Ingress クラス。デフォルトは |
ingressDomain | OpenShift クラスターのグローバル Ingress ドメイン。これは明示的に指定する必要があります。デフォルト値はありません。 |
ingressStrategy |
Ingress 作成のストラテジー。オプション: |
securityContextFsGroup |
Che Pod およびワークスペース Pod コンテナーが実行される FSGroup。デフォルト値は |
securityContextRunAsUser |
Che Pod およびワークスペース Pod コンテナーの実行に使用するユーザーの ID。デフォルト値は |
singleHostExposureType |
serverExposureStrategy が |
tlsSecretName |
TLS が有効にされている場合に ingress TLS 終端を設定するために使用されるシークレットの名前。フィールドが空の文字列である場合、デフォルトのクラスター証明書が使用されます。 |
表2.6 CodeReady Workspaces によって使用される CodeReady Workspaces メトリクス収集に関連する CheCluster
カスタムリソース metrics
設定。
プロパティー | 説明 |
---|---|
enable |
Che サーバーエンドポイント |
表2.7 CheCluster
カスタムリソース status
は、CodeReady Workspaces インストールの観察される状態を定義します。
プロパティー | 説明 |
---|---|
cheClusterRunning |
Che インストールのステータス。 |
cheURL | Che サーバーへの公開 URL。 |
cheVersion | 現在のインストールされている Che バージョン。 |
dbProvisioned | PostgreSQL インスタンスが正しくプロビジョニングされているかどうかを示します。 |
devfileRegistryURL | devfile レジストリーへの公開 URL。 |
devworkspaceStatus | Devworkspace サブシステムのステータス |
gitHubOAuthProvisioned | アイデンティティープロバイダーインスタンス、Keycloak または RH-SSO が GitHub OAuth と統合するように設定されているかどうかを示します。 |
helpLink | 現在の Operator ステータスに関連するヘルプの検索に使用する URL を参照する URL。 |
keycloakProvisioned | アイデンティティープロバイダーインスタンス、Keycloak または RH-SSO がレルム、クライアント、およびユーザーと共にプロビジョニングされているかどうかを示します。 |
keycloakURL | アイデンティティープロバイダーサーバー (Keycloak/RH-SSO) の公開 URL。 |
message | Pod がこの状態にある理由の詳細を示す、人が判読できるメッセージ。 |
openShiftOAuthUserCredentialsSecret |
HTPasswd アイデンティティープロバイダーのユーザー認証情報を含む |
openShiftoAuthProvisioned | アイデンティティープロバイダーインスタンス、Keycloak または RH-SSO が OpenShift OAuth と統合するように設定されているかどうかを示します。 |
pluginRegistryURL | プラグインレジストリーへの公開 URL。 |
reason | Pod がこの状態にある理由の詳細を示す簡単な CamelCase メッセージ。 |