Skip to content

Commit bdb07fb

Browse files
SUSE AI: added recommended Lifecycle Manager install method (#38)
* SUSE AI: added recommended Lifecycle Manager install method * Apply suggestions from code review Co-authored-by: Daria Vladykina <daria.vladykina@suse.com>
1 parent eb07f72 commit bdb07fb

1 file changed

Lines changed: 41 additions & 6 deletions

File tree

tasks/ai-lifecycle-manager-installing-rancher-ui.adoc

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ifdef::override-title[]
77
:page-revdate: {revdate}
88
endif::[]
99
ifndef::override-title[]
10-
= Installing {sailifecyclemanager} using {ranchera} UI
10+
= Installing {sailifecyclemanager} extension using {ranchera} UI
1111
endif::[]
1212
// overridden abstract?
1313
ifdef::override-abstract[]
@@ -24,18 +24,53 @@ endif::[]
2424

2525
include::../snippets/ai-rancher-admin-requirement.adoc[]
2626

27+
You can install the extension either from a GitHub branch or from a GitHub registry (OCI container).
28+
29+
[#ai-lifecycle-manager-extension-github-branch]
30+
== Installation using a GitHub branch (the recommended method)
31+
32+
The {sailifecyclemanager} extension is primarily distributed via a GitHub branch (gh-pages).
33+
This is the default and recommended installation method because it *enables seamless, in-place upgrades* directly from the {ranchera} UI.
34+
35+
. In {ranchera}, navigate to menu:Extensions[Manage Repositories]
36+
. Click btn:[Create], enter a name for the repository and select `Git repository containing Helm chart or cluster template definitions`.
37+
. Enter `https://github.com/SUSE/suse-ai-lifecycle-manager` as the Git repository URL and `gh-pages` as the Git branch.
38+
Confirm with btn:[Create].
39+
. Wait until the {sailifecyclemanager} repository has the Active state.
40+
. Go back to the `Extensions` page and install {sailifecyclemanager}.
41+
. Reload {ranchera} Dashboard by reloading the Web browser window to ensure the extension is loaded in the UI.
42+
. The "SUSE AI Lifecycle Manager" logo will now appear on the left panel of the {ranchera} Dashboard.
43+
44+
[NOTE]
45+
.Points to consider
46+
====
47+
* Using the GitHub branch method allows seamless updates without reinstallation.
48+
* If the extension does not appear after installation, try clearing the browser cache and reloading again.
49+
====
50+
51+
[#ai-lifecycle-manager-extension-github-registry]
52+
== Installation using a GitHub registry (an alternative method)
53+
54+
This method is provided for environments where Git-based repositories cannot be used.
55+
It does not support in-place upgrades.
56+
2757
. In {ranchera}, navigate to menu:Extensions[Manage Extensions Catalog]
2858
. Import the extension catalog from GitHub.
29-
Enter `ghcr.io/suse/suse-ai-lifecycle-manager:<VERSION>` in the btn:[Catalog Image Reference] input field.
30-
Replace `<VERSION>` with a tag published in the GitHub Container Registry.
31-
Confirm with btn:[Load].
59+
Enter `ghcr.io/suse/suse-ai-lifecycle-manager:<VERSION>` in the btn:[Catalog Image Reference] input field.
60+
Replace `<VERSION>` with a tag published in the GitHub Container Registry.
61+
Confirm with btn:[Load].
3262
. From the `Manage Repositories` page, verify if the {sailifecyclemanager} repository has the `Active` state.
33-
If not, refresh the connection.
63+
If not, refresh the connection.
3464
. Go back to the `Extensions` page and start the installation by clicking btn:[{sailifecyclemanager}].
3565
. Reload {ranchera} Dashboard by reloading the Web browser window to ensure the extension is loaded in the UI.
66+
The "`SUSE AI Lifecycle Manager`" logo will now appear on the left panel of the {ranchera} Dashboard.
3667

3768
[NOTE]
69+
.Points to consider
3870
====
39-
Newly published catalogs are not always available immediately.
71+
* To upgrade to a newer version of the extension, you must *reinstall the container* with the updated version tag.
72+
In-place upgrades are not supported with this method.
73+
* Replace `<VERSION>` with a valid tag published in the GitHub Container Registry.
74+
* Newly published catalogs are not always available immediately.
4075
If the catalog does not show up after publishing, navigate to menu:Extensions[Manage Repositories] and manually refresh the repository to force a re-sync.
4176
====

0 commit comments

Comments
 (0)