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/extend/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
22 changes: 0 additions & 22 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,6 @@
*** xref:con_persistent-user-home.adoc[]
** xref:configuring-dashboard.adoc[]
*** xref:configuring-getting-started-samples.adoc[]
*** xref:configuring-editors-definitions.adoc[]
*** xref:show-deprecated-editors.adoc[]
*** xref:configuring-default-editor.adoc[]
*** xref:concealing-editors.adoc[]
*** xref:configuring-editors-download-urls.adoc[]
*** xref:configuring-ai-providers.adoc[]
**** xref:ai-provider-api-key-secret-reference.adoc[]
*** xref:customizing-openshift-che-branding-images.adoc[]
** xref:configuring-oauth-for-git-providers.adoc[]
*** xref:configuring-oauth-2-for-github.adoc[]
Expand All @@ -56,19 +49,4 @@
** xref:devworkspace-backup.adoc[]
*** xref:devworkspace-backup-integrated-openshift-registry.adoc[]
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
* xref:managing-ide-extensions.adoc[]
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
** xref:configuring-the-open-vsx-registry-url.adoc[]
** xref:enabling-the-managed-open-vsx-registry.adoc[]
** xref:proc_deploy-open-vsx-from-source.adoc[]
** xref:proc_deploy-open-vsx-from-workspace.adoc[]
** xref:proc_configure-internal-open-vsx-access.adoc[]
** xref:proc_deleting-extension-using-openvsx-admin-api.adoc[]
** xref:proc_deleting-extension-from-postgresql-database.adoc[]
* xref:configuring-visual-studio-code.adoc[]
** xref:configuring-single-and-multiroot-workspaces.adoc[]
** xref:trusted-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:default-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:manage-extension-installation.adoc[]
** xref:editor-configurations-for-microsoft-visual-studio-code.adoc[]
* xref:managing-workloads-using-the-che-server-api.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -191,5 +191,5 @@ Optional. A JSON array of provider `id` values that are pre-selected in the AI S

.Additional resources

* xref:configuring-ai-providers.adoc[]
* xref:ai-provider-api-key-secret-reference.adoc[]
* xref:extend:configuring-ai-providers.adoc[]
* xref:extend:ai-provider-api-key-secret-reference.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@

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

* xref:configuring-editors-definitions.adoc[]
* xref:extend:configuring-editors-definitions.adoc[]

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

* xref:show-deprecated-editors.adoc[]
* xref:extend:show-deprecated-editors.adoc[]

* xref:configuring-default-editor.adoc[]
* xref:extend:configuring-default-editor.adoc[]

* xref:concealing-editors.adoc[]
* xref:extend:concealing-editors.adoc[]

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

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

The {prod-short} build of link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] is the default IDE of a new workspace.

You can automate installation of Microsoft Visual Studio Code extensions from the xref:administration-guide:extensions-for-microsoft-visual-studio-code-open-source.adoc[Open VSX registry] at workspace startup. See _Automating installation of Microsoft Visual Studio Code extensions at workspace startup_.
You can automate installation of Microsoft Visual Studio Code extensions from the xref:extend:extensions-for-microsoft-visual-studio-code-open-source.adoc[Open VSX registry] at workspace startup. See _Automating installation of Microsoft Visual Studio Code extensions at workspace startup_.

[TIP]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
To have the Microsoft Visual Studio Code - Open Source IDE automatically install chosen extensions, you can add an `extensions.json` file to the remote Git repository that contains your project source code and that will be cloned into workspaces.

.Prerequisites
* The public OpenVSX registry at link:https://open-vsx.org[open-vsx.org] is selected and accessible over the internet. See xref:administration-guide:extensions-for-microsoft-visual-studio-code-open-source.adoc[Selecting an Open VSX registry instance].
* The public OpenVSX registry at link:https://open-vsx.org[open-vsx.org] is selected and accessible over the internet. See xref:extend:extensions-for-microsoft-visual-studio-code-open-source.adoc[Selecting an Open VSX registry instance].
+
[TIP]
====
To install recommended extensions in a restricted environment, consider the following options instead:

* xref:administration-guide:configuring-the-open-vsx-registry-url.adoc[] to point to your OpenVSX registry.
* xref:extend:configuring-the-open-vsx-registry-url.adoc[] to point to your OpenVSX registry.

* xref:defining-a-common-ide.adoc[].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]

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

