gcloud: Thu Oct 5 11:50:15 UTC 2023

gcloud/redis/clusters/create

@@ -0,0 +1,133 @@
+NAME
+    gcloud redis clusters create - create a new Memorystore for Redis Cluster
+        instance
+
+SYNOPSIS
+    gcloud redis clusters create (CLUSTER : --region=REGION) --network=NETWORK
+        --shard-count=SHARD_COUNT [--async] [--auth-mode=AUTH_MODE]
+        [--replica-count=REPLICA_COUNT]
+        [--transit-encryption-mode=TRANSIT_ENCRYPTION_MODE]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Create a new Memorystore for Redis Cluster instance, and uses Private
+    Service Connect service connectivity automation to automate connectivity
+    for instances.
+
+    This command can fail for the following reasons:
+      ▪ A cluster with the same name already exists.
+      ▪ The active account does not have permission to create clusters.
+      ▪ Some required APIs not enabled yet.
+      ▪ No connection policy defined yet on the network and in the region a
+        cluster will be created.
+      ▪ Miss the steps for creating and configuring a service account (to
+        grant permissions) in both host project and service project, if a
+        shared VPC network is used.
+
+    Refer to
+    https://cloud.google.com/memorystore/docs/cluster/networking#prerequisites_required_before_creating_a_cluster
+    for prerequisites.
+
+EXAMPLES
+    To create a cluster with name my-redis-cluster in region us-central1 with 3
+    shards and with a discovery endpoint created on network "default", run:
+
+        $ gcloud redis clusters create my-redis-cluster \
+            --region=us-central1 --shard-count=3 \
+            --network=projects/NETWORK_PROJECT_ID/global/networks/default
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Arguments and flags that specify the cluster you want
+     to create. Your cluster ID must be 1 to 63 characters and use only
+     lowercase letters, numbers, or hyphens. It must start with a lowercase
+     letter and end with a lowercase letter or number. The arguments in this
+     group can be used to specify the attributes of this resource. (NOTE) Some
+     attributes are not given arguments in this group but can be set in other
+     ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --region=REGION
+          The name of the Redis region of the cluster. Overrides the default
+          redis/region property value for this command invocation.
+
+          To set the region attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+REQUIRED FLAGS
+     --network=NETWORK
+        The network used to create your instance. It must use the format:
+        projects/NETWORK_PROJECT_ID/global/networks/NETWORK_ID. The network ID
+        used here must match the network ID used by the service connection
+        policy. Otherwise, the create operation fails
+
+     --shard-count=SHARD_COUNT
+        The shard count of the cluster.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --auth-mode=AUTH_MODE
+        Available authorization mode of a Redis cluster. AUTH_MODE must be one
+        of:
+
+         disabled
+            Authorization is disabled for the cluster.
+
+         iam-auth
+            IAM basic authorization is enabled for the cluster.
+
+     --replica-count=REPLICA_COUNT
+        The replica count of each shard.
+
+     --transit-encryption-mode=TRANSIT_ENCRYPTION_MODE
+        Transit encryption mode used for the Redis cluster. If not provided,
+        encryption is disabled for the cluster. TRANSIT_ENCRYPTION_MODE must be
+        one of:
+
+         disabled
+            In-transit encryption is disabled for the cluster.
+
+         server-authentication
+            The cluster uses server managed encryption for in-transit
+            encryption.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters create
+
+        $ gcloud beta redis clusters create
+

gcloud/redis/clusters/delete

@@ -0,0 +1,79 @@
+NAME
+    gcloud redis clusters delete - delete a Memorystore for Redis Cluster
+        instance
+
+SYNOPSIS
+    gcloud redis clusters delete (CLUSTER : --region=REGION) [--async]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Delete a Memorystore for Redis Cluster instance.
+
+    This command can fail for the following reasons:
+      ▪ The cluster specified does not exist.
+      ▪ The active account does not have permission to access the given
+        cluster.
+
+EXAMPLES
+    To delete a cluster with the name my-redis-cluster in your default region,
+    run:
+
+        $ gcloud redis clusters delete my-redis-cluster
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Arguments and flags that specify the cluster you want
+     to delete. The arguments in this group can be used to specify the
+     attributes of this resource. (NOTE) Some attributes are not given
+     arguments in this group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --region=REGION
+          The name of the Redis region of the cluster. Overrides the default
+          redis/region property value for this command invocation.
+
+          To set the region attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters delete
+
+        $ gcloud beta redis clusters delete
+

gcloud/redis/clusters/describe

