gcloud: Thu Dec 14 10:23:57 UTC 2023

gcloud/container/hub/clusterupgrade/create

@@ -0,0 +1,93 @@
+NAME
+    gcloud container hub clusterupgrade create - create the clusterupgrade
+        feature for a fleet within a given project
+
+SYNOPSIS
+    gcloud container hub clusterupgrade create
+        [--default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING]
+        [--upstream-fleet=UPSTREAM_FLEET]
+        [--add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE
+          --upgrade-selector=[name=NAME],[version=VERSION]]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Create the clusterupgrade feature for a fleet within a given project.
+
+EXAMPLES
+    To create the clusterupgrade feature for the current fleet, run:
+
+        $ gcloud container hub clusterupgrade create \
+            --default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING
+
+FLAGS
+     --default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING
+        Configures the default soaking duration for each upgrade propagating
+        through the current fleet to become "COMPLETE". Soaking begins after
+        all clusters in the fleet are on the target version, or after 30 days
+        if all cluster upgrades are not complete. Once an upgrade state becomes
+        "COMPLETE", it will automatically be propagated to the downstream
+        fleet. Max is 30 days.
+
+        To configure Rollout Sequencing for a fleet, this attribute must be
+        set. To do this while specifying a default soaking duration of 7 days,
+        run:
+
+            $ gcloud container hub clusterupgrade create \
+                --default-upgrade-soaking=7d
+
+     --upstream-fleet=UPSTREAM_FLEET
+        The upstream fleet. GKE will finish upgrades on the upstream fleet
+        before applying the same upgrades to the current fleet.
+
+        To configure the upstream fleet, run:
+
+            $ gcloud container hub clusterupgrade create             \
+                --upstream-fleet={upstream_fleet}
+
+     Upgrade soaking override.
+
+         Defines a specific soaking time override for a particular upgrade
+         propagating through the current fleet that supercedes the default
+         soaking duration configured by `--default-upgrade-soaking`.
+
+         To set an upgrade soaking override of 12 hours for the upgrade with
+         name, `k8s_control_plane`, and version, `1.23.1-gke.1000`, run:
+
+         $ gcloud container hub clusterupgrade create               \
+         --add-upgrade-soaking-override=12h               \
+         --upgrade-selector=name="k8s_control_plane",\
+         version="1.23.1-gke.1000"
+
+       --add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE
+          Overrides the soaking time for a particular upgrade name and version
+          propagating through the current fleet. Set soaking to 0 days to
+          bypass soaking and fast-forward the upgrade to the downstream fleet.
+
+          See $ gcloud topic datetimes for information on duration formats.
+
+          This flag argument must be specified if any of the other arguments in
+          this group are specified.
+
+       --upgrade-selector=[name=NAME],[version=VERSION]
+          Name and version of the upgrade to be overridden where version is a
+          full GKE version. Currently, name can be either k8s_control_plane or
+          k8s_node.
+
+          This flag argument must be specified if any of the other arguments in
+          this group are specified.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha container hub clusterupgrade create
+
+        $ gcloud beta container hub clusterupgrade create
+

gcloud/container/hub/clusterupgrade/describe

@@ -0,0 +1,47 @@
+NAME
+    gcloud container hub clusterupgrade describe - describe the clusterupgrade
+        feature for a fleet within a given project
+
+SYNOPSIS
+    gcloud container hub clusterupgrade describe
+        [--show-linked-cluster-upgrade] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Describe the Fleet clusterupgrade feature used for configuring fleet-based
+    rollout sequencing.
+
+EXAMPLES
+    To view the cluster upgrade feature information for the current fleet, run:
+
+        $ gcloud container hub clusterupgrade describe
+
+FLAGS
+     --show-linked-cluster-upgrade
+        Shows the cluster upgrade feature information for the current fleet as
+        well as information for all other fleets linked in the same rollout
+        sequence (provided that the caller has permission to view the upstream
+        and downstream fleets). This displays cluster upgrade information for
+        fleets in the current fleet's rollout sequence in order of furthest
+        upstream to downstream.
+
+        To view the cluster upgrade feature information for the rollout
+        sequence containing the current fleet, run:
+
+            $ gcloud container hub clusterupgrade describe \
+                --show-linked-cluster-upgrade
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha container hub clusterupgrade describe
+
+        $ gcloud beta container hub clusterupgrade describe
+

gcloud/container/hub/clusterupgrade/help

@@ -0,0 +1,34 @@
+NAME
+    gcloud container hub clusterupgrade - configure the Fleet clusterupgrade
+        feature
+
+SYNOPSIS
+    gcloud container hub clusterupgrade COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    This fleet feature is used to configure fleet-based rollout sequencing.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        Create the clusterupgrade feature for a fleet within a given project.
+
+     describe
+        Describe the clusterupgrade feature for a fleet within a given project.
+
+     update
+        Update the clusterupgrade feature for a fleet within a given project.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha container hub clusterupgrade
+
+        $ gcloud beta container hub clusterupgrade
+

gcloud/container/hub/clusterupgrade/update

@@ -0,0 +1,120 @@
+NAME
+    gcloud container hub clusterupgrade update - update the clusterupgrade
+        feature for a fleet within a given project
+
+SYNOPSIS
+    gcloud container hub clusterupgrade update
+        [--default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING]
+        [--remove-upgrade-soaking-overrides
+          | --add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE
+          --upgrade-selector=[name=NAME],[version=VERSION]]
+        [--reset-upstream-fleet | --upstream-fleet=UPSTREAM_FLEET]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update the clusterupgrade feature for a fleet within a given project.
+
+EXAMPLES
+    To update the clusterupgrade feature for the current fleet, run:
+
+        $ gcloud container hub clusterupgrade update \
+            --default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING
+
+FLAGS
+     --default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING
+        Configures the default soaking duration for each upgrade propagating
+        through the current fleet to become "COMPLETE". Soaking begins after
+        all clusters in the fleet are on the target version, or after 30 days
+        if all cluster upgrades are not complete. Once an upgrade state becomes
+        "COMPLETE", it will automatically be propagated to the downstream
+        fleet. Max is 30 days.
+
+        To configure Rollout Sequencing for a fleet, this attribute must be
+        set. To do this while specifying a default soaking duration of 7 days,
+        run:
+
+            $ gcloud container hub clusterupgrade update \
+                --default-upgrade-soaking=7d
+
+     At most one of these can be specified:
+
+       --remove-upgrade-soaking-overrides
+          Removes soaking time overrides for all upgrades propagating through
+          the current fleet. Consequently, all upgrades will follow the soak
+          time configured by --default-upgrade-soaking until new overrides are
+          configured with --add_upgrade_soaking_override and
+          --upgrade_selector.
+
+          To remove all configured soaking time overrides, run:
+
+              $ gcloud container hub clusterupgrade update \
+                  --remove-upgrade-soaking-overrides
+
+       Upgrade soaking override.
+
+           Defines a specific soaking time override for a particular upgrade
+           propagating through the current fleet that supercedes the default
+           soaking duration configured by `--default-upgrade-soaking`.
+
+           To set an upgrade soaking override of 12 hours for the upgrade with
+           name, `k8s_control_plane`, and version, `1.23.1-gke.1000`, run:
+
+           $ gcloud container hub clusterupgrade update               \
+           --add-upgrade-soaking-override=12h               \
+           --upgrade-selector=name="k8s_control_plane",\
+           version="1.23.1-gke.1000"
+
+         --add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE
+            Overrides the soaking time for a particular upgrade name and
+            version propagating through the current fleet. Set soaking to 0
+            days to bypass soaking and fast-forward the upgrade to the
+            downstream fleet.
+
+            See $ gcloud topic datetimes for information on duration formats.
+
+            This flag argument must be specified if any of the other arguments
+            in this group are specified.
+
+         --upgrade-selector=[name=NAME],[version=VERSION]
+            Name and version of the upgrade to be overridden where version is a
+            full GKE version. Currently, name can be either k8s_control_plane
+            or k8s_node.
+
+            This flag argument must be specified if any of the other arguments
+            in this group are specified.
+
+     At most one of these can be specified:
+
+       --reset-upstream-fleet
+          Clears the relationship between the current fleet and its upstream
+          fleet in the rollout sequence.
+
+          To remove the link between the current fleet and its upstream fleet,
+          run:
+
+              $ gcloud container hub clusterupgrade update --reset-upstream-fleet
+
+       --upstream-fleet=UPSTREAM_FLEET
+          The upstream fleet. GKE will finish upgrades on the upstream fleet
+          before applying the same upgrades to the current fleet.
+
+          To configure the upstream fleet, run:
+
+              $ gcloud container hub clusterupgrade update             \
+                  --upstream-fleet={upstream_fleet}
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha container hub clusterupgrade update
+
+        $ gcloud beta container hub clusterupgrade update
+