* {editor-definition-samples-link}
25 changes: 25 additions & 0 deletions modules/extend/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.Extend
* Choose which editors are available
** xref:configuring-editors-definitions.adoc[]
** xref:configuring-default-editor.adoc[]
** xref:concealing-editors.adoc[]
** xref:show-deprecated-editors.adoc[]
** xref:configuring-editors-download-urls.adoc[]
* xref:configuring-visual-studio-code.adoc[]
** xref:configuring-single-and-multiroot-workspaces.adoc[]
** xref:trusted-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:default-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:manage-extension-installation.adoc[]
** xref:editor-configurations-for-microsoft-visual-studio-code.adoc[]
* xref:managing-ide-extensions.adoc[]
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
** xref:configuring-the-open-vsx-registry-url.adoc[]
* Deploy a private extension registry
** xref:proc_deploy-open-vsx-from-source.adoc[]
** xref:proc_deploy-open-vsx-from-workspace.adoc[]
** xref:proc_configure-internal-open-vsx-access.adoc[]
** xref:enabling-the-managed-open-vsx-registry.adoc[]
** xref:proc_deleting-extension-using-openvsx-admin-api.adoc[]
** xref:proc_deleting-extension-from-postgresql-database.adoc[]
* xref:configuring-ai-providers.adoc[]
** xref:ai-provider-api-key-secret-reference.adoc[]
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:page-aliases: administration-guide:ai-provider-api-key-secret-reference.adoc
:_content-type: REFERENCE
:description: Kubernetes Secret schema, labels, and naming convention for AI provider API keys that are automatically mounted into workspace containers.
:keywords: administration, ai, api key, secret, kubernetes, devworkspace controller, environment variable, mount
Expand All @@ -10,7 +11,8 @@
[role="_abstract"]
Each user's AI provider API key is stored as a {kubernetes} `Opaque` Secret in the user's personal {orch-namespace}. The {devworkspace} Controller automatically mounts matching Secrets as environment variables into all workspace containers. Use this reference when manually creating or troubleshooting AI provider key Secrets.

== Secret schema

== What the Secret contains

[source,yaml,subs="+quotes,+attributes"]
----
Expand All @@ -36,7 +38,7 @@ data:
<5> Mounts the Secret data keys as environment variables (not as files).
<6> The data key is the environment variable name. The value is base64-encoded. The variable is injected directly into all workspace containers.

== Label and annotation reference
== Required labels and annotations

[cols="1,1,2",options="header"]
|===
Expand All @@ -59,7 +61,7 @@ data:
| Used by the {prod-short} dashboard to identify and list AI provider key Secrets when rendering the AI Selector widget.
|===

== Secret naming convention
== How to name your Secret

Secret names follow the pattern:

Expand All @@ -77,7 +79,7 @@ Example:
| `ai-provider-openai-api-key`
|===

== Manual Secret creation
== Create the Secret manually

Advanced users can create AI provider key Secrets manually using `{orch-cli}` instead of the dashboard UI. Use the same labels and annotations as shown in the schema above:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:page-aliases: administration-guide:concealing-editors.adoc
:_content-type: PROCEDURE
:description: Concealing editors in the Dashboard UI
:keywords: administration guide, concealing, dashboard, editors
:navtitle: Concealing editors
:navtitle: Hide editors from the dashboard

[id="concealing-editors"]
= Concealing editors
= Hide editors from the dashboard


Learn how to conceal {prod-short} editors. This is useful when you want to hide selected editors from the Dashboard UI, for example hide the IntelliJ IDEA Ultimate and have only Visual Studio Code - Open Source visible.

Expand All @@ -18,7 +20,7 @@ Learn how to conceal {prod-short} editors. This is useful when you want to hide

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

. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
. Configure the `CheCluster` Custom Resource. See xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
+
[source,yaml]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
:page-aliases: administration-guide:configuring-ai-providers.adoc
:_content-type: PROCEDURE
:description: Register AI providers in Eclipse Che so that developers can select and use AI coding assistants when creating workspaces.
:keywords: administration, ai, ai provider, opencode, configmap, ai-tool-registry, api key, injector image, dockerfile, architecture, arch, version
:navtitle: Configuring AI providers
:navtitle: Register AI coding assistants
:page-aliases:

[id="configuring-ai-providers"]
= Configure AI providers
= Register AI coding assistants

:FeatureName: The AI provider feature
include::example$snip_che-technology-preview.adoc[]
include::administration-guide:example$snip_che-technology-preview.adoc[]