@@ -0,0 +1,76 @@
+NAME
+    gcloud redis clusters describe - show metadata for a Memorystore for Redis
+        Cluster instance
+
+SYNOPSIS
+    gcloud redis clusters describe (CLUSTER : --region=REGION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Show metadata for a Memorystore for Redis Cluster instance.
+
+    Displays all metadata associated with a cluster given a valid cluster name.
+
+    This command can fail for the following reasons:
+      ▪ The cluster specified does not exist.
+      ▪ The active account does not have permission to access the given
+        cluster.
+
+EXAMPLES
+    To display the metadata for a cluster with the name my-redis-cluster in the
+    default region, run:
+
+        $ gcloud redis clusters describe my-redis-cluster
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Arguments and flags that specify the cluster you want
+     to describe. The arguments in this group can be used to specify the
+     attributes of this resource. (NOTE) Some attributes are not given
+     arguments in this group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --region=REGION
+          The name of the Redis region of the cluster. Overrides the default
+          redis/region property value for this command invocation.
+
+          To set the region attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters describe
+
+        $ gcloud beta redis clusters describe
+

gcloud/redis/clusters/get-cluster-certificate-authority

@@ -0,0 +1,77 @@
+NAME
+    gcloud redis clusters get-cluster-certificate-authority - get the
+        certificate authority information for a Memorystore for Redis Cluster
+        instance
+
+SYNOPSIS
+    gcloud redis clusters get-cluster-certificate-authority
+        (CLUSTER : --region=REGION) [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Get the certificate authority information for a Memorystore for Redis
+    Cluster instance.
+
+    This command can fail for the following reasons:
+      ▪ The cluster specified does not exist.
+      ▪ The active account does not have permission to access the given
+        cluster.
+
+EXAMPLES
+    To get the metadata for a cluster with the name my-redie-cluster in the
+    default region, run:
+
+        $ gcloud redis clusters get-cluster-certificate-authority \
+            my-redis-cluster
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Arguments and flags that specify the cluster. The
+     arguments in this group can be used to specify the attributes of this
+     resource. (NOTE) Some attributes are not given arguments in this group but
+     can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --region=REGION
+          The name of the Redis region of the cluster. Overrides the default
+          redis/region property value for this command invocation.
+
+          To set the region attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters get-cluster-certificate-authority
+
+        $ gcloud beta redis clusters get-cluster-certificate-authority
+

gcloud/redis/clusters/help

@@ -0,0 +1,43 @@
+NAME
+    gcloud redis clusters - manage Memorystore for Redis Cluster instances
+
+SYNOPSIS
+    gcloud redis clusters COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Manage Memorystore for Redis Cluster instances.
+
+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 a new Memorystore for Redis Cluster instance.
+
+     delete
+        Delete a Memorystore for Redis Cluster instance.
+
+     describe
+        Show metadata for a Memorystore for Redis Cluster instance.
+
+     get-cluster-certificate-authority
+        Get the certificate authority information for a Memorystore for Redis
+        Cluster instance.
+
+     list
+        List Memorystore for Redis Cluster instances.
+
+     update
+        Update Memorystore Cluster for Redis instance.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters
+
+        $ gcloud beta redis clusters
+

gcloud/redis/clusters/list

@@ -0,0 +1,88 @@
+NAME
+    gcloud redis clusters list - list Memorystore for Redis Cluster instances
+
+SYNOPSIS
+    gcloud redis clusters list [--region=REGION] [--filter=EXPRESSION]
+        [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    List all clusters under the specified project and region.
+
+    To specify the maximum number of clusters to list, use the --limit flag.
+
+EXAMPLES
+    To list up to five clusters, run:
+
+        $ gcloud redis clusters list --limit=5
+
+FLAGS
+     Region resource - The region of the clusters to display. This represents a
+     Cloud resource. (NOTE) Some attributes are not given arguments in this
+     group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument --region on the command line with a fully
+        specified name;
+      ◆ set the property redis/region with a fully specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+       --region=REGION
+          ID of the region or fully qualified identifier for the region.
+
+          To set the region attribute:
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters list
+
+        $ gcloud beta redis clusters list
+

gcloud/redis/clusters/update

@@ -0,0 +1,86 @@
+NAME
+    gcloud redis clusters update - update Memorystore Cluster for Redis
+        instance
+
+SYNOPSIS
+    gcloud redis clusters update (CLUSTER : --region=REGION) [--async]
+        [--replica-count=REPLICA_COUNT] [--shard-count=SHARD_COUNT]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update the metadata and/or configuration parameters of a Redis cluster.
+
+    This command can fail for the following reasons:
+      ▪ The cluster specified does not exist.
+      ▪ The active account does not have permission to update the given
+        cluster.
+
+EXAMPLES
+    To update a Redis cluster with 5 shard and 2 replica, run:
+
+        $ gcloud redis clusters update my-redis-cluster --shard-count=5 \
+            --replica-count=2
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Arguments and flags that specify the Memorystore Redis
+     cluster you want to update. The arguments in this group can be used to
+     specify the attributes of this resource. (NOTE) Some attributes are not
+     given arguments in this group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --region=REGION
+          The name of the Redis region of the cluster. Overrides the default
+          redis/region property value for this command invocation.
+
+          To set the region attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --region on the command line;
+          ▸ set the property redis/region.
+
+FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --replica-count=REPLICA_COUNT
+        The replica count of each shard.
+
+     --shard-count=SHARD_COUNT
+        The shard count of the cluster.
+
+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.
+
+API REFERENCE
+    This command uses the redis/v1 API. The full documentation for this API can
+    be found at: https://cloud.google.com/memorystore/docs/redis/
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha redis clusters update
+
+        $ gcloud beta redis clusters update
+

gcloud/redis/help

@@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
 GROUPS
     GROUP is one of the following:
 
+     clusters
+        Manage Memorystore for Redis Cluster instances.
+
      instances
         Manage Cloud Memorystore Redis instances.