第3章 Dev Spaces の設定

containerBuildConfiguration

コンテナーのビルド設定。

defaultComponents

DevWorkspaces に適用されるデフォルトコンポーネント。デフォルトコンポーネントは、Devfile にコンポーネントが含まれていない場合に使用します。

defaultEditor

一緒に作成するワークスペースのデフォルトエディター。プラグイン ID または URI を指定できます。プラグイン ID には publisher/plugin/version 形式が必要です。URI は http:// または https:// で始まる必要があります。

defaultNamespace

ユーザーのデフォルトの namespace。

{ "autoProvision": true, "template": "<username>-che"}

defaultPlugins

DevWorkspaces に適用されるデフォルトのプラグイン。

deploymentStrategy

DeploymentStrategy は、既存のワークスペース Pod を新しい Pod に置き換えるために使用するデプロイメントストラテジーを定義します。利用可能なデプロイメントは Recreate および RollingUpdate です。Recreate デプロイメントストラテジーでは、新規ワークスペース Pod が作成される前に既存のワークスペース Pod が強制終了されます。RollingUpdate デプロイメントストラテジーでは、新しいワークスペース Pod が作成され、新しいワークスペース Pod が ready 状態にある場合にのみ既存のワークスペース Pod が削除されます。指定しない場合、デフォルトの Recreate デプロイメントストラテジーが使用されます。

disableContainerBuildCapabilities

コンテナービルド機能を無効にします。false (デフォルト値) に設定すると、devEnvironments.security.containerSecurityContext フィールドは無視され、コンテナー SecurityContext (\n containerSecurityContext: allowPrivilegeEscalation: true capabilities: add: - SETGID - SETUID) が適用されます。

gatewayContainer

GatewayContainer の設定。

imagePullPolicy

imagePullPolicy は、DevWorkspace のコンテナーに使用される imagePullPolicy を定義します。

maxNumberOfRunningWorkspacesPerUser

ユーザーごとの実行中のワークスペースの最大数。値 -1 を指定すると、ユーザーはワークスペースを無制限に実行できます。

maxNumberOfWorkspacesPerUser

ユーザーが保持できる停止中と実行中の両方のワークスペースの総数。値 -1 を指定すると、ユーザーはワークスペースを無制限に保持できます。

-1

nodeSelector

ノードセレクターは、ワークスペース Pod を実行できるノードを制限します。

persistUserHome

persistUserHome は、ワークスペースでユーザーのホームディレクトリーを永続化するための設定オプションを定義します。

podSchedulerName

ワークスペース Pod の Pod スケジューラー。指定しない場合、Pod スケジューラーはクラスターのデフォルトのスケジューラーに設定されます。

projectCloneContainer

プロジェクトクローンコンテナーの設定。

secondsOfInactivityBeforeIdling

ワークスペースのアイドルタイムアウト (秒単位)。このタイムアウトは、アクティビティーがない場合にワークスペースがアイドル状態になるまでの期間です。非アクティブによるワークスペースのアイドリングを無効にするには、この値を -1 に設定します。

1800

secondsOfRunBeforeIdling

ワークスペースのタイムアウトを秒単位で実行します。このタイムアウトは、ワークスペースが実行される最大期間です。ワークスペースの実行タイムアウトを無効にするには、この値を -1 に設定します。

-1

security

ワークスペースのセキュリティー設定。

serviceAccount

ワークスペースの開始時に DevWorkspace オペレーターが使用する ServiceAccount。

serviceAccountTokens

投影されたボリュームとしてワークスペース Pod にマウントされる ServiceAccount トークンのリスト。

startTimeoutSeconds

StartTimeoutSeconds は、ワークスペースが自動的に失敗するまでの開始にかかる最大期間 (秒単位) を決定します。指定しない場合、デフォルト値の 300 秒 (5 分) が使用されます。

300

ストレージ

ワークスペースの永続ストレージ。

{ "pvcStrategy": "per-user"}

tolerations

ワークスペース Pod の Pod 許容範囲によって、ワークスペース Pod を実行できる場所が制限されます。

trustedCerts

信頼できる証明書の設定。

user

ユーザー設定

autoProvision

ユーザー namespace の自動作成を許可するかどうかを示します。false に設定すると、クラスター管理者がユーザー namespace を事前に作成する必要があります。

true

テンプレート

