Update Dashboard extensions documentation with OCI installation via Rancher UI #375

jtomasek · 2024-09-16T11:03:14Z

No description provided.

ranjinimn

I have completed my review and I had a few suggestions. Once they are incorporated, I will be happy to review again.

ranjinimn · 2024-09-23T09:02:26Z

asciidoc/components/rancher-dashboard-extensions.adoc

+=== Installing with Rancher Dashboard UI
+
+1. Click *Extensions* in the *Configuration* section of the navigation sidebar.
+2. On the Extensions page click the three dot menu at the top right and select *Manage Repositories*


Suggested change

2. On the Extensions page click the three dot menu at the top right and select *Manage Repositories*

2. On the Extensions page, click the three dot menu at the top right and select *Manage Repositories*.

ranjinimn · 2024-09-23T09:03:09Z

asciidoc/components/rancher-dashboard-extensions.adoc

+1. Click *Extensions* in the *Configuration* section of the navigation sidebar.
+2. On the Extensions page click the three dot menu at the top right and select *Manage Repositories*
+
+Each extension is distributed via it's own OCI artefact. Therefore it is required to add repositories for each extension we want to install.


For consistency, can we either use either artefact or artifact?

Also, jut another suggestion:

Each extension is distributed via it's own OCI artefact. Therefore, you need to add repositories for each extension that needs to be installed.

ranjinimn · 2024-09-23T09:04:46Z

asciidoc/components/rancher-dashboard-extensions.adoc

+
+Each extension is distributed via it's own OCI artefact. Therefore it is required to add repositories for each extension we want to install.
+
+3. On the *Repositories page* click `Create` button.


Suggested change

3. On the *Repositories page* click `Create` button.

3. On the *Repositories page*, click `Create`.

ranjinimn · 2024-09-23T09:05:11Z

asciidoc/components/rancher-dashboard-extensions.adoc

+Each extension is distributed via it's own OCI artefact. Therefore it is required to add repositories for each extension we want to install.
+
+3. On the *Repositories page* click `Create` button.
+4. In the form, specify the repository name and OCI artefact URL and click `Create`


Suggested change

4. In the form, specify the repository name and OCI artefact URL and click `Create`

4. In the form, specify the repository name and OCI artefact URL, and click `Create`

ranjinimn · 2024-09-23T09:07:22Z

asciidoc/components/rancher-dashboard-extensions.adoc

+
+=== Installing with Rancher Dashboard UI
+
+1. Click *Extensions* in the *Configuration* section of the navigation sidebar.


For numbering, instead of manual numbering, replace "1." with just "." "2." with ".", etc,. It will automatically provide the number.
For example:

. Click *Extensions* in the *Configuration* section of the navigation sidebar.

ranjinimn · 2024-09-23T09:09:58Z

asciidoc/components/rancher-dashboard-extensions.adoc

+
+image::dashboard-extensions-create-oci-repository.png[]
+
+5. The extension repository is added to the list and showing the `Active` state.


Is there any action for the user here? Apart from seeing the status?

Suggested change

5. The extension repository is added to the list and showing the `Active` state.

. You can see that the extension repository is added to the list and is in `Active` state.

No subsequent action here.

ranjinimn · 2024-09-23T09:13:04Z

asciidoc/components/rancher-dashboard-extensions.adoc

+Each extension is distributed via it's own OCI artefact. Therefore it is required to add repositories for each extension we want to install.
+
+3. On the *Repositories page* click `Create` button.
+4. In the form, specify the repository name and OCI artefact URL and click `Create`


Suggested change

4. In the form, specify the repository name and OCI artefact URL and click `Create`

4. In the form, specify the repository name and OCI artefact URL and click `Create`.

ranjinimn · 2024-09-23T09:13:49Z

asciidoc/components/rancher-dashboard-extensions.adoc

+
+7. On the extension card click `Install` and confirm the installation.
+
+Once the extension is installed Rancher UI will prompt to reload the page as described in the `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions#installing-extensions[Installing Extensions Rancher documentation page]`.


Suggested change

Once the extension is installed Rancher UI will prompt to reload the page as described in the `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions#installing-extensions[Installing Extensions Rancher documentation page]`.

