|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * upgrading/rosa-hcp-upgrading.adoc |
| 4 | + |
| 5 | +:_mod-docs-content-type: PROCEDURE |
| 6 | +[id="rosa-hcp-upgrading-cli_{context}"] |
| 7 | += Upgrading with the ROSA CLI |
| 8 | + |
| 9 | +You can manually upgrade a {hcp-title} cluster by using the ROSA CLI. This method schedules the cluster for an immediate upgrade if a more recent version is available. |
| 10 | + |
| 11 | +[NOTE] |
| 12 | +==== |
| 13 | +Your control plane only supports machine pools within two minor Y-stream versions. For example, a {hcp-title} cluster with a control plane using version 4.15.z supports machine pools with version 4.13.z and 4.14.z, but the control plane does not support machine pools using version 4.12.z. |
| 14 | +==== |
| 15 | + |
| 16 | +.Prerequisites |
| 17 | + |
| 18 | +* You have installed and configured the latest version of the ROSA CLI. |
| 19 | +
|
| 20 | +.Procedure |
| 21 | + |
| 22 | +. Verify the current version of your cluster by running the following command: |
| 23 | ++ |
| 24 | +[source,terminal] |
| 25 | +---- |
| 26 | +$ rosa describe cluster --cluster=<cluster_name_or_id> <1> |
| 27 | +---- |
| 28 | +<1> Replace `<cluster_name_or_id>` with the cluster name or the cluster ID. |
| 29 | + |
| 30 | +. List the versions that you can upgrade your control plane and machine pools to by running the following commands: |
| 31 | ++ |
| 32 | +.. For the control plane versions, run the following command: |
| 33 | ++ |
| 34 | +[source,terminal] |
| 35 | +---- |
| 36 | +$ rosa list upgrade --cluster=<cluster_name|cluster_id> |
| 37 | +---- |
| 38 | ++ |
| 39 | +The command returns a list of available updates, including the recommended version. |
| 40 | ++ |
| 41 | +.Example output |
| 42 | ++ |
| 43 | +[source,terminal] |
| 44 | +---- |
| 45 | +VERSION NOTES |
| 46 | +4.14.8 recommended |
| 47 | +4.14.7 |
| 48 | +4.14.6 |
| 49 | +---- |
| 50 | ++ |
| 51 | +.. For the machine pool versions, run the following command: |
| 52 | ++ |
| 53 | +[source,terminal] |
| 54 | +---- |
| 55 | +$ rosa list upgrade --cluster <cluster-name> --machinepool <machinepool_name> |
| 56 | +---- |
| 57 | ++ |
| 58 | +The command returns a list of available updates, including the recommended version. |
| 59 | ++ |
| 60 | +.Example output |
| 61 | ++ |
| 62 | +[source,terminal] |
| 63 | +---- |
| 64 | +VERSION NOTES |
| 65 | +4.14.5 recommended |
| 66 | +4.14.4 |
| 67 | +4.14.3 |
| 68 | +4.14.2 |
| 69 | +4.14.1 |
| 70 | +---- |
| 71 | ++ |
| 72 | +[NOTE] |
| 73 | +==== |
| 74 | +The latest available update for machine pools is limited to the current current version of the control plane. Ensure your control plane is up to date first. |
| 75 | +==== |
| 76 | + |
| 77 | +. Upgrade your cluster with one of the following options: |
| 78 | +** Upgrade the cluster's hosted control plane by running the following command: |
| 79 | ++ |
| 80 | +[source,terminal] |
| 81 | +---- |
| 82 | +$ rosa upgrade cluster -c <cluster_name> --control-plane [--schedule-date=XX --schedule-time=XX] [--version <version_number>] |
| 83 | +---- |
| 84 | ++ |
| 85 | +Your hosted control plane is now scheduled for an upgrade. |
| 86 | + |
| 87 | +** Upgrade a specific machine pool on your cluster by running the following command: |
| 88 | ++ |
| 89 | +[source,terminal] |
| 90 | +---- |
| 91 | +$ rosa upgrade machinepool -c <cluster_name> <your_machine_pool_id> [--schedule-date=XX --schedule-time=XX] [--version <version_number>] |
| 92 | +---- |
| 93 | ++ |
| 94 | +Your machine pool is now scheduled for an upgrade. |
| 95 | +// |
| 96 | +// ** Upgrade both the hosted control plane and all attached machine pools by running the following command: |
| 97 | +// + |
| 98 | +// [source,terminal] |
| 99 | +// ---- |
| 100 | +// $ rosa upgrade cluster -c <cluster_name> [--schedule-date=XX --schedule-time=XX] [--version <version_number>] |
| 101 | +// ---- |
| 102 | +// + |
| 103 | +// Your hosted control plane and machine pools are now scheduled for an upgrade. |
| 104 | + |
| 105 | +.Troubleshooting |
| 106 | +* Sometimes a scheduled upgrade does not initiate. See link:https://access.redhat.com/solutions/6648291[Upgrade maintenance cancelled] for more information. |
0 commit comments