Changes for page Rancher 2

Last modified by Diana Strebkova on 2025/12/12 14:23

From 8.1 to 9.1 From 12.2 to 12.3

From version 9.1

edited by Diana Strebkova
on 2025/12/08 15:43

Change comment: There is no comment for this version

To version 12.2

edited by Diana Strebkova
on 2025/12/12 12:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -159,7 +159,7 @@
  == Add public helm chart ==
  {{warning width="70" title="Chartmuseum Deprecation"}}
--Chartmuseum is deprecated in new Harbor versions, we are migrating all helm charts to oci-compatible repositories in Harbor! New approach to add chart repositories in rancher.
++Chartmuseum is deprecated in new Harbor versions, we are migrating all helm charts to oci-compatible repositories in Harbor with "PKEY-helm" naming convention. For internal harbor repos, use new approach to add OCI chart repositories in rancher.
  {{/warning}}
  In this section, we describe (% style="color:#172b4d" %)how to add public helm charts like the one of DevOps-as-a-Service to a cluster to allow manual deployments.
@@ -218,11 +218,9 @@
  [[image:Screenshot 2024-07-03 at 15.13.55.png||data-xwiki-image-style-border="true" height="149" width="785"]]
--====  ====
--
  ==== Target: OCI Repository ====
--To add public oci-repository, navigate to repository create button and click it.
++To add public oci-repository, navigate to repository create button and click it. For target, use OCI Repository like shown below:
  [[image:1765207154466-828.png||height="298" width="821"]]