Once the extension is installed Rancher UI prompts to reload the page as described in the `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions#installing-extensions[Installing Extensions Rancher documentation page]`.

jtomasek · 2024-09-24T13:38:08Z

Thanks for your review @ranjinimn! I've updated the PR with your suggestions.

jdob · 2024-09-24T19:53:07Z

While you're in here, can you look at the installation instructions for the plugin operator and see if we can pin them to versions? I'm a bit uncomfortable leaving them version-less. Here are the lines I'm talking about:

helm upgrade --create-namespace -n cattle-ui-plugin-system \
  --install ui-plugin-operator rancher-charts/ui-plugin-operator
helm upgrade --create-namespace -n cattle-ui-plugin-system \
  --install ui-plugin-operator-crd rancher-charts/ui-plugin-operator-crd

jdob

Let me know if there's a reason we don't pin the ui-plugin-operator to a specific version and I'll remove the request changes flag.

…ancher UI

Since Rancher 2.9 the ui-plugin-operator is built in the Rancher Dashboard. The code is deprecated https://github.com/rancher/ui-plugin-operator?tab=readme-ov-file and moved to Rancher dashboard controllers codebase https://github.com/rancher/rancher/tree/release/v2.9/pkg/controllers/dashboard/plugin

jtomasek force-pushed the 3.1-dashboard-extensions branch from 909c294 to 06c799f Compare September 16, 2024 11:03

hardys approved these changes Sep 23, 2024

View reviewed changes

hardys requested a review from ranjinimn September 23, 2024 08:33

ranjinimn reviewed Sep 23, 2024

View reviewed changes

jtomasek force-pushed the 3.1-dashboard-extensions branch from 46bdcc5 to 988b43a Compare September 24, 2024 13:35

jtomasek requested a review from ranjinimn September 24, 2024 13:38

jdob requested changes Sep 24, 2024

View reviewed changes

jtomasek force-pushed the 3.1-dashboard-extensions branch 2 times, most recently from 190819d to 6757bde Compare September 26, 2024 10:25

jtomasek mentioned this pull request Sep 26, 2024

Remove references to ui-plugin-operator #401

Merged

jtomasek added 3 commits September 26, 2024 13:51

Update Dashboard extensions documentation with OCI installation via R…

af81c64

…ancher UI

Update dashboard-extensions repository URLs and chart versions

5745e82

jtomasek force-pushed the 3.1-dashboard-extensions branch from 6757bde to 26e872b Compare September 26, 2024 11:52

jtomasek requested a review from jdob September 26, 2024 12:04

jdob approved these changes Sep 26, 2024

View reviewed changes

jtomasek merged commit ee2afb8 into suse-edge:main Sep 27, 2024
1 check passed

	2. On the Extensions page click the three dot menu at the top right and select Manage Repositories
	2. On the Extensions page, click the three dot menu at the top right and select Manage Repositories.

	3. On the Repositories page click `Create` button.
	3. On the Repositories page, click `Create`.

	4. In the form, specify the repository name and OCI artefact URL and click `Create`
	4. In the form, specify the repository name and OCI artefact URL, and click `Create`


		=== Installing with Rancher Dashboard UI

		1. Click Extensions in the Configuration section of the navigation sidebar.

	5. The extension repository is added to the list and showing the `Active` state.
	. You can see that the extension repository is added to the list and is in `Active` state.

	Once the extension is installed Rancher UI will prompt to reload the page as described in the `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions#installing-extensions[Installing Extensions Rancher documentation page]`.
	Once the extension is installed Rancher UI prompts to reload the page as described in the `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions#installing-extensions[Installing Extensions Rancher documentation page]`.

Update Dashboard extensions documentation with OCI installation via Rancher UI #375

Update Dashboard extensions documentation with OCI installation via Rancher UI #375

Uh oh!

Conversation

jtomasek commented Sep 16, 2024

Uh oh!

ranjinimn 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

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jtomasek commented Sep 24, 2024

Uh oh!

jdob commented Sep 24, 2024

Uh oh!

jdob left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants