From 84ba9d55e2805c60df429ad12b642b758168e451 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 16 Aug 2021 11:05:15 -0700 Subject: [PATCH] pkg/cli/admin/upgrade/upgrade: Copy edits, including "assists with cluster upgrades" The previous: This command will request that the cluster begin an upgrade... and similar confused some readers [1], because the no-argument invocation is just a read query that does not request an update. This commit makes the wording more generic, to match the subcommand's actual generic functionality (reading from and optionally writing to ClusterVersion). I've also tweaked the "No updates available" message to avoid folks misreading as: ... doing so may not... result in downtime or data loss. when we are trying to convey that updating despite a lack of recommendations might be dangerous. In both cases, the wording I'm altering dates back to the creation of this subcommand in cd30f2f864 (Add `oc adm upgrade` to display available updates or trigger an update, 2018-12-04, openshift/origin#21605). [1]: https://bugzilla.redhat.com/show_bug.cgi?id=1992680#c2 --- pkg/cli/admin/upgrade/upgrade.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/cli/admin/upgrade/upgrade.go b/pkg/cli/admin/upgrade/upgrade.go index 0aae5f8449..2bbf9da0af 100644 --- a/pkg/cli/admin/upgrade/upgrade.go +++ b/pkg/cli/admin/upgrade/upgrade.go @@ -38,9 +38,9 @@ func New(f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command Use: "upgrade --to=VERSION", Short: "Upgrade a cluster", Long: templates.LongDesc(` - Upgrade the cluster to a newer version + Check on upgrade status or upgrade the cluster to a newer version - This command will request that the cluster begin an upgrade. If no arguments are passed + This command assists with cluster upgrades. If no arguments are passed the command will retrieve the current version info and display whether an upgrade is in progress or whether any errors might prevent an upgrade, as well as show the suggested updates available to the cluster. Information about compatible updates is periodically @@ -363,7 +363,7 @@ func (o *Options) Run() error { if c := findCondition(cv.Status.Conditions, configv1.RetrievedUpdates); c != nil && c.Status == configv1.ConditionFalse { fmt.Fprintf(o.ErrOut, "warning: Cannot display available updates:\n Reason: %s\n Message: %s\n\n", c.Reason, c.Message) } else { - fmt.Fprintf(o.Out, "No updates available. You may force an upgrade to a specific release image, but doing so may not be supported and result in downtime or data loss.\n") + fmt.Fprintf(o.Out, "No updates available. You may force an upgrade to a specific release image, but doing so may not be supported and may result in downtime or data loss.\n") } }