@@ -247,13 +247,17 @@
  |=(((
  Index URL
  )))|(((
--oci:[[~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas-helm/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]]chartname, for example:
++oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/**<chartname>**, for example:
--oci:[[~~/~~/registry.sdc.t-systems.net/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]][[devopsaas-helm/jenkins-lib>>url:https://registry-manoni.devops.t-systems.net/harbor/projects/139/repositories/jenkins-lib]]
++oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/jenkins-lib
++
++{{info}}
++Take into account, that all internal harbor repositories with helm charts have PKEY-helm naming convention, adding repo with both docker images and helm charts may not be supported in rancher.
++{{/info}}
  )))
  {{info}}
--Now all internal helm charts are stored in harbor folders with -helm suffix. Adding the whole public project doesn't work natively anymore, so each separate chart should be added as a separate repo.
++Now all internal helm charts are stored in harbor folders with -helm suffix. Adding the whole public project doesn't work natively anymore, so each separate chart should be added as a separate repo. //**If you have a need in adding the whole project with many repositories, please contact support for finding a possible solution.**//
  {{/info}}
  === Deploy Helm charts ===
@@ -266,7 +266,6 @@
  == Add private chart repository ==
--
  === Create a robot account in Harbor ===
  To add project specific helm charts to Rancher, a Harbor robot account is needed, that is able to read helm charts and pull repositories. If you don't have such an account yet, please follow the instructions given in the [[Create Robot Account section of the Harbor documentation>>doc:Harbor.Harbor 2\.7 Robot Accounts.WebHome||anchor="create_robot_account"]] and make sure to grant at least the following permissions:
@@ -279,6 +279,8 @@
  (% class="p1" %)
  In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu.
++
++
  [[image:attach:Screenshot 2023-04-25 at 13.11.48.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="400" width="209"]]
  (% class="p1" %)
@@ -288,11 +288,10 @@
  ==== [[image:attach:Screenshot 2023-04-25 at 13.30.33.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="127" width="1100"]] ====
  (% id="HTarget:http28s29URL-1" class="p1" %)
--====
--Target: http(s) URL ====
++==== Target: http(s) URL ====
  {{warning title="Chartmuseum Deprecation"}}
--Chartmuseum in Harbor is deprecated, meaning we won't be able to add repositories to Rancher that way anymore. Instead use Target: OCI repository.
++Chartmuseum in Harbor is deprecated, meaning we won't be able to add internal harbor repositories to Rancher that way anymore. Instead use Target: OCI repository.
  {{/warning}}
  (% class="p1" %)
@@ -309,17 +309,20 @@
  (% class="p1" %)
  Click Create.
++(% id="HTarget:OCIRepository-1" class="p1" %)
  ==== Target: OCI Repository ====
  {{info}}
--Now all internal helm charts are stored in harbor folders with -helm suffix. Adding the whole public project doesn't work natively anymore, so each separate chart should be added as a separate repo.
++Now all internal helm charts are stored in harbor folders with -helm suffix. Adding the whole public project doesn't work natively anymore, so each separate chart should be added as a separate repo.//** If you have a real need to add the whole project, please contact support for finding a possible solution.**//
  {{/info}}
  (% class="p1" %)
--Choose OCI repository in Target and for url, use  ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chatname>##
++Choose OCI repository in Target and for url, use  ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chartname>##
--(% class="p1" %)
--Replace ##<domain>## , ##<project>##  and ##<chatname> ##as necessary to match your set-up.
++(% class="box" %)
++(((
++Replace ##<domain>## , ##<project>##  and ##<chartname> ##as necessary to match your set-up. Your charts should be stored in ##<project>-helm ##repository in Harbor, which is created by default when project is created in portal.
++)))
  (% class="p1" %)
  For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section.
@@ -330,6 +330,106 @@
  (% class="wikigeneratedid" %)
  Click Create.
++(% class="wrapped" %)
++|=(((
++Field
++)))|=(((
++Value
++)))
++|=(((
++Name
++)))|(((
++sdcloud-sdportal
++)))
++|=(((
++Description
++)))|(((
++Sdportal charts of sdcloud project
++)))
++|=(((
++Index URL
++)))|(((
++oci:~/~/registry.sdc.t-systems.net/sdcloud-helm/sdportal
++
++{{info}}
++Now we should target a chart repo directly, not the whole project. In you need to reference the whole project with a lot of repos, please contact support to find a possible solution.
++{{/info}}
++)))
++
++=== Migrating chart repositories in rancher to new OCI Repository format ===
++
++(% class="box warningmessage" %)
++(((
++ChartMuseum is being deprecated. After the migration is complete, **all harbor charts will be removed from ChartMuseum**, and **old HTTP(S)-based chart repositories will no longer work in Rancher (for internal harbor charts)**.
++)))
++
++To ensure a smooth transition, we recommend to **add an OCI-based repository alongside the existing ChartMuseum repository** during the migration phase.
++
++(% class="box" %)
++(((
++**We will make your charts available in the corresponding new `<pkey>-helm` OCI projects.**
++)))
++
++| Term | Meaning
++| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository.
++| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`).
++
++##__**Why This Migration Is Required:**__##
++
++* ##ChartMuseum is deprecated and will be removed.##
++* ##Applications deployed from old repos keep a reference to that repo inside their labels.##
++* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.##
++
++## Migration Steps:##
++
++1. ##Create the New OCI Repository in Rancher##
++11. Go to **Apps → Repositories**.
++11. Add a new repository of type **OCI**.
++11. Name it similarly to your old repo name (e.g. `<chart-repo-name>-oci`). You can't name it the same.
++11. Point it to the new OCI endpoint.
++1. ##Disable the Old ChartMuseum Repository Temporarily##. ##This step ensures that Rancher resolves charts from the new OCI repo.##
++11. Go to **Apps → Repositories**.
++11. Disable the old HTTP(S)-based repository.
++11. Keep it disabled until the migration is done.
++1. ##Update Existing Applications to Use the New OCI Repo##
++##Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition.##
++11. Go to **Apps → Installed Apps**.
++11. Open the application that was deployed using the old repo.
++11. Click **Upgrade**.
++11. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**.
++11. Choose the chart version you want to deploy (same or newer).
++11. Click **Upgrade**.
++1. ##Re-enable the Old Repository (Optional) If you still need the old repo for other apps, re-enable it after the migration steps above.##Note: Even if a newer chart version exists in the old repository, your migrated app **will not see it**, because it is no longer connected to that repo
++
++----
++
++## Reverting the Migration (If Needed)
++If you want to move an app back to the old repository:##
++
++1. Temporarily disable the new OCI repo.
++1. Enable the old ChartMuseum repo.
++1. Open the application → **Upgrade**.
++1. Select the chart from the old repo.
++1. Save.
++
++This will reconnect the app to the old repository.
++
++----
++
++## Summary
++- Add new OCI repo → disable old repo → upgrade apps → reconnect to OCI repo.
++- After upgrade, apps no longer track versions from the old repository.
++- Old repository will stop functioning after ChartMuseum shutdown, so migration is required.##
++
++----
++
++If you want, I can also generate:
++- a shorter version (1-pager),
++- a diagram,
++- a Rancher UI screenshot guide,
++- or a version tailored for your team’s internal wiki.
++
++
  = Automated deployments with Jenkins =
  In this section, we describe(% style="color:#172b4d" %) how to set-up **automated builds, tests and deployments** for Jenkins.