mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
239 lines
4.9 KiB
Plaintext
239 lines
4.9 KiB
Plaintext
|
|
// Module included in the following assemblies:
|
|
//
|
|
// * rosa_cli/rosa-manage-objects-cli.adoc
|
|
:_mod-docs-content-type: REFERENCE
|
|
[id="rosa-upgrading-cluster_{context}"]
|
|
= Upgrade and delete upgrade for objects
|
|
|
|
This section describes the `upgrade` command usage for objects.
|
|
|
|
[id="rosa-upgrade-cluster_{context}"]
|
|
== upgrade cluster
|
|
|
|
Schedule a cluster upgrade.
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--cluster
|
|
|Required: The name or ID (string) of the cluster that the upgrade will be scheduled for.
|
|
|
|
|--interactive
|
|
|Enables interactive mode.
|
|
|
|
|--version
|
|
|The version (string) of OpenShift Container Platform that the cluster will be upgraded to.
|
|
|
|
|--schedule-date
|
|
|The next date (string) when the upgrade will run at the specified time in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd`
|
|
|
|
|--schedule-time
|
|
|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm`
|
|
ifdef::openshift-rosa[]
|
|
|--node-drain-grace-period
|
|
|Sets a grace period (string) for how long the pod disruption budget-protected workloads are respected during upgrades. After this grace period, any workloads protected by pod disruption budgets that have not been successfully drained from a node will be forcibly evicted. Default: `1 hour`
|
|
endif::openshift-rosa[]
|
|
ifdef::openshift-rosa-hcp[]
|
|
|--control-plane
|
|
|Upgrades the cluster's hosted control plane.
|
|
endif::openshift-rosa-hcp[]
|
|
|===
|
|
|
|
|
|
.Optional arguments inherited from parent commands
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--help
|
|
|Shows help for this command.
|
|
|===
|
|
|
|
.Examples
|
|
Interactively schedule an upgrade on a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade cluster --cluster=mycluster --interactive
|
|
----
|
|
|
|
Schedule a cluster upgrade within the hour on a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
|
|
----
|
|
|
|
[id="rosa-delete-upgrade-cluster_{context}"]
|
|
== delete cluster upgrade
|
|
|
|
Cancel a scheduled cluster upgrade.
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--cluster
|
|
|Required: The name or ID (string) of the cluster that the upgrade will be cancelled for.
|
|
|===
|
|
|
|
.Optional arguments inherited from parent commands
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--help
|
|
|Shows help for this command.
|
|
|
|
|--debug
|
|
|Enables debug mode.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
ifdef::openshift-rosa-hcp[]
|
|
[id="rosa-upgrade-machinepool_{context}"]
|
|
== upgrade machinepool
|
|
|
|
Upgrades a specific machine pool configured on a {product-title} cluster.
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--cluster
|
|
|Required: The name or ID (string) of the cluster.
|
|
|
|
|--schedule-date
|
|
|The next date (string) when the upgrade will run at the specified time in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd`
|
|
|
|
|--schedule-time
|
|
|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm`
|
|
|
|
|===
|
|
|
|
.Optional arguments inherited from parent commands
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--help
|
|
|Shows help for this command.
|
|
|
|
|--debug
|
|
|Enables debug mode.
|
|
|
|
|--profile
|
|
|Specifies an AWS profile (string) from your credentials file.
|
|
|===
|
|
|
|
.Example
|
|
Upgrade a machine pool on a cluster named `mycluster`.
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade machinepool --cluster=mycluster
|
|
----
|
|
|
|
[id="rosa-delete-upgrade-machinepool_{context}"]
|
|
== delete machinepool upgrade
|
|
|
|
Cancel a scheduled machinepool upgrade.
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--cluster
|
|
|Required: The name or ID (string) of the cluster.
|
|
|===
|
|
|
|
.Optional arguments inherited from parent commands
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--help
|
|
|Shows help for this command.
|
|
|
|
|--debug
|
|
|Enables debug mode.
|
|
|
|
|--profile
|
|
|Specifies an AWS profile (string) from your credentials file.
|
|
|===
|
|
endif::openshift-rosa-hcp[]
|
|
//Per wgordon, rosa upgrade roles is not needed for HCP clusters
|
|
ifndef::openshift-rosa-hcp[]
|
|
[id="rosa-upgrade-roles_{context}"]
|
|
== upgrade roles
|
|
Upgrades roles configured on a cluster.
|
|
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade roles --cluster=<cluster_id>
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--cluster
|
|
|Required: The name or ID (string) of the cluster.
|
|
|===
|
|
|
|
.Optional arguments inherited from parent commands
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
|--help
|
|
|Shows help for this command.
|
|
|
|
|--debug
|
|
|Enables debug mode.
|
|
|
|
|--profile
|
|
|Specifies an AWS profile (string) from your credentials file.
|
|
|===
|
|
|
|
.Example
|
|
Upgrade roles on a cluster named `mycluster`.
|
|
[source,terminal]
|
|
----
|
|
$ rosa upgrade roles --cluster=mycluster
|
|
----
|
|
endif::openshift-rosa-hcp[]
|