ユーザー namespace を事前に作成しない場合には、このフィールドは最初のワークスペースの起動時に作成される Kubernetes namespace を定義します。che-workspace-<username> など、<username> と <userid> のプレースホルダーを使用できます。

"<username>-che"

editor

デフォルトのプラグインを指定するエディター ID。

plugins

指定されたエディターのデフォルトのプラグイン URI。

env

コンテナーに設定する環境変数のリスト。

image

コンテナーイメージ。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

imagePullPolicy

イメージプルポリシーデフォルト値は、nightly、latest、または latest イメージの場合は Always で、他の場合は IfNotPresent です。

name

コンテナー名

resources

このコンテナーに必要なコンピューティングリソース。

perUserStrategyPvcConfig

per-user PVC ストラテジーを使用する場合の PVC 設定。

perWorkspaceStrategyPvcConfig

per-workspace PVC ストラテジーを使用する場合の PVC 設定。

pvcStrategy

OpenShift Dev Spaces サーバーの永続ボリューム要求ストラテジー。サポートされているストラテジーは、per-user (1 つのボリューム内のすべてのワークスペース PVC)、per-workspace (各ワークスペースに個別の PVC が与えられる)、ephemeral (ワークスペースが停止すると、ローカルの変更が失われる非永続ストレージ) です。

"per-user"

claimSize

Persistent Volume Claim のサイズ。要求サイズを更新するには、要求サイズをプロビジョニングするストレージクラスがサイズ変更をサポートしている必要があります。

storageClass

Persistent Volume Claim のストレージクラス。省略されるか、空のままの場合は、デフォルトのストレージクラスが使用されます。

claimSize

Persistent Volume Claim のサイズ。要求サイズを更新するには、要求サイズをプロビジョニングするストレージクラスがサイズ変更をサポートしている必要があります。

storageClass

Persistent Volume Claim のストレージクラス。省略されるか、空のままの場合は、デフォルトのストレージクラスが使用されます。

gitTrustedCertsConfigMapName

ConfigMap には、OpenShift Dev Spaces コンポーネントに伝播し、Git に特定の設定を提供するための証明書が含まれています。次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ ConfigMap には、app.kubernetes.io/part-of=che.eclipse.org ラベルが付いています。

openShiftSecurityContextConstraint

コンテナーを構築するための OpenShift セキュリティーコンテキスト制約。

"container-build"

cheServer

OpenShift Dev Spaces サーバーに関連する一般的な設定。

{ "debug": false, "logLevel": "INFO"}

dashboard

OpenShift Dev Spaces インストールで使用されるダッシュボードに関連する設定。

devWorkspace

DevWorkspace Operator の設定。

devfileRegistry

OpenShift Dev Spaces インストールで使用される Devfile レジストリーに関連する設定。

imagePuller

Kubernetes Image Puller の設定。

metrics

OpenShift Dev Spaces サーバーのメトリック設定。

{ "enable": true}

pluginRegistry

OpenShift Dev Spaces インストールで使用されるプラグインレジストリーに関連する設定。

clusterRoles

OpenShift Dev Spaces ServiceAccount に割り当てられた追加の ClusterRoles。各ロールには、app.kubernetes.io/part-of=che.eclipse.org ラベルが必要です。デフォルトのロールは、<devspaces-namespace>-cheworkspaces-clusterrole - <devspaces-namespace>-cheworkspaces-namespaces-clusterrole - <devspaces-namespace>-cheworkspaces-devworkspace-clusterrole で、ここでの <che-namespace> は CheCluster CRD が作成される namespace です。OpenShift Dev Spaces Operator は、付与するためにはこれらの ClusterRoles のすべてのパーミッションをすでに持っていなければなりません。

debug

OpenShift Dev Spaces サーバーのデバッグモードを有効にします。

false

デプロイメント

デプロイメントオーバーライドオプション。

extraProperties

CheCluster カスタムリソース (CR) の他のフィールドからすでに生成されている値に加えて、OpenShift Dev Spaces サーバーによって使用される、生成された che ConfigMap に適用される追加の環境変数のマップ。extraProperties フィールドに、他の CR フィールドから che で通常生成されるプロパティーが含まれる場合、extraProperties で定義された値が代わりに使用されます。

logLevel

OpenShift Dev Spaces サーバーのログレベル: INFO または DEBUG。

"INFO"

proxy

