From 64056a8b5f24b67665ce623b6642e1983a528a03 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Mon, 24 Aug 2026 19:58:31 +0530 Subject: [PATCH] chore: promote Configure to top-level Antora module (JTBD Phase 4) Move configuration content from administration-guide to a new top-level modules/configure/ Antora module. Preserve admin-guide nav entries for pages moved by other PRs (Extend, Integrate). Move persistent-user-home image to configure module. Co-authored-by: Cursor --- antora.yml | 3 +- .../examples/snip_che-curated-access.adoc | 2 +- modules/administration-guide/nav.adoc | 72 ++++-------------- .../pages/configuring-dashboard.adoc | 23 ------ .../proc_che-configuring-ingresses.adoc | 0 ...ring-che-with-self-signed-certificate.adoc | 0 .../tools-container-example.png | Bin modules/configure/nav.adoc | 47 ++++++++++++ .../pages/adding-labels-and-annotations.adoc | 0 ...-options-for-the-che-server-component.adoc | 2 +- ...ster-custom-resource-fields-reference.adoc | 6 +- .../pages/con_persistent-user-home.adoc | 0 .../pages/configuring-a-user-namespace.adoc | 2 +- ...ls-for-cloud-development-environments.adoc | 1 + .../pages/configuring-che-hostname.adoc | 0 ...ring-che-with-self-signed-certificate.adoc | 2 +- .../pages/configuring-che.adoc | 0 .../pages/configuring-dashboard.adoc | 23 ++++++ .../pages/configuring-fuse.adoc | 6 +- .../configuring-getting-started-samples.adoc | 0 ...netes-namespace-creation-on-openshift.adoc | 0 .../configuring-namespace-provisioning.adoc | 2 +- .../pages/configuring-network-policies.adoc | 2 +- .../pages/configuring-networking.adoc | 0 .../pages/configuring-proxy.adoc | 0 .../pages/configuring-server-components.adoc | 0 .../pages/configuring-storage-classes.adoc | 0 .../pages/configuring-storage-sizes.adoc | 0 .../pages/configuring-storage.adoc | 0 .../configuring-the-storage-strategy.adoc | 0 ...onfiguring-workspace-target-namespace.adoc | 0 ...ring-workspaces-endpoints-base-domain.adoc | 0 .../configuring-workspaces-globally.adoc | 2 +- .../configuring-workspaces-nodeselector.adoc | 0 ...omizing-openshift-che-branding-images.adoc | 0 ...itories-with-self-signed-certificates.adoc | 0 ...-backup-integrated-openshift-registry.adoc | 0 ...workspace-backup-regular-oci-registry.adoc | 0 .../pages/devworkspace-backup.adoc | 2 +- ...ling-access-to-dev-fuse-for-openshift.adoc | 0 .../enabling-container-run-capabilities.adoc | 0 .../enabling-fuse-for-all-workspaces.adoc | 2 +- ...un-multiple-workspaces-simultaneously.adoc | 0 .../importing-untrusted-tls-certificates.adoc | 0 ...er-of-workspaces-that-a-user-can-keep.adoc | 0 ...that-all-users-can-run-simultaneously.adoc | 0 ...ng-workloads-using-the-che-server-api.adoc | 2 +- .../provisioning-namespaces-in-advance.adoc | 2 +- ...anding-the-checluster-custom-resource.adoc | 2 +- ...figure-the-checluster-custom-resource.adoc | 2 +- .../partials/con_network-policies.adoc | 0 ...ing-che-server-advanced-configuration.adoc | 0 ...configuring-network-policies-manually.adoc | 0 .../partials/proc_configuring-routes.adoc | 0 ...ing-operator-managed-network-policies.adoc | 0 ...ip_defining-dwo-namespace-for-backups.adoc | 0 modules/discover/pages/che-operator.adoc | 2 +- modules/discover/pages/che-server.adoc | 4 +- modules/discover/pages/dashboard.adoc | 2 +- modules/discover/pages/roles-and-tasks.adoc | 2 +- .../end-user-guide/pages/accessing-fuse.adoc | 4 +- .../enabling-overlay-with-a-configmap.adoc | 2 +- .../restoring-workspaces-from-backups.adoc | 2 +- ...using-the-fuse-overlay-storage-driver.adoc | 2 +- .../partials/proc_creating-workspaces.adoc | 8 +- .../pages/creating-a-telemetry-plugin.adoc | 4 +- .../pages/what-to-configure-next.adoc | 4 +- .../your-first-week-as-administrator.adoc | 2 +- .../using-a-git-provider-access-token.adoc | 4 +- .../con_next-steps-after-installation.adoc | 2 +- .../proc_deploying-che-using-gitops.adoc | 2 +- ...lling-che-in-a-restricted-environment.adoc | 2 +- ...talling-che-on-minikube-keycloak-oidc.adoc | 2 +- .../proc_installing-che-on-minikube.adoc | 2 +- ...r-custom-resource-during-installation.adoc | 4 +- .../pages/configuring-server-logging.adoc | 2 +- .../pages/the-woopra-telemetry-plugin.adoc | 4 +- .../proc_configuring-server-logging.adoc | 4 +- ...roc_enabling-and-exposing-che-metrics.adoc | 2 +- .../partials/proc_logging-http-traffic.adoc | 4 +- .../configuring-advanced-authorization.adoc | 2 +- ...user-data-in-compliance-with-the-gdpr.adoc | 4 +- .../secure/pages/security-best-practices.adoc | 12 +-- 83 files changed, 152 insertions(+), 145 deletions(-) delete mode 100644 modules/administration-guide/pages/configuring-dashboard.adoc rename modules/{administration-guide => configure}/examples/proc_che-configuring-ingresses.adoc (100%) rename modules/{administration-guide => configure}/examples/snip_che-xref-configuring-che-with-self-signed-certificate.adoc (100%) rename modules/{administration-guide => configure}/images/persistent-user-home/tools-container-example.png (100%) create mode 100644 modules/configure/nav.adoc rename modules/{administration-guide => configure}/pages/adding-labels-and-annotations.adoc (100%) rename modules/{administration-guide => configure}/pages/advanced-configuration-options-for-the-che-server-component.adoc (88%) rename modules/{administration-guide => configure}/pages/checluster-custom-resource-fields-reference.adoc (97%) rename modules/{administration-guide => configure}/pages/con_persistent-user-home.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-a-user-namespace.adoc (99%) rename modules/{administration-guide => configure}/pages/configuring-allowed-urls-for-cloud-development-environments.adoc (93%) rename modules/{administration-guide => configure}/pages/configuring-che-hostname.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-che-with-self-signed-certificate.adoc (95%) rename modules/{administration-guide => configure}/pages/configuring-che.adoc (100%) create mode 100644 modules/configure/pages/configuring-dashboard.adoc rename modules/{administration-guide => configure}/pages/configuring-fuse.adoc (83%) rename modules/{administration-guide => configure}/pages/configuring-getting-started-samples.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-namespace-provisioning.adoc (88%) rename modules/{administration-guide => configure}/pages/configuring-network-policies.adoc (93%) rename modules/{administration-guide => configure}/pages/configuring-networking.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-proxy.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-server-components.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-storage-classes.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-storage-sizes.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-storage.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-the-storage-strategy.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-workspace-target-namespace.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-workspaces-endpoints-base-domain.adoc (100%) rename modules/{administration-guide => configure}/pages/configuring-workspaces-globally.adoc (91%) rename modules/{administration-guide => configure}/pages/configuring-workspaces-nodeselector.adoc (100%) rename modules/{administration-guide => configure}/pages/customizing-openshift-che-branding-images.adoc (100%) rename modules/{administration-guide => configure}/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc (100%) rename modules/{administration-guide => configure}/pages/devworkspace-backup-integrated-openshift-registry.adoc (100%) rename modules/{administration-guide => configure}/pages/devworkspace-backup-regular-oci-registry.adoc (100%) rename modules/{administration-guide => configure}/pages/devworkspace-backup.adoc (97%) rename modules/{administration-guide => configure}/pages/enabling-access-to-dev-fuse-for-openshift.adoc (100%) rename modules/{administration-guide => configure}/pages/enabling-container-run-capabilities.adoc (100%) rename modules/{administration-guide => configure}/pages/enabling-fuse-for-all-workspaces.adoc (93%) rename modules/{administration-guide => configure}/pages/enabling-users-to-run-multiple-workspaces-simultaneously.adoc (100%) rename modules/{administration-guide => configure}/pages/importing-untrusted-tls-certificates.adoc (100%) rename modules/{administration-guide => configure}/pages/limiting-the-number-of-workspaces-that-a-user-can-keep.adoc (100%) rename modules/{administration-guide => configure}/pages/limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc (100%) rename modules/{administration-guide => configure}/pages/managing-workloads-using-the-che-server-api.adoc (91%) rename modules/{administration-guide => configure}/pages/provisioning-namespaces-in-advance.adoc (94%) rename modules/{administration-guide => configure}/pages/understanding-the-checluster-custom-resource.adoc (95%) rename modules/{administration-guide => configure}/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc (91%) rename modules/{administration-guide => configure}/partials/con_network-policies.adoc (100%) rename modules/{administration-guide => configure}/partials/con_understanding-che-server-advanced-configuration.adoc (100%) rename modules/{administration-guide => configure}/partials/proc_configuring-network-policies-manually.adoc (100%) rename modules/{administration-guide => configure}/partials/proc_configuring-routes.adoc (100%) rename modules/{administration-guide => configure}/partials/proc_enabling-operator-managed-network-policies.adoc (100%) rename modules/{administration-guide => configure}/partials/snip_defining-dwo-namespace-for-backups.adoc (100%) diff --git a/antora.yml b/antora.yml index f019768006..c8035b4310 100644 --- a/antora.yml +++ b/antora.yml @@ -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 @@ -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: diff --git a/modules/administration-guide/examples/snip_che-curated-access.adoc b/modules/administration-guide/examples/snip_che-curated-access.adoc index 0e75123a69..f75cde5fe9 100644 --- a/modules/administration-guide/examples/snip_che-curated-access.adoc +++ b/modules/administration-guide/examples/snip_che-curated-access.adoc @@ -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[]. diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index ad78f8b903..d9d6e67815 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -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[] @@ -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[] diff --git a/modules/administration-guide/pages/configuring-dashboard.adoc b/modules/administration-guide/pages/configuring-dashboard.adoc deleted file mode 100644 index 56047f6105..0000000000 --- a/modules/administration-guide/pages/configuring-dashboard.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_content-type: ASSEMBLY -:description: Configuring dashboard -:keywords: administration-guide, configuring, dashboard -:navtitle: Configuring dashboard -:page-aliases: - -[id="configuring-dashboard"] -= Configuring dashboard - -* xref:configuring-getting-started-samples.adoc[] - -* xref:configuring-editors-definitions.adoc[] - -* xref:configuring-editors-download-urls.adoc[] - -* xref:show-deprecated-editors.adoc[] - -* xref:configuring-default-editor.adoc[] - -* xref:concealing-editors.adoc[] - -* xref:customizing-openshift-che-branding-images.adoc[] - diff --git a/modules/administration-guide/examples/proc_che-configuring-ingresses.adoc b/modules/configure/examples/proc_che-configuring-ingresses.adoc similarity index 100% rename from modules/administration-guide/examples/proc_che-configuring-ingresses.adoc rename to modules/configure/examples/proc_che-configuring-ingresses.adoc diff --git a/modules/administration-guide/examples/snip_che-xref-configuring-che-with-self-signed-certificate.adoc b/modules/configure/examples/snip_che-xref-configuring-che-with-self-signed-certificate.adoc similarity index 100% rename from modules/administration-guide/examples/snip_che-xref-configuring-che-with-self-signed-certificate.adoc rename to modules/configure/examples/snip_che-xref-configuring-che-with-self-signed-certificate.adoc diff --git a/modules/administration-guide/images/persistent-user-home/tools-container-example.png b/modules/configure/images/persistent-user-home/tools-container-example.png similarity index 100% rename from modules/administration-guide/images/persistent-user-home/tools-container-example.png rename to modules/configure/images/persistent-user-home/tools-container-example.png diff --git a/modules/configure/nav.adoc b/modules/configure/nav.adoc new file mode 100644 index 0000000000..8010185c3a --- /dev/null +++ b/modules/configure/nav.adoc @@ -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[] diff --git a/modules/administration-guide/pages/adding-labels-and-annotations.adoc b/modules/configure/pages/adding-labels-and-annotations.adoc similarity index 100% rename from modules/administration-guide/pages/adding-labels-and-annotations.adoc rename to modules/configure/pages/adding-labels-and-annotations.adoc diff --git a/modules/administration-guide/pages/advanced-configuration-options-for-the-che-server-component.adoc b/modules/configure/pages/advanced-configuration-options-for-the-che-server-component.adoc similarity index 88% rename from modules/administration-guide/pages/advanced-configuration-options-for-the-che-server-component.adoc rename to modules/configure/pages/advanced-configuration-options-for-the-che-server-component.adoc index fc40c2613a..43d1bc8098 100644 --- a/modules/administration-guide/pages/advanced-configuration-options-for-the-che-server-component.adoc +++ b/modules/configure/pages/advanced-configuration-options-for-the-che-server-component.adoc @@ -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"] diff --git a/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc b/modules/configure/pages/checluster-custom-resource-fields-reference.adoc similarity index 97% rename from modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc rename to modules/configure/pages/checluster-custom-resource-fields-reference.adoc index 2d4a2989e3..2608c0be11 100644 --- a/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc +++ b/modules/configure/pages/checluster-custom-resource-fields-reference.adoc @@ -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 @@ -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[] diff --git a/modules/administration-guide/pages/con_persistent-user-home.adoc b/modules/configure/pages/con_persistent-user-home.adoc similarity index 100% rename from modules/administration-guide/pages/con_persistent-user-home.adoc rename to modules/configure/pages/con_persistent-user-home.adoc diff --git a/modules/administration-guide/pages/configuring-a-user-namespace.adoc b/modules/configure/pages/configuring-a-user-namespace.adoc similarity index 99% rename from modules/administration-guide/pages/configuring-a-user-namespace.adoc rename to modules/configure/pages/configuring-a-user-namespace.adoc index a67f0d99cc..1cd1bbcd08 100644 --- a/modules/administration-guide/pages/configuring-a-user-namespace.adoc +++ b/modules/configure/pages/configuring-a-user-namespace.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-allowed-urls-for-cloud-development-environments.adoc b/modules/configure/pages/configuring-allowed-urls-for-cloud-development-environments.adoc similarity index 93% rename from modules/administration-guide/pages/configuring-allowed-urls-for-cloud-development-environments.adoc rename to modules/configure/pages/configuring-allowed-urls-for-cloud-development-environments.adoc index 9ece02cd8a..6933b1da47 100644 --- a/modules/administration-guide/pages/configuring-allowed-urls-for-cloud-development-environments.adoc +++ b/modules/configure/pages/configuring-allowed-urls-for-cloud-development-environments.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-che-hostname.adoc b/modules/configure/pages/configuring-che-hostname.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-che-hostname.adoc rename to modules/configure/pages/configuring-che-hostname.adoc diff --git a/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc b/modules/configure/pages/configuring-che-with-self-signed-certificate.adoc similarity index 95% rename from modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc rename to modules/configure/pages/configuring-che-with-self-signed-certificate.adoc index 259cf17344..2d3b4b9346 100644 --- a/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc +++ b/modules/configure/pages/configuring-che-with-self-signed-certificate.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-che.adoc b/modules/configure/pages/configuring-che.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-che.adoc rename to modules/configure/pages/configuring-che.adoc diff --git a/modules/configure/pages/configuring-dashboard.adoc b/modules/configure/pages/configuring-dashboard.adoc new file mode 100644 index 0000000000..3c95c719a0 --- /dev/null +++ b/modules/configure/pages/configuring-dashboard.adoc @@ -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[] + diff --git a/modules/administration-guide/pages/configuring-fuse.adoc b/modules/configure/pages/configuring-fuse.adoc similarity index 83% rename from modules/administration-guide/pages/configuring-fuse.adoc rename to modules/configure/pages/configuring-fuse.adoc index b6da34436e..794ece1763 100644 --- a/modules/administration-guide/pages/configuring-fuse.adoc +++ b/modules/configure/pages/configuring-fuse.adoc @@ -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 @@ -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[]. diff --git a/modules/administration-guide/pages/configuring-getting-started-samples.adoc b/modules/configure/pages/configuring-getting-started-samples.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-getting-started-samples.adoc rename to modules/configure/pages/configuring-getting-started-samples.adoc diff --git a/modules/administration-guide/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc b/modules/configure/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc rename to modules/configure/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc diff --git a/modules/administration-guide/pages/configuring-namespace-provisioning.adoc b/modules/configure/pages/configuring-namespace-provisioning.adoc similarity index 88% rename from modules/administration-guide/pages/configuring-namespace-provisioning.adoc rename to modules/configure/pages/configuring-namespace-provisioning.adoc index 0502e2f333..b2457351f2 100644 --- a/modules/administration-guide/pages/configuring-namespace-provisioning.adoc +++ b/modules/configure/pages/configuring-namespace-provisioning.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-network-policies.adoc b/modules/configure/pages/configuring-network-policies.adoc similarity index 93% rename from modules/administration-guide/pages/configuring-network-policies.adoc rename to modules/configure/pages/configuring-network-policies.adoc index 26d36b6ee3..c381ed8e56 100644 --- a/modules/administration-guide/pages/configuring-network-policies.adoc +++ b/modules/configure/pages/configuring-network-policies.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-networking.adoc b/modules/configure/pages/configuring-networking.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-networking.adoc rename to modules/configure/pages/configuring-networking.adoc diff --git a/modules/administration-guide/pages/configuring-proxy.adoc b/modules/configure/pages/configuring-proxy.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-proxy.adoc rename to modules/configure/pages/configuring-proxy.adoc diff --git a/modules/administration-guide/pages/configuring-server-components.adoc b/modules/configure/pages/configuring-server-components.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-server-components.adoc rename to modules/configure/pages/configuring-server-components.adoc diff --git a/modules/administration-guide/pages/configuring-storage-classes.adoc b/modules/configure/pages/configuring-storage-classes.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-storage-classes.adoc rename to modules/configure/pages/configuring-storage-classes.adoc diff --git a/modules/administration-guide/pages/configuring-storage-sizes.adoc b/modules/configure/pages/configuring-storage-sizes.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-storage-sizes.adoc rename to modules/configure/pages/configuring-storage-sizes.adoc diff --git a/modules/administration-guide/pages/configuring-storage.adoc b/modules/configure/pages/configuring-storage.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-storage.adoc rename to modules/configure/pages/configuring-storage.adoc diff --git a/modules/administration-guide/pages/configuring-the-storage-strategy.adoc b/modules/configure/pages/configuring-the-storage-strategy.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-the-storage-strategy.adoc rename to modules/configure/pages/configuring-the-storage-strategy.adoc diff --git a/modules/administration-guide/pages/configuring-workspace-target-namespace.adoc b/modules/configure/pages/configuring-workspace-target-namespace.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-workspace-target-namespace.adoc rename to modules/configure/pages/configuring-workspace-target-namespace.adoc diff --git a/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc b/modules/configure/pages/configuring-workspaces-endpoints-base-domain.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc rename to modules/configure/pages/configuring-workspaces-endpoints-base-domain.adoc diff --git a/modules/administration-guide/pages/configuring-workspaces-globally.adoc b/modules/configure/pages/configuring-workspaces-globally.adoc similarity index 91% rename from modules/administration-guide/pages/configuring-workspaces-globally.adoc rename to modules/configure/pages/configuring-workspaces-globally.adoc index 12ea472c39..2908bf251d 100644 --- a/modules/administration-guide/pages/configuring-workspaces-globally.adoc +++ b/modules/configure/pages/configuring-workspaces-globally.adoc @@ -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 diff --git a/modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc b/modules/configure/pages/configuring-workspaces-nodeselector.adoc similarity index 100% rename from modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc rename to modules/configure/pages/configuring-workspaces-nodeselector.adoc diff --git a/modules/administration-guide/pages/customizing-openshift-che-branding-images.adoc b/modules/configure/pages/customizing-openshift-che-branding-images.adoc similarity index 100% rename from modules/administration-guide/pages/customizing-openshift-che-branding-images.adoc rename to modules/configure/pages/customizing-openshift-che-branding-images.adoc diff --git a/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc b/modules/configure/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc similarity index 100% rename from modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc rename to modules/configure/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc diff --git a/modules/administration-guide/pages/devworkspace-backup-integrated-openshift-registry.adoc b/modules/configure/pages/devworkspace-backup-integrated-openshift-registry.adoc similarity index 100% rename from modules/administration-guide/pages/devworkspace-backup-integrated-openshift-registry.adoc rename to modules/configure/pages/devworkspace-backup-integrated-openshift-registry.adoc diff --git a/modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc b/modules/configure/pages/devworkspace-backup-regular-oci-registry.adoc similarity index 100% rename from modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc rename to modules/configure/pages/devworkspace-backup-regular-oci-registry.adoc diff --git a/modules/administration-guide/pages/devworkspace-backup.adoc b/modules/configure/pages/devworkspace-backup.adoc similarity index 97% rename from modules/administration-guide/pages/devworkspace-backup.adoc rename to modules/configure/pages/devworkspace-backup.adoc index c4fc4ef0aa..f73885b21c 100644 --- a/modules/administration-guide/pages/devworkspace-backup.adoc +++ b/modules/configure/pages/devworkspace-backup.adoc @@ -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} diff --git a/modules/administration-guide/pages/enabling-access-to-dev-fuse-for-openshift.adoc b/modules/configure/pages/enabling-access-to-dev-fuse-for-openshift.adoc similarity index 100% rename from modules/administration-guide/pages/enabling-access-to-dev-fuse-for-openshift.adoc rename to modules/configure/pages/enabling-access-to-dev-fuse-for-openshift.adoc diff --git a/modules/administration-guide/pages/enabling-container-run-capabilities.adoc b/modules/configure/pages/enabling-container-run-capabilities.adoc similarity index 100% rename from modules/administration-guide/pages/enabling-container-run-capabilities.adoc rename to modules/configure/pages/enabling-container-run-capabilities.adoc diff --git a/modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc b/modules/configure/pages/enabling-fuse-for-all-workspaces.adoc similarity index 93% rename from modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc rename to modules/configure/pages/enabling-fuse-for-all-workspaces.adoc index 7be77ede2f..3bd51bd949 100644 --- a/modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc +++ b/modules/configure/pages/enabling-fuse-for-all-workspaces.adoc @@ -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}. diff --git a/modules/administration-guide/pages/enabling-users-to-run-multiple-workspaces-simultaneously.adoc b/modules/configure/pages/enabling-users-to-run-multiple-workspaces-simultaneously.adoc similarity index 100% rename from modules/administration-guide/pages/enabling-users-to-run-multiple-workspaces-simultaneously.adoc rename to modules/configure/pages/enabling-users-to-run-multiple-workspaces-simultaneously.adoc diff --git a/modules/administration-guide/pages/importing-untrusted-tls-certificates.adoc b/modules/configure/pages/importing-untrusted-tls-certificates.adoc similarity index 100% rename from modules/administration-guide/pages/importing-untrusted-tls-certificates.adoc rename to modules/configure/pages/importing-untrusted-tls-certificates.adoc diff --git a/modules/administration-guide/pages/limiting-the-number-of-workspaces-that-a-user-can-keep.adoc b/modules/configure/pages/limiting-the-number-of-workspaces-that-a-user-can-keep.adoc similarity index 100% rename from modules/administration-guide/pages/limiting-the-number-of-workspaces-that-a-user-can-keep.adoc rename to modules/configure/pages/limiting-the-number-of-workspaces-that-a-user-can-keep.adoc diff --git a/modules/administration-guide/pages/limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc b/modules/configure/pages/limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc similarity index 100% rename from modules/administration-guide/pages/limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc rename to modules/configure/pages/limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc diff --git a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc b/modules/configure/pages/managing-workloads-using-the-che-server-api.adoc similarity index 91% rename from modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc rename to modules/configure/pages/managing-workloads-using-the-che-server-api.adoc index ce49cac804..463321669e 100644 --- a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc +++ b/modules/configure/pages/managing-workloads-using-the-che-server-api.adoc @@ -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 diff --git a/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc b/modules/configure/pages/provisioning-namespaces-in-advance.adoc similarity index 94% rename from modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc rename to modules/configure/pages/provisioning-namespaces-in-advance.adoc index e4c7a95a85..fa5ec660b9 100644 --- a/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc +++ b/modules/configure/pages/provisioning-namespaces-in-advance.adoc @@ -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 diff --git a/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc b/modules/configure/pages/understanding-the-checluster-custom-resource.adoc similarity index 95% rename from modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc rename to modules/configure/pages/understanding-the-checluster-custom-resource.adoc index 2b4f043b24..73ac9cabdc 100644 --- a/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc +++ b/modules/configure/pages/understanding-the-checluster-custom-resource.adoc @@ -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 diff --git a/modules/administration-guide/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc b/modules/configure/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc similarity index 91% rename from modules/administration-guide/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc rename to modules/configure/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc index 4cf4c4069e..93b6ed3237 100644 --- a/modules/administration-guide/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc +++ b/modules/configure/pages/using-the-cli-to-configure-the-checluster-custom-resource.adoc @@ -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 diff --git a/modules/administration-guide/partials/con_network-policies.adoc b/modules/configure/partials/con_network-policies.adoc similarity index 100% rename from modules/administration-guide/partials/con_network-policies.adoc rename to modules/configure/partials/con_network-policies.adoc diff --git a/modules/administration-guide/partials/con_understanding-che-server-advanced-configuration.adoc b/modules/configure/partials/con_understanding-che-server-advanced-configuration.adoc similarity index 100% rename from modules/administration-guide/partials/con_understanding-che-server-advanced-configuration.adoc rename to modules/configure/partials/con_understanding-che-server-advanced-configuration.adoc diff --git a/modules/administration-guide/partials/proc_configuring-network-policies-manually.adoc b/modules/configure/partials/proc_configuring-network-policies-manually.adoc similarity index 100% rename from modules/administration-guide/partials/proc_configuring-network-policies-manually.adoc rename to modules/configure/partials/proc_configuring-network-policies-manually.adoc diff --git a/modules/administration-guide/partials/proc_configuring-routes.adoc b/modules/configure/partials/proc_configuring-routes.adoc similarity index 100% rename from modules/administration-guide/partials/proc_configuring-routes.adoc rename to modules/configure/partials/proc_configuring-routes.adoc diff --git a/modules/administration-guide/partials/proc_enabling-operator-managed-network-policies.adoc b/modules/configure/partials/proc_enabling-operator-managed-network-policies.adoc similarity index 100% rename from modules/administration-guide/partials/proc_enabling-operator-managed-network-policies.adoc rename to modules/configure/partials/proc_enabling-operator-managed-network-policies.adoc diff --git a/modules/administration-guide/partials/snip_defining-dwo-namespace-for-backups.adoc b/modules/configure/partials/snip_defining-dwo-namespace-for-backups.adoc similarity index 100% rename from modules/administration-guide/partials/snip_defining-dwo-namespace-for-backups.adoc rename to modules/configure/partials/snip_defining-dwo-namespace-for-backups.adoc diff --git a/modules/discover/pages/che-operator.adoc b/modules/discover/pages/che-operator.adoc index 5063c88371..fefbab80eb 100644 --- a/modules/discover/pages/che-operator.adoc +++ b/modules/discover/pages/che-operator.adoc @@ -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[] diff --git a/modules/discover/pages/che-server.adoc b/modules/discover/pages/che-server.adoc index 43ae745a71..b0697176b1 100644 --- a/modules/discover/pages/che-server.adoc +++ b/modules/discover/pages/che-server.adoc @@ -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. @@ -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[] diff --git a/modules/discover/pages/dashboard.adoc b/modules/discover/pages/dashboard.adoc index c4967bbdaf..3b808f37d7 100644 --- a/modules/discover/pages/dashboard.adoc +++ b/modules/discover/pages/dashboard.adoc @@ -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[] diff --git a/modules/discover/pages/roles-and-tasks.adoc b/modules/discover/pages/roles-and-tasks.adoc index 32d4808276..a822d87a30 100644 --- a/modules/discover/pages/roles-and-tasks.adoc +++ b/modules/discover/pages/roles-and-tasks.adoc @@ -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[]. diff --git a/modules/end-user-guide/pages/accessing-fuse.adoc b/modules/end-user-guide/pages/accessing-fuse.adoc index 0ae1cf5d92..7e88703cd0 100644 --- a/modules/end-user-guide/pages/accessing-fuse.adoc +++ b/modules/end-user-guide/pages/accessing-fuse.adoc @@ -11,12 +11,12 @@ You must have access to `/dev/fuse` to use fuse-overlayfs. This section describe .Prerequisites -* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[]. +* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:configure:configuring-fuse.adoc[]. * Determine a workspace to use fuse-overlayfs with. .Procedure -. Use the `pod-overrides` attribute to add the required annotations defined in xref:administration-guide:configuring-fuse.adoc[] to the workspace. The `pod-overrides` attribute allows merging certain fields in the workspace pod's `spec`. +. Use the `pod-overrides` attribute to add the required annotations defined in xref:configure:configuring-fuse.adoc[] to the workspace. The `pod-overrides` attribute allows merging certain fields in the workspace pod's `spec`. + For OpenShift versions older than 4.15: + diff --git a/modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc b/modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc index 8726c0853d..2f0e08e42e 100644 --- a/modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc +++ b/modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc @@ -35,7 +35,7 @@ Otherwise, you can update the `/home/user/.config/containers/storage.conf` for a .Prerequisites -* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[]. +* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:configure:configuring-fuse.adoc[]. * A workspace with the required annotations are set by following xref:accessing-fuse.adoc[] diff --git a/modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc b/modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc index b320e23e5f..3b77ef5f31 100644 --- a/modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc +++ b/modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc @@ -10,7 +10,7 @@ When backups are enabled for {devworkspace} instances on your cluster, a cron job backs up workspace data for stopped workspaces. Backup storage, registry access, and schedules are configured cluster-wide by administrators in the {devworkspace} Operator. -For administrator steps, see xref:administration-guide:devworkspace-backup.adoc[]. +For administrator steps, see xref:configure:devworkspace-backup.adoc[]. Backing up and restoring workspaces allows you to recover uncommitted source code changes. Restored workspaces use a minimal devfile rather than the original project devfile. diff --git a/modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc b/modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc index 54ec0af6f5..b3bed9a04c 100644 --- a/modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc +++ b/modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc @@ -17,7 +17,7 @@ For more efficient image management, use the fuse-overlayfs storage driver which You must meet the following requirements to use fuse-overlayfs in a workspace: -. For OpenShift versions older than 4.15, the administrator has enabled `/dev/fuse` access on the cluster by following xref:administration-guide:configuring-fuse.adoc[]. +. For OpenShift versions older than 4.15, the administrator has enabled `/dev/fuse` access on the cluster by following xref:configure:configuring-fuse.adoc[]. . The workspace has the necessary annotations for using the `/dev/fuse` device. See xref:accessing-fuse.adoc[]. . The `storage.conf` file in the workspace container has been configured to use fuse-overlayfs. See xref:enabling-overlay-with-a-configmap.adoc[]. diff --git a/modules/end-user-guide/partials/proc_creating-workspaces.adoc b/modules/end-user-guide/partials/proc_creating-workspaces.adoc index abd1d59e8d..c3029aeb25 100644 --- a/modules/end-user-guide/partials/proc_creating-workspaces.adoc +++ b/modules/end-user-guide/partials/proc_creating-workspaces.adoc @@ -27,18 +27,18 @@ Creating workspaces through the {prod-short} dashboard provides better user expe * An active `{orch-cli}` session with permissions to create `DevWorkspace` resources in your {orch-namespace} on the cluster. See {orch-cli-link}. -* You know the relevant {prod-short} user namespace on the cluster. +* You know the relevant {prod-short} user {namespace} on the cluster. + -TIP: You can visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`. +TIP: You can visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user {namespace} as `name`. -* You are in the {prod-short} user namespace on the cluster. +* You are in the {prod-short} user {namespace} on the cluster. + [TIP] ==== On OpenShift, you can use the command-line `oc` tool to link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/developer-cli-commands.html#oc-project[display your current namespace or switch to a namespace]. ==== + -NOTE: {prod-short} administrators who intend to create workspaces for other users must create the `DevWorkspace` custom resource in a user namespace that is provisioned by {prod-short} or by the administrator. See xref:administration-guide:configuring-namespace-provisioning.adoc[]. +NOTE: {prod-short} administrators who intend to create workspaces for other users must create the `DevWorkspace` custom resource in a user {namespace} that is provisioned by {prod-short} or by the administrator. See xref:configure:configuring-namespace-provisioning.adoc[]. .Procedure diff --git a/modules/extensions/pages/creating-a-telemetry-plugin.adoc b/modules/extensions/pages/creating-a-telemetry-plugin.adoc index c3c54b71f7..3dbf23abe2 100644 --- a/modules/extensions/pages/creating-a-telemetry-plugin.adoc +++ b/modules/extensions/pages/creating-a-telemetry-plugin.adoc @@ -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:administration-guide: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: @@ -402,7 +402,7 @@ spec: .Additional resources -* xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. +* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. .Verification steps diff --git a/modules/get-started-admin/pages/what-to-configure-next.adoc b/modules/get-started-admin/pages/what-to-configure-next.adoc index 57f4e7c426..58683a04ef 100644 --- a/modules/get-started-admin/pages/what-to-configure-next.adoc +++ b/modules/get-started-admin/pages/what-to-configure-next.adoc @@ -20,7 +20,7 @@ After verifying the platform and configuring Git access, continue with these con | Recommended | Configure workspace resource limits, idle timeouts, and the number of workspaces per user. -| xref:administration-guide:configuring-workspaces-globally.adoc[Set workspace policies for all users] +| xref:configure:configuring-workspaces-globally.adoc[Set workspace policies for all users] | Recommended | Configure OAuth for additional Git providers (GitLab, Bitbucket, Azure DevOps). @@ -32,7 +32,7 @@ After verifying the platform and configuring Git access, continue with these con | As needed | Customize the `CheCluster` custom resource to change {prod-short} behavior. -| xref:administration-guide:understanding-the-checluster-custom-resource.adoc[Customize the central configuration] +| xref:configure:understanding-the-checluster-custom-resource.adoc[Customize the central configuration] |=== diff --git a/modules/get-started-admin/pages/your-first-week-as-administrator.adoc b/modules/get-started-admin/pages/your-first-week-as-administrator.adoc index f5a30464dd..2ba58b3bfb 100644 --- a/modules/get-started-admin/pages/your-first-week-as-administrator.adoc +++ b/modules/get-started-admin/pages/your-first-week-as-administrator.adoc @@ -26,4 +26,4 @@ The first three tasks are covered in this guide. The fourth task is covered acro * xref:secure:managing-identities-and-authorizations.adoc[Secure {prod-short}] * xref:optimize:caching-images-for-faster-workspace-start.adoc[Speed up workspace starts with image caching] -* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[Customize the central configuration] +* xref:configure:understanding-the-checluster-custom-resource.adoc[Customize the central configuration] diff --git a/modules/get-started-user/pages/using-a-git-provider-access-token.adoc b/modules/get-started-user/pages/using-a-git-provider-access-token.adoc index fc7ad9ac57..bccac558b6 100644 --- a/modules/get-started-user/pages/using-a-git-provider-access-token.adoc +++ b/modules/get-started-user/pages/using-a-git-provider-access-token.adoc @@ -101,7 +101,7 @@ stringData: ---- // vale RedHat.GitLinks = YES -. Open `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`. +. Open `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user {namespace} as `name`. . Apply the Secret to your {prod-short} user {orch-namespace}: + @@ -147,7 +147,7 @@ $ git clone https://github.com/____/____.git .Additional resources * xref:authenticating-to-a-git-server-from-a-workspace.adoc[] -* xref:administration-guide:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[Deploy with support for Git repositories with self-signed certificates] +* xref:configure:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[Deploy with support for Git repositories with self-signed certificates] * link:https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on[Authorizing a personal access token for use with SAML single sign-on] // vale RedHat.CaseSensitiveTerms = YES diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index ea58995e02..fca01ff659 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -18,7 +18,7 @@ include::partial$snip_persona-admin.adoc[] [role="_additional-resources"] .Additional resources -* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] +* xref:configure:understanding-the-checluster-custom-resource.adoc[] * xref:administration-guide:configuring-oauth-for-git-providers.adoc[] * xref:get-started-user:starting-a-workspace-from-a-git-repository-url.adoc[] * xref:get-started-admin:verify-the-platform-end-to-end.adoc[] diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index 520a991360..7e906303ff 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -226,4 +226,4 @@ $ {orch-cli} get csv -A | grep {prod-operator-package-name} * link:https://argo-cd.readthedocs.io/en/stable/getting_started/[Argo CD Getting Started] * link:https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/[Argo CD sync options] -* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] +* xref:configure:understanding-the-checluster-custom-resource.adoc[] diff --git a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index 326b61ba18..e359d278fc 100644 --- a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -54,7 +54,7 @@ $ {prod-cli} server:deploy \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml ---- -. Allow incoming traffic from the {prod-short} namespace to all Pods in the user {orch-namespace}s. See: xref:administration-guide:configuring-network-policies.adoc[]. +. Allow incoming traffic from the {prod-short} namespace to all Pods in the user {orch-namespace}s. See: xref:configure:configuring-network-policies.adoc[]. .Verification diff --git a/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc index cf252b28bb..7129fadd43 100644 --- a/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc @@ -372,4 +372,4 @@ sleep 5s && \ [role="_additional-resources"] .Additional resources -* xref:administration-guide:configuring-che-with-self-signed-certificate.adoc[] +* xref:configure:configuring-che-with-self-signed-certificate.adoc[] diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index fb1e774de7..8924f4e175 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -60,4 +60,4 @@ $ {prod-cli} dashboard:open [role="_additional-resources"] .Additional resources -* xref:administration-guide:configuring-che-with-self-signed-certificate.adoc[] +* xref:configure:configuring-che-with-self-signed-certificate.adoc[] diff --git a/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc index 04ab10d4cb..9c627f65f7 100644 --- a/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc +++ b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc @@ -52,6 +52,6 @@ $ oc get configmap che -o jsonpath='{.data.__}' \ [role="_additional-resources"] .Additional resources -* xref:administration-guide:checluster-custom-resource-fields-reference.adoc[]. +* xref:configure:checluster-custom-resource-fields-reference.adoc[]. -* xref:administration-guide:advanced-configuration-options-for-the-che-server-component.adoc[]. +* xref:configure:advanced-configuration-options-for-the-che-server-component.adoc[]. diff --git a/modules/observe/pages/configuring-server-logging.adoc b/modules/observe/pages/configuring-server-logging.adoc index dfde403f4b..7916b0e6bb 100644 --- a/modules/observe/pages/configuring-server-logging.adoc +++ b/modules/observe/pages/configuring-server-logging.adoc @@ -9,7 +9,7 @@ Fine-tune the log levels of individual loggers available in the {prod-short} server to control output verbosity and isolate issues during troubleshooting. -The log level of the whole {prod-short} server is configured globally using the `cheLogLevel` configuration property of the Operator. See xref:administration-guide: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. diff --git a/modules/observe/pages/the-woopra-telemetry-plugin.adoc b/modules/observe/pages/the-woopra-telemetry-plugin.adoc index 5445db3832..df475addfd 100644 --- a/modules/observe/pages/the-woopra-telemetry-plugin.adoc +++ b/modules/observe/pages/the-woopra-telemetry-plugin.adoc @@ -30,7 +30,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:administration-guide: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] ---- @@ -48,4 +48,4 @@ spec: * xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] -* xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] +* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/observe/partials/proc_configuring-server-logging.adoc b/modules/observe/partials/proc_configuring-server-logging.adoc index e231ee03c8..3d52118b44 100644 --- a/modules/observe/partials/proc_configuring-server-logging.adoc +++ b/modules/observe/partials/proc_configuring-server-logging.adoc @@ -12,7 +12,7 @@ Configure the log levels of individual loggers in the {prod-short} server with t .Procedure -. Configure the `CheCluster` Custom Resource. See xref:administration-guide: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"] ---- @@ -41,5 +41,5 @@ spec: * xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] -* xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] +* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/observe/partials/proc_enabling-and-exposing-che-metrics.adoc b/modules/observe/partials/proc_enabling-and-exposing-che-metrics.adoc index e42d71dd08..503a2404b1 100644 --- a/modules/observe/partials/proc_enabling-and-exposing-che-metrics.adoc +++ b/modules/observe/partials/proc_enabling-and-exposing-che-metrics.adoc @@ -11,7 +11,7 @@ .Procedure -. Configure the `CheCluster` Custom Resource. See xref:administration-guide: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"] ---- diff --git a/modules/observe/partials/proc_logging-http-traffic.adoc b/modules/observe/partials/proc_logging-http-traffic.adoc index d23e59b66e..1bdc5e92f3 100644 --- a/modules/observe/partials/proc_logging-http-traffic.adoc +++ b/modules/observe/partials/proc_logging-http-traffic.adoc @@ -12,7 +12,7 @@ Log the HTTP traffic between the {prod-short} server and the API server of the { .Procedure -. Configure the `CheCluster` Custom Resource. See xref:administration-guide: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] ---- @@ -27,5 +27,5 @@ spec: * xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] -* xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] +* xref:configure:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/secure/pages/configuring-advanced-authorization.adoc b/modules/secure/pages/configuring-advanced-authorization.adoc index 46e473c533..0a97a7ccd8 100644 --- a/modules/secure/pages/configuring-advanced-authorization.adoc +++ b/modules/secure/pages/configuring-advanced-authorization.adoc @@ -15,7 +15,7 @@ Restrict {prod-short} access to specific users and groups so that you can contro .Procedure -. Configure the `CheCluster` Custom Resource. See xref:administration-guide: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"] ---- diff --git a/modules/secure/pages/removing-user-data-in-compliance-with-the-gdpr.adoc b/modules/secure/pages/removing-user-data-in-compliance-with-the-gdpr.adoc index 1c03da566b..2f24865ccb 100644 --- a/modules/secure/pages/removing-user-data-in-compliance-with-the-gdpr.adoc +++ b/modules/secure/pages/removing-user-data-in-compliance-with-the-gdpr.adoc @@ -51,6 +51,6 @@ $ {orch-cli} get users [role="_additional-resources"] .Additional resources -* xref:administration-guide:managing-workloads-using-the-che-server-api.adoc[] -* xref:administration-guide:configuring-workspace-target-namespace.adoc[] +* xref:configure:managing-workloads-using-the-che-server-api.adoc[] +* xref:configure:configuring-workspace-target-namespace.adoc[] * xref:install:proc_uninstalling-che.adoc[] diff --git a/modules/secure/pages/security-best-practices.adoc b/modules/secure/pages/security-best-practices.adoc index c19a46b45c..bea662d518 100644 --- a/modules/secure/pages/security-best-practices.adoc +++ b/modules/secure/pages/security-best-practices.adoc @@ -111,16 +111,16 @@ The following table lists the resources and actions that you can grant users per |projects |"get" -|devworkspace +|`devworkspaces` |"get", "create", "delete", "list", "update", "patch", "watch" -|devworkspacetemplates +|`devworkspacetemplates` |"get", "create", "delete", "list", "update", "patch", "watch" |=== [IMPORTANT] ==== -Each user is granted permissions only to their namespace and cannot access other users' resources. Cluster administrators can add extra permissions to users. They should not remove permissions granted by default. +Each user is granted permissions only to their {namespace} and cannot access other users' resources. Cluster administrators can add extra permissions to users. They should not remove permissions granted by default. For more details about configuring cluster roles for {prod} users and role-based access control, see the Additional resources section. ==== @@ -136,7 +136,7 @@ Isolation of the development environments is implemented using OpenShift project [IMPORTANT] ==== -Access to the resources in a namespace must be limited to the developer owning it. Granting read access to another developer is equivalent to sharing the developer credentials and should be avoided. +Access to the resources in a {namespace} must be limited to the developer owning it. Granting read access to another developer is equivalent to sharing the developer credentials and should be avoided. ==== == Restrict platform access with allow and deny lists @@ -240,7 +240,7 @@ For credential-free Git access that reduces token sprawl, see Additional resourc [role="_additional-resources"] .Additional resources -* xref:administration-guide:provisioning-namespaces-in-advance.adoc[] +* xref:configure:provisioning-namespaces-in-advance.adoc[] * xref:configuring-cluster-roles-for-users.adoc[] * xref:configuring-advanced-authorization.adoc[] * xref:administration-guide:configuring-oauth-for-git-providers.adoc[] @@ -249,6 +249,6 @@ For credential-free Git access that reduces token sprawl, see Additional resourc * link:https://docs.openshift.com/container-platform/{ocp4-ver}/applications/quotas/quotas-setting-per-project.html[Resource quotas per project] * link:https://docs.openshift.com/container-platform/{ocp4-ver}/nodes/clusters/nodes-cluster-limit-ranges.html[Limit ranges] * link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/networking_overview/index#about-openshift-sdn[OpenShift networking overview] -* xref:administration-guide:configuring-network-policies.adoc[] +* xref:configure:configuring-network-policies.adoc[] * xref:install:proc_installing-che-in-a-restricted-environment.adoc[] * xref:administration-guide:extensions-for-microsoft-visual-studio-code-open-source.adoc[]