Skip to content

Commit f9ee350

Browse files
gtrivedi88claude
andauthored
docs: restructure Open VSX on-premises documentation (#3078)
* docs: add procedure to deploy Open VSX with a pre-built image Replaces the workspace-based deployment section of the monolithic running-the-open-vsx-on-premises.adoc page. Shows actual commands instead of opaque devfile task references. Fixes CRW-10789 by removing the notified column from the personal_access_token INSERT. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add procedure to deploy Open VSX from source Replaces the CLI-based deployment section and build steps from the monolithic running-the-open-vsx-on-premises.adoc page. Fixes CRW-10789 SQL bug, updates stale eclipse/openvsx URLs, fixes AsciiDoc source block syntax. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add procedure to configure internal Open VSX access Extracts the 'Setting Up Internal Access' section from the monolithic running-the-open-vsx-on-premises.adoc into a standalone, JTBD-aligned procedure for security hardening. * docs: rewrite Open VSX registry URL configuration procedure Adds proper abstract, prerequisites, definition lists, verification, rate limiting note, air-gap warning, and Additional resources. Adapted from downstream CQA 2.1-compliant content. * docs: promote delete-via-API procedure to standalone page Moves from partials/ to pages/ for independent discoverability. Fixes CRW-10789 SQL bug (removes notified column), replaces hardcoded oc with {orch-cli}, converts to definition lists. * docs: promote delete-from-DB procedure to standalone page Moves from partials/ to pages/ for independent discoverability. Replaces hardcoded oc with {orch-cli}, adds Antora metadata, adds Additional resources with xref to admin API method. * docs: rewrite IDE extensions concept page with JTBD framing Replaces thin wrapper (one sentence + xref list) with proper concept explaining WHY extension management matters and the three registry options. All links in Additional resources per DITA ConceptLink rule. * docs: update nav.adoc for restructured Open VSX section Replaces 3 monolithic entries with 7 focused pages following JTBD user journey: understand → configure → deploy → secure → maintain. * docs: remove replaced monolithic pages, snippets, and partials Removes files superseded by the new modular structure: - running-the-open-vsx-on-premises.adoc (replaced by 3 focused procedures) - deleting-extension-from-the-open-vsx-on-premises.adoc (thin wrapper) - snip_che-deploy-open-vsx.adoc (content inlined) - snip_che-deploy-open-vsx-using-oc.adoc (content inlined) - partials/proc_deleting-* (promoted to standalone pages) Updates xrefs in out-of-scope partials that referenced the deleted page. * docs: fix broken xrefs to partial files in registry URL procedure Replace xrefs to non-page partials (adding-or-removing-extensions-*) with xref to their parent page (extensions-for-microsoft-visual-studio- code-open-source.adoc) for valid Antora resolution. * docs: add Next steps, fix SQL, add workspace deploy procedure Address SME review feedback: - Restore notified column in SQL INSERT statements (mandatory for OpenVSX v0.33.0+) in all 3 procedure files - Add image compatibility note to pre-built deploy procedure - Add new procedure: deploy Open VSX from a Che workspace using devfile tasks (preserves devfile-based workflow for existing users) - Update nav.adoc and concept page with workspace procedure xref - Add Next steps to deploy procedures - Fix broken xrefs to partial files in registry URL procedure - Fix Vale errors (namespace wording) * docs: remove pre-built image procedure (upstream-only deploy is from source) The openvsx-deployment-no-es.yml template requires custom-built images, which only exist downstream. Remove the misleading pre-built image procedure from upstream and redirect all xrefs to the from-source procedure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6f8511c commit f9ee350

15 files changed

Lines changed: 584 additions & 475 deletions

modules/administration-guide/examples/snip_che-deploy-open-vsx-using-oc.adoc

Lines changed: 0 additions & 153 deletions
This file was deleted.

modules/administration-guide/examples/snip_che-deploy-open-vsx.adoc

Lines changed: 0 additions & 30 deletions
This file was deleted.

modules/administration-guide/nav.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,12 @@
113113
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
114114
* xref:managing-ide-extensions.adoc[]
115115
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
116-
** xref:running-the-open-vsx-on-premises.adoc[]
117-
** xref:deleting-extension-from-the-open-vsx-on-premises.adoc[]
118116
** xref:configuring-the-open-vsx-registry-url.adoc[]
117+
** xref:proc_deploy-open-vsx-from-source.adoc[]
118+
** xref:proc_deploy-open-vsx-from-workspace.adoc[]
119+
** xref:proc_configure-internal-open-vsx-access.adoc[]
120+
** xref:proc_deleting-extension-using-openvsx-admin-api.adoc[]
121+
** xref:proc_deleting-extension-from-postgresql-database.adoc[]
119122
* xref:configuring-visual-studio-code.adoc[]
120123
** xref:configuring-single-and-multiroot-workspaces.adoc[]
121124
** xref:trusted-extensions-for-microsoft-visual-studio-code.adoc[]
Lines changed: 52 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,72 @@
11
:_content-type: PROCEDURE
2-
:description: Configuring the Open VSX registry URL for all {prod} workspaces
3-
:keywords: administration guide, configuring, openvsx, registry
4-
:navtitle: Open VSX registry URL
2+
:description: Configure the Open VSX registry URL for {prod} workspaces
3+
:keywords: administration guide, configuring, openvsx, registry, extensions
4+
:navtitle: Configure the Open VSX registry URL
55
:page-aliases:
66

77
[id="configuring-the-open-vsx-registry-url"]
8-
= Configuring the Open VSX registry URL
8+
= Configure the Open VSX registry URL
99

10-
To search and install extensions, the Microsoft Visual Studio Code - Open Source editor uses an embedded Open VSX registry instance.
11-
You can also configure {prod-short} to use another Open VSX registry instance rather than the embedded one.
10+
[role="_abstract"]
11+
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.
12+
13+
The default is the embedded instance of the Open VSX registry.
14+
15+
If the default Open VSX registry instance does not meet your requirements, you can select one of the following instances:
16+
17+
* The Open VSX registry instance at `pass:c,a,q[https://open-vsx.org]` that requires access to the internet.
18+
19+
* A standalone Open VSX registry instance that is deployed on a network accessible from {prod-short} workspace pods.
20+
21+
.Prerequisites
22+
23+
* You have administrator access to the cluster where {prod-short} is deployed.
24+
* You have an active `{orch-cli}` session with administrative permissions. See {orch-cli-link}.
1225

1326
.Procedure
14-
* Set the URL of your Open VSX registry instance in the CheCluster Custom Resource `spec.components.pluginRegistry.openVSXURL` field.
27+
28+
. Edit the `CheCluster` custom resource to update the `openVSXURL` value:
1529
+
16-
[source,yaml,subs="+attributes,+quotes"]
30+
[source,yaml,subs="+quotes"]
1731
----
1832
spec:
19-
components:
20-
# [...]
21-
pluginRegistry:
22-
openVSXURL: __<your_open_vsx_registy>__
23-
# [...]
33+
components:
34+
pluginRegistry:
35+
openVSXURL: "__<url_of_an_open_vsx_registry_instance>__"
2436
----
2537
+
38+
where:
39+
+
40+
`__<url_of_an_open_vsx_registry_instance>__`:: The URL of the Open VSX registry instance. For example: `openVSXURL: "pass:c,a,q[https://open-vsx.org]"`.
41+
+
42+
--
43+
* To select the embedded Open VSX registry instance in the `plugin-registry` pod, use `openVSXURL: ''`. You can customize the list of included extensions. See xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[].
44+
45+
* You can also point `openVSXURL` at the URL of a standalone Open VSX registry instance. The URL must be accessible from within your organization's cluster and not blocked by a proxy.
46+
--
47+
+
48+
[NOTE]
49+
====
50+
To ensure the stability and performance of the community-supported Open VSX Registry, API usage is organized into defined tiers. The Eclipse Foundation implements these limits to protect infrastructure from high-frequency automated traffic and to provide consistent service quality for all users. For more information, see link:https://github.com/EclipseFdn/open-vsx.org/wiki/rate-limiting[Rate Limits and Usage Tiers] and the link:https://github.com/EclipseFdn/open-vsx.org/wiki[open-vsx.org wiki].
51+
====
52+
+
53+
[IMPORTANT]
54+
====
55+
Using link:https://open-vsx.org[https://open-vsx.org] is not recommended in an air-gapped environment, isolated from the internet. To reduce the risk of malware infections and unauthorized access to your code, use the embedded or self-hosted Open VSX registry with a curated set of extensions.
56+
====
57+
+
2658
[WARNING]
2759
====
2860
Due to the dedicated Microsoft link:https://cdn.vsassets.io/v/M190_20210811.1/_content/Microsoft-Visual-Studio-Marketplace-Terms-of-Use.pdf[Terms of Use], link:https://marketplace.visualstudio.com/vscode[Visual Studio Code Marketplace] is not supported by {prod}.
2961
====
3062

63+
.Verification
64+
65+
* Confirm that the `plugin-registry` pod has restarted and is running.
66+
* Open a workspace and verify that extensions are available from the selected registry instance in the *Extensions* view.
67+
68+
[role="_additional-resources"]
3169
.Additional resources
70+
3271
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
3372
* link:https://open-vsx.org/[Open VSX registry]

modules/administration-guide/pages/deleting-extension-from-the-open-vsx-on-premises.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
11
:_content-type: CONCEPT
2-
:description: Managing IDE extensions
3-
:keywords: extensions, plugins, plug-ins, registry
2+
:description: Options for managing IDE extensions in {prod} workspaces
3+
:keywords: extensions, plugins, openvsx, registry, ide
44
:navtitle: Managing IDE extensions
5-
//:page-aliases:
5+
:page-aliases:
66

77
[id="managing-ide-extensions"]
88
= Managing IDE extensions
99

10-
IDEs use extensions or plugins to extend their functionality, and the mechanism for managing extensions differs between IDEs.
10+
[role="_abstract"]
11+
Manage IDE extensions in {prod-short} workspaces to control which extensions are available, trusted, and pre-installed for users across different IDE types. Extension management is essential for air-gapped environments, security-conscious organizations, and teams that need consistent developer tooling.
12+
13+
IDEs in {prod-short} use extensions to provide language support, debugging, linting, and other development tools. The Microsoft Visual Studio Code - Open Source editor manages extensions through the Open VSX registry.
14+
15+
{prod-short} supports three registry configurations:
16+
17+
Embedded Open VSX registry:: Runs in the `plugin-registry` pod and supports air-gapped, offline, and proxy-restricted environments. Contains a default subset of extensions that you can customize.
18+
19+
Public Open VSX registry:: The community-hosted registry at `open-vsx.org`, accessed over the internet. Provides the full catalog of openly published extensions.
20+
21+
Standalone Open VSX registry:: A self-hosted instance deployed on a network accessible from {prod-short} workspace pods. Provides full control over available extensions for organizations that need a curated, private registry.
22+
23+
[role="_additional-resources"]
24+
.Additional resources
1125

1226
* xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
13-
* xref:running-the-open-vsx-on-premises.adoc[]
14-
* xref:deleting-extension-from-the-open-vsx-on-premises.adoc[]
1527
* xref:configuring-the-open-vsx-registry-url.adoc[]
16-
28+
* xref:proc_deploy-open-vsx-from-source.adoc[]
29+
* xref:proc_deploy-open-vsx-from-workspace.adoc[]
30+
* xref:proc_configure-internal-open-vsx-access.adoc[]
31+
* xref:proc_deleting-extension-using-openvsx-admin-api.adoc[]
32+
* xref:proc_deleting-extension-from-postgresql-database.adoc[]
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
:_content-type: PROCEDURE
2+
:description: Restrict the Open VSX registry to internal cluster access
3+
:keywords: administration guide, openvsx, security, internal, routing
4+
:navtitle: Configure internal Open VSX access
5+
:page-aliases:
6+
7+
[id="proc_configure-internal-open-vsx-access"]
8+
= Configure internal access to the Open VSX registry
9+
10+
[role="_abstract"]
11+
Restrict your Open VSX registry to internal cluster traffic by removing the public route and configuring {prod-short} to use the internal service URL. Internal routing keeps extension registry traffic within the cluster and avoids public exposure.
12+
13+
.Prerequisites
14+
15+
* You have Open VSX deployed in the `openvsx` namespace.
16+
* You have the `{orch-cli}` tool installed.
17+
* You are logged in to the cluster as a cluster administrator.
18+
* You have `jq` installed.
19+
20+
.Procedure
21+
22+
. Delete the public route for the Open VSX registry:
23+
+
24+
[source,bash,subs="+attributes,+quotes",options="nowrap"]
25+
----
26+
{orch-cli} delete route internal -n openvsx
27+
----
28+
29+
. Update the CheCluster custom resource to use the internal service DNS URL:
30+
+
31+
[source,bash,subs="+attributes,+quotes",options="nowrap"]
32+
----
33+
export CHECLUSTER_NAME="$({orch-cli} get checluster --all-namespaces -o json | jq -r '.items[0].metadata.name')" &&
34+
export CHECLUSTER_NAMESPACE="$({orch-cli} get checluster --all-namespaces -o json | jq -r '.items[0].metadata.namespace')" &&
35+
export PATCH='{"spec":{"components":{"pluginRegistry":{"openVSXURL":"http://openvsx-server.openvsx.svc:8080"}}}}' &&
36+
{orch-cli} patch checluster "${CHECLUSTER_NAME}" --type=merge --patch "${PATCH}" -n "${CHECLUSTER_NAMESPACE}"
37+
----
38+
39+
. Restart any running workspaces to apply the new registry URL.
40+
41+
.Verification
42+
43+
* Start a workspace and verify that extensions are available in the Extensions view using the internal registry.
44+
45+
[role="_additional-resources"]
46+
.Additional resources
47+
48+
* xref:proc_deploy-open-vsx-from-source.adoc[]
49+
* xref:configuring-the-open-vsx-registry-url.adoc[]

0 commit comments

Comments
 (0)