Changes for page Rancher 2
Last modified by Diana Strebkova on 2026/04/20 09:21
From version 4.3
edited by Diana Strebkova
on 2025/12/08 15:21
on 2025/12/08 15:21
Change comment:
There is no comment for this version
To version 27.1
edited by Diana Strebkova
on 2026/04/20 09:20
on 2026/04/20 09:20
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 4 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -158,10 +158,6 @@ 158 158 159 159 == Add public helm chart == 160 160 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. 163 -{{/warning}} 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. 166 166 167 167 (% id="HCreateAppRepositoryinRancher" class="p1" %) ... ... @@ -177,17 +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 -==== ==== 176 +To add public oci-repository, navigate to repository create button and click it. For target, use OCI Repository like shown below: 182 182 183 -(% id="HTarget:http28s29URL" class="p1" %) 184 -==== Target: http(s) URL ==== 178 +[[image:1765207154466-828.png||height="298" width="821"]] 185 185 186 -{{warning}} 187 -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 188 -{{/warning}} 189 - 190 -(% class="p1" %) 191 191 In the "Repository: Create" dialog, simply fill in the following fields. Authentication is not required. 192 192 193 193 (% class="wrapped" %) ... ... @@ -199,7 +199,7 @@ 199 199 |=((( 200 200 Name 201 201 )))|((( 202 -devops -as-a-service191 +devopsaas-jenkins-auto-agent 203 203 ))) 204 204 |=((( 205 205 Description ... ... @@ -209,28 +209,74 @@ 209 209 |=((( 210 210 Index URL 211 211 )))|((( 212 -[[https:~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]] 201 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/**<chartname>**, for example: 202 + 203 +oci:~/~/registry.sdc.t-systems.net/devopsaas-helm/jenkins-auto-agent 204 + 205 +{{box}} 206 +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. 207 +{{/box}} 213 213 ))) 214 214 215 -[[image:attach:image-2024-2-27_14-29-17.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="540"]] 210 +{{info}} 211 +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.**// 212 +{{/info}} 216 216 214 +=== Deploy Helm charts === 215 + 216 +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. 217 + 218 +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"]]. 219 + 220 +[[image:attach:image-2023-5-19_16-1-52.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1100"]] 221 + 222 +== Add private chart repository == 223 + 224 +=== Create a robot account in Harbor === 225 + 226 +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: 227 + 228 +* Read Artifact 229 +* Pull Repository 230 + 231 +(% id="HCreateAppRepositoryinRancher-1" class="p1" %) 232 +=== Create App Repository in Rancher === 233 + 217 217 (% class="p1" %) 218 - Finally, clickCreate.235 +In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu. 219 219 220 - Therepositoryisnowlisted:237 +[[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"]] 221 221 222 -[[image:Screenshot 2024-07-03 at 15.13.55.png||data-xwiki-image-style-border="true" height="149" width="785"]] 239 +(% class="p1" %) 240 +Create a new Repository by pressing the Create button. 223 223 242 +(% class="p1" id="HTarget:http28s29URL-1" %) 243 +[[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"]] 244 + 245 +(% id="HTarget:http28s29URL-1" class="p1" %) 224 224 ==== ==== 225 225 226 -==== Target: OCI Repository ==== 248 +{{info}} 249 +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.**// 250 +{{/info}} 227 227 228 -To add public oci-repository, navigate to repository create button and click it. 252 +(% class="p1" %) 253 +Choose OCI repository in Target and for url, use ##oci:~/~/registry-<domain>.devops.t-systems.net/<project>-helm/<chartname>## 229 229 230 -[[image:1765207154466-828.png||height="298" width="821"]] 255 +(% class="box" %) 256 +((( 257 +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. 258 +))) 231 231 232 -In the "Repository: Create" dialog, simply fill in the following fields. Authentication is not required. 260 +(% class="p1" %) 261 +For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section. 233 233 263 +(% class="wikigeneratedid" %) 264 +[[image:1765208347952-345.36.18.png||height="449" width="849"]] 265 + 266 +(% class="wikigeneratedid" %) 267 +Click Create. 268 + 234 234 (% class="wrapped" %) 235 235 |=((( 236 236 Field ... ... @@ -240,69 +240,103 @@ 240 240 |=((( 241 241 Name 242 242 )))|((( 243 -d evops-as-a-service-helm278 +sdcloud-sdportal 244 244 ))) 245 245 |=((( 246 246 Description 247 247 )))|((( 248 - PublicHelmchartsas documentedat [[https:~~/~~/docs.devops.t-systems.net>>url:https://docs.devops.t-systems.net||shape="rect"]]283 +Sdportal charts of sdcloud project 249 249 ))) 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, for example:288 +oci:~/~/registry.sdc.t-systems.net/sdcloud-helm/sdportal 254 254 255 -oci:[[~~/~~/registry.sdc.t-systems.net/chartrepo/devopsaas-helm/>>url:https://registry.sdc.t-systems.net/chartrepo/devopsaas/||shape="rect"]][[jenkins-lib>>url:https://registry-manoni.devops.t-systems.net/harbor/projects/139/repositories/jenkins-lib]] 256 -))) 257 - 258 258 {{info}} 259 -Now allhelmchartsare accessibleinharborfolderswith -helmsuffix. Addingthe whole projectdoesn'tworknatively anymore,so eachseparatechartshouldbeaddedas a separaterepo.291 +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. 260 260 {{/info}} 293 +))) 261 261 262 -== =Deploy Helmcharts ===295 +== Migrating chart repositories in rancher to new OCI Repository format == 263 263 264 -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. 297 +(% class="box warningmessage" %) 298 +((( 299 +ChartMuseum is deprecated. **All harbor charts are removed from ChartMuseum**, and **old HTTP(S)-based chart repositories no longer work in Rancher (for internal harbor charts)**. 300 +))) 265 265 266 -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"]]. 302 +(% class="box" %) 303 +((( 304 +**All your charts are available in the corresponding `<pkey>-helm` OCI project.** 305 +))) 267 267 268 - [[image:attach:image-2023-5-19_16-1-52.png||data-xwiki-image-style-border="true"queryparams="effects=drop-shadow" width="1100"]]307 +There are two ways to migrate your repositories: 269 269 270 -== Add private chart repository == 309 +1. ##Direct Transition (Editing the Existing Repository)## 310 +1*. Change the target to “OCI Repository”. 311 +1*. Update the URL as required (the repository name cannot be changed) and add a new robot account for helm project, check documentation above 312 +1*. After saving, installed apps will automatically start using the updated repository. 313 +1*. (% class="box" %) 314 +((( 315 +Important limitation: OCI repositories must point directly to a single chart repository, not to a parent folder. 316 +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”). 317 +The other charts will no longer receive updates through this repo, and you will still need to create additional repositories for each individual chart. 318 +))) 319 +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: 320 +1*. Create a new OCI repository for each chart, 321 +1*. Keep the old ChartMuseum repo enabled during the migration, 322 +1*. Migrate applications gradually following the steps described here. 323 +1*. This avoids disruptions and allows controlled migration. 324 + 325 +1. //Special Case: Old Repo Targeting Multiple Chart Repos// 326 +If your existing repository targets multiple chart repositories and you need the new OCI setup to behave the same way, please **contact support.** 271 271 328 +| Term | Meaning 329 +| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository. 330 +| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`). 272 272 273 - ===CreatearobotaccountinHarbor===332 +##__**Why This Migration Is Required:**__## 274 274 275 -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: 334 +* ##ChartMuseum is deprecated.## 335 +* ##Applications deployed from old repos keep a reference to that repo inside their labels.## 336 +* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.## 276 276 277 -* Read Helm Chart 278 -* Pull Repository 338 +## Migration Steps:## 279 279 280 -(% id="HCreateAppRepositoryinRancher-1" class="p1" %) 281 -=== Create App Repository in Rancher === 340 +1. ##Create the New OCI Repository in Rancher## 341 +11. Go to **Apps → Repositories**. 342 +11. Add a new repository of type **OCI**. 343 +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.**__ 344 +11. Point it to the new OCI endpoint. 345 +1. ##Disable the Old ChartMuseum Repository Temporarily## 346 +##This step ensures that Rancher resolves charts from the new OCI repo.## 347 +11. Go to **Apps → Repositories**. 348 +11. Disable the old HTTP(S)-based repository. 349 +11. Keep it disabled until the migration is done. 350 +[[image:1765548124989-482.59.06.png||height="152" width="485"]] 351 +1. ##Update Existing Applications to Use the New OCI Repo## 352 +Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition. 353 +11. Go to **Apps → Installed Apps**. 354 +11. Open the application that was deployed using the old repo. 355 +11. Click **Edit/Upgrade**. 356 +[[image:1765548598644-830.png||height="138" width="811"]] 357 +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: 358 +[[image:1765548750604-334.png||height="293" width="308"]] 359 +11. Choose the chart version you want to deploy (same or newer). 360 +11. Click **Upgrade**. 361 +1. ##Re-enable the Old Repository (Optional) ## 362 +If you still need the old repo for other apps, re-enable it after the migration steps above. 363 +**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 282 282 283 -(% class="p1" %) 284 -In Rancher UI, switch to the intended cluster and go to Apps/Repositories using the left side menu. 285 -[[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"]] 365 +##If you want to move an app back to the old repository:## 286 286 287 -(% class="p1" %) 288 -Create a new Repository by pressing the Create button. 367 +1. Temporarily disable the new OCI repo. 368 +1. Enable the old ChartMuseum repo. 369 +1. Open the application → **Upgrade**. 370 +1. Select the chart from the old repo. 371 +1. Save. 289 289 290 -(% 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 -\\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. 293 -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 +This will reconnect the app to the old repository. 294 294 295 -(% class="p1" %) 296 -Replace ##<domain>## and ##<project>## as necessary to match your set-up. 297 - 298 -(% class="p1" %) 299 -For Authentication, select "Create a HTTP Basic Auth Secret" and provide the Username and Password of the Harbor robot account from the previous section. 300 -[[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"]] 301 - 302 -(% class="p1" %) 303 -Click Create. 304 - 305 - 306 306 = Automated deployments with Jenkins = 307 307 308 308 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