1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-13 08:27:05 +00:00

gcloud: Wed Oct 11 10:37:28 UTC 2023

This commit is contained in:
Automated 2023-10-11 10:37:28 +00:00
parent 9641ff6585
commit c30bb7b4ce
137 changed files with 3139 additions and 267 deletions

View file

@ -9,6 +9,10 @@ SYNOPSIS
[--initial-delay=INITIAL_DELAY] [--instance-redistribution-type=TYPE]
[--list-managed-instances-results=MODE]
[--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME]]
[--stateful-external-ip=[enabled],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-internal-ip=[enabled],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--target-distribution-shape=SHAPE] [--target-pool=[TARGET_POOL,...]]
[--zones=ZONE,[ZONE,...]]
[--health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK
@ -143,6 +147,76 @@ OPTIONAL FLAGS
the group; for example, when the instance is deleted manually or
when the group size is decreased.
--stateful-external-ip=[enabled],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
External IPs considered stateful by the instance group. Managed
instance groups preserve stateful IPs on VM autohealing, update, and
recreate events.
Use this argument multiple times to make more external IPs stateful.
At least one of the following is required:
enabled
Marks the IP address as stateful. The network interface named nic0
is assumed by default when interface-name is not specified. This
flag can be omitted when interface-name is provided explicitly.
interface-name
Marks the IP address from this network interface as stateful. This
flag can be omitted when enabled is provided.
Additional arguments:
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-internal-ip=[enabled],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Internal IPs considered stateful by the instance group. Managed
instance groups preserve stateful IPs on VM autohealing, update, and
recreate events.
Use this argument multiple times to make more internal IPs stateful.
At least one of the following is required:
enabled
Marks the IP address as stateful. The network interface named nic0
is assumed by default when interface-name is not specified. This
flag can be omitted when interface-name is provided explicitly.
interface-name
Marks the IP address from this network interface as stateful. This
flag can be omitted when enabled is provided.
Additional arguments:
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--target-distribution-shape=SHAPE
Specifies how a regional managed instance group distributes its
instances across zones within the region. The default shape is even.

View file

@ -8,30 +8,40 @@ SYNOPSIS
--instance=INSTANCE
[--stateful-disk=[auto-delete=AUTO-DELETE],
[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE]]
[--stateful-external-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-internal-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]]
[--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud compute instance-groups managed create-instance creates a virtual
machine instance with a defined name and optionally its stateful
configuration: stateful disk and stateful metadata key-values. Stateful
configuration is stored in the corresponding newly created per-instance
config. An instance with a per-instance config will preserve its given
name, specified disks, and specified metadata key-values during instance
recreation, auto-healing, updates, and any other lifecycle transitions of
the instance.
configuration: stateful disk, stateful metadata key-values, and stateful IP
addresses. Stateful configuration is stored in the corresponding newly
created per-instance config. An instance with a per-instance config will
preserve its given name, specified disks, specified metadata key-values,
and specified internal and external IPs during instance recreation,
auto-healing, updates, and any other lifecycle transitions of the instance.
EXAMPLES
To create an instance instance-1 in my-group (in region europe-west4) with
metadata my-key: my-value and a disk disk-1 attached to it as the device
device-1, run:
metadata my-key: my-value, a disk disk-1 attached to it as the device
device-1, stateful internal IP 192.168.0.10 on the default interface
(nic0), and existing address reservation my-address for stateful external
IP on interface nic1, run:
$ gcloud compute instance-groups managed create-instance my-group \
--region=europe-west4 --instance=instance-1 \
--stateful-disk='device-name=foo,source=https://compute.googleap\
is.com/compute/alpha/projects/my-project/zones/europe-west4/disks/di\
sk-1,mode=rw,auto-delete=on-permanent-instance-deletion' \
--stateful-metadata='my-key=my-value'
--stateful-metadata='my-key=my-value' \
--stateful-internal-ip=address=192.168.0.10,\
auto-delete=on-permanent-instance-deletion \
--stateful-external-ip=address=/projects/example-project/\
regions/europe-west4/addresses/my-address,interface-name=nic1
POSITIONAL ARGUMENTS
NAME
@ -53,6 +63,92 @@ OPTIONAL FLAGS
The same disk can be attached to more than one instance but only in
read-only mode.
--stateful-external-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
Use this argument multiple times to update more IPs.
If a stateful external IP with the given interface name already exists
in the current instance configuration, its properties are replaced by
the newly provided ones. Otherwise, a new stateful external IP
definition is added to the instance configuration.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
*address*::: Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-internal-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
Use this argument multiple times to update more IPs.
If a stateful internal IP with the given interface name already exists
in the current instance configuration, its properties are replaced by
the newly provided ones. Otherwise, a new stateful internal IP
definition is added to the instance configuration.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
*address*::: Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]
Additional metadata to be made available to the guest operating system
in addition to the metadata defined in the instance template.