Kubernetes クラスターのプロキシーサーバー設定。OpenShift クラスターに追加の設定は必要ありません。これらの設定を OpenShift クラスターに指定することで、OpenShift プロキシー設定をオーバーライドします。

credentialsSecretName

プロキシーサーバーの user と password 含むシークレット名。シークレットには、app.kubernetes.io/part-of=che.eclipse.org ラベルが必要です。

nonProxyHosts

プロキシーをバイパスして直接アクセスできるホストのリスト。ワイルドカードドメインを指定するには、次の形式 .<DOMAIN> を使用します。例: - localhost - my.host.com - 123.42.12.32 プロキシー設定が必要な場合にのみ使用します。Operator は OpenShift クラスター全体のプロキシー設定を尊重し、カスタムリソースで nonProxyHost を定義すると、クラスタープロキシー設定の非プロキシーホストリストとカスタムリソースで定義されたリストがマージされます。次のページを参照してください: https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html。

port

プロキシーサーバーポート。

url

プロキシーサーバーの URL (プロトコル + ホスト名)。プロキシー設定が必要な場合にのみ使用してください。Operator は OpenShift クラスター全体のプロキシー設定を尊重し、カスタムリソースで URL を定義すると、クラスタープロキシー設定がオーバーライドされます。次のページを参照してください: https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html。

デプロイメント

デプロイメントオーバーライドオプション。

disableInternalRegistry

内部プラグインレジストリーを無効にします。

externalPluginRegistries

外部プラグインレジストリー。

openVSXURL

VSX レジストリー URL を開きます。省略した場合は、埋め込みインスタンスが使用されます。

url

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

デプロイメント

デプロイメントオーバーライドオプション。

disableInternalRegistry

内部 devfile レジストリーを無効にします。

externalDevfileRegistries

サンプルのすぐに使用できる devfile を提供する外部 devfile レジストリー。

url

すぐに使用できるサンプルの devfile を提供する devfile レジストリーのパブリック UR。

branding

Dashboard のブランディングリソース

デプロイメント

デプロイメントオーバーライドオプション。

headerMessage

ダッシュボードのヘッダーメッセージ。

logLevel

ダッシュボードのログレベル。

"ERROR"

表示

ダッシュボードにメッセージを表示するように指示します。

text

ユーザーダッシュボードに表示される警告メッセージ。

enable

コミュニティーでサポートされている Kubernetes Image Puller Operator をインストールして設定します。仕様を指定せずに値を true に設定すると、Operator によって管理されるデフォルトの Kubernetes Image Puller オブジェクトが作成されます。値を false に設定すると、仕様が提供されているかどうかに関係なく、Kubernetes Image Puller オブジェクトが削除され、Operator がアンインストールされます。spec.images フィールドを空のままにしておくと、推奨されるワークスペース関連のイメージのセットが自動的に検出され、インストール後に事前にプルされます。この Operator とその動作はコミュニティーによってサポートされていますが、そのペイロードは商用サポートされているイメージをプルするために商用サポートされている場合があることに注意してください。

spec

CheCluster で Image Puller を設定するための Kubernetes Image Puller 仕様。

enable

OpenShift Dev Spaces サーバーエンドポイントの metrics を有効にします。

true

azure

ユーザーが Azure DevOps Service (dev.azure.com) でホストされているリポジトリーを操作できるようにします。

bitbucket

ユーザーが Bitbucket でホストされているリポジトリー (bitbucket.org または自己ホスト型) を操作できるようにします。

github

ユーザーが GitHub (github.com または GitHub Enterprise) でホストされているリポジトリーを操作できるようにします。

gitlab

ユーザーが GitLab (gitlab.com または自己ホスト型) でホストされているリポジトリーを操作できるようにします。

disableSubdomainIsolation

サブドメイン分離を無効にします。che.eclipse.org/scm-github-disable-subdomain-isolation アノテーションを優先して非推奨になりました。詳細については、次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-github/

endpoint

GitHub サーバーのエンドポイント URL。che.eclipse.org/scm-server-endpoint アノテーションが推奨されるため、非推奨になりました。詳細については、次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-github/

secretName

Kubernetes シークレット。Base64 でエンコードされた GitHub OAuth クライアント ID と GitHub OAuth クライアントシークレットが含まれます。詳細については、次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-github/

endpoint

