Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ nav:
- modules/secure/nav.adoc
- modules/optimize/nav.adoc
- modules/observe/nav.adoc
- modules/configure/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down Expand Up @@ -128,7 +129,7 @@ ext:
- run:
command: ./tools/checluster_docs_gen.sh
scan:
base: modules/administration-guide/examples/checluster-properties
base: modules/configure/examples/checluster-properties
dir: build/collector/checluster-properties
files: checluster-properties.adoc
# - run:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
With this setup, you achieve a curated access to {prod-short},
where cluster administrators control provisioning for each user
and can explicitly configure various settings including resource limits and quotas.
Learn more about project provisioning in the xref:administration-guide:provisioning-namespaces-in-advance.adoc[].
Learn more about project provisioning in the xref:configure:provisioning-namespaces-in-advance.adoc[].
72 changes: 15 additions & 57 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,61 +1,20 @@
.Administration Guide

* xref:configuring-che.adoc[]
** xref:understanding-the-checluster-custom-resource.adoc[]
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
*** xref:checluster-custom-resource-fields-reference.adoc[]
** xref:configuring-namespace-provisioning.adoc[]
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces-in-advance.adoc[]
*** xref:configuring-a-user-namespace.adoc[]
*** xref:configuring-kubernetes-namespace-creation-on-openshift.adoc[]
** xref:configuring-server-components.adoc[]
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
** xref:configuring-workspaces-globally.adoc[]
*** xref:limiting-the-number-of-workspaces-that-a-user-can-keep.adoc[]
*** xref:limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc[]
*** xref:enabling-users-to-run-multiple-workspaces-simultaneously.adoc[]
*** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
*** xref:configuring-workspaces-nodeselector.adoc[]
*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
*** xref:enabling-container-run-capabilities.adoc[]
** xref:configuring-networking.adoc[]
*** xref:configuring-network-policies.adoc[]
*** xref:configuring-che-hostname.adoc[]
*** xref:configuring-che-with-self-signed-certificate.adoc[]
*** xref:importing-untrusted-tls-certificates.adoc[]
*** xref:adding-labels-and-annotations.adoc[]
*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
*** xref:configuring-proxy.adoc[]
** xref:configuring-storage.adoc[]
*** xref:configuring-storage-classes.adoc[]
*** xref:configuring-the-storage-strategy.adoc[]
*** xref:configuring-storage-sizes.adoc[]
*** xref:con_persistent-user-home.adoc[]
** xref:configuring-dashboard.adoc[]
*** xref:configuring-getting-started-samples.adoc[]
*** xref:configuring-editors-definitions.adoc[]
*** xref:show-deprecated-editors.adoc[]
*** xref:configuring-default-editor.adoc[]
*** xref:concealing-editors.adoc[]
*** xref:configuring-editors-download-urls.adoc[]
*** xref:configuring-ai-providers.adoc[]
**** xref:ai-provider-api-key-secret-reference.adoc[]
*** xref:customizing-openshift-che-branding-images.adoc[]
** xref:configuring-oauth-for-git-providers.adoc[]
*** xref:configuring-oauth-2-for-github.adoc[]
*** xref:configuring-oauth-2-for-gitlab.adoc[]
*** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[]
*** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[]
*** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[]
*** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[]
** xref:configuring-fuse.adoc[]
*** xref:enabling-access-to-dev-fuse-for-openshift.adoc[]
*** xref:enabling-fuse-for-all-workspaces.adoc[]
** xref:devworkspace-backup.adoc[]
*** xref:devworkspace-backup-integrated-openshift-registry.adoc[]
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
* Editors and AI providers
** xref:configuring-editors-definitions.adoc[]
** xref:show-deprecated-editors.adoc[]
** xref:configuring-default-editor.adoc[]
** xref:concealing-editors.adoc[]
** xref:configuring-editors-download-urls.adoc[]
** xref:configuring-ai-providers.adoc[]
*** xref:ai-provider-api-key-secret-reference.adoc[]
* xref:configuring-oauth-for-git-providers.adoc[]
** xref:configuring-oauth-2-for-github.adoc[]
** xref:configuring-oauth-2-for-gitlab.adoc[]
** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[]
** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[]
* xref:managing-ide-extensions.adoc[]
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
** xref:configuring-the-open-vsx-registry-url.adoc[]
Expand All @@ -71,4 +30,3 @@
** xref:default-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:manage-extension-installation.adoc[]
** xref:editor-configurations-for-microsoft-visual-studio-code.adoc[]
* xref:managing-workloads-using-the-che-server-api.adoc[]
23 changes: 0 additions & 23 deletions modules/administration-guide/pages/configuring-dashboard.adoc

