Skip to Content

Changes for page Rancher 2

Last modified by Diana Strebkova on 2026/04/20 09:21
From version 5.1
edited by Diana Strebkova
on 2025/12/08 15:28
Change comment: There is no comment for this version
To version 24.4
edited by Diana Strebkova
on 2026/04/20 09:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -159,7 +159,7 @@
159 159  == Add public helm chart ==
160 160  
161 161  {{warning width="70" title="Chartmuseum Deprecation"}}
162 -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.
162 +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.
163 163  {{/warning}}
164 164  
165 165  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.
... ... @@ -177,14 +177,10 @@
177 177  (% class="p1" %)
178 178  [[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"]]
179 179  
180 -(% id="H" class="p1" %)
181 -==== Target: http(s) URL ====
180 +To add public oci-repository, navigate to repository create button and click it. For target, use OCI Repository like shown below:
182 182  
183 -{{warning}}
184 -This example is being deprecated, you can still add other external repositories in that way, but all internal harbor-hosted repositories should be added as Target: OCI Repository
185 -{{/warning}}
182 +[[image:1765207154466-828.png||height="298" width="821"]]
186 186  
187 -(% class="p1" %)
188 188  In the "Repository: Create" dialog, simply fill in the following fields. Authentication is not required.
189 189  
190 190  (% class="wrapped" %)
... ... @@ -196,7 +196,7 @@
196 196  |=(((
197 197  Name
198 198  )))|(((
199 -devops-as-a-service
195 +devopsaas-jenkins-auto-agent
200 200  )))
201 201  |=(((
202 202  Description
... ... @@ -206,26 +206,74 @@
206 206  |=(((
207 207  Index URL
208 208  )))|(((
209 -[[https:~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]]
205 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/**<chartname>**, for example:
206 +
207 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/jenkins-auto-agent
208 +
209 +{{box}}
210 +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 is not supported in rancher.
211 +{{/box}}
210 210  )))
211 211  
212 -[[image:attach:image-2024-2-27_14-29-17.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="540"]]
214 +{{info}}
215 +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.**//
216 +{{/info}}
213 213  
218 +=== Deploy Helm charts ===
219 +
220 +Now go to Apps>Charts and filter if necessary for the devops-as-a-service Helm chart repository. Like shown below, a list of available charts is displayed. Simply click on one of the tiles to deploy them to your cluster.
221 +
222 +Please note that the jenkins-lib charts are only generated for testing purposes. It doesn't make sense to deploy them. Your Jenkins is automatically retrieving the Jenkinslib directly using [[Git>>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse||shape="rect"]].
223 +
224 +[[image:attach:image-2023-5-19_16-1-52.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1100"]]
225 +
226 +== Add private chart repository ==
227 +
228 +=== Create a robot account in Harbor ===
229 +
230 +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:
231 +
232 +* Read Artifact
233 +* Pull Repository
234 +
235 +(% id="HCreateAppRepositoryinRancher-1" class="p1" %)
236 +=== Create App Repository in Rancher ===
237 +
214 214  (% class="p1" %)
215 -Finally, click Create.
239 +In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu.
216 216  
217 -The repository is now listed:
241 +[[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"]]
218 218  
219 -[[image:Screenshot 2024-07-03 at 15.13.55.png||data-xwiki-image-style-border="true" height="149" width="785"]]
243 +(% class="p1" %)
244 +Create a new Repository by pressing the Create button.
220 220  
221 -==== Target: OCI Repository ====
246 +(% class="p1" id="HTarget:http28s29URL-1" %)
247 +[[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"]]
222 222  
223 -To add public oci-repository, navigate to repository create button and click it.
249 +(% id="HTarget:http28s29URL-1" class="p1" %)
250 +==== ====
224 224  
225 -[[image:1765207154466-828.png||height="298" width="821"]]
252 +{{info}}
253 +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.**//
254 +{{/info}}
226 226  
227 -In the "Repository: Create" dialog, simply fill in the following fields. Authentication is not required.
256 +(% class="p1" %)
257 +Choose OCI repository in Target and for url, use  ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chartname>##
228 228  
259 +(% class="box" %)
260 +(((
261 +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.
262 +)))
263 +
264 +(% class="p1" %)
265 +For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section.
266 +
267 +(% class="wikigeneratedid" %)
268 +[[image:1765208347952-345.36.18.png||height="449" width="849"]]
269 +
270 +(% class="wikigeneratedid" %)
271 +Click Create.
272 +
229 229  (% class="wrapped" %)
230 230  |=(((
231 231  Field
... ... @@ -235,69 +235,105 @@
235 235  |=(((
236 236  Name
237 237  )))|(((
238 -devopsaas-jenkins-auto-agent
282 +sdcloud-sdportal
239 239  )))
240 240  |=(((
241 241  Description
242 242  )))|(((
243 -Public Helm charts as documented at [[https:~~/~~/docs.devops.t-systems.net>>url:https://docs.devops.t-systems.net||shape="rect"]]
287 +Sdportal charts of sdcloud project
244 244  )))
245 245  |=(((
246 246  Index URL
247 247  )))|(((
248 -oci:[[~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas-helm/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]]chartname, for example:
292 +oci:~/~/registry.sdc.t-systems.net/sdcloud-helm/sdportal
249 249  
250 -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]]
251 -)))
252 -
253 253  {{info}}
254 -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.
295 +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.
255 255  {{/info}}
297 +)))
256 256  
257 -=== Deploy Helm charts ===
299 +== Migrating chart repositories in rancher to new OCI Repository format ==
258 258  
259 -Now go to Apps>Charts and filter if necessary for the devops-as-a-service Helm chart repository. Like shown below, a list of available charts is displayed. Simply click on one of the tiles to deploy them to your cluster.
301 +(% class="box warningmessage" %)
302 +(((
303 +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)**.
304 +)))
260 260  
261 -Please note that the jenkins-lib charts are only generated for testing purposes. It doesn't make sense to deploy them. Your Jenkins is automatically retrieving the Jenkinslib directly using [[Git>>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse||shape="rect"]].
306 +(% class="box" %)
307 +(((
308 +**All your charts are available in the corresponding  `<pkey>-helm` OCI project.**
309 +)))
262 262  
263 -[[image:attach:image-2023-5-19_16-1-52.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1100"]]
311 +There are two ways to migrate your repositories:
264 264  
265 -== Add private chart repository ==
313 +1. ##Direct Transition (Editing the Existing Repository)##
314 +1*. Change the target to “OCI Repository”.
315 +1*. Update the URL as required (the repository name cannot be changed) and add a new robot account for hel, check documentation above
316 +1*. After saving, installed apps will automatically start using the updated repository.
317 +1*. (% class="box" %)
318 +(((
319 +Important limitation: OCI repositories must point directly to a single chart repository, not to a parent folder.
320 +If your old repository included several charts (for example “bitbucket” and “jira”), then after switching to OCI you can only target one chart (e.g. “bitbucket”).
321 +The other charts will no longer receive updates through this repo, and you will still need to create additional repositories for each individual chart.
322 +)))
323 +1. Add New Repositories One by One (Recommended), preserve the old one till the end. This approach allows a smooth transition while the old ChartMuseum repository continues to function. You can:
324 +1*. Create a new OCI repository for each chart,
325 +1*. Keep the old ChartMuseum repo enabled during the migration,
326 +1*. Migrate applications gradually following the steps described here.
327 +1*. This avoids disruptions and allows controlled migration.
328 +
329 +1. //Special Case: Old Repo Targeting Multiple Chart Repos//
330 +If your existing repository targets multiple chart repositories and you need the new OCI setup to behave the same way, please **contact support.**
266 266  
332 +To ensure a smooth transition, we recommend to **add an OCI-based repository alongside the existing ChartMuseum repository** during the migration phase. If you don't w
267 267  
268 -=== Create a robot account in Harbor ===
334 +| Term | Meaning
335 +| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository.
336 +| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`).
269 269  
270 -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:
338 +##__**Why This Migration Is Required:**__##
271 271  
272 -* Read Helm Chart
273 -* Pull Repository
340 +* ##ChartMuseum is deprecated and will be removed.##
341 +* ##Applications deployed from old repos keep a reference to that repo inside their labels.##
342 +* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.##
274 274  
275 -(% id="HCreateAppRepositoryinRancher-1" class="p1" %)
276 -=== Create App Repository in Rancher ===
344 +## Migration Steps:##
277 277  
278 -(% class="p1" %)
279 -In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu.
280 -[[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"]]
346 +1. ##Create the New OCI Repository in Rancher##
347 +11. Go to **Apps → Repositories**.
348 +11. Add a new repository of type **OCI**.
349 +11. Name it similarly to your old repo name (e.g. `<chart-repo-name>-oci`). __**You can't name it the same and can't rename it later.**__
350 +11. Point it to the new OCI endpoint.
351 +1. ##Disable the Old ChartMuseum Repository Temporarily## 
352 +##This step ensures that Rancher resolves charts from the new OCI repo.##
353 +11. Go to **Apps → Repositories**.
354 +11. Disable the old HTTP(S)-based repository.
355 +11. Keep it disabled until the migration is done.
356 +[[image:1765548124989-482.59.06.png||height="152" width="485"]]
357 +1. ##Update Existing Applications to Use the New OCI Repo##
358 +Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition.
359 +11. Go to **Apps → Installed Apps**.
360 +11. Open the application that was deployed using the old repo.
361 +11. Click **Edit/Upgrade**.
362 +[[image:1765548598644-830.png||height="138" width="811"]]
363 +11. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**. Or enter the chart name in search bar:
364 +[[image:1765548750604-334.png||height="293" width="308"]]
365 +11. Choose the chart version you want to deploy (same or newer).
366 +11. Click **Upgrade**.
367 +1. ##Re-enable the Old Repository (Optional) ##
368 +If you still need the old repo for other apps, re-enable it after the migration steps above.
369 +**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
281 281  
282 -(% class="p1" %)
283 -Create a new Repository by pressing the Create button.
371 +##If you want to move an app back to the old repository:##
284 284  
285 -(% class="p1" %)
286 -[[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"]]
287 -\\A name for the Repository has to be set. In the screenshot, the project name CITEST is used, which corresponds to our example from above.
288 -Choose http(s) URL to an index generated by Helm and provide the Index URL ##https:~/~/registry-<domain>.devops.t-systems.net/chartrepo/<project>/##
373 +1. Temporarily disable the new OCI repo.
374 +1. Enable the old ChartMuseum repo.
375 +1. Open the application → **Upgrade**.
376 +1. Select the chart from the old repo.
377 +1. Save.
289 289  
290 -(% class="p1" %)
291 -Replace ##<domain>## and ##<project>## as necessary to match your set-up.
379 +This will reconnect the app to the old repository.
292 292  
293 -(% class="p1" %)
294 -For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section.
295 -[[image:attach:Screenshot 2023-04-26 at 18.10.15.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="468" width="1100"]]
296 -
297 -(% class="p1" %)
298 -Click Create.
299 -
300 -
301 301  = Automated deployments with Jenkins =
302 302  
303 303  In this section, we describe(% style="color:#172b4d" %) how to set-up **automated builds, tests and deployments** for Jenkins.
1765208347952-345.36.18.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dianastrebkovat-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +199.3 KB
Content
1765548124989-482.59.06.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dianastrebkovat-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +64.4 KB
Content
1765548598644-830.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dianastrebkovat-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +153.4 KB
Content
1765548750604-334.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dianastrebkovat-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +103.0 KB
Content
© 2018-2026 T-Systems International GmbH