GitLab サーバーのエンドポイント URL。che.eclipse.org/scm-server-endpoint アノテーションが推奨されるため、非推奨になりました。次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-gitlab/。

secretName

Kubernetes シークレット。Base64 でエンコードされた GitHub アプリケーション ID と GitLab アプリケーションクライアントシークレットが含まれます。次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-gitlab/。

endpoint

Bitbucket サーバーのエンドポイント URL。che.eclipse.org/scm-server-endpoint アノテーションが推奨されるため、非推奨になりました。次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-1-for-a-bitbucket-server/。

secretName

Kubernetes シークレット。Base64 でエンコードされた Bitbucket OAuth 1.0 または OAuth 2.0 データが含まれます。詳細は、https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ および https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/ を参照してください。

secretName

Kubernetes シークレット。Base64 でエンコードされた Azure DevOps Service アプリケーション ID とクライアントシークレットが含まれます。次のページを参照してください: https://www.eclipse.org/che/docs/stable/administration-guide/cconfiguring-oauth-2-for-microsoft-azure-devops-services

annotations

Ingress (OpenShift プラットフォームのルート) に設定されるアノテーションを定義します。Kubernetes プラットフォームのデフォルトは次のとおりです: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600"、nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600"、nginx.ingress.kubernetes.io/ssl-redirect: "true"

auth

認証設定

{ "gateway": { "configLabels": { "app": "che", "component": "che-gateway-config" } }}

domain

OpenShift クラスターの場合、Operator はドメインを使用してルートのホスト名を生成します。生成されたホスト名は、che-<devspaces-namespace>.<domain> のパターンに従います。<devspaces-namespace> は、CheCluster CRD が作成される namespace です。ラベルと組み合わせて、デフォルト以外の Ingress Controller によって提供されるルートを作成します。Kubernetes クラスターの場合、グローバル Ingress ドメインが含まれます。デフォルト値はありません。指定する必要があります。

hostname

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

ingressClassName

IngressClassName は、IngressClass クラスターリソースの名前です。クラス名が IngressClassName フィールドと kubernetes.io/ingress.class アノテーションの両方で定義されている場合、IngressClassName フィールドが優先されます。

labels

Ingress (OpenShift プラットフォームのルート) に設定されるラベルを定義します。

tlsSecretName

Ingress TLS ターミネーションのセットアップに使用されるシークレットの名前。フィールドが空の文字列の場合、デフォルトのクラスター証明書が使用されます。シークレットには、app.kubernetes.io/part-of=che.eclipse.org ラベルが必要です。

advancedAuthorization

高度な承認設定。Che へのアクセスを許可するユーザーとグループを決定します。ユーザーは、allowUsers リストに含まれているか、allowGroups リストのグループのメンバーであり、denyUsers リストに含まれず、denyGroups リストのグループのメンバーでもない場合に、OpenShift Dev Spaces へのアクセスを許可されます。allowUsers と allowGroups が空の場合、すべてのユーザーが Che にアクセスできます。DenyUsers と DenyGroups が空の場合、すべてのユーザーが Che へのアクセスを拒否されます。

gateway

ゲートウェイ設定。

{ "configLabels": { "app": "che", "component": "che-gateway-config" }}

identityProviderURL

アイデンティティープロバイダーサーバーの公開 URL。

identityToken

アップストリームに渡される ID トークン。サポートされるトークンには、id_token と access_token の 2 種類があります。デフォルト値は id_token です。このフィールドは、Kubernetes 専用に作成された OpenShift Dev Spaces インストールに固有であり、OpenShift では無視されます。

oAuthAccessTokenInactivityTimeoutSeconds

OpenShift 側で ID フェデレーションをセットアップするために使用される OpenShift OAuthClient リソースに設定するトークンの非アクティブタイムアウト。0 は、このクライアントのトークンがタイムアウトしないことを意味します。

oAuthAccessTokenMaxAgeSeconds

OpenShift 側で ID フェデレーションをセットアップするために使用される OpenShift OAuthClient リソースに設定するアクセストークンの最大有効期間。0 は有効期限がないことを意味します。

oAuthClientName

OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift OAuthClient リソースの名前。

oAuthScope

アクセストークンのスコープ。このフィールドは、Kubernetes 専用に作成された OpenShift Dev Spaces インストールに固有であり、OpenShift では無視されます。

oAuthSecret

OpenShift 側でアイデンティティーフェデレーションを設定するために使用される OpenShift OAuthClient リソースに設定されたシークレットの名前。

