| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Configuring the Che installation :: Eclipse Che Documentation</title> |
| <link rel="canonical" href="https://www.eclipse.org/che/docs/che-7/installation-guide/configuring-the-che-installation/"> |
| <meta name="keywords" content="installation-guide, configuring-the-che-installation, configuring-che"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="stylesheet" href="../../../_/css/site.css"> |
| <link rel="stylesheet" href="../../../_/css/extra.css"> |
| <link rel="stylesheet" href="../../../_/font-awesome-4.7.0/css/font-awesome.min.css"> |
| <link rel="icon" href="../../../favicon.ico" type="image/x-icon"> |
| <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> |
| <script>var uiRootPath = '../../../_'</script> |
| </head> |
| <body class="article"> |
| <header class="header" role="banner"> |
| <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="../../../_/img/icon-eclipse-che.svg" class="navbar-logo" alt="Eclipse Che logo"> |
| <a href="https://www.eclipse.org/che/docs">Eclipse Che Documentation</a> |
| </div> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <div class="navbar-end"> |
| <div class="navbar-item hide-for-print"> |
| <script async src="https://cse.google.com/cse.js?cx=002898025167115630151:gnr5edrg2eo"></script> |
| <div class="gcse-searchbox" enableAutoComplete="true"></div> |
| </div> |
| <a class="navbar-item" href="https://www.eclipse.org/che/docs">Home</a> |
| <a class="navbar-item" href="https://che.eclipse.org/">Blog</a> |
| <a class="navbar-item" href="https://github.com/eclipse/che">Source Code</a> |
| </div> |
| </div> |
| </nav> |
| <div class="gcse-searchresults"></div> |
| </header><div class="body"> |
| <div class="nav-container" data-component="che-7" data-version="master"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <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"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../overview/introduction-to-eclipse-che/">Introduction to Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../overview/che-architecture/">Che architecture</a> |
| </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="../../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">End-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/navigating-che/">Navigating Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/navigating-che-using-the-dashboard/">Navigating Che: dashboard</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/importing-certificates-to-browsers/">Importing certificates to browsers</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/accessing-che-from-openshift-developer-perspective/">Navigating Che from OpenShift Developer Perspective</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/che-theia-ide-basics/">Che-Theia IDE basics</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/defining-custom-commands-for-che-theia/">Defining custom commands for Che-Theia</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/version-control/">Version Control</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/che-theia-troubleshooting/">Che-Theia Troubleshooting</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode/">Differences in how Che-Theia Webview works on a single-host mode comparing to a multi-host mode</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/workspaces-overview/">Using developer workspaces</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-code-sample/">Creating a workspace from code sample</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-remote-devfile/">Creating a workspace from a remote devfile using the dashboard</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-local-devfile-using-chectl/">Creating a workspace from local devfile using chectl</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/creating-a-workspace-by-importing-the-source-code-of-a-project/">Creating a workspace by importing the source code of a project</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/configuring-a-workspace-with-dashboard/">Configuring a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/running-a-workspace-with-dashboard/">Running a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/importing-kubernetes-applications-into-a-workspace/">Importing Kubernetes applications into a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/remotely-accessing-workspaces/">Remotely accessing workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-workspace-container/">Mounting a secret as a file or an environment variable into a workspace container</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/authenticating-on-scm-server-with-a-personal-access-token/">Authenticating on SCM Server with a personal access token</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/authoring-devfiles/">Authoring devfiles</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/authoring-devfiles-version-1/">Authoring devfiles version 1</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/authoring-devfiles-version-2/">Authoring devfiles version 2</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/customizing-developer-environments/">Customizing developer environments</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/what-is-a-che-theia-plug-in/">What is a Che-Theia plug-in</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/adding-a-vs-code-extension-to-a-workspace/">Adding a VS Code extension to a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/adding-a-vs-code-extension-to-the-che-plugin-registry/">Adding a VS Code extension to the Che plug-ins registry</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/publishing-metadata-for-a-vs-code-extension/">Publishing a VS Code extension</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/testing-a-visual-studio-code-extension-in-che/">Testing a VS Code extension in Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../end-user-guide/using-alternative-ides-in-che/">Using alternative IDEs in Che</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/support-for-jetbrains-ides/">JetBrains IDEs</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/using-jetbrains-intellij-idea-community-edition/">Using IntelliJ Idea Community Edition</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/using-jetbrains-intellij-idea-ultimate-edition/">Using IntelliJ Idea Ultimate Edition</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/configuring-an-existing-workspace-to-use-intellij-idea/">Configuring an existing workspace to use IntelliJ IDEA</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/using-jetbrains-webstorm/">Using WebStorm</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../end-user-guide/provisioning-jetbrains-activation-code-for-offline-use/">Provisioning activation code for offline use</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../end-user-guide/support-for-theia-based-ides/">Theia-based IDEs</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/adding-tools-to-che-after-creating-a-workspace/">Adding tools to Che after creating a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-private-container-registries/">Using private container registries</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-artifact-repositories-in-a-restricted-environment/">Using artifact repositories in a restricted environment</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-maven-artifact-repositories/">Using Maven artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-gradle-artifact-repositories/">Using Gradle artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-python-artifact-repositories/">Using Python artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-go-artifact-repositories/">Using Go artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-nuget-artifact-repositories/">Using NuGet artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/using-npm-artifact-repositories/">Using npm artifact repositories</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"> |
| <a class="nav-link" href="../../end-user-guide/viewing-che-workspaces-logs/">Viewing Che workspaces logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../end-user-guide/investigating-failures-at-a-workspace-start-using-the-verbose-mode/">Troubleshooting workspace start failures</a> |
| </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> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Installation Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../supported-platforms/">Supported platforms</a> |
| </li> |
| <li class="nav-item is-current-page" data-depth="1"> |
| <a class="nav-link" href="./">Configuring the Che installation</a> |
| </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-cloud/">Installing Che in cloud</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-openshift-4-using-operatorhub/">Installing Che on OpenShift 4 using OperatorHub</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-openshift-4-using-cli/">Installing Che on OpenShift 4 using CLI</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-openshift-3-using-the-operator/">Installing Che on OpenShift 3</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-kubespray/">Installing Che on Kubespray</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-aws/">Installing Che on AWS</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-google-cloud-platform/">Installing Che on Google Cloud</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-codeready-containers/">Installing Che on CodeReady Containers</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-docker-desktop/">Installing Che on Docker Desktop</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-minishift/">Installing Che on Minishift</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../installing-che-on-kind/">Installing Che on Kind</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-the-chectl-management-tool/">Using the chectl management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../installing-che-in-a-restricted-environment/">Installing Che in restricted environment</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../advanced-configuration/">Advanced configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <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="2"> |
| <a class="nav-link" href="../configuring-namespace-strategies/">Configuring workspace target namespace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-storage-strategies/">Configuring storage strategies</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-storage-types/">Configuring storage types</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-the-number-of-workspaces-that-a-user-can-run/">Configuring the number of workspaces that a user can run</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-the-number-of-workspaces-that-a-user-can-create/">Configuring the number of workspaces that a user can create</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-workspace-exposure-strategies/">Configuring workspace exposure strategies</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-workspaces-nodeselector/">Configuring workspaces nodeSelector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-che-hostname/">Configuring Che hostname</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-ingresses/">Configuring Kubernetes Ingress</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-routes/">Configuring OpenShift Route</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../deploying-che-with-support-for-git-repositories-with-self-signed-certificates/">Deploying Che with support for Git repositories with self-signed certificates</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../installing-che-using-storage-classes/">Installing Che using storage classes</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../importing-untrusted-tls-certificates/">Importing untrusted TLS certificates to Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../switching-between-external-and-internal-communication/">Switching between external and internal ways in inter-component communication</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page/">Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <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="2"> |
| <a class="nav-link" href="../enabling-dev-workspace-engine/">Enabling Dev Workspace engine</a> |
| </li> |
| </ul> |
| </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-che-using-operatorhub/">Upgrading Che using OperatorHub</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 restricted environment</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../upgrading-che-namespace-strategies-other-than-per-user/">Updating Che namespace strategies other than 'per user'</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../uninstalling-che/">Uninstalling Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../uninstalling-che-after-operatorhub-installation-using-openshift-web-console/">Using the OpenShift web console</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../uninstalling-che-after-operatorhub-installation-using-openshift-cli/">Using OpenShift CLI</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../uninstalling-che-after-chectl-installation/">Using chectl</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="../../administration-guide/che-architecture-overview/">Che architecture</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/che-workspace-controller/">Che workspace controller</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/che-workspaces-architecture/">Che workspaces architecture</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/calculating-che-resource-requirements/">Calculating Che resource requirements</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/customizing-the-registries/">Customizing the registries</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/building-custom-registry-images/">Building custom registry images</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/running-custom-registries/">Running custom registries</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/retrieving-che-logs/">Retrieving Che logs</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-server-logging/">Configuring server logging</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-kubernetes-events/">Accessing Kubernetes events on OpenShift</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-operator-events/">Viewing the Operator events on OpenShift</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-che-server-logs/">Viewing Che server logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-external-service-logs/">Viewing external service logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-plug-in-broker-logs/">Viewing Plug-in broker logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/collecting-logs-using-chectl/">Collecting logs using chectl</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/monitoring-che/">Monitoring Che</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/tracing-che/">Tracing Che</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/backup-and-disaster-recovery/">Backup and disaster recovery</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/external-database-setup/">External database setup</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/persistent-volumes-backups/">Persistent Volumes backups</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/defining-the-list-of-images-to-pull/">Defining the list of images</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/defining-the-memory-parameters-for-the-image-puller/">Defining the memory settings</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-using-che-operator/">Installing using the Che Operator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-the-image-puller-operator/">Installing using the Kubernetes Image Puller Operator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-operatorhub/">Installing on OpenShift 4</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-openshift-templates/">Installing on OpenShift 3</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-helm/">Installing using Helm</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/managing-identities-and-authorizations/">Managing identities and authorizations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/authenticating-users/">Authenticating users</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/authorizing-users/">Authorizing users</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-authorization/">Configuring authorization</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-openshift-oauth/">Configuring OpenShift OAuth</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/removing-user-data/">Removing user data</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Contributor Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/branding-che-theia/">Branding Che-Theia</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/developing-che-theia-plug-ins/">Developing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/testing-che-theia-plug-ins/">Testing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/publishing-che-theia-plug-ins/">Publishing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-language/">Adding support for a new language</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-debugger/">Adding support for a new debugger</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../contributor-guide/che-extensibility-reference/">Che extensibility reference</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/che-extension-points/">Che extension points</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/che-theia-plug-in-api/">Che-Theia plug-in API</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/debug-adapter-protocol/">Debug Adapter Protocol</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/language-server-protocol/">Language Server Protocol</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Extensions</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../extensions/eclipse-che4z/">eclipse-che4z.adoc</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <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="2"> |
| <a class="nav-link" href="../../extensions/features-of-openshift-connector/">Features of OpenShift Connector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <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="2"> |
| <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="2"> |
| <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="2"> |
| <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> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../extensions/telemetry/">Telemetry</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/creating-a-telemetry-plugin/">Creating A Telemetry Plugin</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/the-woopra-telemetry-plugin/">The Woopra Telemetry Plugin</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../extensions/java-lombok/">Java Lombok</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="../../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">master</span> |
| </div> |
| <ul class="components"> |
| <li class="component is-current"> |
| <a class="title" href="../../overview/introduction-to-eclipse-che/">Documentation</a> |
| <ul class="versions"> |
| <li class="version is-current is-latest"> |
| <a href="../../overview/introduction-to-eclipse-che/">master</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>Installation Guide</li> |
| <li><a href="./">Configuring the Che installation</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/eclipse/che-docs/edit/master/modules/installation-guide/pages/configuring-the-che-installation.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">Configuring the Che installation</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The following section describes configuration options to install Eclipse Che using the Operator.</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Prerequisites</div> |
| <ul> |
| <li> |
| <p>Choose an installation procedure using the Operator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="understanding-the-checluster-custom-resource_che"><a class="anchor" href="#understanding-the-checluster-custom-resource_che"></a>Understanding the <code>CheCluster</code> Custom Resource</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>A default deployment of Che consist in the application of a parametrized <code>CheCluster</code> Custom Resource by the Eclipse Che Operator.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"><code>CheCluster</code> Custom Resource</dt> |
| <dd> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>A YAML document describing the configuration of the overall Che installation.</p> |
| </li> |
| <li> |
| <p>Contains sections to configure each component: <code>auth</code>, <code>database</code>, <code>server</code>, <code>storage</code>.</p> |
| </li> |
| </ul> |
| </div> |
| </dd> |
| <dt class="hdlist1">Role of the Eclipse Che Operator</dt> |
| <dd> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To translate the <code>CheCluster</code> Custom Resource into configuration (ConfigMap) usable by each component of the Che installation.</p> |
| </li> |
| </ul> |
| </div> |
| </dd> |
| <dt class="hdlist1">Role of the Kubernetes platform</dt> |
| <dd> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To apply the configuration (ConfigMap) for each component.</p> |
| </li> |
| <li> |
| <p>To create the necessary Pods.</p> |
| </li> |
| <li> |
| <p>When Kubernetes detects a change in the configuration of a component, it restarts the Pods accordingly.</p> |
| </li> |
| </ul> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| <div class="exampleblock"> |
| <div class="title">Example 1. Configuring the main properties of the Che server component</div> |
| <div class="content"> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>The user applies a <code>CheCluster</code> Custom Resource containing some configuration related to the <code>server</code>.</p> |
| </li> |
| <li> |
| <p>The Operator generates a necessary ConfigMap, called <code>che</code>.</p> |
| </li> |
| <li> |
| <p>Kubernetes detects change in the ConfigMap and triggers a restart of the Che Pod.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="ulist"> |
| <div class="title">Additional resources</div> |
| <ul> |
| <li> |
| <p><a href="https://docs.openshift.com/container-platform/latest/operators/understanding/olm-what-operators-are.html">Understanding Operators</a>.</p> |
| </li> |
| <li> |
| <p><a href="https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.html">Understanding Custom Resources</a>.</p> |
| </li> |
| <li> |
| <p>To learn how to modify the <code>CheCluster</code> Custom Resource, see the chosen installation procedure.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="checluster-custom-resources-fields-reference_che"><a class="anchor" href="#checluster-custom-resources-fields-reference_che"></a><code>CheCluster</code> Custom Resource fields reference</h2> |
| <div class="sectionbody"> |
| <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_che">A minimal <code>CheCluster</code> Custom Resource example.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-server-settings_che"><code>CheCluster</code> Custom Resource <code>server</code> settings, related to the Che server component.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-database-settings_che"><code>CheCluster</code> Custom Resource <code>database</code> configuration settings related to the database used by Che.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-auth-settings_che">Custom Resource <code>auth</code> configuration settings related to authentication used by Che.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-storage-settings_che"><code>CheCluster</code> Custom Resource <code>storage</code> configuration settings related to persistent storage used by Che.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-k8s-settings_che"><code>CheCluster</code> Custom Resource <code>k8s</code> configuration settings specific to Che installations on Kubernetes or OpenShift.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-metrics-settings_che"><code>CheCluster</code> Custom Resource <code>metrics</code> settings, related to the Che metrics collection used by Che.</a></p> |
| </li> |
| <li> |
| <p><a href="#checluster-custom-resource-status-settings_che"><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_che" class="exampleblock"> |
| <div class="title">Example 2. 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/v1 |
| kind: CheCluster |
| metadata: |
| name: eclipse-che |
| spec: |
| auth: |
| externalIdentityProvider: false |
| database: |
| externalDb: false |
| server: |
| selfSignedCert: false |
| gitSelfSignedCert: false |
| tlsSupport: true |
| storage: |
| pvcStrategy: 'common' |
| pvcClaimSize: '1Gi'</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><!-- vale off --></p> |
| </div> |
| <table id="checluster-custom-resource-server-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 1. <code>CheCluster</code> Custom Resource <code>server</code> settings, related to the Che server component.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">airGapContainerRegistryHostname</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Optional host name, or URL, to an alternate container registry to pull images from. This value overrides the container registry host name defined in all the default container images involved in a Che deployment. This is particularly useful to install Che in a restricted environment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">airGapContainerRegistryOrganization</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Optional repository name of an alternate container 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 to install Che in a restricted environment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">allowUserDefinedWorkspaceNamespaces</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated. The value of this flag is ignored. Defines that a user is allowed to specify a Kubernetes namespace, or an OpenShift project, which differs from the default. It’s NOT RECOMMENDED to set to <code>true</code> without OpenShift OAuth configured. The OpenShift infrastructure also uses this property.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheClusterRoles</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheDebug</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables the debug mode for Che server. Defaults to <code>false</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheFlavor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies a variation of the installation. The options are <code>che</code> for upstream Che installations, or <code>codeready</code> for <a href="https://developers.redhat.com/products/codeready-workspaces/overview">CodeReady Workspaces</a> installation. Override the default value only on necessary occasions.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheHost</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Public host name of the installed Che server. When value is omitted, the value it will be automatically set by the Operator. See the <code>cheHostTLSSecret</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheHostTLSSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. See the <code>cheHost</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in Che deployment. This does NOT include the container image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheImagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in Che deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheImageTag</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the tag of the container image used in Che deployment. Omit it or leave it empty to use the default image tag provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheLogLevel</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Log level for the Che server: <code>INFO</code> or <code>DEBUG</code>. Defaults to <code>INFO</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheServerIngress</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The Che server ingress custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheServerRoute</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The Che server route custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheWorkspaceClusterRole</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Custom cluster role bound to the user for the Che workspaces. The default roles are used when omitted or left blank.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">customCheProperties</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Map of additional environment variables that will be 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). When <code>customCheProperties</code> contains a property that would be normally generated in <code>che</code> ConfigMap from other CR fields, the value defined in the <code>customCheProperties</code> is used instead.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardCpuLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardCpuRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the dashboard deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardImagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the dashboard deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardIngress</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Dashboard ingress custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardMemoryLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the dashboard deployment. Defaults to 256Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardMemoryRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the dashboard deployment. Defaults to 16Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dashboardRoute</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Dashboard route custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryCpuLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU limit used in the devfile registry deployment. In cores. (500m = .5 cores). Default to 500m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryCpuRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU request used in the devfile registry deployment. In cores. (500m = .5 cores). Default to 100m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the devfile registry deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryIngress</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The devfile registry ingress custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryMemoryLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the devfile registry deployment. Defaults to 256Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryMemoryRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the devfile registry deployment. Defaults to 16Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryPullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the devfile registry deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devfileRegistryRoute</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The devfile registry route custom settings.</p></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">Deprecated in favor of <code>externalDevfileRegistries</code> fields.</p></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, that serves sample, ready-to-use devfiles. Configure this in addition to a dedicated devfile registry (when <code>externalDevfileRegistry</code> is <code>false</code>) or instead of it (when <code>externalDevfileRegistry</code> is <code>true</code>)</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalDevfileRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator on whether to deploy a dedicated devfile registry server. By default, a dedicated devfile registry server is started. When <code>externalDevfileRegistry</code> is <code>true</code>, no such dedicated server will be started by the Operator and configure at least one devfile registry with <code>externalDevfileRegistries</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalPluginRegistry</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator on whether to deploy a dedicated plugin registry server. By default, a dedicated plugin registry server is started. When <code>externalPluginRegistry</code> is <code>true</code>, no such dedicated server will be started by the Operator and you will have to manually set the <code>pluginRegistryUrl</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gitSelfSignedCert</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">When enabled, the certificate from <code>che-git-self-signed-cert</code> ConfigMap will be propagated to the Che components and provide particular configuration for Git.</p></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">List of hosts that will be reached directly, bypassing the proxy. Specify wild card domain use the following form <code>.<DOMAIN></code> and <code>|</code> as delimiter, for example: <code>localhost|.my.host.com|123.42.12.32</code> Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration and no additional configuration is required, but defining <code>nonProxyHosts</code> in a custom resource leads to merging non proxy hosts lists from the cluster proxy configuration and ones defined in the custom resources. See the doc <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>. See also the <code>proxyURL</code> fields.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryCpuLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU limit used in the plugin registry deployment. In cores. (500m = .5 cores). Default to 500m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryCpuRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU request used in the plugin registry deployment. In cores. (500m = .5 cores). Default to 100m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the plugin registry deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryIngress</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Plugin registry ingress custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryMemoryLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the plugin registry deployment. Defaults to 256Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryMemoryRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the plugin registry deployment. Defaults to 16Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryPullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the plugin registry deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pluginRegistryRoute</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Plugin registry route custom settings.</p></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">Public URL of the plugin registry that serves sample ready-to-use devfiles. Set this ONLY when a use of an external devfile registry is needed. See the <code>externalPluginRegistry</code> field. By default, this will be automatically calculated by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxyPassword</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Password of the proxy server. Only use when proxy configuration is required. See the <code>proxyURL</code>, <code>proxyUser</code> and <code>proxySecret</code> fields.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxyPort</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Port of the proxy server. Only use when configuring a proxy is required. See also the <code>proxyURL</code> and <code>nonProxyHosts</code> fields.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxySecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The secret that contains <code>user</code> and <code>password</code> for a proxy server. When the secret is defined, the <code>proxyUser</code> and <code>proxyPassword</code> are ignored.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxyURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">URL (protocol+host name) of the proxy server. This drives the appropriate changes in the <code>JAVA_OPTS</code> and <code>https(s)_proxy</code> variables in the Che server and workspaces containers. Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration and no additional configuration is required, but defining <code>proxyUrl</code> in a custom resource leads to overrides the cluster proxy configuration with fields <code>proxyUrl</code>, <code>proxyPort</code>, <code>proxyUser</code> and <code>proxyPassword</code> from the custom resource. See the doc <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>. See also the <code>proxyPort</code> and <code>nonProxyHosts</code> fields.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">proxyUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">User name of the proxy server. Only use when configuring a proxy is required. See also the <code>proxyURL</code>, <code>proxyPassword</code> and <code>proxySecret</code> fields.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">selfSignedCert</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated. The value of this flag is ignored. The Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverCpuLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverCpuRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the CPU request used in the Che server deployment In cores. (500m = .5 cores). Default to 100m.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverExposureStrategy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the server and workspaces exposure type. Possible values are <code>multi-host</code>, <code>single-host</code>, <code>default-host</code>. Defaults to <code>multi-host</code>, which creates a separate ingress, or OpenShift routes, for every required endpoint. <code>single-host</code> makes Che exposed on a single host name with workspaces exposed on subpaths. Read the docs to learn about the limitations of this approach. Also consult the <code>singleHostExposureType</code> property to further configure how the Operator and the Che server make that happen on Kubernetes. <code>default-host</code> exposes the Che server on the host of the cluster. Read the docs to learn about the limitations of this approach.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverMemoryLimit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the Che server deployment. Defaults to 1Gi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverMemoryRequest</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the Che server deployment. Defaults to 512Mi.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">serverTrustStoreConfigMapName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the ConfigMap with public certificates to add to Java trust store of the Che server. This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. The Che server must be aware of its CA cert to be able to request it. This is disabled by default.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">singleHostGatewayConfigMapLabels</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The labels that need to be present in the ConfigMaps representing the gateway configuration.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">singleHostGatewayConfigSidecarImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The image used for the gateway sidecar that provides configuration to the gateway. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">singleHostGatewayImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The image used for the gateway in the single host mode. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">tlsSupport</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated. Instructs the Operator to deploy Che in TLS mode. This is enabled by default. Disabling TLS sometimes cause malfunction of some Che components.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">useInternalClusterSVCNames</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use internal cluster SVC names to communicate between components to speed up the traffic and avoid proxy issues. The default value is <code>true</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">workspaceNamespaceDefault</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Defines Kubernetes default namespace in which user’s workspaces are created for a case when a user does not override it. It’s possible to use <code><username></code>, <code><userid></code> and <code><workspaceid></code> placeholders, such as che-workspace-<username>. In that case, a new namespace will be created for each user or workspace.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-database-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 2. <code>CheCluster</code> Custom Resource <code>database</code> configuration settings related to the database used by Che.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresContainerResources</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL container custom settings</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresDb</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL database name that the Che server uses to connect to the DB. Defaults to <code>dbche</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresHostName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL Database host name that the Che server uses to connect to. Defaults is <code>postgres</code>. Override this value ONLY when using an external database. See field <code>externalDb</code>. In the default case it will be automatically set by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresPassword</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL password that the Che server uses to connect to the DB. When omitted or left blank, it will be set to an automatically generated value.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresPort</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL Database port that the Che server uses to connect to. Defaults to 5432. Override this value ONLY when using an external database. See field <code>externalDb</code>. In the default case it will be automatically set by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The secret that contains PostgreSQL`user` and <code>password</code> that the Che server uses to connect to the DB. When the secret is defined, the <code>chePostgresUser</code> and <code>chePostgresPassword</code> are ignored. When the value is omitted or left blank, the one of following scenarios applies: 1. <code>chePostgresUser</code> and <code>chePostgresPassword</code> are defined, then they will be used to connect to the DB. 2. <code>chePostgresUser</code> or <code>chePostgresPassword</code> are not defined, then a new secret with the name <code>che-postgres-secret</code> will be created with default value of <code>pgche</code> for <code>user</code> and with an auto-generated value for <code>password</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">chePostgresUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL user that the Che server uses to connect to the DB. Defaults to <code>pgche</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalDb</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator on whether to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When <code>externalDb</code> is <code>true</code>, no dedicated database will be deployed by the Operator and you will need to provide connection details to the external DB you are about to use. See also all the fields starting with: <code>chePostgres</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">postgresImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the PostgreSQL database deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">postgresImagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the PostgreSQL database deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-auth-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 3. Custom Resource <code>auth</code> configuration settings related to authentication used by Che.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">externalIdentityProvider</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator on whether or not to deploy a dedicated Identity Provider (Keycloak or RH SSO instance). Instructs the Operator on whether to deploy a dedicated Identity Provider (Keycloak or RH-SSO instance). By default, a dedicated Identity Provider server is deployed as part of the Che installation. When <code>externalIdentityProvider</code> is <code>true</code>, no dedicated identity provider will be deployed by the Operator and you will need to provide details about the external identity provider you are about to use. See also all the other fields starting with: <code>identityProvider</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gatewayAuthenticationSidecarImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Gateway sidecar responsible for authentication when NativeUserMode is enabled. See <a href="https://github.com/oauth2-proxy/oauth2-proxy">oauth2-proxy</a> or <a href="https://github.com/openshift/oauth-proxy">openshift/oauth-proxy</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gatewayAuthorizationSidecarImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Gateway sidecar responsible for authorization when NativeUserMode is enabled. See <a href="https://github.com/brancz/kube-rbac-proxy">kube-rbac-proxy</a> or <a href="https://github.com/openshift/kube-rbac-proxy">openshift/kube-rbac-proxy</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gatewayHeaderRewriteSidecarImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Header Rewrite Proxy sidecar image is used to properly set authorization header. See <a href="https://github.com/che-incubator/header-rewrite-proxy">header-rewrite-proxy</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderAdminUserName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the name of the Identity Provider administrator user. Defaults to <code>admin</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderClientId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of a Identity provider, Keycloak or RH-SSO, <code>client-id</code> that is used for Che. Override this when an external Identity Provider is in use. See the <code>externalIdentityProvider</code> field. When omitted or left blank, it is set to the value of the <code>flavour</code> field suffixed with <code>-public</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderContainerResources</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Identity provider container custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the Identity Provider, Keycloak or RH-SSO, deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderImagePullPolicy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. Default value is <code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderIngress</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Ingress custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderPassword</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the password of Keycloak administrator user. Override this when an external Identity Provider is in use. See the <code>externalIdentityProvider</code> field. When omitted or left blank, it is set to an auto-generated password.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderPostgresPassword</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Password for a Identity Provider, Keycloak or RH-SSO, to connect to the database. Override this when an external Identity Provider is in use. See the <code>externalIdentityProvider</code> field. When omitted or left blank, it is set to an auto-generated password.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderPostgresSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The secret that contains <code>password</code> for the Identity Provider, Keycloak or RH-SSO, to connect to the database. When the secret is defined, the <code>identityProviderPostgresPassword</code> is ignored. When the value is omitted or left blank, the one of following scenarios applies: 1. <code>identityProviderPostgresPassword</code> is defined, then it will be used to connect to the database. 2. <code>identityProviderPostgresPassword</code> is not defined, then a new secret with the name <code>che-identity-postgres-secret</code> will be created with an auto-generated value for <code>password</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderRealm</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of a Identity provider, Keycloak or RH-SSO, realm that is used for Che. Override this when an external Identity Provider is in use. See the <code>externalIdentityProvider</code> field. When omitted or left blank, it is set to the value of the <code>flavour</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderRoute</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Route custom settings.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">identityProviderSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The secret that contains <code>user</code> and <code>password</code> for Identity Provider. When the secret is defined, the <code>identityProviderAdminUserName</code> and <code>identityProviderPassword</code> are ignored. When the value is omitted or left blank, the one of following scenarios applies: 1. <code>identityProviderAdminUserName</code> and <code>identityProviderPassword</code> are defined, then they will be used. 2. <code>identityProviderAdminUserName</code> or <code>identityProviderPassword</code> are not defined, then a new secret with the name <code>che-identity-secret</code> will be created with default value <code>admin</code> for <code>user</code> and with an auto-generated value for <code>password</code>.</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 (Keycloak / RH-SSO server). Set this ONLY when a use of an external Identity Provider is needed. See the <code>externalIdentityProvider</code> field. By default, this will be automatically calculated and set by the Operator.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">initialOpenShiftOAuthUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">For operating with the OpenShift OAuth authentication, create a new user account since the kubeadmin can not be used. If the value is true, then a new OpenShift OAuth user will be created for the HTPasswd identity provider. If the value is false and the user has already been created, then it will be removed. If value is an empty, then do nothing. The user’s credentials are stored in the <code>openshift-oauth-user-credentials</code> secret in 'openshift-config' namespace by Operator. Note that this solution is Openshift 4 platform-specific.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">nativeUserMode</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak.</p></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 setup identity federation on the OpenShift side. Auto-generated when left blank. See also the <code>OpenShiftoAuth</code> field.</p></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 setup identity federation on the OpenShift side. Auto-generated when left blank. See also the <code>OAuthClientName</code> field.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">openShiftoAuth</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Enables the integration of the identity provider (Keycloak / RHSSO) with OpenShift OAuth. Empty value on OpenShift by default. This will allow users to directly login with their OpenShift user through the OpenShift login, and have their workspaces created under personal OpenShift namespaces. WARNING: the <code>kubeadmin</code> user is NOT supported, and logging through it will NOT allow accessing the Che Dashboard.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">updateAdminPassword</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Forces the default <code>admin</code> Che user to update password on first login. Defaults to <code>false</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-storage-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 4. <code>CheCluster</code> Custom Resource <code>storage</code> configuration settings related to persistent storage used by Che.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">postgresPVCStorageClassName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claim dedicated to the PostgreSQL database. When omitted or left blank, a default storage class is used.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">preCreateSubPaths</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. Defaults to <code>false</code>, however it will need to enable it according to the configuration of your Kubernetes cluster.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pvcClaimSize</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Size of the persistent volume claim for workspaces. Defaults to <code>10Gi</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">pvcJobsImage</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used to create sub-paths in the Persistent Volumes. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. See also the <code>preCreateSubPaths</code> field.</p></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. This Can be:`common` (all workspaces PVCs in one volume), <code>per-workspace</code> (one PVC per workspace for all declared volumes) and <code>unique</code> (one PVC per declared volume). Defaults to <code>common</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">workspacePVCStorageClassName</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claims dedicated to the Che workspaces. When omitted or left blank, a default storage class is used.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-k8s-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 5. <code>CheCluster</code> Custom Resource <code>k8s</code> configuration settings specific to Che installations on Kubernetes or OpenShift.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ingressClass</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Ingress class that will define the which controller will manage ingresses. Defaults to <code>nginx</code>. NB: This drives the <code>kubernetes.io/ingress.class</code> annotation on Che-related ingresses.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ingressDomain</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ingressStrategy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Strategy for ingress creation. Options are: <code>multi-host</code> (host is explicitly provided in ingress), <code>single-host</code> (host is provided, path-based rules) and <code>default-host</code> (no host is provided, path-based rules). Defaults to <code>multi-host</code> Deprecated in favor of <code>serverExposureStrategy</code> in the <code>server</code> section, which defines this regardless of the cluster type. When both are defined, the <code>serverExposureStrategy</code> option takes precedence.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">securityContextFsGroup</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The FSGroup in which the Che Pod and workspace Pods containers runs in. Default value is <code>1724</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">securityContextRunAsUser</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ID of the user the Che Pod and workspace Pods containers run as. Default value is <code>1724</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">singleHostExposureType</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">When the serverExposureStrategy is set to <code>single-host</code>, the way the server, registries and workspaces are exposed is further configured by this property. The possible values are <code>native</code>, which means that the server and workspaces are exposed using ingresses on K8s or <code>gateway</code> where the server and workspaces are exposed using a custom gateway based on <a href="https://doc.traefik.io/traefik/">Traefik</a>. All the endpoints whether backed by the ingress or gateway <code>route</code> always point to the subpaths on the same domain. Defaults to <code>native</code>.</p></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">Name of a secret that will be used to setup ingress TLS termination when TLS is enabled. When the field is empty string, the default cluster certificate will be used. See also the <code>tlsSupport</code> field.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-metrics-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 6. <code>CheCluster</code> Custom Resource <code>metrics</code> settings, related to the Che metrics collection used by Che.</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</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> the Che server endpoint. Default to <code>true</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="checluster-custom-resource-status-settings_che" class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 7. <code>CheCluster</code> Custom Resource <code>status</code> defines the observed state of Che installation</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Property</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">cheClusterRunning</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Status of a Che installation. Can be <code>Available</code>, <code>Unavailable</code>, or <code>Available, Rolling Update in Progress</code>.</p></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 to the Che server.</p></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">Current installed Che version.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">dbProvisioned</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Indicates that a PostgreSQL instance has been correctly provisioned or not.</p></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">Public URL to the devfile registry.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">devworkspaceStatus</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The status of the Devworkspace subsystem</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">gitHubOAuthProvisioned</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been configured to integrate with the GitHub OAuth.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">helpLink</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A URL that points to some URL where to find help related to the current Operator status.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">keycloakProvisioned</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been provisioned with realm, client and user.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">keycloakURL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Public URL to the Identity Provider server, Keycloak or RH-SSO,.</p></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 Pod is in this condition.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">openShiftOAuthUserCredentialsSecret</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">OpenShift OAuth secret in <code>openshift-config</code> namespace that contains user credentials for HTPasswd identity provider.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">openShiftoAuthProvisioned</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been configured to integrate with the OpenShift OAuth.</p></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">Public URL to the plugin registry.</p></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 Pod is in this state.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </article> |
| </div> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div><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 src="../../../_/js/site.js"></script> |
| <script async src="../../../_/js/vendor/highlight.js"></script> |
| </body> |
| </html> |
