Changes for page Rancher 2
Last modified by Diana Strebkova on 2025/12/12 14:23
From version 4.1
edited by Diana Strebkova
on 2025/12/08 15:19
on 2025/12/08 15:19
Change comment:
Uploaded new attachment "1765207154466-828.png", version {1}
To version 12.8
edited by Diana Strebkova
on 2025/12/12 13:05
on 2025/12/12 13:05
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 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. ... ... @@ -178,9 +178,6 @@ 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 180 (% id="H" class="p1" %) 181 -==== ==== 182 - 183 -(% id="HTarget:http28s29URL" class="p1" %) 184 184 ==== Target: http(s) URL ==== 185 185 186 186 {{warning}} ... ... @@ -221,13 +221,11 @@ 221 221 222 222 [[image:Screenshot 2024-07-03 at 15.13.55.png||data-xwiki-image-style-border="true" height="149" width="785"]] 223 223 224 -==== ==== 225 - 226 226 ==== Target: OCI Repository ==== 227 227 228 -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: 229 229 230 -[[image:1765207 032873-684.png||height="302" width="905"]]225 +[[image:1765207154466-828.png||height="298" width="821"]] 231 231 232 232 In the "Repository: Create" dialog, simply fill in the following fields. Authentication is not required. 233 233 ... ... @@ -240,7 +240,7 @@ 240 240 |=((( 241 241 Name 242 242 )))|((( 243 -devops -as-a-service-helm238 +devopsaas-jenkins-auto-agent 244 244 ))) 245 245 |=((( 246 246 Description ... ... @@ -250,11 +250,17 @@ 250 250 |=((( 251 251 Index URL 252 252 )))|((( 253 -oci:[[~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas-helm/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]]chartname 248 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/**<chartname>**, for example: 249 + 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}} 254 254 ))) 255 255 256 256 {{info}} 257 - Typeyour information message here.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.**// 258 258 {{/info}} 259 259 260 260 === Deploy Helm charts === ... ... @@ -267,7 +267,6 @@ 267 267 268 268 == Add private chart repository == 269 269 270 - 271 271 === Create a robot account in Harbor === 272 272 273 273 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: ... ... @@ -280,14 +280,25 @@ 280 280 281 281 (% class="p1" %) 282 282 In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu. 283 + 284 + 283 283 [[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"]] 284 284 285 285 (% class="p1" %) 286 286 Create a new Repository by pressing the Create button. 287 287 290 +(% id="HTarget:http28s29URL-1" class="p1" %) 291 +==== [[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"]] ==== 292 + 293 +(% id="HTarget:http28s29URL-1" class="p1" %) 294 +==== Target: http(s) URL ==== 295 + 296 +{{warning title="Chartmuseum Deprecation"}} 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. 298 +{{/warning}} 299 + 288 288 (% class="p1" %) 289 -[[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"]] 290 -\\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. 301 +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. 291 291 Choose http(s) URL to an index generated by Helm and provide the Index URL ##https:~/~/registry-<domain>.devops.t-systems.net/chartrepo/<project>/## 292 292 293 293 (% class="p1" %) ... ... @@ -300,9 +300,124 @@ 300 300 (% class="p1" %) 301 301 Click Create. 302 302 314 +(% id="HTarget:OCIRepository-1" class="p1" %) 315 +==== Target: OCI Repository ==== 303 303 304 -= Automated deployments with Jenkins = 317 +{{info}} 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.**// 319 +{{/info}} 305 305 321 +(% class="p1" %) 322 +Choose OCI repository in Target and for url, use ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chartname>## 323 + 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 +))) 328 + 329 +(% class="p1" %) 330 +For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section. 331 + 332 +(% class="wikigeneratedid" %) 333 +[[image:1765208347952-345.36.18.png||height="449" width="849"]] 334 + 335 +(% class="wikigeneratedid" %) 336 +Click Create. 337 + 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 358 + 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 the fast transition - edit already existing repository to choose Target: OCI repository, then the apps will pick app the change automatically. The only problem is that he OCI repositpry a 374 + 375 +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 376 + 377 +(% class="box" %) 378 +((( 379 +**We will make your charts available in the corresponding new `<pkey>-helm` OCI projects.** 380 +))) 381 + 382 +| Term | Meaning 383 +| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository. 384 +| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`). 385 + 386 +##__**Why This Migration Is Required:**__## 387 + 388 +* ##ChartMuseum is deprecated and will be removed.## 389 +* ##Applications deployed from old repos keep a reference to that repo inside their labels.## 390 +* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.## 391 + 392 +## Migration Steps:## 393 + 394 +1. ##Create the New OCI Repository in Rancher## 395 +11. Go to **Apps → Repositories**. 396 +11. Add a new repository of type **OCI**. 397 +11. Name it similarly to your old repo name (e.g. `<chart-repo-name>-oci`). You can't name it the same. 398 +11. Point it to the new OCI endpoint. 399 +1. ##Disable the Old ChartMuseum Repository Temporarily## 400 +##This step ensures that Rancher resolves charts from the new OCI repo.## 401 +11. Go to **Apps → Repositories**. 402 +11. Disable the old HTTP(S)-based repository. 403 +11. Keep it disabled until the migration is done. 404 +1. ##Update Existing Applications to Use the New OCI Repo## 405 +Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition. 406 +11. Go to **Apps → Installed Apps**. 407 +11. Open the application that was deployed using the old repo. 408 +11. Click **Upgrade**. 409 +11. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**. 410 +11. Choose the chart version you want to deploy (same or newer). 411 +11. Click **Upgrade**. 412 +1. ##Re-enable the Old Repository (Optional) ## 413 +If you still need the old repo for other apps, re-enable it after the migration steps above. 414 +**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 415 + 416 +---- 417 + 418 +## Reverting the Migration (If Needed) 419 +If you want to move an app back to the old repository:## 420 + 421 +1. Temporarily disable the new OCI repo. 422 +1. Enable the old ChartMuseum repo. 423 +1. Open the application → **Upgrade**. 424 +1. Select the chart from the old repo. 425 +1. Save. 426 + 427 +This will reconnect the app to the old repository. 428 + 429 += 430 +Automated deployments with Jenkins = 431 + 306 306 In this section, we describe(% style="color:#172b4d" %) how to set-up **automated builds, tests and deployments** for Jenkins. 307 307 308 308 == Prerequisites ==
- 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