Skip to content

Commit 4c67ffb

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

8 files changed

Lines changed: 230 additions & 166 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: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@
77
[id="extensions-for-microsoft-visual-studio-code-open-source"]
88
= Extensions for Microsoft Visual Studio Code - Open Source
99

10-
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:
10+
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:
1111

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].
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 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].
1313

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

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

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

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

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

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

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
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+
For a more robust extension lifecycle and offline use, set up an internal, on-premises Open VSX registry. The embedded plugin registry is planned for deprecation in a future release. For setup instructions, see xref:running-the-open-vsx-on-premises.adoc[].
12+
====
13+
14+
[NOTE]
15+
====
16+
For IBM Power (`ppc64le`) and IBM Z (`s390x`), you must build the registry locally on the corresponding architecture. See xref:adding-extensions-using-linux[].
17+
====
18+
19+
.Prerequisites
20+
21+
* You have administrator access to a {prod-short} instance.
22+
* You have identified the extensions to add or remove.
23+
* You have the extension IDs from the link:https://open-vsx.org/[Open VSX registry]. Format: `<publisher>.<name>`.
24+
* You have the extension version numbers.
25+
26+
pass:[<!-- vale RedHat.TermsErrors = NO -->]
27+
28+
* (Optional) You can rebuild the container based on the latest tag or SHA to get the latest security fixes after a {prod-short} update.
29+
30+
pass:[<!-- vale RedHat.TermsErrors = YES -->]
31+
32+
.Procedure
33+
34+
. Find the extension on the link:https://open-vsx.org/[Open VSX registry website] and note the publisher, name, and version from the URL:
35+
+
36+
[subs="+quotes"]
37+
----
38+
https://open-vsx.org/extension/__<publisher>__/__<name>__
39+
----
40+
+
41+
[TIP]
42+
====
43+
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.
44+
====
45+
46+
. Log in to the {prod-short} instance as an administrator.
47+
48+
. Start a new workspace using the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository].
49+
50+
. Open a terminal and check out the Git tag that corresponds to your {prod-short} version:
51+
+
52+
[source,bash,subs="+quotes"]
53+
----
54+
$ git checkout __<product_version>__
55+
----
56+
57+
. Open the `che-plugin-registry/openvsx-sync.json` file.
58+
59+
. Add or remove extension entries using the following JSON syntax:
60+
+
61+
[source,json,subs="+quotes"]
62+
----
63+
{
64+
"id": "__<publisher>__.__<name>__",
65+
"version": "__<extension_version>__"
66+
}
67+
----
68+
+
69+
[TIP]
70+
====
71+
For closed-source or internal extensions, add the extension from a `.vsix` file:
72+
73+
[source,json,subs="+quotes"]
74+
----
75+
{
76+
"id": "__<publisher>__.__<name>__",
77+
"download": "__<url_to_vsix_file>__",
78+
"version": "__<extension_version>__"
79+
}
80+
----
81+
82+
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.
83+
====
84+
85+
. Run the build task: *Terminal* -> *Run Task...* -> *devfile* -> *1. Build and Publish a Custom Plugin Registry*.
86+
87+
. Run the configuration task: *Terminal* -> *Run Task...* -> *devfile* -> *2. Configure Che to use the Custom Plugin Registry*.
88+
89+
.Verification
90+
91+
. Verify that the `plugin-registry` pod has restarted and is in the `Running` state.
92+
93+
. Start a new workspace.
94+
95+
. Open the *Extensions* view and verify that your added extensions are available.

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

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

‎modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc‎

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

0 commit comments

Comments
 (0)