Skip to content

Commit d02127e

Browse files
gtrivedi88gtrivedi88
committed
Flat hirerachy to increase visibility
1 parent 194d513 commit d02127e

8 files changed

Lines changed: 259 additions & 165 deletions

‎modules/administration-guide/examples/snip_che-non-default-vsx-registry-instance.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions published on link:https://open-vsx.org[open-vsx.org]. This subset is xref:adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance[customizable].
1+
* The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions published on link:https://open-vsx.org[open-vsx.org]. You can customize this subset by xref:adding-extensions-using-devspaces-workspace[using a Dev Spaces workspace] or xref:adding-extensions-using-linux[using a Linux system].

‎modules/administration-guide/examples/snip_che-steps-to-add-or-remove-extensions-in-openvsx-sync-json.adoc‎

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

‎modules/administration-guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc‎

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

‎modules/administration-guide/pages/extensions-for-microsoft-visual-studio-code-open-source.adoc‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@
77
[id="extensions-for-microsoft-visual-studio-code-open-source"]
88
= Extensions for Microsoft Visual Studio Code - Open Source
99

10+
pass:[<!-- vale RedHat.GitLinks = NO -->]
11+
1012
To manage extensions, link:https://github.com/microsoft/vscode[this IDE] uses one of these link:https://open-vsx.org/about[Open VSX] registry instances:
1113

12-
* The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions published on link:https://open-vsx.org[open-vsx.org]. This subset is xref:adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance[customizable].
14+
pass:[<!-- vale RedHat.GitLinks = YES -->]
15+
16+
* The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions that are published on link:https://open-vsx.org[open-vsx.org]. You can customize this subset by xref:adding-extensions-using-devspaces-workspace[using a Dev Spaces workspace] or by xref:adding-extensions-using-linux[using a Linux system].
1317

1418
* The public link:https://open-vsx.org[open-vsx.org] registry that is accessed over the internet.
1519

16-
* A standalone Open VSX registry instance that is deployed on a network accessible from {prod-short} workspace pods.
20+
* A standalone Open VSX registry instance that is deployed on a network that is accessible from {prod-short} workspace pods.
1721

1822
include::example$snip_{project-context}-default-vsx-registry.adoc[]
1923

2024
include::partial$proc_selecting-an-open-vsx-registry-instance.adoc[leveloffset=+1]
2125

22-
include::partial$proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc[leveloffset=+1]
26+
include::partial$proc_adding-extensions-using-devspaces-workspace.adoc[leveloffset=+1]
27+
28+
include::partial$proc_adding-extensions-using-linux.adoc[leveloffset=+1]

‎modules/administration-guide/partials/proc_adding-extensions-using-devspaces-workspace.adoc‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
:_content-type: PROCEDURE
2+
3+
[id="adding-extensions-using-devspaces-workspace"]
4+
= Adding extensions using a {prod-short} workspace
5+
6+
[role="_abstract"]
7+
You can add or remove extensions in the embedded Open VSX registry instance by building a custom plugin registry image directly within a {prod-short} workspace.
8+
9+
[IMPORTANT]
10+
====
11+
pass:[<!-- vale RedHat.TermsWarnings = NO -->]
12+
13+
For a more robust extension lifecycle and offline use, set up an internal, on-site Open VSX registry.
14+
15+
pass:[<!-- vale RedHat.TermsWarnings = YES -->]
16+
17+
The embedded plugin registry is planned for deprecation in a future release. For setup instructions, see xref:running-the-open-vsx-on-premises.adoc[].
18+
====
19+
20+
[NOTE]
21+
====
22+
For IBM Power (`ppc64le`) and IBM Z (`s390x`), you must build the registry locally on the corresponding architecture. See xref:adding-extensions-using-linux[].
23+
====
24+
25+
.Prerequisites
26+
27+
* You have administrator access to a {prod-short} instance.
28+
* You have identified the extensions to add or remove.
29+
* You have the extension IDs from the link:https://open-vsx.org/[Open VSX registry]. Format: `<publisher>.<name>`.
30+
* You have the extension version numbers.
31+
32+
pass:[<!-- vale RedHat.TermsErrors = NO -->]
33+
34+
* (Optional) You can rebuild the container-based image based on the latest tag or SHA to get the latest security fixes after a {prod-short} update.
35+
36+
pass:[<!-- vale RedHat.TermsErrors = YES -->]
37+
38+
.Procedure
39+
40+
. Find the extension on the link:https://open-vsx.org/[Open VSX registry website] and note the publisher, name, and version from the URL:
41+
+
42+
[subs="+quotes"]
43+
----
44+
https://open-vsx.org/extension/__<publisher>__/__<name>__
45+
----
46+
+
47+
[TIP]
48+
====
49+
50+
pass:[<!-- vale RedHat.GitLinks = NO -->]
51+
52+
If the extension is only available on link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace], ask the publisher to link:https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension[publish it on Open VSX], or link:https://github.com/open-vsx/publish-extensions/issues[report an issue] to the Open VSX team.
53+
54+
pass:[<!-- vale RedHat.GitLinks = YES -->]
55+
56+
====
57+
58+
. Log in to the {prod-short} instance as an administrator.
59+
60+
. Start a new workspace using the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository].
61+
62+
. Open a terminal and check out the Git tag that corresponds to your {prod-short} version:
63+
+
64+
[source,bash,subs="+quotes"]
65+
----
66+
$ git checkout __<product_version>__
67+
----
68+
69+
. Open the `che-plugin-registry/openvsx-sync.json` file.
70+
71+
. Add or remove extension entries using the following JSON syntax:
72+
+
73+
[source,json,subs="+quotes"]
74+
----
75+
{
76+
"id": "__<publisher>__.__<name>__",
77+
"version": "__<extension_version>__"
78+
}
79+
----
80+
+
81+
[TIP]
82+
====
83+
For closed-source or internal extensions, add the extension from a `.vsix` file:
84+
85+
[source,json,subs="+quotes"]
86+
----
87+
{
88+
"id": "__<publisher>__.__<name>__",
89+
"download": "__<url_to_vsix_file>__",
90+
"version": "__<extension_version>__"
91+
}
92+
----
93+
94+
Review the link:https://aka.ms/vsmarketplace-ToU[Terms of Use] for the link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace] before using its resources.
95+
====
96+
97+
. Run the build task: *Terminal* -> *Run Task...* -> *devfile* -> *1. Build and Publish a Custom Plugin Registry*.
98+
99+
. Run the configuration task: *Terminal* -> *Run Task...* -> *devfile* -> *2. Configure Che to use the Custom Plugin Registry*.
100+
101+
.Verification
102+
103+
. Verify that the `plugin-registry` pod has restarted and is in the `Running` state.
104+
105+
. Start a new workspace.
106+
107+
. Open the *Extensions* view and verify that your added extensions are available.

