docs: describe how to remove extensions from the private openvsx registry#3029
Conversation
|
🎊 Navigate the preview: https://699ed922ade53800bc85506f--eclipse-che-docs-pr.netlify.app 🎊 |
b16611f to
e53bcf0
Compare
| @@ -0,0 +1,199 @@ | |||
| You can remove extensions from your private OpenVSX registry in two ways: by using the OpenVSX Admin API (recommended) or by deleting the extension data directly in the PostgreSQL database. | |||
There was a problem hiding this comment.
| You can remove extensions from your private OpenVSX registry in two ways: by using the OpenVSX Admin API (recommended) or by deleting the extension data directly in the PostgreSQL database. | |
| You can remove extensions from your private OpenVSX registry by using one of the following methods: | |
| * Use the OpenVSX administrator API (recommended). | |
| * Delete the extension data directly in the PostgreSQL database. |
| You can remove extensions from your private OpenVSX registry in two ways: by using the OpenVSX Admin API (recommended) or by deleting the extension data directly in the PostgreSQL database. | ||
|
|
||
| [id="delete-extensions-admin-api"] | ||
| === Option 1: Delete extension using the OpenVSX Admin API |
There was a problem hiding this comment.
| === Option 1: Delete extension using the OpenVSX Admin API | |
| == Deleting an extension by using the OpenVSX administrator API |
| [id="delete-extensions-admin-api"] | ||
| === Option 1: Delete extension using the OpenVSX Admin API | ||
|
|
||
| This method uses an admin user and Personal Access Token (PAT) to call the Admin API. |
There was a problem hiding this comment.
| This method uses an admin user and Personal Access Token (PAT) to call the Admin API. | |
| Use this method to call the administrator API with an administrator user and a personal access token (PAT). |
|
|
||
| .Prerequisites | ||
|
|
||
| * Access to the OpenShift cluster where OpenVSX is deployed (namespace `openvsx`). |
There was a problem hiding this comment.
| * Access to the OpenShift cluster where OpenVSX is deployed (namespace `openvsx`). | |
| * You must have access to the OpenShift cluster where OpenVSX is deployed (namespace `openvsx`). |
|
|
||
| .Procedure | ||
|
|
||
| . Add the OpenVSX admin user and PAT to the database. |
There was a problem hiding this comment.
| . Add the OpenVSX admin user and PAT to the database. | |
| . Add the OpenVSX administrator user and PAT to the database: |
| + | ||
| [NOTE] | ||
| ==== | ||
| Use a strong, unique value instead of `openvsx_admin_token` for production. The PAT is passed in the API request URL. |
There was a problem hiding this comment.
| Use a strong, unique value instead of `openvsx_admin_token` for production. The PAT is passed in the API request URL. | |
| Use a strong, unique value instead of `openvsx_admin_token` for production. The system passes the PAT in the API request URL. |
|
@svor I have some updates regarding the flow and content. Here is what I'm thinking. |
| * link:https://github.com/eclipse/openvsx/[Eclipse Open VSX sources] | ||
| * link:https://github.com/eclipse/openvsx/wiki/[Eclipse Open VSX documentation] | ||
|
|
||
| == Delete Extensions in a Private OpenVSX Registry |
There was a problem hiding this comment.
Can we create a separate assembly for this? Generally Additional resources mark the end of the topic. if we want a new one, we can create assembly and then add that asembly to nav? This way we can have the same flow? WDYT?
…stry Signed-off-by: Valerii Svydenko <[email protected]>
f2719bd to
1548ef3
Compare
Signed-off-by: Valerii Svydenko <[email protected]>
Signed-off-by: Valerii Svydenko <[email protected]>
Signed-off-by: Valerii Svydenko <[email protected]>
Signed-off-by: Valerii Svydenko <[email protected]>
What does this pull request change?
Adds an additional section to the Running the Open VSX On-Premises documentation describing how to remove extensions from the Open VSX registry.
What issues does this pull request fix or reference?
https://issues.redhat.com/browse/CRW-10109
Specify the version of the product this pull request applies to
Dev Spaces 3.27.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.
Validate language on files added or modifiedstep reports no vale warnings.