From f0782b96fd61caf45fc6b5fb7775355efbfd6332 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Tue, 7 Jul 2026 10:24:10 +0530 Subject: [PATCH] chore: promote Integrate to top-level Antora module (JTBD Phase 3) Creates a new top-level modules/integrate/ Antora module by extracting OAuth for Git providers (from administration-guide) and OpenShift integration + artifact repositories (from end-user-guide). 19 pages, 24 partials, 4 images moved. Content synced with downstream (devspaces-documentation jtbd-integrate): - All titles use JTBD imperative verbs (no gerunds) - Abstracts follow WHAT+WHY pattern - Prerequisites use "You have..." completed-state wording - Procedure steps use "Create" for resource creation - .Verification sections added to OAuth applying procedures Co-authored-by: Cursor --- .gitignore | 1 + antora.yml | 1 + modules/administration-guide/nav.adoc | 7 --- ...ng-workloads-using-the-che-server-api.adoc | 2 +- modules/discover/pages/roles-and-tasks.adoc | 2 +- modules/end-user-guide/nav.adoc | 12 ----- .../pages/automatic-token-injection.adoc | 23 -------- .../partials/proc_listing-workspaces.adoc | 49 ------------------ .../partials/proc_removing-workspaces.adoc | 40 -------------- .../proc_starting-stopped-workspaces.adoc | 40 -------------- .../partials/proc_stopping-workspaces.adoc | 40 -------------- ...ting-to-a-git-server-from-a-workspace.adoc | 6 +-- ...ctions-you-can-perform-on-a-workspace.adoc | 2 +- .../using-a-git-provider-access-token.adoc | 6 +-- .../con_next-steps-after-installation.adoc | 2 +- .../che-red-hat-application-menu-che-odp.png | Bin .../edit-source-code-button-che-odp.png | Bin .../images/integration/token-injection.png | Bin ...enshift-web-console-from-che-dashboard.png | Bin modules/integrate/nav.adoc | 20 +++++++ .../pages/automatic-token-injection.adoc | 30 +++++++++++ ...guring-oauth-1-for-a-bitbucket-server.adoc | 8 +-- ...guring-oauth-2-for-a-bitbucket-server.adoc | 8 +-- .../pages/configuring-oauth-2-for-github.adoc | 8 +-- .../pages/configuring-oauth-2-for-gitlab.adoc | 8 +-- ...2-for-microsoft-azure-devops-services.adoc | 8 +-- ...uring-oauth-2-for-the-bitbucket-cloud.adoc | 8 +-- .../configuring-oauth-for-git-providers.adoc | 9 ++-- ...ositories-in-a-restricted-environment.adoc | 6 +-- .../enabling-go-artifact-repositories.adoc | 12 ++--- ...enabling-gradle-artifact-repositories.adoc | 14 ++--- .../enabling-maven-artifact-repositories.adoc | 16 +++--- .../enabling-npm-artifact-repositories.adoc | 12 ++--- .../enabling-nuget-artifact-repositories.adoc | 14 ++--- ...enabling-python-artifact-repositories.adoc | 12 ++--- .../pages/integrating-with-kubernetes.adoc | 8 +-- .../pages/managing-workspaces-with-apis.adoc | 10 ++-- ...-from-openshift-developer-perspective.adoc | 8 +-- ...gating-openshift-web-console-from-che.adoc | 10 ++-- ...oper-perspective-integration-with-che.adoc | 2 +- ...ng-che-from-red-hat-applications-menu.adoc | 4 +- ...-link-secret-for-the-bitbucket-server.adoc | 16 +++--- ...-link-secret-for-the-bitbucket-server.adoc | 16 +++--- ...nsumer-secret-for-the-bitbucket-cloud.adoc | 16 +++--- ..._applying-the-github-oauth-app-secret.adoc | 18 ++++--- ...-gitlab-authorized-application-secret.adoc | 18 ++++--- ...zure-devops-services-oauth-app-secret.adoc | 23 +++++--- .../partials/proc_creating-workspaces.adoc | 25 +++++---- ...ng-self-signed-certificate-validation.adoc | 4 +- ...penshift-container-platform-using-che.adoc | 4 +- ...cing-refresh-of-personal-access-token.adoc | 38 ++++++++++++++ .../partials/proc_listing-workspaces.adoc | 46 ++++++++++++++++ .../partials/proc_removing-workspaces.adoc | 29 +++++++++++ ...ng-node-extra-ca-certs-variable-value.adoc | 8 +-- ...lication-link-on-the-bitbucket-server.adoc | 8 +-- ...lication-link-on-the-bitbucket-server.adoc | 8 +-- ...oauth-consumer-in-the-bitbucket-cloud.adoc | 8 +-- .../proc_setting-up-the-github-app.adoc | 8 +-- .../proc_setting-up-the-github-oauth-app.adoc | 10 ++-- ...-up-the-gitlab-authorized-application.adoc | 8 +-- ...osoft-azure-devops-services-oauth-app.adoc | 8 +-- .../proc_starting-stopped-workspaces.adoc | 28 ++++++++++ .../partials/proc_stopping-workspaces.adoc | 28 ++++++++++ ...igmap-that-sets-environment-variables.adoc | 0 64 files changed, 434 insertions(+), 409 deletions(-) delete mode 100644 modules/end-user-guide/pages/automatic-token-injection.adoc delete mode 100644 modules/end-user-guide/partials/proc_listing-workspaces.adoc delete mode 100644 modules/end-user-guide/partials/proc_removing-workspaces.adoc delete mode 100644 modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc delete mode 100644 modules/end-user-guide/partials/proc_stopping-workspaces.adoc rename modules/{end-user-guide => integrate}/images/installation/che-red-hat-application-menu-che-odp.png (100%) rename modules/{end-user-guide => integrate}/images/installation/edit-source-code-button-che-odp.png (100%) rename modules/{end-user-guide => integrate}/images/integration/token-injection.png (100%) rename modules/{end-user-guide => integrate}/images/navigation/navigating-openshift-web-console-from-che-dashboard.png (100%) create mode 100644 modules/integrate/nav.adoc create mode 100644 modules/integrate/pages/automatic-token-injection.adoc rename modules/{administration-guide => integrate}/pages/configuring-oauth-1-for-a-bitbucket-server.adoc (68%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-2-for-a-bitbucket-server.adoc (69%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-2-for-github.adoc (79%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-2-for-gitlab.adoc (70%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc (75%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc (69%) rename modules/{administration-guide => integrate}/pages/configuring-oauth-for-git-providers.adoc (75%) rename modules/{end-user-guide => integrate}/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc (74%) rename modules/{end-user-guide => integrate}/pages/enabling-go-artifact-repositories.adoc (74%) rename modules/{end-user-guide => integrate}/pages/enabling-gradle-artifact-repositories.adoc (79%) rename modules/{end-user-guide => integrate}/pages/enabling-maven-artifact-repositories.adoc (81%) rename modules/{end-user-guide => integrate}/pages/enabling-npm-artifact-repositories.adoc (74%) rename modules/{end-user-guide => integrate}/pages/enabling-nuget-artifact-repositories.adoc (78%) rename modules/{end-user-guide => integrate}/pages/enabling-python-artifact-repositories.adoc (74%) rename modules/{end-user-guide => integrate}/pages/integrating-with-kubernetes.adoc (51%) rename modules/{end-user-guide => integrate}/pages/managing-workspaces-with-apis.adoc (78%) rename modules/{end-user-guide => integrate}/pages/navigating-che-from-openshift-developer-perspective.adoc (86%) rename modules/{end-user-guide => integrate}/pages/navigating-openshift-web-console-from-che.adoc (63%) rename modules/{end-user-guide => integrate}/partials/con_openshift-developer-perspective-integration-with-che.adoc (89%) rename modules/{end-user-guide => integrate}/partials/proc_accessing-che-from-red-hat-applications-menu.adoc (83%) rename modules/{administration-guide => integrate}/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc (69%) rename modules/{administration-guide => integrate}/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc (65%) rename modules/{administration-guide => integrate}/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc (66%) rename modules/{administration-guide => integrate}/partials/proc_applying-the-github-oauth-app-secret.adoc (72%) rename modules/{administration-guide => integrate}/partials/proc_applying-the-gitlab-authorized-application-secret.adoc (63%) rename modules/{administration-guide => integrate}/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc (61%) rename modules/{end-user-guide => integrate}/partials/proc_creating-workspaces.adoc (77%) rename modules/{end-user-guide => integrate}/partials/proc_disabling-self-signed-certificate-validation.adoc (86%) rename modules/{end-user-guide => integrate}/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc (81%) create mode 100644 modules/integrate/partials/proc_forcing-refresh-of-personal-access-token.adoc create mode 100644 modules/integrate/partials/proc_listing-workspaces.adoc create mode 100644 modules/integrate/partials/proc_removing-workspaces.adoc rename modules/{end-user-guide => integrate}/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc (69%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc (86%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc (70%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc (74%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-the-github-app.adoc (84%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-the-github-oauth-app.adoc (67%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-the-gitlab-authorized-application.adoc (74%) rename modules/{administration-guide => integrate}/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc (85%) create mode 100644 modules/integrate/partials/proc_starting-stopped-workspaces.adoc create mode 100644 modules/integrate/partials/proc_stopping-workspaces.adoc rename modules/{end-user-guide => integrate}/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc (100%) diff --git a/.gitignore b/.gitignore index bed5638306..d7a37026fe 100644 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,4 @@ yarn.lock # Do not commit diagrams generated for downstream crw* +CLAUDE.md diff --git a/antora.yml b/antora.yml index 61f46682e6..e1defca524 100644 --- a/antora.yml +++ b/antora.yml @@ -12,6 +12,7 @@ nav: - modules/upgrade/nav.adoc - modules/secure/nav.adoc - modules/optimize/nav.adoc + - modules/integrate/nav.adoc - modules/administration-guide/nav.adoc - modules/extensions/nav.adoc - modules/glossary/nav.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 844c4820c7..e746b81bdc 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -51,13 +51,6 @@ *** 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[] diff --git a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc b/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc index a30623710a..2dcfc8b031 100644 --- a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc +++ b/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc @@ -15,7 +15,7 @@ To manage {prod-short} server and {prod-short} dashboard workloads, use the Swag - `pass:c,a,q[{prod-url}]/swagger` ({prod-short} server) - `pass:c,a,q[{prod-url}]/dashboard/api/swagger` ({prod-short} dashboard) -IMPORTANT: DevWorkspace is a k8s object and manipulations should happen on the Kubernetes API level - xref:end-user-guide:managing-workspaces-with-apis.adoc[] +IMPORTANT: DevWorkspace is a k8s object and manipulations should happen on the Kubernetes API level - xref:integrate:managing-workspaces-with-apis.adoc[] .Additional resources diff --git a/modules/discover/pages/roles-and-tasks.adoc b/modules/discover/pages/roles-and-tasks.adoc index c487c1a27b..e1e570c528 100644 --- a/modules/discover/pages/roles-and-tasks.adoc +++ b/modules/discover/pages/roles-and-tasks.adoc @@ -18,7 +18,7 @@ Common tasks include: * Deploy {prod-short} on a cluster. See xref:install:installing-che.adoc[]. * Configure the `CheCluster` custom resource. See xref:administration-guide:understanding-the-checluster-custom-resource.adoc[]. -* Set up OAuth for Git providers. See xref:administration-guide:configuring-oauth-for-git-providers.adoc[]. +* Set up OAuth for Git providers. See xref:integrate:configuring-oauth-for-git-providers.adoc[]. * Upgrade to the latest version. See xref:administration-guide:upgrading-che.adoc[]. * Monitor metrics and logs. See xref:administration-guide:configuring-observability.adoc[]. diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index 13b4fcbf04..10a2e36f54 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -42,19 +42,7 @@ ** xref:mounting-configmaps.adoc[] *** xref:mounting-git-configuration.adoc[] *** xref:mounting-ssh-configuration.adoc[] -** xref:enabling-artifact-repositories-in-a-restricted-environment.adoc[] -*** xref:enabling-maven-artifact-repositories.adoc[] -*** xref:enabling-gradle-artifact-repositories.adoc[] -*** xref:enabling-npm-artifact-repositories.adoc[] -*** xref:enabling-python-artifact-repositories.adoc[] -*** xref:enabling-go-artifact-repositories.adoc[] -*** xref:enabling-nuget-artifact-repositories.adoc[] * xref:requesting-persistent-storage-for-workspaces.adoc[] -* xref:integrating-with-kubernetes.adoc[] -** xref:managing-workspaces-with-apis.adoc[] -** xref:automatic-token-injection.adoc[] -** xref:navigating-che-from-openshift-developer-perspective.adoc[] -** xref:navigating-openshift-web-console-from-che.adoc[] * xref:troubleshooting-che.adoc[] ** xref:viewing-che-workspaces-logs.adoc[] *** xref:viewing-workspace-logs-in-cli.adoc[] diff --git a/modules/end-user-guide/pages/automatic-token-injection.adoc b/modules/end-user-guide/pages/automatic-token-injection.adoc deleted file mode 100644 index da7caa5b67..0000000000 --- a/modules/end-user-guide/pages/automatic-token-injection.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_content-type: PROCEDURE -:description: Automatic {orch-name} token injection -:keywords: user-guide, token, injection -:navtitle: Automatic {orch-name} token injection -:page-aliases: .:automatic-token-injection.adoc, overview:automatic-token-injection.adoc - -[id="automatic-token-injection"] -= Automatic {orch-name} token injection - -This section describes how to use the {orch-name} user token that is automatically injected into workspace containers which allows running {prod-short} CLI commands against {orch-name} cluster. - -.Procedure - -. Open the {prod-short} dashboard and start a workspace. - -. Once the workspace is started, open a terminal in the container that contains the {prod-short} CLI. - -. Execute {prod-short} CLI commands which allow you to run commands against {orch-name} cluster. CLI can be used for deploying applications, inspecting and managing cluster resources, and viewing logs. {orch-name} user token will be used during the execution of the commands. - -+ -image::integration/token-injection.png[Token Injection in IDE,link="{imagesdir}/integration/token-injection.png"] - -WARNING: The automatic token injection currently works only on the OpenShift infrastructure. diff --git a/modules/end-user-guide/partials/proc_listing-workspaces.adoc b/modules/end-user-guide/partials/proc_listing-workspaces.adoc deleted file mode 100644 index 5057e7e860..0000000000 --- a/modules/end-user-guide/partials/proc_listing-workspaces.adoc +++ /dev/null @@ -1,49 +0,0 @@ - -[id="listing-workspaces"] -= Listing all workspaces - -As a user, you can list your workspaces by using the command line. - -.Prerequisites - -* An active `{orch-cli}` session with permissions to `get` the `DevWorkspace` resources in your {orch-namespace} on the cluster. See {orch-cli-link}. - -* 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`. - -* 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]. -==== - -.Procedure - -* To list your workspaces, enter the following on a command line: -+ -[source,subs="+attributes"] ----- -$ {orch-cli} get devworkspaces ----- -+ -.Output -==== ----- -NAMESPACE NAME DEVWORKSPACE ID PHASE INFO -user1-dev spring-petclinic workspace6d99e9ffb9784491 Running https://url-to-workspace.com -user1-dev golang-example workspacedf64e4a492cd4701 Stopped Stopped -user1-dev python-hello-world workspace69c26884bbc141f2 Failed Container tooling has state CrashLoopBackOff ----- -==== - -[TIP] -==== -You can view *PHASE* changes live by adding the `--watch` flag to this command. -==== - -[NOTE] -==== -Users with administrative permissions on the cluster can list all workspaces from all {prod-short} users by including the `--all-namespaces` flag. -==== \ No newline at end of file diff --git a/modules/end-user-guide/partials/proc_removing-workspaces.adoc b/modules/end-user-guide/partials/proc_removing-workspaces.adoc deleted file mode 100644 index 07494db078..0000000000 --- a/modules/end-user-guide/partials/proc_removing-workspaces.adoc +++ /dev/null @@ -1,40 +0,0 @@ - -[id="removing-workspaces"] -= Removing workspaces - -You can remove a workspace by simply deleting the `DevWorkspace` custom resource. - -WARNING: Deleting the `DevWorkspace` custom resource will also delete other workspace resources if they were created by {prod-short}: for example, the referenced `DevWorkspaceTemplate` and per-workspace `PersistentVolumeClaims`. - -TIP: Remove workspaces by using the {prod-short} dashboard whenever possible. - -.Prerequisites - -* An active `{orch-cli}` session on the cluster. See {orch-cli-link}. - -* You know the workspace name. -+ -[TIP] -==== -You can find the relevant workspace name in the output of `$ {orch-cli} get devworkspaces`. -==== - -* 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`. - -* 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]. -==== - -.Procedure - -* Run the following command to remove a workspace: -+ -[subs="+quotes,attributes"] ----- -$ {orch-cli} delete devworkspace ____ -n ____ ----- diff --git a/modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc b/modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc deleted file mode 100644 index 2472b238c4..0000000000 --- a/modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc +++ /dev/null @@ -1,40 +0,0 @@ - -[id="starting-stopped-workspaces"] -= Starting stopped workspaces - -You can start a stopped workspace by setting the `spec.started` field in the `Devworkspace` custom resource to `true`. - -.Prerequisites - -* An active `{orch-cli}` session on the cluster. See {orch-cli-link}. - -* You know the workspace name. -+ -[TIP] -==== -You can find the relevant workspace name in the output of `$ {orch-cli} get devworkspaces`. -==== - -* 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`. - -* 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]. -==== - -.Procedure - -* Run the following command to start a stopped workspace: -+ -[subs="+quotes,attributes"] ----- -$ {orch-cli} patch devworkspace ____ \ --p '{"spec":{"started":true}}' \ ---type=merge -n ____ && \ -{orch-cli} wait --for=jsonpath='{.status.phase}'=Running \ -dw/____ -n ____ ----- diff --git a/modules/end-user-guide/partials/proc_stopping-workspaces.adoc b/modules/end-user-guide/partials/proc_stopping-workspaces.adoc deleted file mode 100644 index 13798ae00c..0000000000 --- a/modules/end-user-guide/partials/proc_stopping-workspaces.adoc +++ /dev/null @@ -1,40 +0,0 @@ - -[id="stopping-workspaces"] -= Stopping workspaces - -You can stop a workspace by setting the `spec.started` field in the `Devworkspace` custom resource to `false`. - -.Prerequisites - -* An active `{orch-cli}` session on the cluster. See {orch-cli-link}. - -* You know the workspace name. -+ -[TIP] -==== -You can find the relevant workspace name in the output of `$ {orch-cli} get devworkspaces`. -==== - -* 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`. - -* 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]. -==== - -.Procedure - -* Run the following command to stop a workspace: -+ -[subs="+quotes,attributes"] ----- -$ {orch-cli} patch devworkspace ____ \ --p '{"spec":{"started":false}}' \ ---type=merge -n ____ && \ -{orch-cli} wait --for=jsonpath='{.status.phase}'=Stopped \ -dw/____ -n ____ ----- diff --git a/modules/get-started/pages/authenticating-to-a-git-server-from-a-workspace.adoc b/modules/get-started/pages/authenticating-to-a-git-server-from-a-workspace.adoc index 2193cf388c..ffb6c90bad 100644 --- a/modules/get-started/pages/authenticating-to-a-git-server-from-a-workspace.adoc +++ b/modules/get-started/pages/authenticating-to-a-git-server-from-a-workspace.adoc @@ -7,7 +7,6 @@ [id="authenticating-to-a-git-server-from-a-workspace"] = How Git authentication works in Cloud Development Environments -pass:[] include::partial$snip_persona-developer.adoc[] @@ -15,13 +14,12 @@ In a workspace, you can run Git commands that require user authentication like c User authentication to a Git server from a workspace is configured by the administrator or, in some cases, by the individual user: -* Your administrator sets up an xref:administration-guide:configuring-oauth-for-git-providers.adoc[OAuth application on GitHub, GitLab, Bitbucket, or Microsoft Azure Repos] for your organization's {prod} instance. +* Your administrator sets up an xref:integrate:configuring-oauth-for-git-providers.adoc[OAuth application on GitHub, GitLab, Bitbucket, or Microsoft Azure Repos] for your organization's {prod} instance. * As a workaround, some users create and apply their own {kubernetes} Secrets for their personal xref:using-a-git-provider-access-token.adoc[Git-provider access tokens] or link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[configure SSH keys for Git operations]. .Additional resources -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers] +* xref:integrate:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers] * xref:using-a-git-provider-access-token.adoc[User Guide: Using a Git-provider access token] * link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[Configuring DevWorkspaces to use SSH keys for Git operations] -pass:[] \ No newline at end of file diff --git a/modules/get-started/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/get-started/pages/basic-actions-you-can-perform-on-a-workspace.adoc index f90f38ede8..4532f6ab50 100644 --- a/modules/get-started/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/get-started/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -34,4 +34,4 @@ After you start a new workspace, you can perform the following actions on it in |=== -NOTE: Each workspace is a {orch-name} `DevWorkspace` custom resource. You can also manage workspaces from the command line with `{orch-cli}` or `kubectl`. See xref:end-user-guide:managing-workspaces-with-apis.adoc[]. +NOTE: Each workspace is a {orch-name} `DevWorkspace` custom resource. You can also manage workspaces from the command line with `{orch-cli}` or `kubectl`. See xref:integrate:managing-workspaces-with-apis.adoc[]. diff --git a/modules/get-started/pages/using-a-git-provider-access-token.adoc b/modules/get-started/pages/using-a-git-provider-access-token.adoc index df1bd3fcab..b0c729fcea 100644 --- a/modules/get-started/pages/using-a-git-provider-access-token.adoc +++ b/modules/get-started/pages/using-a-git-provider-access-token.adoc @@ -7,11 +7,8 @@ [id="using-a-git-provider-access-token"] = Access private repositories with a personal access token -pass:[] -include::partial$snip_persona-developer.adoc[] - -OAuth for GitHub, GitLab, Bitbucket, or Microsoft Azure Repos needs to be xref:administration-guide:configuring-oauth-for-git-providers.adoc[configured by the administrator] of your organization's {prod-short} instance. If your administrator could not configure it for {prod-short} users, the workaround is for you to use a personal access token. You can configure personal access tokens on the *User Preferences* page of your {prod-short} dashboard: `pass:c,a,q[{prod-url}]/dashboard/#/user-preferences?tab=personal-access-tokens`, or apply it manually as a {kubernetes} Secret in the namespace. +OAuth for GitHub, GitLab, Bitbucket, or Microsoft Azure Repos needs to be xref:integrate:configuring-oauth-for-git-providers.adoc[configured by the administrator] of your organization's {prod-short} instance. If your administrator could not configure it for {prod-short} users, the workaround is for you to use a personal access token. You can configure personal access tokens on the *User Preferences* page of your {prod-short} dashboard: `pass:c,a,q[{prod-url}]/dashboard/#/user-preferences?tab=personal-access-tokens`, or apply it manually as a {kubernetes} Secret in the namespace. Mounting your access token as a Secret enables the {prod-short} Server to access the remote repository that is cloned during workspace creation, including access to the repository's `/.che` and `/.vscode` folders. @@ -167,7 +164,6 @@ The `extraheader` configuration is needed for remote git operations to Azure Dev * xref:administration-guide:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[Deploying Che 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] -pass:[] diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index afe3fbce36..99edfc8f2c 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -16,5 +16,5 @@ After a successful installation, a few configuration tasks remain before your te .Additional resources * xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[] +* xref:integrate:configuring-oauth-for-git-providers.adoc[] * xref:get-started:starting-a-workspace-from-a-git-repository-url.adoc[] diff --git a/modules/end-user-guide/images/installation/che-red-hat-application-menu-che-odp.png b/modules/integrate/images/installation/che-red-hat-application-menu-che-odp.png similarity index 100% rename from modules/end-user-guide/images/installation/che-red-hat-application-menu-che-odp.png rename to modules/integrate/images/installation/che-red-hat-application-menu-che-odp.png diff --git a/modules/end-user-guide/images/installation/edit-source-code-button-che-odp.png b/modules/integrate/images/installation/edit-source-code-button-che-odp.png similarity index 100% rename from modules/end-user-guide/images/installation/edit-source-code-button-che-odp.png rename to modules/integrate/images/installation/edit-source-code-button-che-odp.png diff --git a/modules/end-user-guide/images/integration/token-injection.png b/modules/integrate/images/integration/token-injection.png similarity index 100% rename from modules/end-user-guide/images/integration/token-injection.png rename to modules/integrate/images/integration/token-injection.png diff --git a/modules/end-user-guide/images/navigation/navigating-openshift-web-console-from-che-dashboard.png b/modules/integrate/images/navigation/navigating-openshift-web-console-from-che-dashboard.png similarity index 100% rename from modules/end-user-guide/images/navigation/navigating-openshift-web-console-from-che-dashboard.png rename to modules/integrate/images/navigation/navigating-openshift-web-console-from-che-dashboard.png diff --git a/modules/integrate/nav.adoc b/modules/integrate/nav.adoc new file mode 100644 index 0000000000..ed2f1acd33 --- /dev/null +++ b/modules/integrate/nav.adoc @@ -0,0 +1,20 @@ +.Integrate +* xref:configuring-oauth-for-git-providers.adoc[Connect Git providers with OAuth] +** 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:integrating-with-kubernetes.adoc[Manage workspaces with {orch-name} tools] +** xref:managing-workspaces-with-apis.adoc[] +** xref:automatic-token-injection.adoc[] +** xref:navigating-che-from-openshift-developer-perspective.adoc[] +** xref:navigating-openshift-web-console-from-che.adoc[] +* xref:enabling-artifact-repositories-in-a-restricted-environment.adoc[Resolve dependencies in restricted environments] +** xref:enabling-maven-artifact-repositories.adoc[] +** xref:enabling-gradle-artifact-repositories.adoc[] +** xref:enabling-npm-artifact-repositories.adoc[] +** xref:enabling-python-artifact-repositories.adoc[] +** xref:enabling-go-artifact-repositories.adoc[] +** xref:enabling-nuget-artifact-repositories.adoc[] diff --git a/modules/integrate/pages/automatic-token-injection.adoc b/modules/integrate/pages/automatic-token-injection.adoc new file mode 100644 index 0000000000..e95d011fdf --- /dev/null +++ b/modules/integrate/pages/automatic-token-injection.adoc @@ -0,0 +1,30 @@ +:_content-type: PROCEDURE +:description: Use automatic {orch-name} token injection +:keywords: user-guide, token, injection +:navtitle: Use automatic {orch-name} token injection +:page-aliases: .:automatic-token-injection.adoc, overview:automatic-token-injection.adoc + +[id="automatic-token-injection"] += Use automatic {orch-name} token injection + +Use the {orch-name} user token that is automatically injected into workspace containers to run `{orch-cli}` and `kubectl` commands against the {orch-name} cluster without explicit login. + +[WARNING] +==== +The automatic token injection currently works only on the OpenShift infrastructure. +==== + +.Prerequisites + +* You have a running instance of {prod}. + +.Procedure + +. Open the {prod-short} dashboard and start a workspace. + +. After the workspace starts, open a terminal in the workspace container. + +. Run `{orch-cli}` or `kubectl` commands to deploy applications, inspect and manage cluster resources, or view logs. The injected {orch-name} user token authenticates these commands automatically. + ++ +image::integration/token-injection.png[Token Injection in IDE,link="{imagesdir}/integration/token-injection.png"] diff --git a/modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc b/modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc similarity index 68% rename from modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc rename to modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc index b6ef03bc0f..250d787622 100644 --- a/modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc +++ b/modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 1.0 for a Bitbucket Server +:description: Connect Bitbucket Server with OAuth 1.0 so that developers can push and pull code :keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-1, oauth-1.0 -:navtitle: Configuring OAuth 1.0 for a Bitbucket Server -// :page-aliases: +:navtitle: Connect Bitbucket Server with OAuth 1.0 +:page-aliases: administration-guide:configuring-oauth-1-for-a-bitbucket-server.adoc [id="configuring-oauth-1-for-a-bitbucket-server"] -= Configuring OAuth 1.0 for a Bitbucket Server += Connect Bitbucket Server with OAuth 1.0 To enable users to work with a remote Git repository that is hosted on a Bitbucket Server: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc b/modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc similarity index 69% rename from modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc rename to modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc index 46d2b7e5bc..6f90d834d1 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 2.0 for a Bitbucket Server +:description: Connect Bitbucket Server with OAuth 2.0 so that developers can push and pull code :keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for a Bitbucket Server -// :page-aliases: +:navtitle: Connect Bitbucket Server with OAuth 2.0 +:page-aliases: administration-guide:configuring-oauth-2-for-a-bitbucket-server.adoc [id="configuring-oauth-2-for-a-bitbucket-server"] -= Configuring OAuth 2.0 for a Bitbucket Server += Connect Bitbucket Server with OAuth 2.0 You can use OAuth 2.0 to enable users to work with a remote Git repository that is hosted on a Bitbucket Server: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-github.adoc b/modules/integrate/pages/configuring-oauth-2-for-github.adoc similarity index 79% rename from modules/administration-guide/pages/configuring-oauth-2-for-github.adoc rename to modules/integrate/pages/configuring-oauth-2-for-github.adoc index ed1587a8fb..c3c78ec633 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-github.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-github.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 2.0 for GitHub +:description: Connect GitHub with OAuth so that developers can push and pull code :keywords: configuring-oauth, authorization, github, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for GitHub -:page-aliases: +:navtitle: Connect GitHub with OAuth +:page-aliases: administration-guide:configuring-oauth-2-for-github.adoc [id="configuring-oauth-2-for-github"] -= Configuring OAuth 2.0 for GitHub += Connect GitHub with OAuth To enable users to work with a remote Git repository that is hosted on GitHub: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc b/modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc similarity index 70% rename from modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc rename to modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc index 0b60e26d41..6a5e8c16e8 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 2.0 for GitLab +:description: Connect GitLab with OAuth so that developers can push and pull code :keywords: configuring-oauth, authorization, gitlab, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for GitLab -:page-aliases: +:navtitle: Connect GitLab with OAuth +:page-aliases: administration-guide:configuring-oauth-2-for-gitlab.adoc [id="configuring-oauth-2-for-gitlab"] -= Configuring OAuth 2.0 for GitLab += Connect GitLab with OAuth To enable users to work with a remote Git repository that is hosted using a GitLab instance: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc b/modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc similarity index 75% rename from modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc rename to modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc index 3c0d804c7d..799057e754 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 2.0 for Microsoft Azure DevOps Services +:description: Connect Azure DevOps with Microsoft Entra ID so that developers can push and pull code :keywords: configuring-oauth, authorization, microsoft azure devops services, microsoft azure repos, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for Microsoft Azure DevOps Services -:page-aliases: +:navtitle: Connect Azure DevOps with Microsoft Entra ID +:page-aliases: administration-guide:configuring-oauth-2-for-microsoft-azure-devops-services.adoc [id="configuring-oauth-2-for-microsoft-azure-devops-services"] -= Configuring OAuth 2.0 for Microsoft Azure DevOps Services += Connect Azure DevOps with Microsoft Entra ID ++++ diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc b/modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc similarity index 69% rename from modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc rename to modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc index ff31f339cb..5ccc158487 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Configuring OAuth 2.0 for the Bitbucket Cloud +:description: Connect Bitbucket Cloud with OAuth so that developers can push and pull code :keywords: configuring-oauth, authorization, bitbucket, bitbucket-cloud, cloud, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for the Bitbucket Cloud -// :page-aliases: +:navtitle: Connect Bitbucket Cloud with OAuth +:page-aliases: administration-guide:configuring-oauth-2-for-the-bitbucket-cloud.adoc [id="configuring-oauth-2-for-the-bitbucket-cloud"] -= Configuring OAuth 2.0 for the Bitbucket Cloud += Connect Bitbucket Cloud with OAuth You can enable users to work with a remote Git repository that is hosted in the Bitbucket Cloud: diff --git a/modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc b/modules/integrate/pages/configuring-oauth-for-git-providers.adoc similarity index 75% rename from modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc rename to modules/integrate/pages/configuring-oauth-for-git-providers.adoc index 96429b64f5..39771377bd 100644 --- a/modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc +++ b/modules/integrate/pages/configuring-oauth-for-git-providers.adoc @@ -1,11 +1,11 @@ :_content-type: CONCEPT -:description: Configuring OAuth for Git providers +:description: Connect Git providers with OAuth to enable credential-free access for developers :keywords: azure, bitbucket, gitlab, github, git -:navtitle: Configuring OAuth for Git providers -// :page-aliases: +:navtitle: Connect Git providers with OAuth +:page-aliases: administration-guide:configuring-oauth-for-git-providers.adoc [id="configuring-oauth-for-git-providers"] -= Configuring OAuth for Git providers += Connect Git providers with OAuth [NOTE] ==== @@ -29,3 +29,4 @@ You can configure OAuth between {prod-short} and Git providers, enabling users t * Configuring xref:configuring-oauth-1-for-a-bitbucket-server.adoc[OAuth 1.0 for a Bitbucket Server] * xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[] +include::partial$proc_forcing-refresh-of-personal-access-token.adoc[leveloffset=+1] diff --git a/modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc b/modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc similarity index 74% rename from modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc rename to modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc index f387dceefa..5d8e969bcd 100644 --- a/modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc +++ b/modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Enabling artifact repositories in a restricted environment +:description: Resolve build dependencies in restricted or air-gapped environments by connecting workspaces to internal package registries :keywords: artifact-repositories, artifact-repository, maven, gradle, nuget, python, go, npm -:navtitle: Enabling artifact repositories in a restricted environment +:navtitle: Resolve dependencies in restricted environments :page-aliases: using-artifact-repositories-in-a-restricted-environment.adoc [id="enabling-artifact-repositories-in-a-restricted-environment"] -= Enabling artifact repositories in a restricted environment += Resolve dependencies in restricted environments By configuring technology stacks, you can work with artifacts from in-house repositories using self-signed certificates: diff --git a/modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc b/modules/integrate/pages/enabling-go-artifact-repositories.adoc similarity index 74% rename from modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc rename to modules/integrate/pages/enabling-go-artifact-repositories.adoc index f5830e78d3..c56677606e 100644 --- a/modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-go-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable a Go artifact repository in Go workspaces that run in a restricted environment. +:description: Enable Go artifact repositories by setting GOPROXY and GONOSUMDB environment variables :keywords: go, artifact-repository, artifact-repositories -:navtitle: Go +:navtitle: Enable Go artifact repositories :page-aliases: using-go-artifact-repositories.adoc [id="enabling-go-artifact-repositories"] -= Enabling Go artifact repositories += Enable Go artifact repositories -You can enable a Go artifact repository in Go workspaces that run in a restricted environment. +Configure Go to use a module proxy by setting environment variables in your workspaces. .Prerequisites @@ -17,7 +17,7 @@ include::partial$snip_warning-about-applying-a-configmap-that-sets-environment-v .Procedure -. Apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -37,7 +37,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. Apply the ConfigMap to set the following environment variables in the `tools` container: +. Create a ConfigMap to set the following environment variables in the `tools` container: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- diff --git a/modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc b/modules/integrate/pages/enabling-gradle-artifact-repositories.adoc similarity index 79% rename from modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc rename to modules/integrate/pages/enabling-gradle-artifact-repositories.adoc index 34d117f313..b2afdac54c 100644 --- a/modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-gradle-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable a Gradle artifact repository in Gradle workspaces that run in a restricted environment. +:description: Enable a Gradle artifact repository so that Gradle workspaces can download plugins and dependencies from your internal registry. :keywords: gradle, artifact-repository, artifact-repositories -:navtitle: Gradle +:navtitle: Enable Gradle artifact repositories :page-aliases: using-gradle-artifact-repositories.adoc [id="enabling-gradle-artifact-repositories"] -= Enabling Gradle artifact repositories += Enable Gradle artifact repositories -You can enable a Gradle artifact repository in Gradle workspaces that run in a restricted environment. +Enable a Gradle artifact repository so that Gradle workspaces can download plugins and dependencies from your internal registry. .Prerequisites @@ -15,7 +15,7 @@ You can enable a Gradle artifact repository in Gradle workspaces that run in a r .Procedure -. Apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -35,7 +35,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. Apply the ConfigMap for the TrustStore initialization script: +. Create a ConfigMap for the TrustStore initialization script: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -56,7 +56,7 @@ data: keytool -importcert -noprompt -file /home/user/certs/tls.cer -cacerts -storepass changeit ---- -. Apply the ConfigMap for the Gradle init script: +. Create a ConfigMap for the Gradle init script: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- diff --git a/modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc b/modules/integrate/pages/enabling-maven-artifact-repositories.adoc similarity index 81% rename from modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc rename to modules/integrate/pages/enabling-maven-artifact-repositories.adoc index 6513e1e039..58c4296ab1 100644 --- a/modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-maven-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable a Maven artifact repository in Maven workspaces that run in a restricted environment. +:description: Enable a Maven artifact repository so that Java workspaces can resolve dependencies from your internal Nexus or Artifactory server. :keywords: maven, artifact-repository, artifact-repositories -:navtitle: Maven +:navtitle: Enable Maven artifact repositories :page-aliases: using-maven-artifact-repositories.adoc [id="enabling-maven-artifact-repositories"] -= Enabling Maven artifact repositories += Enable Maven artifact repositories -You can enable a Maven artifact repository in Maven workspaces that run in a restricted environment. +Enable a Maven artifact repository so that Java workspaces can resolve dependencies from your internal Nexus or Artifactory server. .Prerequisites @@ -16,7 +16,7 @@ You can enable a Maven artifact repository in Maven workspaces that run in a res .Procedure -. In the `____-{prod-id-short}` namespace, apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -36,7 +36,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. In the `____-{prod-id-short}` namespace, apply the ConfigMap to create the `settings.xml` file: +. Create a ConfigMap for the `settings.xml` file: + [source,yaml,subs="+quotes"] ---- @@ -85,9 +85,9 @@ data: ---- -. Optional: When using JBoss EAP-based devfiles, apply a second `settings-xml` ConfigMap in the `____-{prod-id-short}` namespace, and with the same content, a different name, and the `/home/jboss/.m2` mount path. +. Optional: When using JBoss EAP-based devfiles, create a second `settings-xml` ConfigMap with a different name and the `/home/jboss/.m2` mount path. Use the same content as step 3. -. In the `____-{prod-id-short}` namespace, apply the ConfigMap for the TrustStore initialization script: +. Create a ConfigMap for the TrustStore initialization script that matches your Java version: + .Java 8 diff --git a/modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc b/modules/integrate/pages/enabling-npm-artifact-repositories.adoc similarity index 74% rename from modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc rename to modules/integrate/pages/enabling-npm-artifact-repositories.adoc index 71138821f5..ed30dc4ad1 100644 --- a/modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-npm-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable an npm artifact repository in npm workspaces that run in a restricted environment. +:description: Enable an npm artifact repository so that Node.js workspaces can install packages from your internal npm registry. :keywords: npm, artifact-repository, artifact-repositories -:navtitle: npm +:navtitle: Enable npm artifact repositories :page-aliases: using-npm-artifact-repositories.adoc [id="enabling-npm-artifact-repositories"] -= Enabling npm artifact repositories += Enable npm artifact repositories -You can enable an npm artifact repository in npm workspaces that run in a restricted environment. +Enable an npm artifact repository so that Node.js workspaces can install packages from your internal npm registry. .Prerequisites @@ -17,7 +17,7 @@ include::partial$snip_warning-about-applying-a-configmap-that-sets-environment-v .Procedure -. Apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -37,7 +37,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. Apply the ConfigMap to set the following environment variables in the `tools` container: +. Create a ConfigMap to set the following environment variables in the `tools` container: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- diff --git a/modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc b/modules/integrate/pages/enabling-nuget-artifact-repositories.adoc similarity index 78% rename from modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc rename to modules/integrate/pages/enabling-nuget-artifact-repositories.adoc index bec40213b7..b078974087 100644 --- a/modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-nuget-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable a NuGet artifact repository in NuGet workspaces that run in a restricted environment. +:description: Enable a NuGet artifact repository so that .NET workspaces can restore packages from your internal NuGet feed. :keywords: nuget, artifact-repository, artifact-repositories -:navtitle: NuGet +:navtitle: Enable NuGet artifact repositories :page-aliases: using-nuget-artifact-repositories.adoc [id="enabling-nuget-artifact-repositories"] -= Enabling NuGet artifact repositories += Enable NuGet artifact repositories -You can enable a NuGet artifact repository in NuGet workspaces that run in a restricted environment. +Enable a NuGet artifact repository so that .NET workspaces can restore packages from your internal NuGet feed. .Prerequisites @@ -17,7 +17,7 @@ include::partial$snip_warning-about-applying-a-configmap-that-sets-environment-v .Procedure -. Apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -37,7 +37,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. Apply the ConfigMap to set the environment variable for the path of the TLS certificate file in the `tools` container: +. Create a ConfigMap to set the environment variable for the path of the TLS certificate file in the `tools` container: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -54,7 +54,7 @@ data: SSL_CERT_FILE: /home/user/certs/tls.cer ---- -. Apply the ConfigMap to create the `nuget.config` file: +. Create a ConfigMap for the `nuget.config` file: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- diff --git a/modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc b/modules/integrate/pages/enabling-python-artifact-repositories.adoc similarity index 74% rename from modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc rename to modules/integrate/pages/enabling-python-artifact-repositories.adoc index ff400c03f4..9140409018 100644 --- a/modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-python-artifact-repositories.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: You can enable a Python artifact repository in Python workspaces that run in a restricted environment. +:description: Enable Python artifact repositories by configuring pip to use an internal PyPI mirror :keywords: python, artifact-repository, artifact-repositories -:navtitle: Python +:navtitle: Enable Python artifact repositories :page-aliases: using-python-artifact-repositories.adoc [id="enabling-python-artifact-repositories"] -= Enabling Python artifact repositories += Enable Python artifact repositories -You can enable a Python artifact repository in Python workspaces that run in a restricted environment. +Configure pip to use an internal PyPI mirror by mounting environment variables into your workspaces. .Prerequisites @@ -17,7 +17,7 @@ include::partial$snip_warning-about-applying-a-configmap-that-sets-environment-v .Procedure -. Apply the Secret for the TLS certificate: +. Create a Secret to store the TLS certificate: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- @@ -37,7 +37,7 @@ data: ---- <1> Base64 encoding with disabled line wrapping. -. Apply the ConfigMap to set the following environment variables in the `tools` container: +. Create a ConfigMap to set the following environment variables in the `tools` container: + [source,yaml,subs="+quotes,+attributes,+macros"] ---- diff --git a/modules/end-user-guide/pages/integrating-with-kubernetes.adoc b/modules/integrate/pages/integrating-with-kubernetes.adoc similarity index 51% rename from modules/end-user-guide/pages/integrating-with-kubernetes.adoc rename to modules/integrate/pages/integrating-with-kubernetes.adoc index 69ad1f1c31..c282a311cb 100644 --- a/modules/end-user-guide/pages/integrating-with-kubernetes.adoc +++ b/modules/integrate/pages/integrating-with-kubernetes.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:description: Integrating with {orch-name} +:description: Manage workspaces with {orch-name} tools including CLI commands and console integration :keywords: overview, integrating with {orch-name} -:navtitle: Integrating with {orch-name} -:page-aliases: +:navtitle: Manage workspaces with {orch-name} tools +:page-aliases: end-user-guide:integrating-with-kubernetes.adoc [id="integrating-with-kubernetes"] -= Integrating with {orch-name} += Manage workspaces with {orch-name} tools * xref:automatic-token-injection.adoc[] * xref:navigating-che-from-openshift-developer-perspective.adoc[] diff --git a/modules/end-user-guide/pages/managing-workspaces-with-apis.adoc b/modules/integrate/pages/managing-workspaces-with-apis.adoc similarity index 78% rename from modules/end-user-guide/pages/managing-workspaces-with-apis.adoc rename to modules/integrate/pages/managing-workspaces-with-apis.adoc index 8e610dd4b5..2c0f37588e 100644 --- a/modules/end-user-guide/pages/managing-workspaces-with-apis.adoc +++ b/modules/integrate/pages/managing-workspaces-with-apis.adoc @@ -1,11 +1,13 @@ :_content-type: ASSEMBLY -:navtitle: Managing workspaces with {orch-name} APIs -:description: Managing workspaces with {orch-name} APIs +:navtitle: Manage workspaces from the command line +:description: Manage workspaces from the command line :keywords: api, list workspaces, create workspace, restart workspace, stop workspace, start workspace, remove workspace -// :page-aliases: +:page-aliases: end-user-guide:managing-workspaces-with-apis.adoc [id="managing-workspaces-with-apis"] -= Managing workspaces with {orch-name} APIs += Manage workspaces from the command line + +Manage {prod-short} workspaces with `{orch-cli}` and `kubectl` to list, create, stop, start, and remove workspaces without using the dashboard. On your organization's {orch-name} cluster, {prod-short} workspaces are represented as `DevWorkspace` custom resources of the same name. As a result, if there is a workspace named `my-workspace` in the {prod-short} dashboard, there is a corresponding `DevWorkspace` custom resource named `my-workspace` in the user's {orch-namespace} on the cluster. diff --git a/modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc b/modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc similarity index 86% rename from modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc rename to modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc index 728e4af20a..9014519dc3 100644 --- a/modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc +++ b/modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc @@ -1,12 +1,12 @@ :_content-type: ASSEMBLY -:description: Navigating {prod-short} from OpenShift Developer Perspective +:description: {prod-short} in the OpenShift Developer Perspective :keywords: overview, accessing-che-from-openshift-developer-perspective -:navtitle: Navigating {prod-short} from OpenShift Developer Perspective +:navtitle: {prod-short} in the OpenShift Developer Perspective :page-aliases: .:accessing-che-from-openshift-developer-perspective.adoc, overview:accessing-che-from-openshift-developer-perspective.adoc, accessing-che-from-openshift-developer-perspective.adoc [id="navigating-{prod-id-short}-from-openshift-developer-perspective"] -= Navigating {prod-short} from OpenShift Developer Perspective += {prod-short} in the OpenShift Developer Perspective The OpenShift Container Platform web console provides two perspectives; the *Administrator* perspective and the *Developer* perspective. @@ -25,7 +25,7 @@ The Developer perspective provides workflows specific to developer use cases, su [IMPORTANT] ==== -Starting with {ocp} 4.19, the perspectives in the web console have unified to simplify navigation, reduce context switching, streamline tasks, and provide users with a more cohesive {ocp} experience. +Starting with {ocp} 4.19, the perspectives in the web console have unified to simplify navigation, reduce context switching, consolidate tasks, and provide users with a more cohesive {ocp} experience. With this unified design, there is no longer a *Developer* perspective in the default view; however, _all_ {ocp} web console features are discoverable to all users. If you are not the cluster owner, you might need to request permission for certain features from the cluster owner. The *Developer* perspective can still be manually enabled if you prefer. diff --git a/modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc b/modules/integrate/pages/navigating-openshift-web-console-from-che.adoc similarity index 63% rename from modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc rename to modules/integrate/pages/navigating-openshift-web-console-from-che.adoc index 9f439d4a8a..59d916f812 100644 --- a/modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc +++ b/modules/integrate/pages/navigating-openshift-web-console-from-che.adoc @@ -1,18 +1,18 @@ :_content-type: PROCEDURE -:description: Navigating OpenShift web console from {prod-short} +:description: Navigate to the {orch-name} web console from {prod-short} :keywords: overview, OpenShift, web console -:navtitle: Navigating OpenShift web console from {prod-short} +:navtitle: Navigate to the {orch-name} web console from {prod-short} :page-aliases: .:accessing-openshift-web-console-from-che.adoc, overview:accessing-openshift-web-console-from-che.adoc, accessing-openshift-web-console-from-che.adoc [id="navigating-openshift-web-console-from-{prod-id-short}"] -= Navigating OpenShift web console from {prod-short} += Navigate to the {orch-name} web console from {prod-short} -This section describes how to access OpenShift web console from {prod-short}. +Navigate to the {orch-name} web console from the {prod-short} dashboard to manage cluster resources, inspect pods, and troubleshoot workspace issues without leaving your workflow. .Prerequisites -* The {prod-short} Operator is available in OpenShift 4. +* You have the {prod-short} Operator available in OpenShift 4. .Procedure diff --git a/modules/end-user-guide/partials/con_openshift-developer-perspective-integration-with-che.adoc b/modules/integrate/partials/con_openshift-developer-perspective-integration-with-che.adoc similarity index 89% rename from modules/end-user-guide/partials/con_openshift-developer-perspective-integration-with-che.adoc rename to modules/integrate/partials/con_openshift-developer-perspective-integration-with-che.adoc index 0ca4f1f2cd..4c5a03f559 100644 --- a/modules/end-user-guide/partials/con_openshift-developer-perspective-integration-with-che.adoc +++ b/modules/integrate/partials/con_openshift-developer-perspective-integration-with-che.adoc @@ -5,7 +5,7 @@ [id="openshift-developer-perspective-integration-with-che"] = OpenShift Developer Perspective integration with {prod-short} -This section provides information about OpenShift Developer Perspective support for {prod-short}. +{prod-short} integrates with the OpenShift Developer Perspective so that you can access workspaces directly from the OpenShift web console. When the {prod-short} Operator is deployed into OpenShift Container Platform 4.2 and later, it creates a `ConsoleLink` Custom Resource (CR). This adds an interactive link to the *Red Hat Applications* menu for accessing the {prod-short} installation using the OpenShift Developer Perspective console. diff --git a/modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc b/modules/integrate/partials/proc_accessing-che-from-red-hat-applications-menu.adoc similarity index 83% rename from modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc rename to modules/integrate/partials/proc_accessing-che-from-red-hat-applications-menu.adoc index e171a7ca57..e9c392e369 100644 --- a/modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc +++ b/modules/integrate/partials/proc_accessing-che-from-red-hat-applications-menu.adoc @@ -3,9 +3,9 @@ // accessing-{prod-id-short}-from-openshift-developer-perspective [id="accessing-{prod-id-short}-from-red-hat-applications-menu"] -= Accessing {prod-short} from Red Hat Applications menu += Access {prod-short} from the Red Hat Applications menu -This section describes how to access {prod-short} workspaces from the *Red Hat Applications* menu on the OpenShift Container Platform. +Access {prod-short} workspaces from the *Red Hat Applications* menu on the OpenShift Container Platform. .Prerequisites diff --git a/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc b/modules/integrate/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc similarity index 69% rename from modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc index b7a6d01f72..2acae50c7a 100644 --- a/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc +++ b/modules/integrate/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying an application link Secret for the Bitbucket Server +:description: Connect {prod-short} to your Bitbucket Server OAuth 1.0 application :keywords: bitbucket, bitbucket-server, application-link, bitbucket-secret -:navtitle: Applying an application link Secret for the Bitbucket Server +:navtitle: Connect {prod-short} to your Bitbucket Server OAuth 1.0 application // :page-aliases: [id="applying-an-application-link-secret-for-the-bitbucket-server"] -= Applying an application link Secret for the Bitbucket Server += Connect {prod-short} to your Bitbucket Server OAuth 1.0 application -Prepare and apply the application link Secret for the Bitbucket Server. +Connect {prod-short} to your Bitbucket Server OAuth 1.0 application so that developers can access Bitbucket Server repositories from workspaces without re-entering credentials. .Prerequisites -* The application link is set up on the Bitbucket Server. +* You have configured the application link on the Bitbucket Server. -* The following files, which were created when setting up the application link, are prepared: +* You have the following files, which were created when configuring the application link: ** `privatepkcs8-stripped.pem` ** `bitbucket-consumer-key` ** `bitbucket-shared-secret` @@ -58,4 +58,6 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +.Verification + +* Verify that the output displays `secret/bitbucket-oauth-config created`. diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc b/modules/integrate/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc similarity index 65% rename from modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc index d451547114..af83fb020a 100644 --- a/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc +++ b/modules/integrate/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying an OAuth 2.0 application link Secret for the Bitbucket Server +:description: Connect {prod-short} to your Bitbucket Server OAuth 2.0 application :keywords: bitbucket, bitbucket-server, application-link, bitbucket-secret -:navtitle: Applying an OAuth 2.0 application link Secret for the Bitbucket Server +:navtitle: Connect {prod-short} to your Bitbucket Server OAuth 2.0 application // :page-aliases: [id="applying-an-oauth-2-application-link-secret-for-the-bitbucket-server"] -= Applying an OAuth 2.0 application link Secret for the Bitbucket Server += Connect {prod-short} to your Bitbucket Server OAuth 2.0 application -Prepare and apply the OAuth 2.0 application link Secret for the Bitbucket Server. +Connect {prod-short} to your Bitbucket Server OAuth 2.0 application so that developers can access Bitbucket Server repositories from workspaces without re-entering credentials. .Prerequisites -* The application link is set up on the Bitbucket Server. +* You have configured the OAuth 2.0 application link on the Bitbucket Server. -* The following values, which were generated when setting up the Bitbucket application link, are prepared: +* You have the following values, which were generated when configuring the Bitbucket application link: ** Bitbucket *Client ID* ** Bitbucket *Client secret* @@ -55,4 +55,6 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +.Verification + +* Verify that the output displays `secret/bitbucket-oauth-config created`. diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc b/modules/integrate/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc similarity index 66% rename from modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc rename to modules/integrate/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc index e2356c99d5..ece96ff691 100644 --- a/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc +++ b/modules/integrate/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying an OAuth consumer Secret for the Bitbucket Cloud +:description: Connect {prod-short} to your Bitbucket Cloud OAuth consumer :keywords: bitbucket, bitbucket-cloud, oauth-consumer, bitbucket-consumer, oauth-consumer-secret, bitbucket-client-secret -:navtitle: Applying an OAuth consumer Secret for the Bitbucket Cloud +:navtitle: Connect {prod-short} to your Bitbucket Cloud OAuth consumer // :page-aliases: [id="applying-an-oauth-consumer-secret-for-the-bitbucket-cloud"] -= Applying an OAuth consumer Secret for the Bitbucket Cloud += Connect {prod-short} to your Bitbucket Cloud OAuth consumer -Prepare and apply an OAuth consumer Secret for the Bitbucket Cloud. +Connect {prod-short} to your Bitbucket Cloud OAuth consumer so that developers can access Bitbucket Cloud repositories from workspaces without re-entering credentials. .Prerequisites -* The OAuth consumer is set up in the Bitbucket Cloud. +* You have configured the OAuth consumer in the Bitbucket Cloud. -* The following values, which were generated when setting up the Bitbucket OAuth consumer, are prepared: +* You have the following values, which were generated when configuring the Bitbucket OAuth consumer: ** Bitbucket OAuth consumer Key ** Bitbucket OAuth consumer Secret @@ -53,4 +53,6 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +.Verification + +* Verify that the output displays `secret/bitbucket-oauth-config created`. diff --git a/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc b/modules/integrate/partials/proc_applying-the-github-oauth-app-secret.adoc similarity index 72% rename from modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc rename to modules/integrate/partials/proc_applying-the-github-oauth-app-secret.adoc index 37c58d2044..271e184849 100644 --- a/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc +++ b/modules/integrate/partials/proc_applying-the-github-oauth-app-secret.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying the GitHub OAuth App Secret +:description: Connect {prod-short} to your GitHub OAuth application :keywords: github-oauth-app, apply, secret, github -:navtitle: Applying the GitHub OAuth App Secret +:navtitle: Connect {prod-short} to your GitHub OAuth application // :page-aliases: [id="applying-the-github-oauth-app-secret"] -= Applying the GitHub OAuth App Secret += Connect {prod-short} to your GitHub OAuth application -Prepare and apply the GitHub OAuth App Secret. +Connect {prod-short} to your GitHub OAuth application so that developers can access GitHub repositories from workspaces without re-entering credentials. .Prerequisites -* Setting up the GitHub OAuth App is completed. +* You have configured the GitHub OAuth App. -* The following values, which were generated when setting up the GitHub OAuth App, are prepared: +* You have the following values, which were generated when configuring the GitHub OAuth App: ** *GitHub OAuth Client ID* ** *GitHub OAuth Client Secret* @@ -57,4 +57,8 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +. Optional: To configure OAuth 2.0 for another GitHub provider, repeat the previous steps and create a second GitHub OAuth Secret with a different name. + +.Verification + +* Verify that the output displays `secret/github-oauth-config created`. diff --git a/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc b/modules/integrate/partials/proc_applying-the-gitlab-authorized-application-secret.adoc similarity index 63% rename from modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc rename to modules/integrate/partials/proc_applying-the-gitlab-authorized-application-secret.adoc index 3e40ee9f82..38464f38db 100644 --- a/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc +++ b/modules/integrate/partials/proc_applying-the-gitlab-authorized-application-secret.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying the GitLab-authorized application Secret +:description: Connect {prod-short} to your GitLab OAuth application :keywords: gitlab, apply, secret, gitlab-application, gitlab-client-secret -:navtitle: Applying the GitLab-authorized application Secret +:navtitle: Connect {prod-short} to your GitLab OAuth application // :page-aliases: [id="applying-the-gitlab-authorized-application-secret"] -= Applying the GitLab-authorized application Secret += Connect {prod-short} to your GitLab OAuth application -Prepare and apply the GitLab-authorized application Secret. +Connect {prod-short} to your GitLab OAuth application so that developers can access GitLab repositories from workspaces without re-entering credentials. .Prerequisites -* Setting up the GitLab authorized application is completed. +* You have configured the GitLab authorized application. -* The following values, which were generated when setting up the GitLab authorized application, are prepared: +* You have the following values, which were generated when configuring the GitLab authorized application: ** *GitLab Application ID* ** *GitLab Client Secret* @@ -55,6 +55,8 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +. Optional: To configure OAuth 2.0 for another GitLab provider, repeat the previous steps and create a second GitLab OAuth Secret with a different name. -To configure OAuth 2.0 for another Gitlab provider, you have to repeat the steps above and create a second Gitlab OAuth Secret with a different name. \ No newline at end of file +.Verification + +* Verify that the output displays `secret/gitlab-oauth-config created`. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc b/modules/integrate/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc similarity index 61% rename from modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc rename to modules/integrate/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc index 52e33117a1..b7c33ecb75 100644 --- a/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc +++ b/modules/integrate/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc @@ -1,19 +1,19 @@ :_content-type: PROCEDURE -:description: Applying the Microsoft Entra ID OAuth App Secret +:description: Connect {prod-short} to your Microsoft Entra ID application :keywords: microsoft-azure-devops-entra-id-oauth-app, apply, secret -:navtitle: Applying the Microsoft Entra ID OAuth App Secret +:navtitle: Connect {prod-short} to your Microsoft Entra ID application // :page-aliases: [id="applying-the-microsoft-entra-id-oauth-app-secret"] -= Applying the Microsoft Entra ID OAuth App Secret += Connect {prod-short} to your Microsoft Entra ID application -Prepare and apply the Secret that enables {prod-short} to authenticate with Microsoft Entra ID for Azure DevOps repository access. +Connect {prod-short} to your Microsoft Entra ID application so that developers can access Azure DevOps repositories from workspaces without re-entering credentials. .Prerequisites -* You have set up the Microsoft Entra ID OAuth App. +* You have configured the Microsoft Entra ID OAuth App. -* The following values, which were generated when setting up the Microsoft Entra ID OAuth App, are prepared: +* You have the following values, which were generated when configuring the Microsoft Entra ID OAuth App: ** *Application (client) ID* ** *Directory (tenant) ID* ** *Client Secret* @@ -56,6 +56,13 @@ ____ EOF ---- -. Verify in the output that the Secret is created. +.Verification -. Wait for the rollout of the {prod-short} server components to be completed. \ No newline at end of file +* Verify that the output displays `secret/azure-devops-oauth-config created`. + +* Verify that the rollout of the {prod-short} server components is complete: ++ +[subs="+quotes,+attributes"] +---- +$ {orch-cli} rollout status deployment/che -n {prod-namespace} +---- \ No newline at end of file diff --git a/modules/end-user-guide/partials/proc_creating-workspaces.adoc b/modules/integrate/partials/proc_creating-workspaces.adoc similarity index 77% rename from modules/end-user-guide/partials/proc_creating-workspaces.adoc rename to modules/integrate/partials/proc_creating-workspaces.adoc index abd1d59e8d..09442ba31c 100644 --- a/modules/end-user-guide/partials/proc_creating-workspaces.adoc +++ b/modules/integrate/partials/proc_creating-workspaces.adoc @@ -1,8 +1,8 @@ [id="creating-workspaces"] -= Creating workspaces += Create workspaces -If your use case does not permit use of the {prod-short} dashboard, you can create workspaces with {orch-name} APIs by applying custom resources to the cluster. +If your use case does not permit use of the {prod-short} dashboard, create workspaces with {orch-name} APIs by applying custom resources to the cluster. [NOTE] ==== @@ -25,24 +25,20 @@ Creating workspaces through the {prod-short} dashboard provides better user expe .Prerequisites -* An active `{orch-cli}` session with permissions to create `DevWorkspace` resources in your {orch-namespace} on the cluster. See {orch-cli-link}. +* You have 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. -+ -TIP: You can visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`. +* You know your {prod-short} user namespace on the cluster. 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 your {prod-short} user namespace on the cluster. See {orch-cli-link}. + -[TIP] +[NOTE] ==== -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]. +{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:administration-guide:configuring-namespace-provisioning.adoc[]. .Procedure -. To prepare the `DevWorkspace` custom resource, copy the contents of the target Git repository's devfile. +. Copy the contents of the target Git repository's devfile to prepare the `DevWorkspace` custom resource. + .Copied devfile contents with `schemaVersion: 2.2.0` ==== @@ -55,7 +51,10 @@ components: ---- ==== + -TIP: For more details, see the link:https://devfile.io/docs/2.2.0/what-is-a-devfile[devfile v2 documentation]. +[TIP] +==== +For more details, see the link:https://devfile.io/docs/2.2.0/what-is-a-devfile[devfile v2 documentation]. +==== . Create a `DevWorkspace` custom resource, pasting the devfile contents from the previous step under the `spec.template` field. + diff --git a/modules/end-user-guide/partials/proc_disabling-self-signed-certificate-validation.adoc b/modules/integrate/partials/proc_disabling-self-signed-certificate-validation.adoc similarity index 86% rename from modules/end-user-guide/partials/proc_disabling-self-signed-certificate-validation.adoc rename to modules/integrate/partials/proc_disabling-self-signed-certificate-validation.adoc index 9a2d008dbb..b7815af394 100644 --- a/modules/end-user-guide/partials/proc_disabling-self-signed-certificate-validation.adoc +++ b/modules/integrate/partials/proc_disabling-self-signed-certificate-validation.adoc @@ -1,5 +1,5 @@ [id="disabling-self-signed-certificate-validation"] -= Disabling self-signed certificate validation += Disable self-signed certificate validation Run the command below to disable SSL/TLS, bypassing the validation of your self-signed certificates. Note that this is a potential security risk. For a better solution, configure a self-signed certificate you trust with `NODE_EXTRA_CA_CERTS`. @@ -7,7 +7,7 @@ Run the command below to disable SSL/TLS, bypassing the validation of your self- * Run the following command in the terminal: + -[source, yaml] +[source,terminal] ---- npm config set strict-ssl false ---- diff --git a/modules/end-user-guide/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc b/modules/integrate/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc similarity index 81% rename from modules/end-user-guide/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc rename to modules/integrate/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc index 62a1590f39..26df05f126 100644 --- a/modules/end-user-guide/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc +++ b/modules/integrate/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc @@ -3,9 +3,9 @@ // accessing-{prod-id-short}-from-openshift-developer-perspective [id="editing-the-code-of-applications-running-in-openshift-container-platform-using-che"] -= Editing the code of applications running in OpenShift Container Platform using {prod-short} += Edit application code from the OpenShift Developer Perspective -This section describes how to start editing the source code of applications running on OpenShift using {prod-short}. +Edit the source code of applications running on OpenShift using {prod-short}. .Prerequisites diff --git a/modules/integrate/partials/proc_forcing-refresh-of-personal-access-token.adoc b/modules/integrate/partials/proc_forcing-refresh-of-personal-access-token.adoc new file mode 100644 index 0000000000..98e33b4a17 --- /dev/null +++ b/modules/integrate/partials/proc_forcing-refresh-of-personal-access-token.adoc @@ -0,0 +1,38 @@ +[id="forcing-refresh-of-personal-access-token"] += Refresh an expired access token automatically + +:_content-type: PROCEDURE +:description: Refresh expired access tokens automatically on workspace startup so that developers do not encounter authentication failures caused by stale personal access tokens. + +Refresh expired access tokens automatically on workspace startup so that developers do not encounter authentication failures caused by stale personal access tokens. + +[IMPORTANT] +==== +This is an experimental feature. +==== + +.Prerequisites + +* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. + +.Procedure + +. Modify the `CheCluster` Custom Resource to enable forced token refresh: ++ +[source,yaml] +---- +spec: + components: + cheServer: + extraProperties: + CHE_FORCE_REFRESH_PERSONAL_ACCESS_TOKEN: "true" +---- + +.Verification + +* Start a new workspace and verify that the personal access token is refreshed by checking the {prod-short} server logs. + +.Additional resources + +* xref:configuring-oauth-2-for-github.adoc[] +* xref:configuring-oauth-2-for-gitlab.adoc[] diff --git a/modules/integrate/partials/proc_listing-workspaces.adoc b/modules/integrate/partials/proc_listing-workspaces.adoc new file mode 100644 index 0000000000..a7a3ada90f --- /dev/null +++ b/modules/integrate/partials/proc_listing-workspaces.adoc @@ -0,0 +1,46 @@ + +[id="listing-workspaces"] += List all workspaces + +List your workspaces from the command line to check their status, identify stopped or failed workspaces, and monitor resource usage across your {prod-short} environment. + +.Prerequisites + +* You have an active `{orch-cli}` session with permissions to `get` the `DevWorkspace` resources in your {orch-namespace} on the cluster. See {orch-cli-link}. + +* You know the relevant {prod-short} user namespace on the cluster. 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. See {orch-cli-link}. + +.Procedure + +. List your workspaces: ++ +[source,subs="+attributes"] +---- +$ {orch-cli} get devworkspaces +---- ++ +.Output +==== +---- +NAMESPACE NAME DEVWORKSPACE ID PHASE INFO +user1-dev spring-petclinic workspace6d99e9ffb9784491 Running https://url-to-workspace.com +user1-dev golang-example workspacedf64e4a492cd4701 Stopped Stopped +user1-dev python-hello-world workspace69c26884bbc141f2 Failed Container tooling has state CrashLoopBackOff +---- +==== + +. Optional: Add the `--watch` flag to show *PHASE* changes live: ++ +[source,subs="+attributes"] +---- +$ {orch-cli} get devworkspaces --watch +---- + +. Optional: Add the `--all-namespaces` flag to list workspaces from all {prod-short} users. This requires administrative permissions on the cluster. ++ +[source,subs="+attributes"] +---- +$ {orch-cli} get devworkspaces --all-namespaces +---- \ No newline at end of file diff --git a/modules/integrate/partials/proc_removing-workspaces.adoc b/modules/integrate/partials/proc_removing-workspaces.adoc new file mode 100644 index 0000000000..2e1c458251 --- /dev/null +++ b/modules/integrate/partials/proc_removing-workspaces.adoc @@ -0,0 +1,29 @@ + +[id="removing-workspaces"] += Remove workspaces + +Remove a workspace from the command line by deleting its `DevWorkspace` custom resource. The {prod-short} dashboard is the recommended method for routine operations. + +[WARNING] +==== +Deleting the `DevWorkspace` custom resource also deletes other workspace resources if they were created by {prod-short}: for example, the referenced `DevWorkspaceTemplate` and per-workspace `PersistentVolumeClaims`. +==== + +.Prerequisites + +* You have an active `{orch-cli}` session on the cluster. See {orch-cli-link}. + +* You know the workspace name. Run `{orch-cli} get devworkspaces` to list workspace names. + +* You know the relevant {prod-short} user namespace on the cluster. Visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`. See {orch-cli-link}. + +* You are in the {prod-short} user namespace on the cluster. + +.Procedure + +* Run the following command to remove a workspace: ++ +[subs="+quotes,attributes"] +---- +$ {orch-cli} delete devworkspace ____ -n ____ +---- diff --git a/modules/end-user-guide/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc b/modules/integrate/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc similarity index 69% rename from modules/end-user-guide/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc rename to modules/integrate/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc index b675cb5eae..7c4345eb61 100644 --- a/modules/end-user-guide/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc +++ b/modules/integrate/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc @@ -1,5 +1,5 @@ [id="restoring-node-extra-ca-certs-variable-value"] -= Configuring NODE_EXTRA_CA_CERTS to use a certificate += Configure NODE_EXTRA_CA_CERTS to use a certificate Use the command below to set NODE_EXTRA_CA_CERTS to point to where you have your SSL/TLS certificate. @@ -7,9 +7,9 @@ Use the command below to set NODE_EXTRA_CA_CERTS to point to where you have your * Run the following command in the terminal: + -[source, bash] +[source,terminal] ---- -`export NODE_EXTRA_CA_CERTS=/public-certs/nexus.cer` <1> -`npm install` +export NODE_EXTRA_CA_CERTS=/public-certs/nexus.cer <1> +npm install ---- <1> `/public-certs/nexus.cer` is the path to self-signed SSL/TLS certificate of Nexus artifactory. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc b/modules/integrate/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc similarity index 86% rename from modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc index 31a8566a1b..df696d1ad9 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc +++ b/modules/integrate/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up an application link on the Bitbucket Server +:description: Create an OAuth 1.0 application link on the Bitbucket Server :keywords: bitbucket, bitbucket-server, application-link -:navtitle: Setting up an application link on the Bitbucket Server +:navtitle: Create an OAuth 1.0 application link on the Bitbucket Server // :page-aliases: [id="setting-up-an-application-link-on-the-bitbucket-server"] -= Setting up an application link on the Bitbucket Server += Create an OAuth 1.0 application link on the Bitbucket Server -Set up an application link for OAuth 1.0 on the Bitbucket Server. +Create an OAuth 1.0 application link on the Bitbucket Server so that {prod-short} can authenticate your developers and provide credential-free access to Bitbucket Server repositories. .Prerequisites diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc b/modules/integrate/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc similarity index 70% rename from modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc index 0090bc0eb5..13872a254f 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc +++ b/modules/integrate/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up an OAuth 2.0 application link on the Bitbucket Server +:description: Create an OAuth 2.0 application link on the Bitbucket Server :keywords: bitbucket, bitbucket-server, application-link, oauth2 -:navtitle: Setting up an OAuth 2.0 application link on the Bitbucket Server +:navtitle: Create an OAuth 2.0 application link on the Bitbucket Server // :page-aliases: [id="setting-up-an-oauth-2-application-link-on-the-bitbucket-server"] -= Setting up an OAuth 2.0 application link on the Bitbucket Server += Create an OAuth 2.0 application link on the Bitbucket Server -Set up an OAuth 2.0 application link on the Bitbucket Server. +Create an OAuth 2.0 application link on the Bitbucket Server so that {prod-short} can authenticate your developers and provide credential-free access to Bitbucket Server repositories. .Prerequisites diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc b/modules/integrate/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc similarity index 74% rename from modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc rename to modules/integrate/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc index ef2c9fd48f..6ea2a2fb77 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc +++ b/modules/integrate/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up an OAuth consumer in the Bitbucket Cloud +:description: Create an OAuth consumer in the Bitbucket Cloud :keywords: bitbucket, bitbucket-cloud, oauth-consumer, bitbucket-oauth-consumer, oauth-application -:navtitle: Setting up an OAuth consumer in the Bitbucket Cloud +:navtitle: Create an OAuth consumer in the Bitbucket Cloud // :page-aliases: [id="setting-up-an-oauth-consumer-in-the-bitbucket-cloud"] -= Setting up an OAuth consumer in the Bitbucket Cloud += Create an OAuth consumer in the Bitbucket Cloud -Set up an OAuth consumer for OAuth 2.0 in the Bitbucket Cloud. +Create an OAuth consumer in the Bitbucket Cloud so that {prod-short} can authenticate your developers and provide credential-free access to Bitbucket Cloud repositories. .Prerequisites diff --git a/modules/administration-guide/partials/proc_setting-up-the-github-app.adoc b/modules/integrate/partials/proc_setting-up-the-github-app.adoc similarity index 84% rename from modules/administration-guide/partials/proc_setting-up-the-github-app.adoc rename to modules/integrate/partials/proc_setting-up-the-github-app.adoc index 05d9ce18fc..26e074a55a 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-github-app.adoc +++ b/modules/integrate/partials/proc_setting-up-the-github-app.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up the GitHub App +:description: Create a GitHub App for {prod-short} :keywords: github, github-app -:navtitle: Setting up the GitHub App +:navtitle: Create a GitHub App for {prod-short} // :page-aliases: [id="setting-up-the-github-app"] -= Setting up the GitHub App += Create a GitHub App for {prod-short} -Set up a GitHub App to enable users to work with GitHub repositories. +Create a GitHub App to provide finer-grained permissions for repository access from {prod-short} workspaces. .Prerequisites diff --git a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc b/modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc similarity index 67% rename from modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc rename to modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc index 9c5bd0204b..c0067ad139 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc +++ b/modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up the GitHub OAuth App +:description: Create a GitHub OAuth application for {prod-short} :keywords: github, github-oauth-app -:navtitle: Setting up the GitHub OAuth App +:navtitle: Create a GitHub OAuth application for {prod-short} // :page-aliases: [id="setting-up-the-github-oauth-app"] -= Setting up the GitHub OAuth App += Create a GitHub OAuth application for {prod-short} -Set up a GitHub OAuth App using OAuth 2.0. +Create an OAuth 2.0 application on GitHub so that {prod-short} can authenticate your developers and provide credential-free access to GitHub repositories. .Prerequisites @@ -15,7 +15,7 @@ Set up a GitHub OAuth App using OAuth 2.0. .Procedure -. Go to link:https://github.com/settings/applications/new[]. +. Go to link:https://github.com/settings/applications/new[the GitHub OAuth application registration page]. //Long version: Click your GitHub avatar menu:Settings[Developer settings > OAuth Apps > Register a new application]. max-cx . Enter the following values: diff --git a/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc b/modules/integrate/partials/proc_setting-up-the-gitlab-authorized-application.adoc similarity index 74% rename from modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc rename to modules/integrate/partials/proc_setting-up-the-gitlab-authorized-application.adoc index ef52a4b2fd..a0dc117e33 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc +++ b/modules/integrate/partials/proc_setting-up-the-gitlab-authorized-application.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Setting up the GitLab authorized application +:description: Create a GitLab OAuth application for {prod-short} :keywords: gitlab, gitlab-application, gitlab-authorized-application, authorized-application -:navtitle: Setting up the GitLab authorized application +:navtitle: Create a GitLab OAuth application for {prod-short} // :page-aliases: [id="setting-up-the-gitlab-authorized-application"] -= Setting up the GitLab authorized application += Create a GitLab OAuth application for {prod-short} -Set up a GitLab authorized application using OAuth 2.0. +Create an authorized application on GitLab so that {prod-short} can authenticate your developers and provide credential-free access to GitLab repositories. .Prerequisites diff --git a/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc b/modules/integrate/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc similarity index 85% rename from modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc rename to modules/integrate/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc index 862eab9d24..8d4a8f64f9 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc +++ b/modules/integrate/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc @@ -1,15 +1,15 @@ :_content-type: PROCEDURE -:description: Setting up the Microsoft Entra ID OAuth App +:description: Create a Microsoft Entra ID application for {prod-short} :keywords: azure, devops, oauth -:navtitle: Setting up the Microsoft Entra ID OAuth App +:navtitle: Create a Microsoft Entra ID application for {prod-short} // :page-aliases: pass:[] [id="setting-up-the-microsoft-entra-id-oauth-app"] -= Setting up the Microsoft Entra ID OAuth App += Create a Microsoft Entra ID application for {prod-short} -Set up a Microsoft Entra ID OAuth App to enable {prod-short} users to interact with Azure DevOps Git repositories without re-entering credentials. +Create a Microsoft Entra ID application so that {prod-short} can authenticate your developers and provide credential-free access to Azure DevOps repositories. .Prerequisites diff --git a/modules/integrate/partials/proc_starting-stopped-workspaces.adoc b/modules/integrate/partials/proc_starting-stopped-workspaces.adoc new file mode 100644 index 0000000000..3dd77b8ab1 --- /dev/null +++ b/modules/integrate/partials/proc_starting-stopped-workspaces.adoc @@ -0,0 +1,28 @@ + +[id="starting-stopped-workspaces"] += Start stopped workspaces + +Start a stopped workspace by setting the `spec.started` field in the `DevWorkspace` custom resource to `true`. + +.Prerequisites + +* You have an active `{orch-cli}` session on the cluster. See {orch-cli-link}. + +* You have the workspace name. Run `{orch-cli} get devworkspaces` to list workspace names. + +* You have the relevant {prod-short} user namespace on the cluster. 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. See {orch-cli-link}. + +.Procedure + +. Run the following command to start a stopped workspace: ++ +[subs="+quotes,attributes"] +---- +$ {orch-cli} patch devworkspace ____ \ +-p '{"spec":{"started":true}}' \ +--type=merge -n ____ && \ +{orch-cli} wait --for=jsonpath='{.status.phase}'=Running \ +dw/____ -n ____ +---- diff --git a/modules/integrate/partials/proc_stopping-workspaces.adoc b/modules/integrate/partials/proc_stopping-workspaces.adoc new file mode 100644 index 0000000000..8df6a4a8d4 --- /dev/null +++ b/modules/integrate/partials/proc_stopping-workspaces.adoc @@ -0,0 +1,28 @@ + +[id="stopping-workspaces"] += Stop workspaces + +Stop a workspace by setting the `spec.started` field in the `DevWorkspace` custom resource to `false`. + +.Prerequisites + +* You have an active `{orch-cli}` session on the cluster. See {orch-cli-link}. + +* You have the workspace name. Run `{orch-cli} get devworkspaces` to list workspace names. + +* You have the relevant {prod-short} user namespace on the cluster. 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. See {orch-cli-link}. + +.Procedure + +. Run the following command to stop a workspace: ++ +[subs="+quotes,attributes"] +---- +$ {orch-cli} patch devworkspace ____ \ +-p '{"spec":{"started":false}}' \ +--type=merge -n ____ && \ +{orch-cli} wait --for=jsonpath='{.status.phase}'=Stopped \ +dw/____ -n ____ +---- diff --git a/modules/end-user-guide/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc b/modules/integrate/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc similarity index 100% rename from modules/end-user-guide/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc rename to modules/integrate/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc