blob: b7f945d7298017b195ef386352661a2ad1d1b8f9 [file] [log] [blame]
<!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.3">
<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>
</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="#">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/">Eclipse Che 7 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/">Hosted Che</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>
</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/configuring-a-workspace-using-a-devfile/">Configuring a workspace using a devfile</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/making-a-workspace-portable-using-a-devfile/">Making a workspace portable using a devfile</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/creating-and-configuring-a-new-workspace/">Creating and configuring a new workspace</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/importing-a-kubernetes-application-into-a-workspace/">Importing a Kubernetes application 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/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-by-importing-source-code-of-a-project/">Creating a workspace by importing source code of a project</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>
</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/using-alternative-ides-in-che/">Using alternative IDEs in Che</a>
</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>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../end-user-guide/configuring-oauth-authorization/">Configuring OAuth authorization</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/configuring-github-oauth/">Configuring GitHub OAuth</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/configuring-openshift-oauth/">Configuring OpenShift OAuth</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/troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/troubleshooting-network-problems/">Troubleshooting network problems</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/starting-a-che-workspace-in-debug-mode/">Starting a workspace in debug mode</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../end-user-guide/restarting-a-che-workspace-in-debug-mode-after-start-failure/">Restarting a workspace in debug mode after start failure</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</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 namespace strategies</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="../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="../configuring-storage-types/">Configuring storage types</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../importing-tls-certificates-to-che-server-java-truststore/">Importing TLS certificates to Che server Java truststore</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>
</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-devfile-and-plug-in-registries/">Customizing devfile and plug-in registries</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../administration-guide/building-and-running-a-custom-registry-image/">Building and running a custom registry image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../administration-guide/including-the-plug-in-binaries-in-the-registry-image/">Including the plug-in binaries in the registry image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../administration-guide/editing-a-devfile-and-plug-in-at-runtime/">Editing a devfile and plug-in at runtime</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../administration-guide/using-a-visual-studio-code-extension-in-che/">Using a VS Code extension in Che</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../administration-guide/testing-a-visual-studio-code-extension-in-che/">Testing a VS Code extension in Che</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/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-che-workspaces-logs/">Viewing Che workspaces 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/managing-users/">Managing users</a>
<ul class="nav-list">
<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/removing-user-data/">Removing user data</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../administration-guide/securing-che/">Securing Che</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>
</ul>
</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">
<a class="nav-link" href="../../administration-guide/caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a>
</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</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">
<a class="nav-link" href="../../extensions/telemetry/">Telemetry</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">Eclipse Che 7 Documentation</span>
<span class="version">Stable</span>
</div>
<ul class="components">
<li class="component">
<span class="title">devfile</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../devfile/">master</a>
</li>
</ul>
</li>
<li class="component is-current">
<span class="title">Eclipse Che 7 Documentation</span>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../../overview/introduction-to-eclipse-che/">Stable</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/">Eclipse Che 7 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">
<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&#160;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_configuring-the-che-installation"><a class="anchor" href="#understanding-the-checluster-custom-resource_configuring-the-che-installation"></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&#160;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&#160;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 Kubernetes</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/olm-what-operators-are.html">Understanding Operators</a>.</p>
</li>
<li>
<p><a href="https://docs.openshift.com/container-platform/latest/operators/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_configuring-the-che-installation"><a class="anchor" href="#checluster-custom-resources-fields-reference_configuring-the-che-installation"></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_configuring-the-che-installation">A minimal <code>CheCluster</code> Custom Resource example.</a></p>
</li>
<li>
<p><a href="#checluster-custom-resource-auth-settings_configuring-the-che-installation"><code>CheCluster</code> Custom Resource <code>auth</code> configuration settings related to authentication used by Che installation</a></p>
</li>
<li>
<p><a href="#checluster-custom-resource-database-settings_configuring-the-che-installation"><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-server-settings_configuring-the-che-installation"><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-storage-settings_configuring-the-che-installation"><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_configuring-the-che-installation"><code>CheCluster</code> Custom Resource <code>k8s</code> configuration settings specific to Che installations on Kubernetes</a></p>
</li>
<li>
<p><a href="#checluster-custom-resource-installation-settings_configuring-the-che-installation"><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_configuring-the-che-installation" 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>
<table id="checluster-custom-resource-server-settings_configuring-the-che-installation" 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: 20%;">
<col style="width: 20%;">
<col style="width: 60%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>airGapContainerRegistryHostname</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">An optional host name or URL to an alternative container registry to pull images from. This value overrides the container registry host name defined in all default container images involved in a Che deployment. This is particularly useful to install Che in an air-gapped environment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>airGapContainerRegistryOrganization</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Optional repository name of an alternative 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 an air-gapped environment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheDebug</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables the debug mode for Che server.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheFlavor</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>che</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Flavor of the installation.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheHost</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Operator automatically sets the value.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A public host name of the installed Che server.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheImagePullPolicy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in Che deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheImageTag</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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"><code>cheImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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"><code>cheLogLevel</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>INFO</code></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>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cheWorkspaceClusterRole</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Custom cluster role bound to the user for the Che workspaces. Omit or leave empty to use the default roles.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>customCheProperties</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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). If <code>customCheProperties</code> contains a property that would be normally generated in <code>che</code> ConfigMap from other CR fields, then the value defined in the <code>customCheProperties</code> will be used instead.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>devfileRegistryImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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"><code>devfileRegistryMemoryLimit</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>256Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the Devfile registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>devfileRegistryMemoryRequest</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>16Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the Devfile registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>devfileRegistryPullPolicy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the Devfile registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>devfileRegistryUrl</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Operator automatically sets the value.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public URL of the Devfile registry that serves sample, ready-to-use devfiles. Set it if you use an external devfile registry (see the <code>externalDevfileRegistry</code> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>externalDevfileRegistry</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator to deploy a dedicated Devfile registry server. By default a dedicated devfile registry server is started. If <code>externalDevfileRegistry</code> set to <code>true</code>, the Operator does not start a dedicated registry server automatically and you need to set the <code>devfileRegistryUrl</code> field manually.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>externalPluginRegistry</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator to deploy a dedicated Plugin registry server. By default, a dedicated plug-in registry server is started. If <code>externalPluginRegistry</code> set to <code>true</code>, the Operator does not deploy a dedicated server automatically and you need to set the <code>pluginRegistryUrl</code> field manually.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nonProxyHosts</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of hosts that will not use the configured proxy. Use <code>|`</code> as delimiter, for example <code>localhost|my.host.com|123.42.12.32</code> Only use when configuring a proxy is required (see also the <code>proxyURL</code> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pluginRegistryImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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"><code>pluginRegistryMemoryLimit</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>256Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the Plugin registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pluginRegistryMemoryRequest</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>16Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the Plugin registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pluginRegistryPullPolicy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the Plugin registry deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pluginRegistryUrl</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</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 it only when using an external devfile registry (see the <code>externalPluginRegistry</code> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>proxyPassword</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password of the proxy server. Only use when proxy configuration is required.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>proxyPort</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>proxyURL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>proxyUser</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>serverMemoryLimit</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1Gi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory limit used in the Che server deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>serverMemoryRequest</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>512Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the memory request used in the Che server deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>tlsSupport</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator to deploy Che in TLS mode.</p></td>
</tr>
</tbody>
</table>
<table id="checluster-custom-resource-database-settings_configuring-the-che-installation" 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: 20%;">
<col style="width: 20%;">
<col style="width: 60%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>chePostgresDb</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>dbche</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL database name that the Che server uses to connect to the database.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>chePostgresHostName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</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 to <code>postgres</code>. Override this value only when using an external database. (See the field <code>externalDb</code>.)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>chePostgresPassword</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">auto-generated value</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL password that the Che server uses to connect to the database.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>chePostgresPort</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5432</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL Database port that the Che server uses to connect to. Override this value only when using an external database (see field <code>externalDb</code>).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>chePostgresUser</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pgche</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PostgreSQL user that the Che server uses to connect to the database.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>externalDb</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. If set to <code>true</code>, the Operator does not deploy a dedicated database automatically, you need to provide connection details to an external database. See all the fields starting with: <code>chePostgres</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>postgresImagePullPolicy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Always` for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the PostgreSQL database deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>postgresImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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>
</tbody>
</table>
<table id="checluster-custom-resource-auth-settings_configuring-the-che-installation" class="tableblock frame-all grid-all stretch">
<caption class="title">Table 3. <code>CheCluster</code> Custom Resource <code>auth</code> configuration settings related to authentication used by Che installation</caption>
<colgroup>
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 60%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>externalIdentityProvider</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">By default, a dedicated Identity Provider server is deployed as part of the Che installation. But if <code>externalIdentityProvider</code> is <code>true</code>, then no dedicated identity provider will be deployed by the Operator and you might need to provide details about the external identity provider you want 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"><code>identityProviderAdminUserName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>admin</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the name of the Identity Provider admin user.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderClientId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of an Identity provider (Keycloak / RH SSO) <code>client-id</code> that must be used for Che. This is useful to override it ONLY if you use an external Identity Provider (see the <code>externalIdentityProvider</code> field). If omitted or left blank, it will be set to the value of the <code>flavor</code> field suffixed with <code>-public</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderImagePullPolicy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code> for <code>nightly</code> or <code>latest</code> images, and <code>IfNotPresent</code> in other cases</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the image pull policy used in the Identity Provider (Keycloak / RH SSO) deployment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the container image used in the Identity Provider (Keycloak / 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"><code>identityProviderPassword</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Overrides the password of Keycloak admin user. Override it only when using an external Identity Provider (see the <code>externalIdentityProvider</code> field). Omit or leave empty to set an auto-generated password.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderPostgresPassword</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password for The Identity Provider (Keycloak / RH SSO) to connect to the database. This is useful to override it ONLY if you use an external Identity Provider (see the <code>externalIdentityProvider</code> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderRealm</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of an Identity provider (Keycloak / RH SSO) realm. Override it only when using an external Identity Provider (see the <code>externalIdentityProvider</code> field). Omit or leave empty blank to set it to the value of the <code>flavor</code> field.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>identityProviderURL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Operator to deploy a dedicated Identity Provider (Keycloak or RH SSO instance). Public URL of the Identity Provider server (Keycloak / RH SSO server). Set it only when using an external Identity Provider (see the <code>externalIdentityProvider</code> field).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>oAuthClientName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</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. See also the <code>OpenShiftoAuth</code> field.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>oAuthSecret</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the Operator sets the value automatically</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. See also the <code>OAuthClientName</code> field.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>openShiftoAuth</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code> on OpenShift</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables the integration of the identity provider (Keycloak / RHSSO) with OpenShift OAuth. This allows users to log in with their OpenShift login and have their workspaces created under personal OpenShift namespaces. The <code>kubeadmin</code> user is not supported, and logging through does not allow access to the Che Dashboard.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>updateAdminPassword</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></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.</p></td>
</tr>
</tbody>
</table>
<table id="checluster-custom-resource-storage-settings_configuring-the-che-installation" 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: 20%;">
<col style="width: 20%;">
<col style="width: 60%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>postgresPVCStorageClassName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claim dedicated to the PostgreSQL database. Omitted or leave empty to use a default storage class.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>preCreateSubPaths</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Instructs the Che server to launch a special Pod to pre-create a subpath in the Persistent Volumes. Enable it according to the configuration of your K8S cluster.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pvcClaimSize</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1Gi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Size of the persistent volume claim for workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pvcJobsImage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</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"><code>pvcStrategy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>common</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Available options:`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).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>workspacePVCStorageClassName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Storage class for the Persistent Volume Claims dedicated to the Che workspaces. Omit or leave empty to use a default storage class.</p></td>
</tr>
</tbody>
</table>
<table id="checluster-custom-resource-k8s-settings_configuring-the-che-installation" 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</caption>
<colgroup>
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 60%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ingressClass</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nginx</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Ingress class that defines which controller manages ingresses.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ingressDomain</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Global ingress domain for a K8S cluster. This field must be explicitly specified. This drives the <code>is kubernetes.io/ingress.class</code> annotation on Che-related ingresses.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ingressStrategy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>multi-host</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Strategy for ingress creation. This can be <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).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityContextFsGroup,omitempty</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1724</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">FSGroup the Che Pod and Workspace Pods containers run in.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityContextRunAsUser</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1724</code></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.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>tlsSecretName</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">omit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of a secret that is used to set ingress TLS termination if TLS is enabled. See also the <code>tlsSupport</code> field.</p></td>
</tr>
</tbody>
</table>
<table id="checluster-custom-resource-installation-settings_configuring-the-che-installation" class="tableblock frame-all grid-all stretch">
<caption class="title">Table 6. <code>CheCluster</code> Custom Resource <code>status</code> defines the observed state of Che installation</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 75%;">
</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"><code>cheClusterRunning</code></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"><code>cheURL</code></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"><code>cheVersion</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Currently installed Che version.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>dbProvisioned</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether a PostgreSQL instance has been correctly provisioned.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>devfileRegistryURL</code></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"><code>helpLink</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A URL to where to find help related to the current Operator status.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>keycloakProvisioned</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether an Identity Provider instance (Keycloak / RH SSO) has been provisioned with realm, client and user.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>keycloakURL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public URL to the Identity Provider server (Keycloak / RH SSO).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>message</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A human-readable message with details about why the Pod is in this state.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>openShiftoAuthProvisioned</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Indicates whether an Identity Provider instance (Keycloak / 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"><code>pluginRegistryURL</code></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"><code>reason</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A brief CamelCase message with details about why the Pod is in this state.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</article>
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
</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>