View file

@ -9,6 +9,10 @@ SYNOPSIS
default="none"]
[--stateful-disk=[auto-delete=AUTO-DELETE],
[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE]]
[--stateful-external-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-internal-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]] [--no-update-instance]
[--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...]
@ -36,6 +40,20 @@ EXAMPLES
does not exist in the group's instance template, then the command adds
my-disk to my-instance.
To create a per-instance config with a stateful internal IP 192.168.0.10
and a stateful external IP reserved in address my-address, on instance
my-instance, run:
$ gcloud compute instance-groups managed instance-configs create \
my-group --region=europe-west4 --instance=my-instance \
--stateful-internal-ip=address=192.168.0.10,\
interface-name=nic0 \
--stateful-external-ip=address=/projects/example-project/\
regions/europe-west4/addresses/my-address,interface-name=nic0
If the provided IP address is not yet reserved, the MIG automatically
creates a corresponding IP address reservation.
POSITIONAL ARGUMENTS
NAME
Name of the managed instance group to create a per-instance config for.
@ -99,6 +117,90 @@ OPTIONAL FLAGS
the group; for example, when the instance is deleted manually or
when the group size is decreased.
--stateful-external-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
You can preserve the IP address that's specified in a network interface
for a specific managed instance, even if that network interface is not
defined in the group's instance template.
Use this argument multiple times to attach and preserve multiple IPs.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
*address*::: Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-internal-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
You can preserve the IP address that's specified in a network interface
for a specific managed instance, even if that network interface is not
defined in the group's instance template.
Use this argument multiple times to attach and preserve multiple IPs.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
*address*::: Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]
Additional metadata to be made available to the guest operating system
in addition to the metadata defined in the instance template.

View file

@ -8,9 +8,15 @@ SYNOPSIS
[--instance-update-minimal-action=INSTANCE_UPDATE_MINIMAL_ACTION;
default="none"]
[--remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...]]
[--remove-stateful-external-ips=KEY,[KEY,...]]
[--remove-stateful-internal-ips=KEY,[KEY,...]]
[--remove-stateful-metadata=KEY,[KEY,...]]
[--stateful-disk=[auto-delete=AUTO-DELETE],
[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE]]
[--stateful-external-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-internal-ip=[address=ADDRESS],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]] [--no-update-instance]
[--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...]
@ -43,6 +49,20 @@ EXAMPLES
for my-disk-1 and my-disk-2; if these disk are not defined in the group's
instance template, then they are detached.
To update a per-instance configuration with a stateful internal IP
192.168.0.10, on instance my-instance, run:
$ gcloud compute instance-groups managed instance-configs update \
my-group --region=europe-west4 --instance=my-instance \
--stateful-internal-ip=address=192.168.0.10,interface-name=nic0
To update a per-instance configuration to remove a stateful external IP
that's defined in network interface nic0, on instance my-instance, run:
$ gcloud compute instance-groups managed instance-configs update \
my-group --region=europe-west4 --instance=my-instance \
--remove-stateful-internal-ips=nic0
POSITIONAL ARGUMENTS
NAME
Name of the managed instance group to update per-instance config for.
@ -74,6 +94,14 @@ OPTIONAL FLAGS
Remove stateful configuration for the specified disks from the
instance's configuration.
--remove-stateful-external-ips=KEY,[KEY,...]
List of all stateful IP network interface names to remove from the
instance's per-instance configuration.
--remove-stateful-internal-ips=KEY,[KEY,...]
List of all stateful IP network interface names to remove from the
instance's per-instance configuration.
--remove-stateful-metadata=KEY,[KEY,...]
Remove stateful configuration for the specified metadata keys from the
instance's configuration.
@ -119,6 +147,114 @@ OPTIONAL FLAGS
the group; for example, when the instance is deleted manually or
when the group size is decreased.
--stateful-external-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
You can preserve the IP address that's specified in a network interface
for a specific managed instance, even if that network interface is not
defined in the group's instance template.
Use this argument multiple times to update multiple IPs.
If a stateful IP with the given network interface name exists in the
current per-instance configuration, its properties are replaced by the
newly provided ones. Otherwise, a new stateful IP definition is added
to the per-instance configuration.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
address
(Optional) Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
The address flag is optional if an address is already defined in
the instance's per-instance configuration. Otherwise it is
required.
If omitted, the currently configured address remains unchanged.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-internal-ip=[address=ADDRESS],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
You can preserve the IP address that's specified in a network interface
for a specific managed instance, even if that network interface is not
defined in the group's instance template.
Use this argument multiple times to update multiple IPs.
If a stateful IP with the given network interface name exists in the
current per-instance configuration, its properties are replaced by the
newly provided ones. Otherwise, a new stateful IP definition is added
to the per-instance configuration.
interface-name
(Optional) Network interface name. If omitted, the default network
interface named nic0 is assumed.
address
(Optional) Static IP address to assign to the instance in one of
the following formats:
+ Address: URL of a static IP address reservation. For example:
projects/example-project/regions/us-east1/addresses/example-ip-name.
+ Literal: For example: 130.211.181.55.
If the provided IP address is not yet reserved, the managed
instance group automatically creates the corresponding IP address
reservation. If the provided IP address is reserved, the group
assigns the reservation to the instance.
The address flag is optional if an address is already defined in
the instance's per-instance configuration. Otherwise it is
required.
If omitted, the currently configured address remains unchanged.
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-metadata=KEY=VALUE,[KEY=VALUE,...]
Additional metadata to be made available to the guest operating system
in addition to the metadata defined in the instance template.