configLabels

ゲートウェイ設定ラベル。

{ "app": "che", "component": "che-gateway-config"}

デプロイメント

デプロイメントオーバーライドオプション。ゲートウェイのデプロイメントは複数のコンテナーで設定されているため、設定では次の名前で区別する必要があります。gateway - configbump - oauth-proxy - kube-rbac-proxy

kubeRbacProxy

OpenShift Dev Spaces ゲートウェイ Pod 内の kube-rbac-proxy の設定。

oAuthProxy

OpenShift Dev Spaces ゲートウェイ Pod 内の oauth-proxy の設定。

traefik

OpenShift Dev Spaces ゲートウェイ Pod 内の Traefik の設定。

hostname

イメージのプルに使用する別のコンテナーレジストリーの任意のホスト名または URL。この値は、OpenShift Dev Spaces デプロイメントに含まれるすべてのデフォルトのコンテナーイメージで定義されたコンテナーレジストリーのホスト名をオーバーライドします。これは、制限された環境で OpenShift Dev Spaces をインストールする場合にとくに役立ちます。

組織

イメージのプルに使用する別のレジストリーのオプションのリポジトリー名。この値は、OpenShift Dev Spaces デプロイメントに含まれるすべてのデフォルトのコンテナーイメージで定義されたコンテナーレジストリー組織をオーバーライドします。これは、制限された環境で OpenShift Dev Spaces をインストールする場合にとくに役立ちます。

コンテナー

Pod に属するコンテナーのリスト。

securityContext

Pod を実行する必要があるセキュリティーオプション。

env

コンテナーに設定する環境変数のリスト。

image

コンテナーイメージ。Operator によって提供されるデフォルトのコンテナーイメージを使用するには、これを省略するか、空のままにします。

imagePullPolicy

イメージプルポリシーデフォルト値は、nightly、latest、または latest イメージの場合は Always で、他の場合は IfNotPresent です。

name

コンテナー名

resources

このコンテナーに必要なコンピューティングリソース。

limits

許可されるコンピューティングリソースの最大量について説明します。

request

必要なコンピューティングリソースの最小量について説明します。

cpu

CPU、コア単位。(500m = 0.5 コア) 値が指定されていない場合は、コンポーネントに応じてデフォルト値が設定されます。値が 0 の場合、コンポーネントには値が設定されません。

memory

メモリー (バイト単位)。(500Gi = 500GiB = 500 * 1024 * 1024 * 1024) 値が指定されていない場合は、コンポーネントに応じてデフォルト値が設定されます。値が 0 の場合、コンポーネントには値が設定されません。

cpu

CPU、コア単位。(500m = 0.5 コア) 値が指定されていない場合は、コンポーネントに応じてデフォルト値が設定されます。値が 0 の場合、コンポーネントには値が設定されません。

memory

メモリー (バイト単位)。(500Gi = 500GiB = 500 * 1024 * 1024 * 1024) 値が指定されていない場合は、コンポーネントに応じてデフォルト値が設定されます。値が 0 の場合、コンポーネントには値が設定されません。

fsGroup

Pod の全コンテナーに適用される特別な補助グループです。デフォルト値は 1724 です。

runAsUser

コンテナープロセスのエントリーポイントを実行するための UID。デフォルト値は 1724 です。

chePhase

OpenShift Dev Spaces デプロイメントの現在のフェーズを指定します。

cheURL

OpenShift Dev Spaces サーバーのパブリック URL。

cheVersion

現在インストールされている OpenShift Dev Spaces のバージョン。

devfileRegistryURL

内部 devfile レジストリーの公開 URL。

gatewayPhase

ゲートウェイデプロイメントの現在のフェーズを指定します。

message

OpenShift Dev Spaces デプロイメントが現在のフェーズにある理由の詳細を示す、人間が判読できるメッセージ。

pluginRegistryURL

内部プラグインレジストリーの公開 URL。

reason

OpenShift Dev Spaces デプロイメントが現在のフェーズにある理由の詳細を示す簡単な CamelCase メッセージ。

workspaceBaseDomain

解決されたワークスペースベースドメイン。これは、仕様で明示的に定義された同じ名前のプロパティーのコピーか、仕様で定義されておらず、OpenShift で実行している場合は、ルートの自動的に解決されたベースドメインです。