[NOTE]
====
Expand All @@ -18,6 +19,7 @@ OpenCode supports only `x86_64` and `arm64`. IBM Z (`s390x`) and IBM Power (`ppc
[role="_abstract"]
Register one or more AI providers in {prod-short} so that developers can select and use AI coding assistants when creating workspaces.


The AI tool registry is stored in a {kubernetes} `ConfigMap` with specific labels. When the ConfigMap exists and contains at least one provider with a matching tool, the AI Selector widget is displayed on the dashboard. When the ConfigMap is absent or empty, the widget is hidden.

{prod-short} reads the node architectures present in the cluster and filters the tool list before sending it to the dashboard. A tool is shown if at least one cluster node matches an architecture in the tool's `arch` list. Tools that omit the `arch` field are shown on all architectures.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:page-aliases: administration-guide:configuring-default-editor.adoc
:_content-type: PROCEDURE
:description: Configuring default editor
:keywords: administration guide, dashboard, editors
:navtitle: Configuring default editor
:navtitle: Set the default IDE for new workspaces

[id="configuring-default-editor"]
= Configuring default editor
= Set the default IDE for new workspaces


Learn how to configure {prod-short} default editor.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:page-aliases: administration-guide:configuring-editors-definitions.adoc
:_content-type: PROCEDURE
:description: Configuring editors definitions
:keywords: administration guide, configuring, dashboard, editors
:navtitle: Configuring editors definitions
:navtitle: Add custom editors to the dashboard
:page-aliases: installation-guide:configuring-editors-definitions.adoc

[id="configuring-editors-definitions"]
= Configuring editors definitions
= Add custom editors to the dashboard


Learn how to configure {prod-short} editor definitions.

Expand Down Expand Up @@ -179,7 +181,7 @@ commands:

. Refresh the {prod-short} Dashboard page to see new available editor.

== Retrieving the editor definition
== Retrieve the editor definition

The editor definition is also served by the {prod-short} dashboard API from the following URL:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:page-aliases: administration-guide:configuring-editors-download-urls.adoc
:_content-type: PROCEDURE
:description: Configuring editors download urls
:keywords: administration guide, dashboard, editors
:navtitle: Configuring editors download urls
:navtitle: Host editor binaries for air-gapped clusters

[id="configuring-editors-download-urls"]
= Configuring editors download URLs
= Host editor binaries for air-gapped clusters


This procedure describes how to configure download URLs for editors. This feature is valuable in air-gapped environments where editors cannot be retrieved from the public internet.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:page-aliases: administration-guide:configuring-single-and-multiroot-workspaces.adoc
:_content-type: PROCEDURE
:description: Configuring single and multiroot workspaces
:keywords: singleroot, multiroot, workspace
:navtitle: Configuring single and multiroot workspaces
:navtitle: Work with multiple projects in one workspace
// :page-aliases:

[id="configuring-single-and-multiroot-workspaces"]
= Configuring single and multi root workspaces
= Work with multiple projects in one workspace


With the multi-root workspace feature, you can work with multiple project folders in the same workspace. This is useful when you are working on several related projects at once, such as product documentation and product code repositories.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
:page-aliases: administration-guide:configuring-the-open-vsx-registry-url.adoc
:_content-type: PROCEDURE
:description: Configure the Open VSX registry URL for {prod} workspaces
:keywords: administration guide, configuring, openvsx, registry, extensions
:navtitle: Configure the Open VSX registry URL
:navtitle: Use an alternative extension registry
:page-aliases:

[id="configuring-the-open-vsx-registry-url"]
= Configure the Open VSX registry URL
= Use an alternative extension registry

[role="_abstract"]
Configure {prod-short} to use an alternative Open VSX registry instance instead of the default embedded registry. Switch to the public open-vsx.org registry for internet-connected environments, or to a standalone on-premises instance for full control over available extensions.


The default is the embedded instance of the Open VSX registry.

If the default Open VSX registry instance does not meet your requirements, you can select one of the following instances:
Expand Down Expand Up @@ -68,5 +70,5 @@ Due to the dedicated Microsoft link:https://cdn.vsassets.io/v/M190_20210811.1/_c
[role="_additional-resources"]
.Additional resources

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
* xref:administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
* link:https://open-vsx.org/[Open VSX registry]
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:page-aliases: administration-guide:configuring-visual-studio-code.adoc
:_content-type: CONCEPT
:description: Configuring Visual Studio Code - Open Source ("Code - OSS")
:keywords: vscode, workspace
:navtitle: Configuring Visual Studio Code - Open Source ("Code - OSS")
:navtitle: Customize the default IDE
//:page-aliases:

[id="configuring-visual-studio-code"]
= Configuring Visual Studio Code - Open Source ("Code - OSS")
= Customize the default IDE


Learn how to configure Visual Studio Code - Open Source ("Code - OSS").

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:page-aliases: administration-guide:default-extensions-for-microsoft-visual-studio-code.adoc
:_content-type: PROCEDURE
:description: Configure default extensions
:keywords: extensions, workspace
:navtitle: Configure default extensions
:navtitle: Pre-install extensions in every workspace
// :page-aliases:

[id="visual-studio-code-default-extensions"]
= Configuring default extensions
= Pre-install extensions in every workspace


Default extensions are a pre-installed set of extensions, specified by putting the extension binary `.vsix` file path to the __DEFAULT_EXTENSIONS__ environment variable.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:page-aliases: administration-guide:editor-configurations-for-microsoft-visual-studio-code.adoc
:_content-type: PROCEDURE
:description: Applying editor configurations
:keywords: settings, extensions, configurations
:navtitle: Applying editor configurations
:navtitle: Apply IDE settings to all workspaces
// :page-aliases:

[id="visual-studio-code-editor-configs"]
= Applying editor configurations
= Apply IDE settings to all workspaces


You can configure Visual Studio Code - Open Source editor by adding configurations to a ConfigMap.
These configurations are applied to any workspace you open.
Expand Down Expand Up @@ -89,7 +91,7 @@ data:
Make sure that the Configmap contains data in a valid JSON format.
====

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

.Verification
. Verify that settings defined in the ConfigMap are applied using one of the following methods:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
[id="enabling-the-managed-open-vsx-registry"]
= Enable the managed Open VSX registry

[role="_abstract"]
[IMPORTANT]
====
The managed Open VSX registry is a Technology Preview feature only.
Expand Down
Loading
Loading