Changes for page Rancher 2
Last modified by Diana Strebkova on 2025/12/12 14:23
From version 14.2
edited by Diana Strebkova
on 2025/12/12 13:35
on 2025/12/12 13:35
Change comment:
There is no comment for this version
To version 11.1
edited by Diana Strebkova
on 2025/12/12 12:08
on 2025/12/12 12:08
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -281,6 +281,7 @@ 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 283 284 +(% class="p1" %) 284 284 285 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"]] 286 286 ... ... @@ -335,6 +335,7 @@ 335 335 (% class="wikigeneratedid" %) 336 336 Click Create. 337 337 339 + 338 338 (% class="wrapped" %) 339 339 |=((( 340 340 Field ... ... @@ -363,95 +363,103 @@ 363 363 364 364 === Migrating chart repositories in rancher to new OCI Repository format === 365 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 -))) 368 +# Migration Guide: ChartMuseum → OCI-based Chart Repositories in Rancher 370 370 371 -There are two ways to migrate your repositories: 370 +## Overview 371 +ChartMuseum is being deprecated. After the migration is complete, **all charts will be removed from ChartMuseum**, and **old HTTP(S)-based chart repositories will no longer work in Rancher**. 372 372 373 -1. ##Direct Transition (Editing the Existing Repository)## 374 -11. Change the target to “OCI Repository”. 375 -11. (% class="box" %) 376 -((( 377 -Update the URL as required (the repository name cannot be changed). 378 -After saving, installed apps will automatically start using the updated repository. 379 -Important limitation: OCI repositories must point directly to a single chart repository, not to a parent folder. 380 -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”). 381 -The other charts will no longer receive updates through this repo, and you will still need to create additional repositories for each individual chart. 382 -))) 383 -1. Add New Repositories One by One (Recommended) 373 +To ensure a smooth transition, each project should **add an OCI-based repository alongside the existing ChartMuseum repository** during the migration phase. 384 384 385 -This approach allows a smooth transition while the old ChartMuseum repository continues to function. 386 -You can: 375 +We will make your charts available in the corresponding new `<pkey>-helm` OCI projects. 387 387 388 -* Create a new OCI repository for each chart, 389 -* Keep the old ChartMuseum repo enabled during the migration, 390 -* Migrate applications gradually following the steps described in the main migration guide. 377 +--- 391 391 392 -This avoids disruptions and allows controlled migration. 379 +## Terminology 380 +| Term | Meaning | 381 +|------|---------| 382 +| **Old Repository** | The existing HTTP/HTTPS ChartMuseum repository. | 383 +| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`). | 393 393 394 - Special Case: Old Repo Targeting Multiple Chart Repos385 +--- 395 395 396 -If your existing repository targets multiple chart repositories and you need the new OCI setup to behave the same way, please contact support. OCI does not support multi-chart endpoints within a single repository, and we can help you find an appropriate solution. 387 +## Why This Migration Is Required 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**. 397 397 398 - 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 w392 +--- 399 399 400 -(% class="box" %) 401 -((( 402 -**We will make your charts available in the corresponding new `<pkey>-helm` OCI projects.** 403 -))) 394 +## Migration Steps 404 404 405 -| Term | Meaning 406 -| **Old Repository** | The existing HTTP/HTTPS Harbor ChartMuseum repository. 407 -| **New Repository** | The new OCI-based Helm chart repository created for your project (e.g. `<chart-repo-name>` in `<pkey>-helm`). 396 +### 1. Create the New OCI Repository in Rancher 397 +1. Go to **Apps → Repositories**. 398 +2. Add a new repository of type **OCI**. 399 +3. Name it exactly like your old repo name (e.g. `<chart-repo-name>`). 400 +4. Point it to the new OCI endpoint. 408 408 409 - ##__**Why This Migration Is Required:**__##402 +--- 410 410 411 -* ##ChartMuseum is deprecated and will be removed.## 412 -* ##Applications deployed from old repos keep a reference to that repo inside their labels.## 413 -* ##Without updating the application to point to the new OCI repo, **Rancher will not detect new chart versions from new repository**.## 404 +### 2. Disable the Old ChartMuseum Repository Temporarily 405 +This step ensures that Rancher resolves charts from the new OCI repo. 414 414 415 -## Migration Steps:## 407 +1. Go to **Apps → Repositories**. 408 +2. Disable the old HTTP(S)-based repository. 409 +3. Keep it disabled until the migration is done. 416 416 417 -1. ##Create the New OCI Repository in Rancher## 418 -11. Go to **Apps → Repositories**. 419 -11. Add a new repository of type **OCI**. 420 -11. Name it similarly to your old repo name (e.g. `<chart-repo-name>-oci`). You can't name it the same. 421 -11. Point it to the new OCI endpoint. 422 -1. ##Disable the Old ChartMuseum Repository Temporarily## 423 -##This step ensures that Rancher resolves charts from the new OCI repo.## 424 -11. Go to **Apps → Repositories**. 425 -11. Disable the old HTTP(S)-based repository. 426 -11. Keep it disabled until the migration is done. 427 -1. ##Update Existing Applications to Use the New OCI Repo## 428 -Applications deployed with the old repository still contain the old repo name in their metadata. You must upgrade them once to transition. 429 -11. Go to **Apps → Installed Apps**. 430 -11. Open the application that was deployed using the old repo. 431 -11. Click **Upgrade**. 432 -11. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**. 433 -11. Choose the chart version you want to deploy (same or newer). 434 -11. Click **Upgrade**. 435 -1. ##Re-enable the Old Repository (Optional) ## 411 +--- 412 + 413 +### 3. Update Existing Applications to Use the New OCI Repo 414 +Applications deployed with the old repository still contain the old repo name in their metadata. 415 +You must upgrade them once to transition. 416 + 417 +1. Go to **Apps → Installed Apps**. 418 +2. Open the application that was deployed using the old repo. 419 +3. Click **Upgrade**. 420 +4. In the list of available chart repositories (scroll to the bottom), select the **new OCI repository**. 421 +5. Choose the chart version you want to deploy (same or newer). 422 +6. Click **Upgrade**. 423 + 424 +After this upgrade: 425 +- Your application is now linked to the **new OCI repository**. 426 +- Rancher will show upgrade notifications only for versions available in the new repo. 427 + 428 +--- 429 + 430 +### 4. Re-enable the Old Repository (Optional) 436 436 If you still need the old repo for other apps, re-enable it after the migration steps above. 437 -**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 438 438 439 - ----433 +> 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. 440 440 441 -## Reverting the Migration (If Needed) 442 -If you want to move an app back to the old repository:## 435 +--- 443 443 437 +## Reverting the Migration (If Needed) 438 +If you want to move an app back to the old repository: 444 444 1. Temporarily disable the new OCI repo. 445 - 1. Enable the old ChartMuseum repo.446 - 1. Open the application → **Upgrade**.447 - 1. Select the chart from the old repo.448 - 1. Save.440 +2. Enable the old ChartMuseum repo. 441 +3. Open the application → **Upgrade**. 442 +4. Select the chart from the old repo. 443 +5. Save. 449 449 450 450 This will reconnect the app to the old repository. 451 451 452 -= 453 -Automated deployments with Jenkins = 447 +--- 454 454 449 +## Summary 450 +- Add new OCI repo → disable old repo → upgrade apps → reconnect to OCI repo. 451 +- After upgrade, apps no longer track versions from the old repository. 452 +- Old repository will stop functioning after ChartMuseum shutdown, so migration is required. 453 + 454 +--- 455 + 456 +If you want, I can also generate: 457 +- a shorter version (1-pager), 458 +- a diagram, 459 +- a Rancher UI screenshot guide, 460 +- or a version tailored for your team’s internal wiki. 461 + 462 + 463 += Automated deployments with Jenkins = 464 + 455 455 In this section, we describe(% style="color:#172b4d" %) how to set-up **automated builds, tests and deployments** for Jenkins. 456 456 457 457 == Prerequisites ==