imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-20 04:58:26 +00:00
Code Activity

gcloud: Wed Apr 17 09:40:58 UTC 2024

Browse source
This commit is contained in:
Automated 2024-04-17 09:40:58 +00:00
parent 7e2535c53d
commit 3740758467
178 changed files with 2958 additions and 1351 deletions
Download patch file Download diff file Expand all files Collapse all files

10
gcloud/ai/custom-jobs/create
View file

@ -7,6 +7,7 @@ SYNOPSIS
[--args=[ARG,...]] [--command=[COMMAND,...]]
[--enable-dashboard-access] [--enable-web-access]
[--labels=[KEY=VALUE,...]] [--network=NETWORK]
[--persistent-resource-id=PERSISTENT_RESOURCE_ID]
[--python-package-uris=[PYTHON_PACKAGE_URIS,...]] [--region=REGION]
[--service-account=SERVICE_ACCOUNT]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
@ -193,6 +194,15 @@ OPTIONAL FLAGS
peered with. Private services access must already have been configured.
If unspecified, the Job is not peered with any network.
--persistent-resource-id=PERSISTENT_RESOURCE_ID
The name of the persistent resource from the same project and region on
which to run this custom job.
If this is specified, the job will be run on existing machines held by
the PersistentResource instead of on-demand short-lived machines. The
network and CMEK configs on the job should be consistent with those on
the PersistentResource, otherwise, the job will be rejected.
--python-package-uris=[PYTHON_PACKAGE_URIS,...]
The common Python package URIs to be used for training with a pre-built
container image. e.g. --python-package-uri=path1,path2 If you are using

3
gcloud/ai/help
View file

@ -39,6 +39,9 @@ GROUPS
operations
Manage Vertex AI operations.
persistent-resources
Create and manage Vertex AI persistent resources.
tensorboards
Manage Vertex AI Tensorboards.

194
gcloud/ai/persistent-resources/create Normal file
View file

@ -0,0 +1,194 @@
NAME
gcloud ai persistent-resources create - create a new persistent resource
SYNOPSIS
gcloud ai persistent-resources create
--persistent-resource-id=PERSISTENT_RESOURCE_ID
(--config=CONFIG --resource-pool-spec=[RESOURCE_POOL_SPEC,...])
[--display-name=DISPLAY_NAME] [--enable-custom-service-account]
[--labels=[KEY=VALUE,...]] [--network=NETWORK] [--region=REGION]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command will create a persistent resource on the users project to use
with Vertex AI custom training jobs. Persistent resources remain active
until they are deleted by the user.
EXAMPLES
To create a PersistentResource under project example in region us-central1,
run:
$ gcloud ai persistent-resources create --region=us-central1 \
--project=example \
--resource-pool-spec=replica-count=1,\
machine-type='n1-standard-4' --display-name=example-resource
REQUIRED FLAGS
--persistent-resource-id=PERSISTENT_RESOURCE_ID
User-specified ID of the Persistent Resource.
resource pool specification.
At least one of these must be specified:
--config=CONFIG
Path to the Persistent Resource configuration file. This file should
be a YAML document containing a list of ResourcePool If an option is
specified both in the configuration file **and** via command-line
arguments, the command-line arguments override the configuration
file. Note that keys with underscore are invalid.
Example(YAML):
resourcePoolSpecs:
machineSpec:
machineType: n1-standard-4
replicaCount: 1
--resource-pool-spec=[RESOURCE_POOL_SPEC,...]
Defines a resource pool to be created in the Persistent Resource. You
can include multiple resource pool specs in order to create a
Persistent Resource with multiple resource pools.
The spec can contain the following fields:
machine-type
(Required): The type of the machine. see
https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types
for supported types. This field corresponds to the
machineSpec.machineType field in ResourcePool API message.
replica-count
(Required if autoscaling not enabled) The number of replicas to
use when creating this resource pool. This field corresponds to
the replicaCount field in 'ResourcePool' API message.
min-replica-count
(Optional) The minimum number of replicas that autoscaling will
down-size to for this resource pool. Both min-replica-count and
max-replica-count are required to enable autoscaling on this
resource pool. The value for this parameter must be at least 1.
max-replica-count
(Optional) The maximum number of replicas that autoscaling will
create for this resource pool. Both min-replica-count and
max-replica-count are required to enable autoscaling on this
resource pool. The maximum value for this parameter is 1000.
accelerator-type
(Optional) The type of GPU to attach to the machines. see
https://cloud.google.com/vertex-ai/docs/training/configure-compute#specifying_gpus
for more requirements. This field corresponds to the
machineSpec.acceleratorType field in ResourcePool API message.
accelerator-count
(Required with accelerator-type) The number of GPUs for each VM
in the resource pool to use. The default the value if 1. This
field corresponds to the machineSpec.acceleratorCount field in
ResourcePool API message.
disk-type
(Optional) The type of disk to use for each machine's boot disk
in the resource pool. The default is pd-standard. This field
corresponds to the diskSpec.bootDiskType field in ResourcePool
API message.
disk-size
(Optional) The disk size in Gb for each machine's boot disk in
the resource pool. The default is 100. This field corresponds to
the diskSpec.bootDiskSizeGb field in ResourcePool API message.
Example: --worker-pool-spec=replica-count=1,machine-type=n1-highmem-2
OPTIONAL FLAGS
--display-name=DISPLAY_NAME
Display name of the Persistent Resource.
--enable-custom-service-account
Whether or not to use a custom user-managed service account with this
Persistent Resource.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--network=NETWORK
Full name of the Google Compute Engine network to which the Job is
peered with. Private services access must already have been configured.
If unspecified, the Job is not peered with any network.
Region resource - Cloud region to create a Persistent Resource. 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 ai/region with a fully specified name;
◆ choose one from the prompted list of available regions 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 ai/region;
▸ choose one from the prompted list of available regions.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the persistent resource. The 'Vertex AI Service Agent'
service account must hold permission 'Cloud KMS CryptoKey
Encrypter/Decrypter'. The arguments in this group can be used to specify
the attributes of this resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
▸ provide the argument --kms-key on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--kms-keyring=KMS_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
▸ provide the argument --kms-key on the command line with a fully
specified name;
▸ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
▸ provide the argument --kms-key on the command line with a fully
specified name;
▸ provide the argument --kms-location on the command line.
--kms-project=KMS_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
▸ provide the argument --kms-key on the command line with a fully
specified name;
▸ provide the argument --kms-project on the command line;
▸ set the property core/project.
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 ai persistent-resources create
$ gcloud beta ai persistent-resources create

