Procedures/managed openvsx registry by svor · Pull Request #3170 · eclipse-che/che-docs

svor · 2026-07-23T15:35:30Z

What does this pull request change?

Provides documentation how to enable OpenVSX as a operand

What issues does this pull request fix or reference?

https://redhat.atlassian.net/browse/CRW-11147

Specify the version of the product this pull request applies to

7.121.0

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

Any procedure:
- Successfully tested.
Any page or link rename:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>

github-actions · 2026-07-23T15:35:39Z

🎊 Navigate the preview: https://6a63882c0f322e41f342e6a3--eclipse-che-docs-pr.netlify.app 🎊

github-actions · 2026-07-23T15:35:40Z

Click here to review and test in web IDE:

Add procedure for deleting extensions from the managed Open VSX registry using the admin API. Fix verification pod labels to use app.kubernetes.io/component instead of app=openvsx. Add NOTE about the registry starting empty. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

ibuziuk · 2026-07-27T13:07:38Z

-{prod-short} supports three registry configurations:
+{prod-short} supports four registry configurations:

 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.


should we have an ordered list here 1 - 4 ?

ibuziuk · 2026-07-27T13:09:30Z


 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.

 Public Open VSX registry:: The community-hosted registry at `open-vsx.org`, accessed over the internet. Provides the full catalog of openly published extensions.


Also, we might want to highlight option 5: https://managed.open-vsx.org/pricing/
manged openvsx

ibuziuk · 2026-07-27T13:11:00Z

+:page-aliases:
+
+[id="enabling-the-managed-open-vsx-registry"]
+= Enabling the managed Open VSX registry


let's clarify that this is tech-preview

gtrivedi88

JTBD mapping

This content maps to Extend > Customize workspace tooling (extend_tooling), specifically Job 34: Control which editors developers can use. It belongs under assembly_deploying-private-registry (Deploy a private extension registry) alongside the existing self-hosted Open VSX procedures.

Merge sequencing recommendation

Option A (preferred): Merge PR #3143 (Extend JTBD restructuring) first, then rebase this PR to place the new file directly in the Extend module (modules/extend/). This avoids the file being added to administration-guide/ and then immediately moved.

Option B (acceptable): Merge this PR first if the feature needs docs before #3143 is ready. The person rebasing #3143 will need to:

Move enabling-the-managed-open-vsx-registry.adoc from administration-guide/pages/ to extend/pages/
Add the xref: to extend/nav.adoc (and remove it from administration-guide/nav.adoc)
Resolve 2-3 small merge conflicts in managing-ide-extensions.adoc and extensions-for-microsoft-visual-studio-code-open-source.adoc

This is roughly 15 minutes of rebase work, so not a blocker.

gtrivedi88 · 2026-07-27T14:10:29Z

+:page-aliases:
+
+[id="enabling-the-managed-open-vsx-registry"]
+= Enabling the managed Open VSX registry


Title: gerund to imperative

Per CQA 2.1 and JTBD title rules, procedure titles must use imperative verbs, not gerunds.

Suggested change

= Enabling the managed Open VSX registry

= Enable the managed Open VSX registry

This also fixes the navtitle/title mismatch. The :navtitle: already says "Enable..." (correct), but the = Title says "Enabling..." (gerund). These must match.

gtrivedi88 · 2026-07-27T14:10:29Z

+:description: Enable the Operator-managed Open VSX registry to deploy a dedicated Open VSX server and PostgreSQL database as {prod} operands
+:keywords: administration guide, openvsx, registry, extensions, managed, operator
+:navtitle: Enable the managed Open VSX registry
+:page-aliases:


Empty :page-aliases: attribute with no value. Since this is a new page with no previous URL to redirect, remove this line entirely.

Suggested change

:page-aliases:

gtrivedi88 · 2026-07-27T14:10:29Z

+= Enabling the managed Open VSX registry
+
+[role="_abstract"]
+Enable {prod-short} to deploy and manage a dedicated Open VSX server with a PostgreSQL database as Operator-managed components. The managed registry is exposed through the {prod-short} gateway and provides a private, curated extension registry without requiring manual deployment or database administration.


Missing Technology Preview admonition

Per @ibuziuk comment and Red Hat SSG rules, add a Technology Preview disclaimer immediately after the abstract:

[IMPORTANT] ==== The managed Open VSX registry is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/. ====

Always spell out "Technology Preview" in full. Never abbreviate to "Tech Preview" or "Technical Preview."

gtrivedi88

Re-posting misplaced inline comments at the correct lines. Apologies for the earlier confusion.

gtrivedi88 · 2026-07-27T15:05:32Z

+* Open a workspace and verify that extensions from the managed registry are available in the *Extensions* view.
+
+[id="configuring-custom-credentials-for-the-managed-open-vsx-registry"]
+== Configuring custom credentials for the managed Open VSX registry


Gerund title. Use imperative.

Suggested change

== Configuring custom credentials for the managed Open VSX registry

== Configure custom credentials for the managed Open VSX registry

gtrivedi88 · 2026-07-27T15:05:32Z

+
+By default, the Operator generates an `openvsx-credentials` secret with random passwords and access tokens. To use custom database credentials and Open VSX user accounts, create a secret and reference it in the `CheCluster` custom resource.
+
+.Procedure


Missing .Prerequisites

This procedure jumps straight to .Procedure without .Prerequisites. Add:

.Prerequisites * An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. * The managed Open VSX registry is enabled and running.

gtrivedi88 · 2026-07-27T15:05:32Z

+    }
+  }'
+----
+


Missing .Verification

The "Configure custom credentials" procedure ends without a .Verification section. Add a verification step so the reader can confirm the credentials were applied, for example:

