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
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ nav:
- modules/upgrade/nav.adoc
- modules/secure/nav.adoc
- modules/optimize/nav.adoc
- modules/configure/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can configure {orch-ingress} labels and annotations, if your organization re

.Procedure

* Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
* Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml,subs="+quotes,+attributes"]
----
Expand All @@ -28,4 +28,4 @@ spec:

* 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:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

* 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:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

* {editor-definition-samples-link}
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[].
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* xref:configuring-che-with-self-signed-certificate.adoc[]
* xref:configure:configuring-che-with-self-signed-certificate.adoc[]
86 changes: 21 additions & 65 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,69 +1,19 @@
.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:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.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-observability.adoc[]
**** xref:the-woopra-telemetry-plugin.adoc[]
**** xref:creating-a-telemetry-plugin.adoc[]
*** xref:configuring-server-logging.adoc[]
*** xref:collecting-logs-using-chectl.adoc[]
**** xref:monitoring-the-dev-workspace-operator.adoc[]
**** xref:monitoring-che.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[]
* xref:configuring-observability.adoc[]
** xref:the-woopra-telemetry-plugin.adoc[]
** xref:creating-a-telemetry-plugin.adoc[]
** xref:configuring-server-logging.adoc[]
** xref:collecting-logs-using-chectl.adoc[]
** xref:monitoring-the-dev-workspace-operator.adoc[]
** xref:monitoring-che.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 @@ -78,4 +28,10 @@
** 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[]
* 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[]

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Learn how to conceal {prod-short} editors. This is useful when you want to hide

include::example$snip_che-editor-id-list.adoc[]

. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
. Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml]
----
Expand Down
10 changes: 0 additions & 10 deletions modules/administration-guide/pages/configuring-che.adoc

This file was deleted.

23 changes: 0 additions & 23 deletions modules/administration-guide/pages/configuring-dashboard.adoc

This file was deleted.

16 changes: 0 additions & 16 deletions modules/administration-guide/pages/configuring-networking.adoc

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@

It is possible to fine-tune the log levels of individual loggers available in the {prod-short} server.

The log level of the whole {prod-short} server is configured globally using the `cheLogLevel` configuration property of the Operator. See xref:checluster-custom-resource-fields-reference.adoc[].
The log level of the whole {prod-short} server is configured globally using the `cheLogLevel` configuration property of the Operator. See xref:configure:checluster-custom-resource-fields-reference.adoc[].
To set the global log level in installations not managed by the Operator, specify the `CHE_LOG_LEVEL` environment variable in the `che`
ConfigMap.

It is possible to configure the log levels of the individual loggers in the {prod-short} server using the `CHE_LOGGER_CONFIG` environment
variable.

include::partial$proc_configuring-server-logging.adoc[leveloffset=+1]
include::configure:partial$proc_configuring-server-logging.adoc[]

include::partial$con_logger-naming.adoc[leveloffset=+1]

Expand Down
28 changes: 0 additions & 28 deletions modules/administration-guide/pages/configuring-storage.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,5 @@ Due to the dedicated Microsoft link:https://cdn.vsassets.io/v/M190_20210811.1/_c
[role="_additional-resources"]
.Additional resources

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
* link:https://open-vsx.org/[Open VSX registry]

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ image::creating-a-telemetry-plugin/devworkspace_telemetry_plugin.png[{devworkspa

Set the telemetry plugin as a default plugin. Default plugins are applied on {devworkspace} startup for new and existing {devworkspace}s.

* Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
* Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
----
spec:
Expand All @@ -402,7 +402,7 @@ spec:

.Additional resources

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].

.Verification steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ data:
Make sure that the Configmap contains data in a valid JSON format.
====

TIP: Consider adding the ConfigMap to the {prod-namespace} namespace. By adding it to the namespace, you replicate the ConfigMap across all user namespaces while preventing modifications within user's namespaces. See xref:configuring-a-user-namespace.adoc[].
TIP: Consider adding the ConfigMap to the {prod-namespace} namespace. By adding it to the namespace, you replicate the ConfigMap across all user namespaces while preventing modifications within user's namespaces. See xref:configure:configuring-a-user-namespace.adoc[].

.Verification
. Verify that settings defined in the ConfigMap are applied using one of the following methods:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Learn how to show deprecated {prod-short} editors on the Dashboard. By default,
-- curl -s http://localhost:8080/dashboard/api/editors | jq -r '[.[] | select(.metadata.tags != null) | select(.metadata.tags[] | contains("Deprecate")) | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"]'
----

. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
. Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml]
----
Expand All @@ -43,4 +43,4 @@ spec:

* 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:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To enable the Woopra plugin on the {prod} installation:

* Deploy the `plugin.yaml` devfile v2 file to an HTTP server with the environment variables set correctly.

. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
. Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml]
----
Expand All @@ -42,4 +42,4 @@ spec:

* 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:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.Procedure

* To log the HTTP traffic between the {prod-short} server and the API server of the {kubernetes} or OpenShift cluster, configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
* To log the HTTP traffic between the {prod-short} server and the API server of the {kubernetes} or OpenShift cluster, configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml]
----
Expand All @@ -20,5 +20,5 @@ spec:

* 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:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can configure this behaviour.

.Procedure

* Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
* Configure the `CheCluster` Custom Resource. See xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml,subs="+attributes,+quotes"]
----
Expand Down
Loading
Loading