68
gcloud/ai/persistent-resources/delete Normal file
View file

@ -0,0 +1,68 @@
NAME
gcloud ai persistent-resources delete - delete an active Persistent
Resource
SYNOPSIS
gcloud ai persistent-resources delete
(PERSISTENT_RESOURCE : --region=REGION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
If the Persistent Resource is not in the active state, the command will not
perform any operation.
EXAMPLES
To delete a persistent resource 123 under project example in region
us-central1, run:
$ gcloud ai persistent-resources delete 123 --project=example \
--region=us-central1
POSITIONAL ARGUMENTS
Persistent resource resource - The persistent resource 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 persistent_resource 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.
PERSISTENT_RESOURCE
ID of the persistent resource or fully qualified identifier for the
persistent resource.
To set the name attribute:
▸ provide the argument persistent_resource on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the persistent resource.
To set the region attribute:
▸ provide the argument persistent_resource on the command line with
a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property ai/region;
▸ choose one from the prompted list of available regions.
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 ai persistent-resources delete
$ gcloud beta ai persistent-resources delete

64
gcloud/ai/persistent-resources/describe Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud ai persistent-resources describe - get detailed information about a
PersistentResource with a given id
SYNOPSIS
gcloud ai persistent-resources describe
(PERSISTENT_RESOURCE : --region=REGION) [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To get the persistent resource with the PersistentResource id 123 under
project example in region us-central1, run:
$ gcloud ai persistent-resources describe 123 --project=example \
--region=us-central1
POSITIONAL ARGUMENTS
Persistent resource resource - The persistent resource 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 persistent_resource 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.
PERSISTENT_RESOURCE
ID of the persistent resource or fully qualified identifier for the
persistent resource.
To set the name attribute:
▸ provide the argument persistent_resource on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the persistent resource.
To set the region attribute:
▸ provide the argument persistent_resource on the command line with
a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property ai/region;
▸ choose one from the prompted list of available regions.
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 ai persistent-resources describe
$ gcloud beta ai persistent-resources describe

40
gcloud/ai/persistent-resources/help Normal file
View file

@ -0,0 +1,40 @@
NAME
gcloud ai persistent-resources - create and manage Vertex AI persistent
resources
SYNOPSIS
gcloud ai persistent-resources COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create and manage Vertex AI persistent resources.
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 persistent resource.
delete
Delete an active Persistent Resource.
describe
Get detailed information about a PersistentResource with a given id.
list
Lists the active persistent resources.
reboot
Reboot a Persistent Resource.
NOTES
These variants are also available:
$ gcloud alpha ai persistent-resources
$ gcloud beta ai persistent-resources

84
gcloud/ai/persistent-resources/list Normal file
View file

@ -0,0 +1,84 @@
NAME
gcloud ai persistent-resources list - lists the active persistent resources
SYNOPSIS
gcloud ai persistent-resources list [--region=REGION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
EXAMPLES
To list the persistent resources of project example in region us-central1,
run:
$ gcloud ai persistent-resources list --project=example \
--region=us-central1
FLAGS
Region resource - Cloud region to list persistent resources. 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 ai/region with a fully specified name;
◆ choose one from the prompted list of available regions 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 ai/region;
▸ choose one from the prompted list of available regions.
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.
NOTES
These variants are also available:
$ gcloud alpha ai persistent-resources list
$ gcloud beta ai persistent-resources list

63
gcloud/ai/persistent-resources/reboot Normal file
View file

@ -0,0 +1,63 @@
NAME
gcloud ai persistent-resources reboot - reboot a Persistent Resource
SYNOPSIS
gcloud ai persistent-resources reboot
(PERSISTENT_RESOURCE : --region=REGION) [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To reboot a persistent resource 123 under project example in region
us-central1, run:
$ gcloud ai persistent-resources reboot 123 --project=example \
--region=us-central1
POSITIONAL ARGUMENTS
Persistent resource resource - The persistent resource to reboot. 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 persistent_resource 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.
PERSISTENT_RESOURCE
ID of the persistent resource or fully qualified identifier for the
persistent resource.
To set the name attribute:
▸ provide the argument persistent_resource on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the persistent resource.
To set the region attribute:
▸ provide the argument persistent_resource on the command line with
a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property ai/region;
▸ choose one from the prompted list of available regions.
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 ai persistent-resources reboot
$ gcloud beta ai persistent-resources reboot