.Verification * Verify that the Open VSX server pod restarts and reaches `Running` status: + [source,shell,subs="+quotes,+attributes,+macros"] ---- {orch-cli} get pods --namespace {prod-namespace} -l app.kubernetes.io/component=openvsx-server ----

gtrivedi88 · 2026-07-27T15:05:32Z

+  }'
+----
+
+IMPORTANT: The secret must exist before it is referenced in the `CheCluster` custom resource. The Operator validates the secret on create and update and rejects the change if the secret is missing or incomplete.


Inline admonition must be block-delimited

Inline IMPORTANT: is not DITA-compatible. Use a block-delimited admonition:

Suggested change

IMPORTANT: The secret must exist before it is referenced in the `CheCluster` custom resource. The Operator validates the secret on create and update and rejects the change if the secret is missing or incomplete.

[IMPORTANT]

====

The secret must exist before it is referenced in the `CheCluster` custom resource. The Operator validates the secret on create and update and rejects the change if the secret is missing or incomplete.

====

gtrivedi88 · 2026-07-27T15:05:32Z

+IMPORTANT: The secret must exist before it is referenced in the `CheCluster` custom resource. The Operator validates the secret on create and update and rejects the change if the secret is missing or incomplete.
+
+[id="customizing-the-open-vsx-server-configuration"]
+== Customizing the Open VSX server configuration


Gerund title. Use imperative.

Suggested change

== Customizing the Open VSX server configuration

== Customize the Open VSX server configuration

gtrivedi88 · 2026-07-27T15:05:32Z

+
+The Operator creates an `openvsx-server` `ConfigMap` with a default `application.yml` configuration when the managed registry is first enabled. This `ConfigMap` is user-editable: the Operator creates it once and does not overwrite subsequent changes. Modifying the `ConfigMap` automatically triggers a rolling restart of the Open VSX server pod.
+
+.Procedure


Missing .Prerequisites

This procedure jumps straight to .Procedure without .Prerequisites. Add:

.Prerequisites * An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. * The managed Open VSX registry is enabled and running.

gtrivedi88 · 2026-07-27T15:05:32Z

+The `ConfigMap` contains a single `application.yml` key with the Open VSX Spring Boot configuration.
+
+[id="deleting-extensions-from-the-managed-open-vsx-registry"]
+== Deleting extensions from the managed Open VSX registry


Gerund title. Use imperative.

Suggested change

== Deleting extensions from the managed Open VSX registry

== Delete extensions from the managed Open VSX registry

gtrivedi88 · 2026-07-27T15:05:32Z

+where `__<extension_version>__` is the version to delete. For example: `1.2.3`.
+
+[id="disabling-the-managed-open-vsx-registry"]
+== Disabling the managed Open VSX registry


Gerund title. Use imperative.

Suggested change

== Disabling the managed Open VSX registry

== Disable the managed Open VSX registry

svor and others added 4 commits July 10, 2026 16:40

procedures: add documentation for operator-managed OpenVSX registry

eb3f2e5

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

procedures: add custom credentials and OpenVSX UI access documentation

5d9acf4

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

procedures: add OpenVSX server configuration customization section

0ccb3d7

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

update changes

96be9a4

Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>

svor requested review from a team, deerskindoll, gtrivedi88 and mkuznyetsov as code owners July 23, 2026 15:35

svor requested a review from ibuziuk July 23, 2026 15:35

ibuziuk reviewed Jul 27, 2026

View reviewed changes

gtrivedi88 reviewed Jul 27, 2026

View reviewed changes

gtrivedi88 mentioned this pull request Jul 27, 2026

docs: rename Bitbucket OAuth consumer to OAuth client #3171

Open

5 tasks

gtrivedi88 reviewed Jul 27, 2026

View reviewed changes


		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.

		Public Open VSX registry:: The community-hosted registry at `open-vsx.org`, accessed over the internet. Provides the full catalog of openly published extensions.

	= Enabling the managed Open VSX registry
	= Enable the managed Open VSX registry

	== Configuring custom credentials for the managed Open VSX registry
	== Configure custom credentials for the managed Open VSX registry


		By default, the Operator generates an `openvsx-credentials` secret with random passwords and access tokens. To use custom database credentials and Open VSX user accounts, create a secret and reference it in the `CheCluster` custom resource.

		.Procedure

	== Customizing the Open VSX server configuration
	== Customize the Open VSX server configuration


		The Operator creates an `openvsx-server` `ConfigMap` with a default `application.yml` configuration when the managed registry is first enabled. This `ConfigMap` is user-editable: the Operator creates it once and does not overwrite subsequent changes. Modifying the `ConfigMap` automatically triggers a rolling restart of the Open VSX server pod.

		.Procedure

	== Deleting extensions from the managed Open VSX registry
	== Delete extensions from the managed Open VSX registry

	== Disabling the managed Open VSX registry
	== Disable the managed Open VSX registry

Uh oh!

Conversation

svor commented Jul 23, 2026

What does this pull request change?

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

Pull Request checklist

Uh oh!

github-actions Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtrivedi88 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

JTBD mapping

Merge sequencing recommendation

Uh oh!

Choose a reason for hiding this comment

Title: gerund to imperative

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Missing Technology Preview admonition

Uh oh!

Uh oh!

gtrivedi88 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Missing .Prerequisites

Uh oh!

Choose a reason for hiding this comment

Missing .Verification

Uh oh!

Choose a reason for hiding this comment

Inline admonition must be block-delimited

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Missing .Prerequisites

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 23, 2026 •

edited

Loading

github-actions Bot commented Jul 23, 2026 •

edited

Loading

gtrivedi88 left a comment •

edited

Loading

Missing `.Prerequisites`

Missing `.Verification`

Missing `.Prerequisites`