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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ yarn.lock

# Do not commit diagrams generated for downstream
crw*
CLAUDE.md
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ nav:
- modules/secure/nav.adoc
- modules/optimize/nav.adoc
- modules/observe/nav.adoc
- modules/integrate/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
7 changes: 0 additions & 7 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,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[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/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 {orch-name} API level - xref:integrate:managing-workspaces-with-apis.adoc[]

.Additional resources

Expand Down
2 changes: 1 addition & 1 deletion modules/discover/pages/roles-and-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Common tasks include:

* Deploy {prod-short} on a cluster. See xref:install:con_installation-overview.adoc[].
* Configure the `CheCluster` custom resource. See xref:administration-guide:understanding-the-checluster-custom-resource.adoc[].
* 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[].
* Control workspace start times with image caching. See xref:optimize:caching-images-for-faster-workspace-start.adoc[].
* Upgrade to the latest version. See xref:upgrade:upgrading-che.adoc[].
* Monitor metrics and logs. See xref:observe:configuring-observability.adoc[].
Expand Down
21 changes: 9 additions & 12 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,13 @@
** 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[]
*** xref:viewing-workspace-logs-in-the-openshift-console.adoc[]
*** xref:viewing-language-servers-and-debug-adapters-logs-in-visual-studio-code.adoc[]
** xref:debugging-a-workspace.adoc[]
** xref:troubleshooting-slow-workspaces.adoc[]
** xref:troubleshooting-network-problems.adoc[]
** xref:troubleshooting-webview-loading-error.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ include::partial$snip_persona-admin.adoc[]
.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-user:starting-a-workspace-from-a-git-repository-url.adoc[]
* xref:get-started-admin:verify-the-platform-end-to-end.adoc[]
20 changes: 20 additions & 0 deletions modules/integrate/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.Integrate
* xref:configuring-oauth-for-git-providers.adoc[]
** xref:configuring-oauth-2-for-github.adoc[]
** xref:configuring-oauth-2-for-gitlab.adoc[]
** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[]
** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[]
* xref:managing-workspaces-with-apis.adoc[]
* xref:integrating-with-kubernetes.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[]
** 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[]
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: Automatic {orch-name} token injection
:keywords: user-guide, token, injection
:navtitle: Automatic {orch-name} token injection
:navtitle: Use 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
= Use 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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 1.0 for a Bitbucket Server
:keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-1, oauth-1.0
:navtitle: Configuring OAuth 1.0 for a Bitbucket Server
:navtitle: Connect Bitbucket Server with OAuth 1.0
// :page-aliases:

[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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 2.0 for a Bitbucket Server
:keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for a Bitbucket Server
:navtitle: Connect Bitbucket Server with OAuth 2.0
// :page-aliases:

[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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 2.0 for GitHub
:keywords: configuring-oauth, authorization, github, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for GitHub
:navtitle: Connect GitHub with OAuth
:page-aliases:

[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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 2.0 for GitLab
:keywords: configuring-oauth, authorization, gitlab, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for GitLab
:navtitle: Connect GitLab with OAuth
:page-aliases:

[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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 2.0 for Microsoft Azure DevOps Services
: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
:navtitle: Connect Azure DevOps with Microsoft Entra ID
:page-aliases:

[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

++++
<!-- vale RedHat.Spelling = NO -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Configuring OAuth 2.0 for the Bitbucket Cloud
:keywords: configuring-oauth, authorization, bitbucket, bitbucket-cloud, cloud, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for the Bitbucket Cloud
:navtitle: Connect Bitbucket Cloud with OAuth
// :page-aliases:

[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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: CONCEPT
:description: Configuring OAuth for Git providers
:keywords: azure, bitbucket, gitlab, github, git
:navtitle: Configuring OAuth for Git providers
:navtitle: Give developers credential-free Git access
// :page-aliases:

[id="configuring-oauth-for-git-providers"]
= Configuring OAuth for Git providers
= Give developers credential-free Git access

[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Enabling artifact repositories in a restricted environment
:keywords: artifact-repositories, artifact-repository, maven, gradle, nuget, python, go, npm
:navtitle: Enabling artifact repositories in a restricted environment
:navtitle: Connect workspaces to your organization's package registries
: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
= Connect workspaces to your organization's package registries

By configuring technology stacks, you can work with artifacts from in-house repositories using self-signed certificates:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable a Go artifact repository in Go workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable a Gradle artifact repository in Gradle workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable a Maven artifact repository in Maven workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable an npm artifact repository in npm workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable a NuGet artifact repository in NuGet workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: PROCEDURE
:description: You can enable a Python artifact repository in Python workspaces that run in a restricted environment.
: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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:description: Integrating with {orch-name}
:keywords: overview, integrating with {orch-name}
:navtitle: Integrating with {orch-name}
:navtitle: Use {orch-name} tools with workspaces
:page-aliases:

[id="integrating-with-kubernetes"]
= Integrating with {orch-name}
= Use {orch-name} tools with workspaces

* xref:automatic-token-injection.adoc[]
* xref:navigating-che-from-openshift-developer-perspective.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
:navtitle: Managing workspaces with {orch-name} APIs
:navtitle: Manage workspaces from the command line
:description: Managing workspaces with {orch-name} APIs
:keywords: api, list workspaces, create workspace, restart workspace, stop workspace, start workspace, remove workspace
// :page-aliases:

[id="managing-workspaces-with-apis"]
= Managing workspaces with {orch-name} APIs
= Manage workspaces from the command line

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_content-type: ASSEMBLY
:description: Navigating {prod-short} from 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_content-type: PROCEDURE
:description: Navigating OpenShift 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}.

Expand Down
Loading