| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>CheCluster Custom Resource fields reference :: Eclipse Che Documentation</title> |
| <link rel="canonical" href="https://www.eclipse.org/che/docs/stable/administration-guide/checluster-custom-resource-fields-reference/"> |
| <meta name="description" content="`CheCluster` Custom Resource fields reference"> |
| <meta name="keywords" content="administration guide, checluster, custom resource"> |
| <meta name="generator" content="Antora 3.1.7"> |
| <link rel="stylesheet" href="../../../../docs/_/css/site.css"> |
| <link rel="stylesheet" href="../../../../docs/_/css/extra.css"> |
| <link rel="stylesheet" href="../../../../docs/_/font-awesome-4.7.0/css/font-awesome.min.css"> |
| <link rel="icon" href="../../../../docs/_/img/favicon.ico" type="image/x-icon"> |
| <script>var uiRootPath = '../../../../docs/_'</script> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-37306001-2"></script> |
| <script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','UA-37306001-2')</script> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <div class="navbar-item"> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| <img src="../../../../docs/_/img/icon-eclipse-che.svg" class="navbar-logo" alt="Eclipse Che logo"> |
| <a href="https://www.eclipse.org/che/docs/index.html">Eclipse Che Documentation</a> |
| </div> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <div class="navbar-end"> |
| <div class="navbar-item search hide-for-print"> |
| <div id="search-field" class="field"> |
| <input id="search-input" type="text" placeholder="Search the docs"> |
| </div> |
| </div> |
| <a class="navbar-item" href="https://www.eclipse.org/che/">Home</a> |
| <a class="navbar-item" href="https://che.eclipseprojects.io/">Blog</a> |
| <a class="navbar-item" href="https://github.com/eclipse/che">Source Code</a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body"> |
| <div class="nav-container" data-component="docs" data-version="7.82.x"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all" style="display: none"></button> |
| <h3 class="title"><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../overview/introduction-to-eclipse-che/">Introduction to Che</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../hosted-che/hosted-che/">Eclipse Che hosted by Red Hat</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">User Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/getting-started-with-che/">Getting started with Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/starting-a-workspace-from-a-git-repository-url/">Starting a workspace from a Git repository URL</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/optional-parameters-for-the-urls-for-starting-a-new-workspace/">Optional parameters for the URLs for starting a new workspace</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-concatenation/">URL parameter concatenation</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-the-ide/">URL parameter for the IDE</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-the-ide-image/">URL parameter for the IDE image</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-starting-duplicate-workspaces/">URL parameter for starting duplicate workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-the-devfile-file-name/">URL parameter for the devfile file name</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-the-devfile-file-path/">URL parameter for the devfile file path</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-the-workspace-storage/">URL parameter for the workspace storage</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-additional-remotes/">URL parameter for additional remotes</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/url-parameter-for-container-image/">URL parameter for a container image</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/starting-a-workspace-from-a-raw-devfile-url/">Starting a workspace from a raw devfile URL</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/basic-actions-you-can-perform-on-a-workspace/">Basic actions you can perform on a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/authenticating-to-a-git-server-from-a-workspace/">Authenticating to a Git server from a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/using-the-fuse-overlay-storage-driver/">Using the fuse-overlayfs storage driver for Podman and Buildah</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/accessing-fuse/">Accessing /dev/fuse</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-overlay-with-a-configmap/">Enabling fuse-overlayfs with a ConfigMap</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/using-che-in-team-workflow/">Using Che in team workflow</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/first-time-contributors/">Badge for first-time contributors</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/benefits-of-pull-requests-review-in-che/">Reviewing pull and merge requests</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/try-in-web-ide-github-action/">Try in Web IDE GitHub action</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../end-user-guide/customizing-workspace-components/">Customizing workspace components</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../end-user-guide/devfile-introduction/">Introduction to devfile in Che</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/ides-in-workspaces/">IDEs in workspaces</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/microsoft-visual-studio-code-open-source-ide/">Microsoft Visual Studio Code - Open Source</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/defining-a-common-ide/">Defining a common IDE</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/using-credentials-and-configurations-in-workspaces/">Using credentials and configurations in workspaces</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/mounting-secrets/">Mounting Secrets</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/creating-image-pull-secrets/">Creating image pull Secrets</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/using-a-git-provider-access-token/">Using a Git-provider access token</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/mounting-configmaps/">Mounting ConfigMaps</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/mounting-git-configuration/">Mounting Git configuration</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/enabling-artifact-repositories-in-a-restricted-environment/">Enabling artifact repositories in a restricted environment</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-maven-artifact-repositories/">Maven</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-gradle-artifact-repositories/">Gradle</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-npm-artifact-repositories/">npm</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-python-artifact-repositories/">Python</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-go-artifact-repositories/">Go</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/enabling-nuget-artifact-repositories/">NuGet</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../end-user-guide/requesting-persistent-storage-for-workspaces/">Requesting persistent storage for workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/integrating-with-kubernetes/">Integrating with Kubernetes</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/managing-workspaces-with-apis/">Managing workspaces with Kubernetes APIs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/automatic-token-injection/">Automatic Kubernetes token injection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/navigating-che-from-openshift-developer-perspective/">Navigating Che from OpenShift Developer Perspective</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/navigating-openshift-web-console-from-che/">Navigating OpenShift web console from Che</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/troubleshooting-che/">Troubleshooting Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/viewing-che-workspaces-logs/">Viewing Che workspaces logs</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/viewing-workspace-logs-in-cli/">Workspace logs in CLI</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/viewing-workspace-logs-in-the-openshift-console/">Workspace logs in OpenShift console</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/viewing-language-servers-and-debug-adapters-logs-in-visual-studio-code/">Language servers and debug adapters logs in the editor</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/troubleshooting-network-problems/">Troubleshooting network problems</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/troubleshooting-webview-loading-error/">Troubleshooting webview loading error</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Administration Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../preparing-the-installation/">Preparing the installation</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../supported-platforms/">Supported platforms</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../installing-the-chectl-management-tool/">Installing the chectl management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../architecture-overview/">Architecture</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../server-components/">Server components</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../che-operator/">Che operator</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../devworkspace-operator/">DevWorkspace operator</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../gateway/">Gateway</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../dashboard/">User dashboard</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../devfile-registries/">Devfile registries</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../che-server/">Che server</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../plugin-registry/">Plug-in registry</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../user-workspaces/">User workspaces</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../calculating-che-resource-requirements/">Calculating Che resource requirements</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../installing-che/">Installing Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../installing-che-in-the-cloud/">Installing Che in the cloud</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-openshift-using-cli/">Installing Che on OpenShift using CLI</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-openshift-using-the-web-console/">Installing Che on OpenShift using the web console</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-in-a-restricted-environment/">Installing Che in a restricted environment</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-microsoft-azure/">Installing Che on Microsoft Azure</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../installing-che-locally/">Installing Che locally</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-red-hat-openshift-local/">Installing Che on Red Hat OpenShift Local</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-minikube/">Installing Che on Minikube</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-minikube-keycloak-oidc/">Installing Che on Minikube with Keycloak as the OIDC provider</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../finding-the-fully-qualified-domain-name-fqdn/">Finding the fully qualified domain name (FQDN)</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-che/">Configuring Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../understanding-the-checluster-custom-resource/">Understanding the <code>CheCluster</code> Custom Resource</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../using-chectl-to-configure-the-checluster-custom-resource-during-installation/">Using chectl to configure the <code>CheCluster</code> Custom Resource during installation</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../using-the-cli-to-configure-the-checluster-custom-resource/">Using the CLI to configure the CheCluster Custom Resource</a> |
| </li> |
| <li class="nav-item is-current-page" data-depth="3"> |
| <a class="nav-link" href="./"><code>CheCluster</code> Custom Resource fields reference</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-namespace-provisioning/">Configuring namespaces</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-workspace-target-namespace/">Configuring namespace name</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../provisioning-namespaces-in-advance/">Provisioning namespaces in advance</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-server-components/">Configuring server components</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container/">Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse Che container</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../advanced-configuration-options-for-the-che-server-component/">Advanced configuration options for Che server</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-number-of-replicas/">Configuring number of replicas for a Eclipse Che container</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-workspaces-globally/">Configuring workspaces globally</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../limiting-the-number-of-workspaces-that-a-user-can-keep/">Limiting the number of workspaces that a user can keep</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../enabling-users-to-run-multiple-workspaces-simultaneously/">Enabling users to run multiple workspaces simultaneously</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../deploying-che-with-support-for-git-repositories-with-self-signed-certificates/">Git with self-signed certificates</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-workspaces-nodeselector/">Configuring workspaces nodeSelector</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-the-open-vsx-registry-url/">Open VSX registry URL</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-a-user-namespace/">Configuring a user namespace</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../defining-the-list-of-images-to-pull/">Defining the list of images</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../defining-the-memory-parameters-for-the-image-puller/">Defining the memory settings</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-image-puller-on-openshift-using-the-web-console/">Installing Image Puller on OpenShift using the web console</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-image-puller-on-openshift-using-cli/">Installing Image Puller on OpenShift using CLI</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-observability/">Configuring observability</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../the-woopra-telemetry-plugin/">The Woopra telemetry plugin</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../creating-a-telemetry-plugin/">Creating a telemetry plugin</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-server-logging/">Configuring server logging</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../collecting-logs-using-chectl/">Collecting logs using chectl</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../monitoring-the-dev-workspace-operator/">Monitoring the DevWorkspace Operator</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../monitoring-che/">Monitoring Che Server</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-networking/">Configuring networking</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-network-policies/">Configuring network policies</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-che-hostname/">Configuring Che hostname</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-che-with-self-signed-certificate/">Configuring Che with self-signed certificates</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../importing-untrusted-tls-certificates/">Importing untrusted TLS certificates to Che</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../adding-labels-and-annotations/">Adding labels and annotations</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-storage/">Configuring storage</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-storage-classes/">Configuring storage classes</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-the-storage-strategy/">Configuring the storage strategy</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-storage-sizes/">Configuring storage sizes</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-dashboard/">Configuring dashboard</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-getting-started-samples/">Configuring getting started samples</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../customizing-openshift-che-consolelink-icon/">Customizing OpenShift Eclipse Che ConsoleLink icon</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../managing-identities-and-authorizations/">Managing identities and authorizations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../configuring-oauth-for-git-providers/">Configuring OAuth for Git providers</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-2-for-github/">Configuring OAuth 2.0 for GitHub</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-2-for-gitlab/">Configuring OAuth 2.0 for GitLab</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-2-for-a-bitbucket-server/">Configuring OAuth 2.0 for a Bitbucket Server</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-2-for-the-bitbucket-cloud/">Configuring OAuth 2.0 for the Bitbucket Cloud</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-1-for-a-bitbucket-server/">Configuring OAuth 1.0 for a Bitbucket Server</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-oauth-2-for-microsoft-azure-devops-services/">Configuring OAuth 2.0 for Microsoft Azure DevOps Services</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-cluster-roles-for-users/">Configuring cluster roles for Che users</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../configuring-advanced-authorization/">Configuring advanced authorization</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../removing-user-data-in-compliance-with-the-gdpr/">Removing user data in compliance with the GDPR</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-fuse/">Configuring fuse-overlayfs</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../managing-ide-extensions/">Managing IDE extensions</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../extensions-for-microsoft-visual-studio-code-open-source/">Extensions for Microsoft Visual Studio Code - Open Source</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../managing-workloads-using-the-che-server-api/">Using the Che server API</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../upgrading-che/">Upgrading Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../upgrading-the-chectl-management-tool/">Upgrading the chectl management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../specifying-the-update-approval-strategy/">Specifying the update approval strategy</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../upgrading-che-using-the-web-console/">Upgrading Che using the OpenShift web console</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../upgrading-che-using-the-cli-management-tool/">Upgrading Che using the CLI management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../upgrading-che-using-the-cli-management-tool-in-restricted-environment/">Upgrading Che in a restricted environment</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../repairing-the-devworkspace-operator-on-openshift/">Repairing the DevWorkspace Operator on OpenShift</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../uninstalling-che/">Uninstalling Che</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../extensions/extensions/">Extensions</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../extensions/openshift-connector-overview/">OpenShift Connector</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../extensions/features-of-openshift-connector/">Features of OpenShift Connector</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../extensions/installing-openshift-connector-in-che/">Installing OpenShift Connector in Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../extensions/authenticating-with-openshift-connector-from-che/">Authenticating with OpenShift Connector from Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../extensions/creating-components-with-openshift-connector-in-che/">Creating Components with OpenShift Connector in Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../extensions/connecting-source-code-from-github-to-a-openshift-component-using-openshift-connector/">Connecting source code from GitHub to a OpenShift Component</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../glossary/che-glossary/">Che glossary</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">Documentation</span> |
| <span class="version">7.82.x</span> |
| </div> |
| <ul class="components"> |
| <li class="component is-current"> |
| <div class="title"><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></div> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../next/overview/introduction-to-eclipse-che/">next</a> |
| </li> |
| <li class="version is-current is-latest"> |
| <a href="../../overview/introduction-to-eclipse-che/">7.82.x</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main class="article"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../overview/introduction-to-eclipse-che/" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></li> |
| <li>Administration Guide</li> |
| <li><a href="../configuring-che/">Configuring Che</a></li> |
| <li><a href="../understanding-the-checluster-custom-resource/">Understanding the <code>CheCluster</code> Custom Resource</a></li> |
| <li><a href="./"><code>CheCluster</code> Custom Resource fields reference</a></li> |
| </ul> |
| </nav> |
| <div class="page-versions"> |
| <button class="version-menu-toggle" title="Show other versions of page">7.82.x</button> |
| <div class="version-menu"> |
| <a class="version" href="../../../next/administration-guide/checluster-custom-resource-fields-reference/">next</a> |
| <a class="version is-current" href="./">7.82.x</a> |
| </div> |
| </div> |
| <div class="edit-this-page"><a href="https://github.com/eclipse-che/che-docs/edit/7.82.x/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc">Edit this Page</a></div> |
| </div> |
| <div class="content"> |
| <aside class="toc sidebar" data-title="Contents" data-levels="2"> |
| <div class="toc-menu"></div> |
| </aside> |
| <article class="doc"> |
| <h1 class="page"><code>CheCluster</code> Custom Resource fields reference</h1> |
| <div class="paragraph"> |
| <p>This section describes all fields available to customize the <code>CheCluster</code> Custom Resource.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#a-minimal-checluster-custom-resource-example">A minimal <code>CheCluster</code> Custom Resource example.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-settings">Development environment configuration options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-defaultNamespace-settings"><code>defaultNamespace</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-defaultPlugins-settings"><code>defaultPlugins</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-gatewayContainer-settings"><code>gatewayContainer</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-storage-settings"><code>storage</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-storage-perUserStrategyPvcConfig-settings"><code>per-user</code> PVC strategy options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-storage-perWorkspaceStrategyPvcConfig-settings"><code>per-workspace</code> PVC strategy options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-trustedCerts-settings"><code>trustedCerts</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-devEnvironments-containerBuildConfiguration-settings"><code>containerBuildConfiguration</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-settings">Che components configuration.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-cheServer-settings">General configuration settings related to the Che server component.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-cheServer-proxy-settings"><code>proxy</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-settings"><code>deployment</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-securityContext-settings"><code>securityContext</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-request-settings"><code>request</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-limits-settings"><code>limits</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-pluginRegistry-settings">Configuration settings related to the Plug-in registry component used by the Che installation.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-pluginRegistry-externalPluginRegistries-settings"><code>externalPluginRegistries</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-settings"><code>deployment</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-securityContext-settings"><code>securityContext</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-request-settings"><code>request</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-limits-settings"><code>limits</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-devfileRegistry-settings">Configuration settings related to the Devfile registry component used by the Che installation.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-devfileRegistry-externalDevfileRegistries-settings"><code>externalDevfileRegistries</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-settings"><code>deployment</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-securityContext-settings"><code>securityContext</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-request-settings"><code>request</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-limits-settings"><code>limits</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-dashboard-settings">Configuration settings related to the Dashboard component used by the Che installation.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-dashboard-headerMessage-settings"><code>headerMessage</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-settings"><code>deployment</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-securityContext-settings"><code>securityContext</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-request-settings"><code>request</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-limits-settings"><code>limits</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-imagePuller-settings">Kubernetes Image Puller component configuration.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-metrics-settings">Che server metrics component configuration.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-gitServices-settings">Configuration settings that allows users to work with remote Git repositories.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-gitServices-github-settings"><code>github</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-gitServices-gitlab-settings"><code>gitlab</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-gitServices-bitbucket-settings"><code>bitbucket</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-gitServices-azure-settings"><code>azure</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-networking-settings">Networking, Che authentication and TLS configuration.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-networking-auth-settings"><code>auth</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-networking-auth-gateway-settings"><code>gateway</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-settings"><code>deployment</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-securityContext-settings"><code>securityContext</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-settings"><code>containers</code> options.</a></p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-request-settings"><code>request</code> options.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-components-common-deployment-containers-resources-limits-settings"><code>limits</code> options.</a></p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-containerRegistry-settings">Configuration of an alternative registry that stores Che images.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-status-settings"><code>CheCluster</code> Custom Resource <code>status</code> defines the observed state of Che installation</a></p> |
| </li> |
| </ul> |
| </div> |
| <div id="a-minimal-checluster-custom-resource-example" class="exampleblock"> |
| <div class="title">Example 1. A minimal <code>CheCluster</code> Custom Resource example.</div> |
| <div class="content"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">apiVersion: org.eclipse.che/v2 |
| kind: CheCluster |
| metadata: |
| name: eclipse-che |
| namespace: eclipse-che |
| spec: |
| components: {} |
| devEnvironments: {} |
| networking: {}</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <table id="checluster-custom-resource-devEnvironments-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 1. Development environment configuration options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">containerBuildConfiguration</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Container build configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">defaultComponents</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Default components applied to DevWorkspaces. These default components are meant to be used when a Devfile, that does not contain any components.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">defaultEditor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The default editor to workspace create with. It could be a plugin ID or a URI. The plugin ID must have <code>publisher/plugin/version</code> format. The URI must start from <code>http://</code> or <code>https://</code>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">defaultNamespace</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">User’s default namespace.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "autoProvision": true, "template": "<username>-che"}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">defaultPlugins</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Default plug-ins applied to DevWorkspaces.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deploymentStrategy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods with new ones. The available deployment stragies are <code>Recreate</code> and <code>RollingUpdate</code>. With the <code>Recreate</code> deployment strategy, the existing workspace pod is killed before the new one is created. With the <code>RollingUpdate</code> deployment strategy, a new workspace pod is created and the existing workspace pod is deleted only when the new workspace pod is in a ready state. If not specified, the default <code>Recreate</code> deployment strategy is used.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">disableContainerBuildCapabilities</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disables the container build capabilities. When set to <code>false</code> (the default value), the devEnvironments.security.containerSecurityContext field is ignored, and the following container SecurityContext is applied: \n containerSecurityContext: allowPrivilegeEscalation: true capabilities: add: - SETGID - SETUID</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gatewayContainer</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">GatewayContainer configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">imagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ImagePullPolicy defines the imagePullPolicy used for containers in a DevWorkspace.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">maxNumberOfRunningWorkspacesPerUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">maxNumberOfWorkspacesPerUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Total number of workspaces, both stopped and running, that a user can keep. The value, -1, allows users to keep an unlimited number of workspaces.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">nodeSelector</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The node selector limits the nodes that can run the workspace pods.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">persistUserHome</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PersistUserHome defines configuration options for persisting the user home directory in workspaces.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">podSchedulerName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Pod scheduler for the workspace pods. If not specified, the pod scheduler is set to the default scheduler on the cluster.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">projectCloneContainer</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Project clone container configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secondsOfInactivityBeforeIdling</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Idle timeout for workspaces in seconds. This timeout is the duration after which a workspace will be idled if there is no activity. To disable workspace idling due to inactivity, set this value to -1.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">1800</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secondsOfRunBeforeIdling</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Run timeout for workspaces in seconds. This timeout is the maximum duration a workspace runs. To disable workspace run timeout, set this value to -1.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">security</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Workspace security configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serviceAccount</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ServiceAccount to use by the DevWorkspace operator when starting the workspaces.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serviceAccountTokens</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of ServiceAccount tokens that will be mounted into workspace pods as projected volumes.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">startTimeoutSeconds</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start before it is automatically failed. If not specified, the default value of 300 seconds (5 minutes) is used.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">300</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">storage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Workspaces persistent storage.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "pvcStrategy": "per-user"}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">tolerations</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The pod tolerations of the workspace pods limit where the workspace pods can run.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">trustedCerts</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Trusted certificate settings.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">user</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">User configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-defaultNamespace-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 2. <code>defaultNamespace</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">autoProvision</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Indicates if is allowed to automatically create a user namespace. If it set to false, then user namespace must be pre-created by a cluster administrator.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">template</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">If you don’t create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. You can use <code><username></code> and <code><userid></code> placeholders, such as che-workspace-<username>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">"<username>-che"</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-defaultPlugins-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 3. <code>defaultPlugins</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">editor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The editor ID to specify default plug-ins for.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">plugins</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Default plug-in URIs for the specified editor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-gatewayContainer-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 4. <code>gatewayContainer</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">env</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of environment variables to set in the container.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">image</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Container image. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">imagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Image pull policy. Default value is <code>Always</code> for <code>nightly</code>, <code>next</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Container name.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">resources</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Compute resources required by this container.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-storage-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 5. <code>storage</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">perUserStrategyPvcConfig</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PVC settings when using the <code>per-user</code> PVC strategy.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">perWorkspaceStrategyPvcConfig</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PVC settings when using the <code>per-workspace</code> PVC strategy.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pvcStrategy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistent volume claim strategy for the Che server. The supported strategies are: <code>per-user</code> (all workspaces PVCs in one volume), <code>per-workspace</code> (each workspace is given its own individual PVC) and <code>ephemeral</code> (non-persistent storage where local changes will be lost when the workspace is stopped.)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">"per-user"</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-storage-perUserStrategyPvcConfig-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 6. <code>per-user</code> PVC strategy options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">claimSize</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">storageClass</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-storage-perWorkspaceStrategyPvcConfig-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 7. <code>per-workspace</code> PVC strategy options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">claimSize</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">storageClass</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-trustedCerts-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 8. <code>trustedCerts</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gitTrustedCertsConfigMapName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. See the following page: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/</a> The ConfigMap must have a <code>app.kubernetes.io/part-of=che.eclipse.org</code> label.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-devEnvironments-containerBuildConfiguration-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 9. <code>containerBuildConfiguration</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">openShiftSecurityContextConstraint</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">OpenShift security context constraint to build containers.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">"container-build"</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 10. Che components configuration.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheServer</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">General configuration settings related to the Che server.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "debug": false, "logLevel": "INFO"}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboard</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration settings related to the dashboard used by the Che installation.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devWorkspace</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">DevWorkspace Operator configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration settings related to the devfile registry used by the Che installation.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">imagePuller</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Kubernetes Image Puller configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">metrics</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Che server metrics configuration.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "enable": true}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration settings related to the plug-in registry used by the Che installation.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-cheServer-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 11. General configuration settings related to the Che server component.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">clusterRoles</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Additional ClusterRoles assigned to Che ServiceAccount. Each role must have a <code>app.kubernetes.io/part-of=che.eclipse.org</code> label. The defaults roles are: - <code><che-namespace>-cheworkspaces-clusterrole</code> - <code><che-namespace>-cheworkspaces-namespaces-clusterrole</code> - <code><che-namespace>-cheworkspaces-devworkspace-clusterrole</code> where the <che-namespace> is the namespace where the CheCluster CR is created. The Che Operator must already have all permissions in these ClusterRoles to grant them.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">debug</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables the debug mode for Che server.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deployment override options.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">extraProperties</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A map of additional environment variables applied in the generated <code>che</code> ConfigMap to be used by the Che server in addition to the values already generated from other fields of the <code>CheCluster</code> custom resource (CR). If the <code>extraProperties</code> field contains a property normally generated in <code>che</code> ConfigMap from other CR fields, the value defined in the <code>extraProperties</code> is used instead.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">logLevel</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The log level for the Che server: <code>INFO</code> or <code>DEBUG</code>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">"INFO"</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-cheServer-proxy-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 12. <code>proxy</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">credentialsSecretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The secret name that contains <code>user</code> and <code>password</code> for a proxy server. The secret must have a <code>app.kubernetes.io/part-of=che.eclipse.org</code> label.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">nonProxyHosts</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A list of hosts that can be reached directly, bypassing the proxy. Specify wild card domain use the following form <code>.<DOMAIN></code>, for example: - localhost - my.host.com - 123.42.12.32 Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, defining <code>nonProxyHosts</code> in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. See the following page: <a href="https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html" class="bare">https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">port</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Proxy server port.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">url</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, defining <code>url</code> in a custom resource leads to overriding the cluster proxy configuration. See the following page: <a href="https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html" class="bare">https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-pluginRegistry-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 13. Configuration settings related to the Plug-in registry component used by the Che installation.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deployment override options.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">disableInternalRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disables internal plug-in registry.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalPluginRegistries</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">External plugin registries.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">openVSXURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Open VSX registry URL. If omitted an embedded instance will be used.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-pluginRegistry-externalPluginRegistries-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 14. <code>externalPluginRegistries</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">url</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Public URL of the plug-in registry.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-devfileRegistry-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 15. Configuration settings related to the Devfile registry component used by the Che installation.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deployment override options.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">disableInternalRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disables internal devfile registry.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalDevfileRegistries</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">External devfile registries serving sample ready-to-use devfiles.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-devfileRegistry-externalDevfileRegistries-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 16. <code>externalDevfileRegistries</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">url</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The public UR of the devfile registry that serves sample ready-to-use devfiles.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-dashboard-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 17. Configuration settings related to the Dashboard component used by the Che installation.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">branding</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Dashboard branding resources.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deployment override options.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">headerMessage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Dashboard header message.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">logLevel</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The log level for the Dashboard.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">"ERROR"</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-dashboard-headerMessage-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 18. <code>headerMessage</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">show</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs dashboard to show the message.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">text</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Warning message displayed on the user dashboard.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-imagePuller-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 19. Kubernetes Image Puller component configuration.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">enable</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to <code>true</code> without providing any specs, it creates a default Kubernetes Image Puller object managed by the Operator. When you set the value to <code>false</code>, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, regardless of whether a spec is provided. If you leave the <code>spec.images</code> field empty, a set of recommended workspace-related images is automatically detected and pre-pulled after installation. Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported for pulling commercially-supported images.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A Kubernetes Image Puller spec to configure the image puller in the CheCluster.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-metrics-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 20. Che server metrics component configuration.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">enable</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables <code>metrics</code> for the Che server endpoint.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-gitServices-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 21. Configuration settings that allows users to work with remote Git repositories.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">azure</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables users to work with repositories hosted on Azure DevOps Service (dev.azure.com).</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">bitbucket</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables users to work with repositories hosted on Bitbucket (bitbucket.org or self-hosted).</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">github</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables users to work with repositories hosted on GitHub (github.com or GitHub Enterprise).</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gitlab</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables users to work with repositories hosted on GitLab (gitlab.com or self-hosted).</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-gitServices-github-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 22. <code>github</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">disableSubdomainIsolation</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disables subdomain isolation. Deprecated in favor of <code>che.eclipse.org/scm-github-disable-subdomain-isolation</code> annotation. See the following page for details: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">endpoint</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">GitHub server endpoint URL. Deprecated in favor of <code>che.eclipse.org/scm-server-endpoint</code> annotation. See the following page for details: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. See the following page for details: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-gitServices-gitlab-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 23. <code>gitlab</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">endpoint</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">GitLab server endpoint URL. Deprecated in favor of <code>che.eclipse.org/scm-server-endpoint</code> annotation. See the following page: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. See the following page: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-gitServices-bitbucket-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 24. <code>bitbucket</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">endpoint</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bitbucket server endpoint URL. Deprecated in favor of <code>che.eclipse.org/scm-server-endpoint</code> annotation. See the following page: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following pages for details: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/</a> and <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/</a>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-gitServices-azure-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 25. <code>azure</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">secretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. See the following page: <a href="https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services" class="bare">https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services</a></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-networking-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 26. Networking, Che authentication and TLS configuration.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">annotations</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Defines annotations which will be set for an Ingress (a route for OpenShift platform). The defaults for kubernetes platforms are: 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"</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">auth</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Authentication settings.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "gateway": { "configLabels": { "app": "che", "component": "che-gateway-config" } }}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">domain</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. The generated hostname follows this pattern: che-<che-namespace>.<domain>. The <che-namespace> is the namespace where the CheCluster CRD is created. In conjunction with labels, it creates a route served by a non-default Ingress controller. For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hostname</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The public hostname of the installed Che server.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ingressClassName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">IngressClassName is the name of an IngressClass cluster resource. If a class name is defined in both the <code>IngressClassName</code> field and the <code>kubernetes.io/ingress.class</code> annotation, <code>IngressClassName</code> field takes precedence.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">labels</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Defines labels which will be set for an Ingress (a route for OpenShift platform).</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">tlsSecretName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the secret used to set up Ingress TLS termination. If the field is an empty string, the default cluster certificate is used. The secret must have a <code>app.kubernetes.io/part-of=che.eclipse.org</code> label.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-networking-auth-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 27. <code>auth</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">advancedAuthorization</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Advance authorization settings. Determines which users and groups are allowed to access Che. User is allowed to access Che if he/she is either in the <code>allowUsers</code> list or is member of group from <code>allowGroups</code> list and not in neither the <code>denyUsers</code> list nor is member of group from <code>denyGroups</code> list. If <code>allowUsers</code> and <code>allowGroups</code> are empty, then all users are allowed to access Che. if <code>denyUsers</code> and <code>denyGroups</code> are empty, then no users are denied to access Che.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gateway</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Gateway settings.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "configLabels": { "app": "che", "component": "che-gateway-config" }}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Public URL of the Identity Provider server.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityToken</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Identity token to be passed to upstream. There are two types of tokens supported: <code>id_token</code> and <code>access_token</code>. Default value is <code>id_token</code>. This field is specific to Che installations made for Kubernetes only and ignored for OpenShift.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthAccessTokenInactivityTimeoutSeconds</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Inactivity timeout for tokens to set in the OpenShift <code>OAuthClient</code> resource used to set up identity federation on the OpenShift side. 0 means tokens for this client never time out.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthAccessTokenMaxAgeSeconds</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Access token max age for tokens to set in the OpenShift <code>OAuthClient</code> resource used to set up identity federation on the OpenShift side. 0 means no expiration.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthClientName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the OpenShift <code>OAuthClient</code> resource used to set up identity federation on the OpenShift side.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthScope</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Access Token Scope. This field is specific to Che installations made for Kubernetes only and ignored for OpenShift.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the secret set in the OpenShift <code>OAuthClient</code> resource used to set up identity federation on the OpenShift side.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-networking-auth-gateway-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 28. <code>gateway</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">configLabels</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Gateway configuration labels.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{ "app": "che", "component": "che-gateway-config"}</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deployment override options. Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: - <code>gateway</code> - <code>configbump</code> - <code>oauth-proxy</code> - <code>kube-rbac-proxy</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">kubeRbacProxy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration for kube-rbac-proxy within the Che gateway pod.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">oAuthProxy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration for oauth-proxy within the Che gateway pod.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">traefik</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Configuration for Traefik within the Che gateway pod.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-containerRegistry-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 29. Configuration of an alternative registry that stores Che images.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hostname</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">An optional hostname or URL of an alternative container registry to pull images from. This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. This is particularly useful for installing Che in a restricted environment.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">organization</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">An optional repository name of an alternative registry to pull images from. This value overrides the container registry organization defined in all the default container images involved in a Che deployment. This is particularly useful for installing Che in a restricted environment.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 30. <code>deployment</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">containers</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of containers belonging to the pod.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">securityContext</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Security options the pod should run with.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-containers-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 31. <code>containers</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">env</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of environment variables to set in the container.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">image</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Container image. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">imagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Image pull policy. Default value is <code>Always</code> for <code>nightly</code>, <code>next</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Container name.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">resources</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Compute resources required by this container.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-containers-resources-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 32. <code>containers</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">limits</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Describes the maximum amount of compute resources allowed.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">request</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Describes the minimum amount of compute resources required.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-containers-resources-request-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 33. <code>request</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cpu</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">CPU, in cores. (500m = .5 cores) If the value is not specified, then the default value is set depending on the component. If value is <code>0</code>, then no value is set for the component.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">memory</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) If the value is not specified, then the default value is set depending on the component. If value is <code>0</code>, then no value is set for the component.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-containers-resources-limits-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 34. <code>limits</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cpu</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">CPU, in cores. (500m = .5 cores) If the value is not specified, then the default value is set depending on the component. If value is <code>0</code>, then no value is set for the component.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">memory</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) If the value is not specified, then the default value is set depending on the component. If value is <code>0</code>, then no value is set for the component.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-components-common-deployment-securityContext-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 35. <code>securityContext</code> options.</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">fsGroup</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A special supplemental group that applies to all containers in a pod. The default value is <code>1724</code>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">runAsUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The UID to run the entrypoint of the container process. The default value is <code>1724</code>.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-status-settings" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 36. <code>CheCluster</code> Custom Resource <code>status</code> defines the observed state of Che installation</caption> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePhase</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the current phase of the Che deployment.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Public URL of the Che server.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheVersion</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Currently installed Che version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The public URL of the internal devfile registry.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gatewayPhase</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the current phase of the gateway deployment.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">message</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A human readable message indicating details about why the Che deployment is in the current phase.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The public URL of the internal plug-in registry.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">reason</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A brief CamelCase message indicating details about why the Che deployment is in the current phase.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">workspaceBaseDomain</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The resolved workspace base domain. This is either the copy of the explicitly defined property of the same name in the spec or, if it is undefined in the spec and we’re running on OpenShift, the automatically resolved basedomain for routes.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div> |
| <a href="https://www.eclipse.org/che/sitemap.xml" target="_blank">Site Map</a> | |
| <a href="https://www.eclipse.org" target="_blank">Eclipse Foundation</a> | |
| <a href="https://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> | |
| <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> | |
| <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a> | |
| <a href="https://www.eclipse.org/legal" target="_blank">Legal Resources</a></div> |
| </footer> |
| |
| <script id="site-script" src="../../../../docs/_/js/site.js" data-ui-root-path="../../../../docs/_"></script> |
| <script async src="../../../../docs/_/js/vendor/highlight.js"></script> |
| <script src="../../../../docs/_/js/vendor/lunr.js"></script> |
| <script src="../../../../docs/_/js/search-ui.js" id="search-ui-script" data-site-root-path="../../../.." data-snippet-length="142" data-stylesheet="../../../../docs/_/css/search.css"></script> |
| <script async src="../../../../search-index.js"></script> |
| </body> |
| </html> |