This file was deleted.

47 changes: 47 additions & 0 deletions modules/configure/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.Configure
* Configure the platform
** xref:configuring-che.adoc[]
*** xref:understanding-the-checluster-custom-resource.adoc[]
**** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
**** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
**** xref:checluster-custom-resource-fields-reference.adoc[]
** xref:configuring-server-components.adoc[]
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
** xref:configuring-dashboard.adoc[]
*** xref:configuring-getting-started-samples.adoc[]
*** xref:customizing-openshift-che-branding-images.adoc[]
** xref:managing-workloads-using-the-che-server-api.adoc[]
* Configure workspaces
** xref:configuring-namespace-provisioning.adoc[]
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces-in-advance.adoc[]
*** xref:configuring-a-user-namespace.adoc[]
*** xref:configuring-kubernetes-namespace-creation-on-openshift.adoc[]
** xref:configuring-workspaces-globally.adoc[]
*** xref:limiting-the-number-of-workspaces-that-a-user-can-keep.adoc[]
*** xref:limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc[]
*** xref:enabling-users-to-run-multiple-workspaces-simultaneously.adoc[]
*** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
*** xref:configuring-workspaces-nodeselector.adoc[]
*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
*** xref:enabling-container-run-capabilities.adoc[]
* Configure networking and storage
** xref:configuring-networking.adoc[]
*** xref:configuring-network-policies.adoc[]
*** xref:configuring-che-hostname.adoc[]
*** xref:configuring-che-with-self-signed-certificate.adoc[]
*** xref:importing-untrusted-tls-certificates.adoc[]
*** xref:adding-labels-and-annotations.adoc[]
*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
*** xref:configuring-proxy.adoc[]
** xref:configuring-storage.adoc[]
*** xref:configuring-storage-classes.adoc[]
*** xref:configuring-the-storage-strategy.adoc[]
*** xref:configuring-storage-sizes.adoc[]
*** xref:con_persistent-user-home.adoc[]
** xref:configuring-fuse.adoc[]
*** xref:enabling-access-to-dev-fuse-for-openshift.adoc[]
*** xref:enabling-fuse-for-all-workspaces.adoc[]
** xref:devworkspace-backup.adoc[]
*** xref:devworkspace-backup-integrated-openshift-registry.adoc[]
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Advanced deployment and configuration methods for the {prod-short} server component.
:keywords: administration guide, configuring, configuration, {prod-short} server
:navtitle: Advanced configuration options for {prod-short} server
:page-aliases: installation-guide:advanced-configuration-options-for-the-che-server-component.adoc, installation-guide:configuring-system-variables.adoc
:page-aliases: installation-guide:advanced-configuration-options-for-the-che-server-component.adoc, installation-guide:configuring-system-variables.adoc, administration-guide:advanced-configuration-options-for-the-che-server-component.adoc