‎modules/administration-guide/partials/proc_adding-extensions-using-linux.adoc‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
:_content-type: PROCEDURE
2+
3+
[id="adding-extensions-using-linux"]
4+
= Adding extensions using a Linux system
5+
6+
[role="_abstract"]
7+
You can add or remove extensions in the embedded Open VSX registry instance by building a custom plugin registry image on a local Linux system.
8+
9+
[IMPORTANT]
10+
====
11+
pass:[<!-- vale RedHat.TermsWarnings = NO -->]
12+
13+
For a more robust extension lifecycle and offline use, set up an internal, on-site Open VSX registry.
14+
15+
pass:[<!-- vale RedHat.TermsWarnings = YES -->]
16+
17+
The embedded plugin registry is planned for deprecation in a future release. For setup instructions, see xref:running-the-open-vsx-on-premises.adoc[].
18+
====
19+
20+
.Prerequisites
21+
22+
* Podman is installed.
23+
* Node.js version 18.20.3 or higher is installed.
24+
* You have access to a container registry such as link:https://quay.io/[quay.io].
25+
* You have identified the extensions to add or remove.
26+
* You have the extension IDs from the link:https://open-vsx.org/[Open VSX registry]. Format: `<publisher>.<name>`.
27+
* You have the extension version numbers.
28+
29+
pass:[<!-- vale RedHat.TermsErrors = NO -->]
30+
31+
* (Optional) You can rebuild the container-based image based on the latest tag or SHA to get the latest security fixes after a {prod-short} update.
32+
33+
pass:[<!-- vale RedHat.TermsErrors = YES -->]
34+
35+
.Procedure
36+
37+
. Find the extension on the link:https://open-vsx.org/[Open VSX registry website] and note the publisher, name, and version from the URL:
38+
+
39+
[subs="+quotes"]
40+
----
41+
https://open-vsx.org/extension/__<publisher>__/__<name>__
42+
----
43+
+
44+
[TIP]
45+
====
46+
47+
pass:[<!-- vale RedHat.GitLinks = NO -->]
48+
49+
If the extension is only available on link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace], ask the publisher to link:https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension[publish it on Open VSX], or link:https://github.com/open-vsx/publish-extensions/issues[report an issue] to the Open VSX team.
50+
51+
pass:[<!-- vale RedHat.GitLinks = YES -->]
52+
53+
====
54+
55+
. Clone the plugin registry repository:
56+
+
57+
[source,bash]
58+
----
59+
$ git clone https://github.com/eclipse-che/che-plugin-registry.git
60+
$ cd che-plugin-registry
61+
----
62+
63+
. Open the `openvsx-sync.json` file.
64+
65+
. Add or remove extension entries using the following JSON syntax:
66+
+
67+
[source,json,subs="+quotes"]
68+
----
69+
{
70+
"id": "__<publisher>__.__<name>__",
71+
"version": "__<extension_version>__"
72+
}
73+
----
74+
+
75+
[TIP]
76+
====
77+
For closed-source or internal extensions, add the extension from a `.vsix` file:
78+
79+
[source,json,subs="+quotes"]
80+
----
81+
{
82+
"id": "__<publisher>__.__<name>__",
83+
"download": "__<url_to_vsix_file>__",
84+
"version": "__<extension_version>__"
85+
}
86+
----
87+
88+
Review the link:https://aka.ms/vsmarketplace-ToU[Terms of Use] for the link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace] before using its resources.
89+
====
90+
91+
. Build the plugin registry container image:
92+
+
93+
[source,bash,subs="+quotes"]
94+
----
95+
$ ./build.sh -o __<username>__ -r quay.io -t custom
96+
----
97+
98+
. Push the image to your container registry:
99+
+
100+
[source,bash,subs="+attributes,+quotes"]
101+
----
102+
$ {docker-cli} push quay.io/__<username>__/plugin-registry:custom
103+
----
104+
105+
. Edit the `CheCluster` custom resource to point to your custom image:
106+
+
107+
[source,yaml,subs="+quotes"]
108+
----
109+
spec:
110+
components:
111+
pluginRegistry:
112+
deployment:
113+
containers:
114+
- image: quay.io/__<username>__/plugin-registry:custom
115+
openVSXURL: ''
116+
----
117+
118+
. Save the changes. The Operator automatically restarts the `plugin-registry` pod.
119+
120+
.Verification
121+
122+
. Verify that the `plugin-registry` pod has restarted and is in the `Running` state.
123+
124+
. Start a new workspace.
125+
126+
. Open the *Extensions* view and verify that your added extensions are available.

0 commit comments

Comments
 (0)