Skip to content

Commit d1c3e2f

Browse files
svorsvor
committed
procedures: Add docs about Open VSX on-premises (eclipse-che#2947)
* feat: add docs about Open VSX on-premises Signed-off-by: Valeriy Svydenko <vsvydenk@redhat.com>
1 parent 39b3dfb commit d1c3e2f

6 files changed

+342
-0
lines changed

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

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
* Installed `oc` and git tools.
2+
* Installed Podman.
3+
* Log in to the OpenShift cluster where a {prod-short} is deployed as an administrator.
4+
+
5+
[TIP]
6+
====
7+
8+
`$ oc login pass:c,a,q[{prod-url}] --username=__<my_user>__`
9+
10+
====
11+
12+
.Procedure
13+
14+
. Create a new OpenShift project for Open VSX.
15+
+
16+
[subs="+attributes,+quotes"]
17+
----
18+
oc new-project openvsx
19+
----
20+
. Clone Open VSX sources.
21+
+
22+
Get Open VSX sources and navigate to the OpenShift deploy directory:
23+
+
24+
[bash,subs="verbatim",options="nowrap"]
25+
----
26+
git clone https://github.com/eclipse/openvsx.git &&
27+
cd openvsx/deploy/openshift
28+
----
29+
30+
. Prepare Open VSX server image.
31+
+
32+
The next step is to build and publish the Open VSX server image. To do this, run the following commands:
33+
+
34+
[bash,subs="verbatim",options="nowrap"]
35+
----
36+
export REGISTRY=quay.io &&
37+
export NAMESPACE=myuser &&
38+
export OPENVSX_SERVER_IMAGE_NAME=openvsx-server &&
39+
export OPENVSX_VERSION=v0.27.0 &&
40+
export OPENVSX_SERVER_IMAGE=${REGISTRY}/${NAMESPACE}/${OPENVSX_SERVER_IMAGE_NAME}:${OPENVSX_VERSION} &&
41+
podman build -t "${OPENVSX_SERVER_IMAGE}" --build-arg "OPENVSX_VERSION=${OPENVSX_VERSION}" -f openvsx.Dockerfile . &&
42+
podman login "${REGISTRY}" &&
43+
podman push "${OPENVSX_SERVER_IMAGE}"
44+
----
45+
+
46+
[IMPORTANT]
47+
====
48+
49+
Make sure to configure the correct container registry and namespace for your image. Additionally, ensure that the image is publicly accessible and can be pulled without authentication.
50+
51+
====
52+
53+
. Prepare Open VSX CLI image.
54+
+
55+
Build and publish the Open VSX CLI image. To do this, run the following commands:
56+
+
57+
[bash,subs="verbatim",options="nowrap"]
58+
----
59+
export OPENVSX_CLI_IMAGE_NAME=openvsx-cli &&
60+
export OPENVSX_CLI_VERSION=0.10.5 &&
61+
export OPENVSX_CLI_IMAGE=${REGISTRY}/${NAMESPACE}/${OPENVSX_CLI_IMAGE_NAME}:${OPENVSX_CLI_VERSION} &&
62+
podman build -t "${OPENVSX_CLI_IMAGE}" --build-arg "OVSX_VERSION=${OPENVSX_CLI_VERSION}" -f cli.Dockerfile . &&
63+
podman push "${OPENVSX_CLI_IMAGE}"
64+
----
65+
+
66+
[IMPORTANT]
67+
====
68+
69+
Ensure that the image is publicly accessible and can be pulled without authentication.
70+
71+
====
72+
73+
. Deploy Open VSX.
74+
+
75+
[bash,subs="verbatim",options="nowrap"]
76+
----
77+
oc process -f openvsx-deployment.yml \
78+
-p OPENVSX_SERVER_IMAGE="${OPENVSX_SERVER_IMAGE}" \
79+
-p OPENVSX_CLI_IMAGE="${OPENVSX_CLI_IMAGE}" \
80+
| oc apply -f -
81+
----
82+
83+
. Verify that all pods in the `openvsx` namespace are running and ready. It might take a few minutes for all pods to become ready. Run the following command:
84+
+
85+
[bash,subs="verbatim",options="nowrap"]
86+
----
87+
oc get pods -n openvsx \
88+
-o jsonpath='{range .items[*]}{@.metadata.name}{"\t"}{@.status.phase}{"\t"}{.status.containerStatuses[*].ready}{"\n"}{end}'
89+
----
90+
91+
. Add Open VSX user with PAT to the database.
92+
+
93+
Find PostgreSQL pod:
94+
+
95+
[bash,subs="verbatim",options="nowrap"]
96+
----
97+
export POSTGRESQL_POD_NAME=$(oc get pods -n openvsx \
98+
-o jsonpath="{.items[*].metadata.name}" | tr ' ' '\n' | grep '^postgresql' | head -n 1)
99+
----
100+
+
101+
Insert username into OpenVSX database:
102+
+
103+
[bash,subs="verbatim",options="nowrap"]
104+
----
105+
oc exec -n openvsx "$POSTGRESQL_POD_NAME" -- bash -c \
106+
"psql -d openvsx -c \"INSERT INTO user_data (id, login_name, role) VALUES (1001, 'eclipse-che', 'privileged');\""
107+
----
108+
+
109+
Insert user PAT into OpenVSX database:
110+
+
111+
[bash,subs="verbatim",options="nowrap"]
112+
----
113+
oc exec -n openvsx "$POSTGRESQL_POD_NAME" -- bash -c \
114+
"psql -d openvsx -c \"INSERT INTO personal_access_token (id, user_data, value, active, created_timestamp, accessed_timestamp, description) VALUES (1001, 1001, 'eclipse_che_token', true, current_timestamp, current_timestamp, 'extensions publisher');\""
115+
----
116+
117+
. Configure {prod-short} to use the internal Open VSX.
118+
+
119+
[bash,subs="verbatim",options="nowrap"]
120+
----
121+
export CHECLUSTER_NAME="$(oc get checluster --all-namespaces -o json | jq -r '.items[0].metadata.name')" &&
122+
export CHECLUSTER_NAMESPACE="$(oc get checluster --all-namespaces -o json | jq -r '.items[0].metadata.namespace')" &&
123+
export OPENVSX_ROUTE_URL="$(oc get route internal -n openvsx -o jsonpath='{.spec.host}')" &&
124+
export PATCH='{"spec":{"components":{"pluginRegistry":{"openVSXURL":"https://'"$OPENVSX_ROUTE_URL"'"}}}}' &&
125+
oc patch checluster "${CHECLUSTER_NAME}" --type=merge --patch "${PATCH}" -n "${CHECLUSTER_NAMESPACE}"
126+
----
127+
+
128+
[TIP]
129+
====
130+
131+
Refer to the xref:configuring-the-open-vsx-registry-url.adoc[] for detailed instructions on configuring the Open VSX registry URL in {prod-short}.
132+
133+
====
134+
135+
. Publish Visual Studio Code extensions with the `ovsx` command.
136+
+
137+
[NOTE]
138+
====
139+
140+
At the beginning, the Open VSX registry does not provide any extension.
141+
142+
====
143+
+
144+
With everything configured, the next step is to publish a Visual Studio Code extension from inside the ovsx-cli container.
145+
To do this, you need two pieces of information: the extension `namespace` name (used for publishing), the download URL of the .vsix extension package.
146+
Once you have this information, run the following commands to publish the extension:
147+
+
148+
.. Retrieve the name of the pod running the Open VSX server:
149+
+
150+
[bash,subs="verbatim",options="nowrap"]
151+
----
152+
export OVSX_POD_NAME=$(oc get pods -n openvsx -o jsonpath="{.items[*].metadata.name}" | tr ' ' '\n' | grep ^ovsx-cli)
153+
----

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
. Build and Publish Open VSX image.
2+
+
3+
To build and deploy the Open VSX server container image to the OpenShift internal image registry, run the `2.2. Build and Publish Open VSX Image` task in the workspace: (`Terminal → Run Task… → devfile → 2.2. Build and Publish OpenVSX Image`). During execution, you will be prompted to enter the Open VSX server version. If left blank, the task will default to using v0.27.0.
4+
+
5+
[TIP]
6+
====
7+
Open VSX server versions could be found on the OpenVSX GitHub release page: https://github.com/eclipse/openvsx/releases
8+
====
9+
10+
. Build and Publish Open VSX CLI (`ovsx`) Image.
11+
+
12+
Run `2.3. Build and Publish OpenVSX CLI Image` task in the workspace (`Terminal → Run Task… → devfile → 2.3. Build and Publish OpenVSX CLI Image`) to build the Open VSX CLI image and push it to OpenShift internal registry.
13+
14+
. Deploy Open VSX.
15+
+
16+
Run `2.4. Deploy OpenVSX` task in the workspace (`Terminal → Run Task… → devfile → 2.4. Deploy OpenVSX`). This command deploys the Open VSX components to an OpenShift project by processing a template file (openvsx-deployment.yml). It creates all required resources defined in the template, which includes:
17+
+
18+
.. Deployments (PostgreSQL, Elasticsearch, Open VSX server, Open VSX CLI).
19+
+
20+
.. Services and Routes for accessing components.
21+
+
22+
.. Secrets for GitHub OAuth credentials and Open VSX personal access token.
23+
24+
+
25+
[TIP]
26+
====
27+
28+
All deployment information is described in the `deploy/openshift/openvsx-deployment.yml` file with some default values such as `OVSX_PAT_BASE64`.
29+
30+
====

‎modules/administration-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108
*** xref:enabling-fuse-for-all-workspaces.adoc[]
109109
* xref:managing-ide-extensions.adoc[]
110110
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
111+
** xref:running-the-open-vsx-on-premises.adoc[]
111112
** xref:configuring-the-open-vsx-registry-url.adoc[]
112113
* xref:configuring-visual-studio-code.adoc[]
113114
** xref:configuring-single-and-multiroot-workspaces.adoc[]

‎modules/administration-guide/pages/managing-ide-extensions.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@
1010
IDEs use extensions or plugins to extend their functionality, and the mechanism for managing extensions differs between IDEs.
1111

1212
* xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
13+
* xref:running-the-open-vsx-on-premises.adoc[]
1314
* xref:configuring-the-open-vsx-registry-url.adoc[]
1415

‎modules/administration-guide/pages/running-the-open-vsx-on-premises.adoc

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
:_content-type: PROCEDURE
2+
:description: Running Open VSX On-Premises
3+
:keywords: administration guide, configuring, openvsx, registry
4+
:navtitle: Running Open VSX On-Premises
5+
:page-aliases:
6+
7+
[id="running-the-open-vsx-on-premises"]
8+
= Running the Open VSX On-Premises
9+
10+
Follow the instructions below to deploy and configure an on-premises Eclipse Open VSX extension registry, fully integrated with {prod-short} and OpenShift environments. Choose one of the two setup paths: using a {prod-short} workspace or the OpenShift CLI (`oc`), to help you set up a secure, internal Open VSX instance. This includes creating necessary OpenShift project, deploying Open VSX components, publishing extensions and integrating the registry with {prod-short}.
11+
12+
== Using {prod-short} instance
13+
14+
.Prerequisites
15+
16+
* Be logged in to a {prod-short} as an administrator.
17+
18+
.Procedure
19+
20+
. Start a workspace using the Open VSX repository.
21+
+
22+
Create a workspace by using the following link:https://github.com/eclipse/openvsx[Eclipse Open VSX repository].
23+
+
24+
[TIP]
25+
====
26+
The environment, including all necessary commands, is defined in the `.devfile.yaml` file.
27+
====
28+
29+
. Create a new OpenShift project for Open VSX.
30+
+
31+
Run `2.1. Create Namespace for OpenVSX` task in the workspace (`Terminal → Run Task… → devfile → 2.1. Create Namespace for OpenVSX`). A new project with the name `openvsx` should be created on the cluster.
32+
33+
include::example$snip_{project-context}-deploy-open-vsx.adoc[]
34+
35+
. Add Open VSX user with PAT to the database.
36+
+
37+
Run the `2.5. Add OpenVSX user with PAT to the DB` task in the workspace (`Terminal → Run Task… → devfile → 2.5. Add OpenVSX user with PAT to the DB`). The command will ask for the Open VSX username and user PAT. You can just click enter to use the default values.
38+
+
39+
[IMPORTANT]
40+
====
41+
42+
The user PAT must match the decoded value of `OVSX_PAT_BASE64` specified in the deployment file. If `OVSX_PAT_BASE64` has been updated, use the new token's decoded value as the user PAT.
43+
44+
====
45+
46+
. Configure {prod-short} to use the internal Open VSX.
47+
+
48+
Run the `2.6. Configure Che to use the internal Open VSX registry` task in the workspace (`Terminal → Run Task… → devfile → 2.6. Configure Che to use the internal OpenVSX registry`). It applies the patch to the `CheCluster` custom resource, updating its configuration to use the specified Open VSX URL for the extension registry.
49+
50+
. Publish an extension from a `.vsix` file.
51+
+
52+
At the beginning, the Open VSX registry does not provide any extension. Once the `openvsx-server` pod is running and in the Ready state, extensions can be published to the registry. The `2.8. Publish a Visual Studio Code Extension from a VSIX file` command publishes an extension to the local Open VSX registry directly from a `.vsix` file. It prompts you to provide the extension's `namespace` name and the path to the `.vsix` file.
53+
54+
. Publish list of extensions.
55+
+
56+
The `2.9. Publish list of Visual Studio Code Extensions` command automates the process of publishing a predefined list of Microsoft Visual Studio Code extensions based on download URLs to the internal Open VSX registry.
57+
+
58+
[TIP]
59+
====
60+
The command reads from the `deploy/openshift/extensions.txt` file, which lists the URLs of `.vsix` files for each extension to be published.
61+
To publish your extensions to Open VSX, update the `extensions.txt` file as needed, then run the 2.9. Publish list of Visual Studio Code Extensions task from the workspace:
62+
`Terminal → Run Task… → devfile → 2.9. Publish list of Visual Studio Code Extensions`.
63+
====
64+
65+
. Verify that {prod-short} uses internal Open VSX.
66+
+
67+
Start any workspace and check the available extensions in the Extensions view of the workspace IDE or by opening the `internal` route in the OpenVSX OpenShift project.
68+
69+
== Using OpenShift CLI (`oc`) tool
70+
71+
.Prerequisites
72+
73+
include::example$snip_{project-context}-deploy-open-vsx-using-oc.adoc[]
74+
+
75+
.. Download the .vsix extension:
76+
+
77+
[bash,subs="verbatim",options="nowrap"]
78+
----
79+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "wget -O /tmp/extension.vsix EXTENSION_DOWNLOAD_URL "
80+
----
81+
+
82+
.. Create an extension namespace:
83+
+
84+
[bash,subs="verbatim",options="nowrap"]
85+
----
86+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "ovsx create-namespace EXTENSION_NAMESPACE_NAME" || true
87+
----
88+
+
89+
.. Publish the extension:
90+
+
91+
[bash,subs="verbatim",options="nowrap"]
92+
----
93+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "ovsx publish /tmp/extension.vsix"
94+
----
95+
+
96+
.. Delete the downloaded extension file:
97+
+
98+
[bash,subs="verbatim",options="nowrap"]
99+
----
100+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "rm /tmp/extension.vsix"
101+
----
102+
+
103+
[TIP]
104+
====
105+
106+
Example: Publish the `redhat.vscode-yaml` extension version 1.18.0:
107+
[bash,subs="verbatim",options="nowrap"]
108+
----
109+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "wget -O /tmp/extension.vsix https://open-vsx.org/api/redhat/vscode-yaml/1.18.0/file/redhat.vscode-yaml-1.18.0.vsix " &&
110+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "ovsx create-namespace redhat" || true &&
111+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "ovsx publish /tmp/extension.vsix" &&
112+
oc exec -n openvsx "${OVSX_POD_NAME}" -- bash -c "rm /tmp/extension.vsix"
113+
----
114+
115+
====
116+
+
117+
. Verify Open VSX extension registry.
118+
+
119+
Check the list of published extensions by navigating to the URL defined in the OPENVSX_ROUTE_URL environment variable.
120+
121+
== Setting Up Internal Access to the Open VSX Service
122+
123+
In addition to using a public route to reference the Open VSX registry, you can also configure {prod-short} to set internal cluster service routing. This method provides enhanced security by keeping traffic confined within the cluster, avoiding public exposure.
124+
125+
.Procedure
126+
127+
Steps for Internal Service Routing:
128+
129+
. Remove the Public Route.
130+
+
131+
Delete the public route associated with the Open VSX registry to restrict external access:
132+
+
133+
[bash,subs="verbatim",options="nowrap"]
134+
----
135+
oc delete route internal -n openvsx
136+
----
137+
138+
. Set the Internal Open VSX Service URL.
139+
+
140+
Update the CheCluster custom resource to use the internal cluster service DNS:
141+
+
142+
[bash,subs="verbatim",options="nowrap"]
143+
----
144+
export CHECLUSTER_NAME="$(oc get checluster --all-namespaces -o json | jq -r '.items[0].metadata.name')" &&
145+
export CHECLUSTER_NAMESPACE="$(oc get checluster --all-namespaces -o json | jq -r '.items[0].metadata.namespace')" &&
146+
export PATCH='{"spec":{"components":{"pluginRegistry":{"openVSXURL":"http://openvsx-server.openvsx.svc:8080"}}}}' &&
147+
oc patch checluster "${CHECLUSTER_NAME}" --type=merge --patch "${PATCH}" -n "${CHECLUSTER_NAMESPACE}"
148+
----
149+
150+
.Additional resources
151+
* link:https://github.com/eclipse/openvsx/[Eclipse Open VSX sources]
152+
* link:https://github.com/eclipse/openvsx/wiki/[Eclipse Open VSX documentation]

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
[id="adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance"]
44
= Adding or removing extensions in the embedded Open VSX registry instance
55

6+
[IMPORTANT]
7+
====
8+
You can manage Visual Studio Code extensions by setting up and using an internal, on-premises Open VSX registry. This approach provides full control over the extension lifecycle, enables offline use, and improves compliance. The embedded plugin registry will be deprecated in future releases, with the Open VSX registry serving as its successor. Refer to the xref:running-the-open-vsx-on-premises.adoc[] for detailed setup instructions.
9+
====
10+
611
You can add or remove extensions in the embedded Open VSX registry instance. This results in a custom build of the Open VSX registry that can be used in your organization’s workspaces.
712

813
pass:[<!-- vale RedHat.TermsErrors = NO -->]

0 commit comments

Comments
 (0)