[id="advanced-configuration-options-for-the-{prod-id-short}-server-component"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: `CheCluster` Custom Resource fields reference
:keywords: administration guide, checluster, custom resource
:navtitle: `CheCluster` Custom Resource fields reference
:page-aliases: installation-guide:checluster-custom-resource-fields-reference.adoc
:page-aliases: installation-guide:checluster-custom-resource-fields-reference.adoc, administration-guide:checluster-custom-resource-fields-reference.adoc

[id="checluster-custom-resources-fields-reference"]
= `CheCluster` Custom Resource fields reference
Expand Down Expand Up @@ -191,5 +191,5 @@ Optional. A JSON array of provider `id` values that are pre-selected in the AI S

.Additional resources

* xref:configuring-ai-providers.adoc[]
* xref:ai-provider-api-key-secret-reference.adoc[]
* xref:administration-guide:configuring-ai-providers.adoc[]
* xref:administration-guide:ai-provider-api-key-secret-reference.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring a user namespace
:keywords: administration guide, configuring, user, namespace
:navtitle: Configuring a user namespace
:page-aliases:
:page-aliases: administration-guide:configuring-a-user-namespace.adoc

[id="configuring-a-user-namespace"]
= Configuring a user namespace
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:page-aliases: administration-guide:configuring-allowed-urls-for-cloud-development-environments.adoc
:_content-type: PROCEDURE
:description: Configuring allowed URLs for Cloud Development Environments
:keywords: administration guide, configuring-allowed-sources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring {prod-short} with self-signed certificates
:keywords: administration guide, configuring, {prod}, {prod-short}, self-signed, certificate
:navtitle: Configuring {prod-short} with self-signed certificates
:page-aliases: installation-guide:configuring-che-with-self-signed-certificate.adoc
:page-aliases: installation-guide:configuring-che-with-self-signed-certificate.adoc, administration-guide:configuring-che-with-self-signed-certificate.adoc

[id="configuring-{prod-id-short}-with-self-signed-certificate"]
= Configuring {prod} with self-signed certificate
Expand Down
23 changes: 23 additions & 0 deletions modules/configure/pages/configuring-dashboard.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
:_content-type: ASSEMBLY
:description: Configuring dashboard
:keywords: administration-guide, configuring, dashboard
:navtitle: Configuring dashboard
:page-aliases: administration-guide:configuring-dashboard.adoc

[id="configuring-dashboard"]
= Configuring dashboard

* xref:configuring-getting-started-samples.adoc[]

* xref:administration-guide:configuring-editors-definitions.adoc[]

* xref:administration-guide:configuring-editors-download-urls.adoc[]

* xref:administration-guide:show-deprecated-editors.adoc[]

* xref:administration-guide:configuring-default-editor.adoc[]

* xref:administration-guide:concealing-editors.adoc[]

* xref:customizing-openshift-che-branding-images.adoc[]

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring fuse for workspaces
:keywords: administration-guide, configuring-fuse
:navtitle: Configuring fuse-overlayfs
:page-aliases:
:page-aliases: administration-guide:configuring-fuse.adoc

[id="configuring-fuse-overlayfs"]
= Configuring fuse-overlayfs
Expand All @@ -11,11 +11,11 @@ By default, the Universal Developer Image (UDI) contains Podman and Buildah whic
However, Podman and Buildah in the UDI are configured to use the `vfs` storage driver which does not provide copy-on-write support.
For more efficient image management, use the fuse-overlayfs storage driver which supports copy-on-write in rootless environments.

To enable fuse-overlayfs for workspaces for OpenShift versions older than 4.15, the administrator must first enable `/dev/fuse` access on the cluster by following xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[].
To enable fuse-overlayfs for workspaces for OpenShift versions older than 4.15, the administrator must first enable `/dev/fuse` access on the cluster by following xref:enabling-access-to-dev-fuse-for-openshift.adoc[].

This is not necessary for OpenShift versions 4.15 and later, since the `/dev/fuse` device is available by default. See link:https://docs.openshift.com/container-platform/4.15/release_notes/ocp-4-15-release-notes.html#ocp-4-15-nodes-dev-fuse[Release Notes].

After enabling `/dev/fuse` access, fuse-overlayfs can be enabled in two ways:

. For all user workspaces within the cluster. See xref:administration-guide:enabling-fuse-for-all-workspaces.adoc[].
. For all user workspaces within the cluster. See xref:enabling-fuse-for-all-workspaces.adoc[].
. For workspaces belonging to certain users. See xref:end-user-guide:using-the-fuse-overlay-storage-driver.adoc[].
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring user {orch-namespace} provisioning
:keywords: administration guide, configuring, namespace
:navtitle: Configuring {orch-namespace}s
:page-aliases: installation-guide:configuring-namespace-strategies.adoc, configuring-namespace-strategies.adoc
:page-aliases: installation-guide:configuring-namespace-strategies.adoc, configuring-namespace-strategies.adoc, administration-guide:configuring-namespace-provisioning.adoc

[id="configuring-user-{orch-namespace}-provisioning"]
= Configuring user {orch-namespace} provisioning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring network policies
:keywords: administration guide, configuring, namespace, network policy, network policies, multitenant isolation, openshift
:navtitle: Configure network policies
:page-aliases: installation-guide:configuring-network-policies.adoc
:page-aliases: installation-guide:configuring-network-policies.adoc, administration-guide:configuring-network-policies.adoc

[id="configuring-network-policies"]
= Configure network policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring workspaces globally
:keywords: administration-guide, configuring, workspaces
:navtitle: Configuring workspaces globally
:page-aliases:
:page-aliases: administration-guide:configuring-workspaces-globally.adoc

[id="configuring-workspaces-globally"]
= Configuring workspaces globally
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: DevWorkspace backup
:keywords: backup, storage
:navtitle: DevWorkspace backup
//:page-aliases:
:page-aliases: administration-guide:devworkspace-backup.adoc

[id="devworkspace-backup"]
= Workspace backup for {prod}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

.Prerequisites

* The xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. This is not required for OpenShift versions 4.15 and later.
* The xref:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. This is not required for OpenShift versions 4.15 and later.

* An active `{orch-cli}` session with administrative permissions to the destination OpenShift cluster. See {orch-cli-link}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Managing {prod-short} server and {prod-short} dashboard workloads using the API
:keywords: administration-guide, api
:navtitle: Using the {prod-short} server API
:page-aliases:
:page-aliases: administration-guide:managing-workloads-using-the-che-server-api.adoc

[id="managing-workloads-using-the-{prod-id-short}-server-api"]
= Managing {prod-short} server and {prod-short} dashboard workloads using the API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Provisioning {orch-namespace}s in advance
:keywords: administration guide, provisioning, {orch-namespace}
:navtitle: Provisioning {orch-namespace}s in advance
:page-aliases:
:page-aliases: administration-guide:provisioning-namespaces-in-advance.adoc

[id="preprovisioning-{orch-namespace}s"]
= Provisioning {orch-namespace}s in advance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Understanding the `CheCluster` Custom Resource
:keywords: administration guide, understanding-the-checluster-custom-resource, configuring-che
:navtitle: Understanding the `CheCluster` Custom Resource
:page-aliases: installation-guide:understanding-the-checluster-custom-resource.adoc, installation-guide:configuring-the-che-installation.adoc
:page-aliases: installation-guide:understanding-the-checluster-custom-resource.adoc, installation-guide:configuring-the-che-installation.adoc, administration-guide:understanding-the-checluster-custom-resource.adoc

[id="understanding-the-checluster-custom-resource"]
= Understanding the `CheCluster` Custom Resource
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Using the CLI to configure the CheCluster Custom Resource
:keywords: administration guide
:navtitle: Using the CLI to configure the CheCluster Custom Resource
:page-aliases: installation-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc, installation-guide:using-cli-to-configure-the-checluster-custom-resource.adoc
:page-aliases: installation-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc, installation-guide:using-cli-to-configure-the-checluster-custom-resource.adoc, administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc

[id="using-the-cli-to-configure-the-checluster-custom-resource"]
= Using the CLI to configure the CheCluster Custom Resource
Expand Down
2 changes: 1 addition & 1 deletion modules/discover/pages/che-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus

.Additional resources

* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[]
* xref:configure:understanding-the-checluster-custom-resource.adoc[]
* xref:install:con_installation-overview.adoc[]
* xref:devworkspace-operator.adoc[]
* xref:gateway.adoc[]
Expand Down
4 changes: 2 additions & 2 deletions modules/discover/pages/che-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:page-aliases: administration-guide:che-server.adoc

[id="{prod-id-short}-server-with-devworkspace"]
= Server and namespace provisioning
= Server and {namespace} provisioning

[role="_abstract"]
The {prod-short} server is a Java web service that creates user namespaces, provisions them with secrets and config maps, and integrates with Git service providers for devfile fetching and authentication.
Expand All @@ -26,6 +26,6 @@ image::architecture/{project-context}-server-interactions.png[{prod-short} serve

.Additional resources

* xref:administration-guide:advanced-configuration-options-for-the-che-server-component.adoc[]
* xref:configure:advanced-configuration-options-for-the-che-server-component.adoc[]

include::example$snip_{project-context}-che-server-additional-resources.adoc[]
2 changes: 1 addition & 1 deletion modules/discover/pages/dashboard.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ When the user requests the user dashboard to start a workspace, the user dashboa

.Additional resources

* xref:administration-guide:configuring-dashboard.adoc[]
* xref:configure:configuring-dashboard.adoc[]
* xref:che-server.adoc[]
2 changes: 1 addition & 1 deletion modules/discover/pages/roles-and-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Platform administrators deploy, configure, secure, upgrade, and monitor {prod-sh
Common tasks include:

* Deploy {prod-short} on a cluster. See xref:install:con_installation-overview.adoc[].
* Configure the `CheCluster` custom resource. See xref:administration-guide:understanding-the-checluster-custom-resource.adoc[].
* Configure the `CheCluster` custom resource. See xref:configure:understanding-the-checluster-custom-resource.adoc[].
* Set up OAuth for Git providers. See xref:administration-guide:configuring-oauth-for-git-providers.adoc[].
* Control workspace start times with image caching. See xref:optimize:caching-images-for-faster-workspace-start.adoc[].
* Upgrade to the latest version. See xref:upgrade:upgrading-che.adoc[].
Expand Down
Loading
Loading