Skip to content

Commit 06c799f

Browse files
committed
Update Dashboard extensions documentation with OCI installation via Rancher UI
1 parent d4dd62d commit 06c799f

File tree

5 files changed

+39
-2
lines changed

5 files changed

+39
-2
lines changed

asciidoc/components/akri.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ In case the protocol used by your device isn't covered by an existing discovery
109109

110110
Akri Dashboard Extension allows you to use Rancher Dashboard user interface to manage and monitor leaf devices and run workloads once these devices are discovered.
111111

112+
See <<components-rancher-dashboard-extensions,Rancher Dashboard Extensions>> for installation guidance.
113+
112114
Once the extension is installed you can navigate to any Akri-enabled managed cluster using cluster explorer. Under *Akri* navigation group you can see Configurations and Instances sections.
113115

114116
image::akri-extension-configurations.png[]

asciidoc/components/rancher-dashboard-extensions.adoc

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ ifdef::env-github[]
1010
:caution-caption: :fire:
1111
:warning-caption: :warning:
1212
endif::[]
13+
:imagesdir: ../images/
1314

14-
Extensions allow users, developers, partners, and customers to extend and enhance the Rancher UI. SUSE Edge 3.0 provides KubeVirt and Akri dashboard extensions.
15+
Extensions allow users, developers, partners, and customers to extend and enhance the Rancher UI. SUSE Edge 3.1 provides KubeVirt and Akri dashboard extensions.
1516

1617
See `https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions[Rancher documentation]` for general information about Rancher Dashboard Extensions.
1718

@@ -34,7 +35,41 @@ Or with Fleet by creating a dedicated GitRepo resource. For more information see
3435

3536
== Installation
3637

37-
All SUSE Edge 3.0 components including dashboard extensions are distributed as OCI artifacts. Rancher Dashboard Apps/Marketplace does not support OCI based Helm repositories `https://github.com/rancher/dashboard/issues/9815[yet]`. Therefore, to install SUSE Edge Extensions you can use Helm or Fleet:
38+
All SUSE Edge 3.1 components including dashboard extensions are distributed as OCI artifacts. To install SUSE Edge Extensions you can use Rancher Dashboard UI, Helm or Fleet:
39+
40+
=== Installing with Rancher Dashboard UI
41+
42+
1. Click *Extensions* in the *Configuration* section of the navigation sidebar.
43+
2. On the Extensions page click the three dot menu at the top right and select *Manage Repositories*
44+
+
45+
Each extension is distributed via it's own OCI artefact. Therefore it is required to add repositories for each extension we want to install.
46+
47+
3. On the *Repositories page* click `Create` button.
48+
4. In the form, specify the repository name and OCI artefact URL and click `Create`
49+
+
50+
Akri Dashboard Extension Repository URL:
51+
`oci://registry.suse.com/edge/3.1/akri-dashboard-extension-chart`
52+
+
53+
KubeVirt Dashboard Extension Repository URL:
54+
`oci://registry.suse.com/edge/3.1/kubevirt-dashboard-extension-chart`
55+
+
56+
image::dashboard-extensions-create-oci-repository.png[]
57+
58+
5. The extension repository is added to the list and showing the `Active` state.
59+
+
60+
image::dashboard-extensions-repositories-list.png[]
61+
62+
6. Navigate back to the *Extensions* in the *Configuration* section of the navigation sidebar.
63+
+
64+
In the *Available* tab you can see the extensions available for installation.
65+
+
66+
image::dashboard-extensions-available-extensions.png[]
67+
68+
7. On the extension card click `Install` and confirm the installation.
69+
+
70+
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]`.
71+
72+
3873

3974
=== Installing with Helm
4075

108 KB
Loading
228 KB
Loading
333 KB
Loading

0 commit comments

Comments
 (0)