View file

@ -8,7 +8,13 @@ SYNOPSIS
[--instance-redistribution-type=TYPE]
[--list-managed-instances-results=MODE]
[--remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...]]
[--remove-stateful-external-ips=INTERFACE_NAME,[...]]
[--remove-stateful-internal-ips=INTERFACE_NAME,[...]]
[--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME]]
[--stateful-external-ip=[enabled],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--stateful-internal-ip=[enabled],
[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]]
[--target-distribution-shape=SHAPE]
[--clear-autohealing
| --initial-delay=INITIAL_DELAY --health-check=HEALTH_CHECK
@ -103,6 +109,14 @@ FLAGS
--remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...]
Remove stateful configuration for the specified disks.
--remove-stateful-external-ips=INTERFACE_NAME,[...]
Remove stateful configuration for the specified interfaces for external
IPs.
--remove-stateful-internal-ips=INTERFACE_NAME,[...]
Remove stateful configuration for the specified interfaces for internal
IPs.
--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME]
Disks considered stateful by the instance group. Managed instance
groups preserve and reattach stateful disks on VM autohealing, update,
@ -128,6 +142,84 @@ FLAGS
the group; for example, when the instance is deleted manually or
when the group size is decreased.
--stateful-external-ip=[enabled],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
Use this argument multiple times to update more IPs.
If a stateful external IP with the given interface name already exists
in the current instance configuration, its properties are replaced by
the newly provided ones. Otherwise, a new stateful external IP
definition is added to the instance configuration.
At least one of the following is required:
enabled
Marks the IP address as stateful. The network interface named nic0
is assumed by default when interface-name is not specified. This
flag can be omitted when interface-name is provided explicitly.
interface-name
Marks the IP address from this network interface as stateful. This
flag can be omitted when enabled is provided.
Additional arguments:
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--stateful-internal-ip=[enabled],[auto-delete=AUTO-DELETE],[interface-name=INTERFACE-NAME]
Managed instance groups preserve stateful IPs on VM autohealing,
update, and recreate events.
Use this argument multiple times to update more IPs.
If a stateful internal IP with the given interface name already exists
in the current instance configuration, its properties are replaced by
the newly provided ones. Otherwise, a new stateful internal IP
definition is added to the instance configuration.
At least one of the following is required:
enabled
Marks the IP address as stateful. The network interface named nic0
is assumed by default when interface-name is not specified. This
flag can be omitted when interface-name is provided explicitly.
interface-name
Marks the IP address from this network interface as stateful. This
flag can be omitted when enabled is provided.
Additional arguments:
auto-delete
(Optional) Prescribes what should happen to an associated static
Address resource when a VM instance is permanently deleted.
Regardless of the value of the delete rule, stateful IP addresses
are always preserved on instance autohealing, update, and
recreation operations. The following options are available:
▸ never: (Default) Never delete the static IP address. Instead,
unassign the address when its instance is permanently deleted and
keep the address reserved.
▸ on-permanent-instance-deletion: Delete the static IP address
reservation when the instance that it's assigned to is
permanently deleted from the instance group; for example, when
the instance is deleted manually or when the group size is
decreased.
--target-distribution-shape=SHAPE
Specifies how a regional managed instance group distributes its
instances across zones within the region. The default shape is even.