Changes for page Rancher 2
Last modified by Diana Strebkova on 2025/12/12 14:23
From version 8.1
edited by Diana Strebkova
on 2025/12/08 15:42
on 2025/12/08 15:42
Change comment:
There is no comment for this version
To version 12.10
edited by Diana Strebkova
on 2025/12/12 13:12
on 2025/12/12 13:12
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
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. ... ... @@ -220,7 +220,7 @@ 220 220 221 221 ==== Target: OCI Repository ==== 222 222 223 -To add public oci-repository, navigate to repository create button and click it. 223 +To add public oci-repository, navigate to repository create button and click it. For target, use OCI Repository like shown below: 224 224 225 225 [[image:1765207154466-828.png||height="298" width="821"]] 226 226 ... ... @@ -245,13 +245,17 @@ 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:248 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/**<chartname>**, for example: 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]] 250 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/jenkins-lib 251 + 252 +{{info}} 253 +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. 254 +{{/info}} 251 251 ))) 252 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. 258 +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.**// 255 255 {{/info}} 256 256 257 257 === Deploy Helm charts === ... ... @@ -264,7 +264,6 @@ 264 264 265 265 == Add private chart repository == 266 266 267 - 268 268 === Create a robot account in Harbor === 269 269 270 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: ... ... @@ -277,6 +277,8 @@ 277 277 278 278 (% class="p1" %) 279 279 In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu. 283 + 284 + 280 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"]] 281 281 282 282 (% class="p1" %) ... ... @@ -285,12 +285,11 @@ 285 285 (% id="HTarget:http28s29URL-1" class="p1" %) 286 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 287 288 -(% class="p1" %) 289 -==== 290 -Target: http(s) URL ==== 293 +(% id="HTarget:http28s29URL-1" class="p1" %) 294 +==== Target: http(s) URL ==== 291 291 292 292 {{warning title="Chartmuseum Deprecation"}} 293 -Chartmuseum in Harbor is deprecated, meaning we won't be able to add repositories to Rancher that way anymore. Instead use Target: OCI repository. 297 +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. 294 294 {{/warning}} 295 295 296 296 (% class="p1" %) ... ... @@ -307,17 +307,20 @@ 307 307 (% class="p1" %) 308 308 Click Create. 309 309 314 +(% id="HTarget:OCIRepository-1" class="p1" %) 310 310 ==== Target: OCI Repository ==== 311 311 312 312 {{info}} 313 -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. 318 +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.**// 314 314 {{/info}} 315 315 316 316 (% class="p1" %) 317 -Choose OCI repository in Target and for url, use ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chatname>## 322 +Choose OCI repository in Target and for url, use ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chartname>## 318 318 319 -(% class="p1" %) 320 -Replace ##<domain>## , ##<project>## and ##<chatname> ##as necessary to match your set-up. 324 +(% class="box" %) 325 +((( 326 +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. 327 +))) 321 321 322 322 (% class="p1" %) 323 323 For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section. ... ... @@ -328,8 +328,101 @@ 328 328 (% class="wikigeneratedid" %) 329 329 Click Create. 330 330 331 -= Automated deployments with Jenkins = 338 +(% class="wrapped" %) 339 +|=((( 340 +Field 341 +)))|=((( 342 +Value 343 +))) 344 +|=((( 345 +Name 346 +)))|((( 347 +sdcloud-sdportal 348 +))) 349 +|=((( 350 +Description 351 +)))|((( 352 +Sdportal charts of sdcloud project 353 +))) 354 +|=((( 355 +Index URL 356 +)))|((( 357 +oci:~/~/registry.sdc.t-systems.net/sdcloud-helm/sdportal 332 332 359 +{{info}} 360 +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. 361 +{{/info}} 362 +))) 363 + 364 +=== Migrating chart repositories in rancher to new OCI Repository format === 365 + 366 +(% class="box warningmessage" %) 367 +((( 368 +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)**. 369 +))) 370 + 371 +There are 2 ways to "migrate" the repos: 372 + 373 +1. You can do t transition and edit already existing repository – choose //Target: OCI repository, //adapt the url (__repo name can't be changed__), then the installed apps will pick app the repo change automatically. The problem is that the OCI repository recommends to target chart repos in the url, not the whole folder anymore. That means if you deployed previously different apps using the old repo, for example "bitbucket" and "jira", now you can only target one repo, for example "bitbucket", you will still need to create a new repo targeting "jira". 374 +1. 375 + 376 +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 377 + 378 +(% class="box" %) 379 +((( 380 +**We will make your charts available in the corresponding new `<pkey>-helm` OCI projects.** 381 +))) 382 + 383 +| Term | Meaning 384 +| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository. 385 +| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`). 386 + 387 +##__**Why This Migration Is Required:**__## 388 + 389 +* ##ChartMuseum is deprecated and will be removed.## 390 +* ##Applications deployed from old repos keep a reference to that repo inside their labels.## 391 +* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.## 392 + 393 +## Migration Steps:## 394 + 395 +1. ##Create the New OCI Repository in Rancher## 396 +11. Go to **Apps → Repositories**. 397 +11. Add a new repository of type **OCI**. 398 +11. Name it similarly to your old repo name (e.g. `<chart-repo-name>-oci`). You can't name it the same. 399 +11. Point it to the new OCI endpoint. 400 +1. ##Disable the Old ChartMuseum Repository Temporarily## 401 +##This step ensures that Rancher resolves charts from the new OCI repo.## 402 +11. Go to **Apps → Repositories**. 403 +11. Disable the old HTTP(S)-based repository. 404 +11. Keep it disabled until the migration is done. 405 +1. ##Update Existing Applications to Use the New OCI Repo## 406 +Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition. 407 +11. Go to **Apps → Installed Apps**. 408 +11. Open the application that was deployed using the old repo. 409 +11. Click **Upgrade**. 410 +11. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**. 411 +11. Choose the chart version you want to deploy (same or newer). 412 +11. Click **Upgrade**. 413 +1. ##Re-enable the Old Repository (Optional) ## 414 +If you still need the old repo for other apps, re-enable it after the migration steps above. 415 +**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 416 + 417 +---- 418 + 419 +## Reverting the Migration (If Needed) 420 +If you want to move an app back to the old repository:## 421 + 422 +1. Temporarily disable the new OCI repo. 423 +1. Enable the old ChartMuseum repo. 424 +1. Open the application → **Upgrade**. 425 +1. Select the chart from the old repo. 426 +1. Save. 427 + 428 +This will reconnect the app to the old repository. 429 + 430 += 431 +Automated deployments with Jenkins = 432 + 333 333 In this section, we describe(% style="color:#172b4d" %) how to set-up **automated builds, tests and deployments** for Jenkins. 334 334 335 335 == Prerequisites ==