imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00
Code Activity

gcloud: Wed Aug 2 11:22:33 UTC 2023

Browse source
This commit is contained in:
Automated 2023-08-02 11:22:33 +00:00
parent 4558a00e48
commit 678b9afba9
240 changed files with 7837 additions and 521 deletions
Download patch file Download diff file Expand all files Collapse all files

89
gcloud/workbench/instances/add-iam-policy-binding Normal file
View file

@ -0,0 +1,89 @@
NAME
gcloud workbench instances add-iam-policy-binding - add IAM policy binding
for an instance
SYNOPSIS
gcloud workbench instances add-iam-policy-binding
(INSTANCE : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Adds a policy binding to the IAM policy of an instance, given an instance
ID and the binding.
EXAMPLES
To add an IAM policy binding for the role of roles/notebooks.admin for the
user 'test-user@gmail.com' on the instance 'instance-id', run:
$ gcloud workbench instances add-iam-policy-binding \
--member='user:test-user@gmail.com' \
--role='roles/notebooks.admin' example-instance \
--location=us-central1-a
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Instance resource - The ID of the instance to add the IAM binding. 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 instance on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the workbench instance.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
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 notebooks/v2 API. The full documentation for this API
can be found at: https://cloud.google.com/notebooks/docs/

60
gcloud/workbench/instances/check-instance-upgradability Normal file
View file

@ -0,0 +1,60 @@
NAME
gcloud workbench instances check-instance-upgradability - request for
checking if an instance is upgradeable
SYNOPSIS
gcloud workbench instances check-instance-upgradability
(INSTANCE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for checking if an instance is upgradeable.
EXAMPLES
To check if an instance can be upgraded, run:
$ gcloud workbench instances check-instance-upgradability \
example-instance --location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

393
gcloud/workbench/instances/create Normal file
View file

@ -0,0 +1,393 @@
NAME
gcloud workbench instances create - request for creating an instance
SYNOPSIS
gcloud workbench instances create (INSTANCE : --location=LOCATION)
[--async] [--disable-proxy-access] [--instance-owners=INSTANCE_OWNERS]
[--labels=[KEY=VALUE,...]]
[--disable-public-ip --enable-ip-forwarding
--machine-type=MACHINE_TYPE; default="n1-standard-4"
--metadata=[KEY=VALUE,...]
--service-account-email=SERVICE_ACCOUNT_EMAIL --tags=[TAGS,...]
--accelerator-core-count=ACCELERATOR_CORE_COUNT
--accelerator-type=ACCELERATOR_TYPE
--boot-disk-encryption=BOOT_DISK_ENCRYPTION
--boot-disk-size=BOOT_DISK_SIZE --boot-disk-type=BOOT_DISK_TYPE
[--boot-disk-kms-key=BOOT_DISK_KMS_KEY
: --boot-disk-encryption-key-keyring=BOOT_DISK_ENCRYPTION_KEY_KEYRING
--boot-disk-encryption-key-location=BOOT_DISK_ENCRYPTION_KEY_LOCATION
--boot-disk-encryption-key-project=BOOT_DISK_ENCRYPTION_KEY_PROJECT]
[--container-repository=CONTAINER_REPOSITORY
: --container-tag=CONTAINER_TAG]
| [(--vm-image-family=VM_IMAGE_FAMILY
| --vm-image-name=VM_IMAGE_NAME)
: --vm-image-project=VM_IMAGE_PROJECT;
default="deeplearning-platform-release"]
--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH --install-gpu-driver
--data-disk-encryption=DATA_DISK_ENCRYPTION
--data-disk-size=DATA_DISK_SIZE --data-disk-type=DATA_DISK_TYPE
[--data-disk-kms-key=DATA_DISK_KMS_KEY
: --data-disk-encryption-key-keyring=DATA_DISK_ENCRYPTION_KEY_KEYRING
--data-disk-encryption-key-location=DATA_DISK_ENCRYPTION_KEY_LOCATION
--data-disk-encryption-key-project=DATA_DISK_ENCRYPTION_KEY_PROJECT]
--network=NETWORK --nic-type=NIC_TYPE [--subnet=SUBNET
: --subnet-region=SUBNET_REGION]
--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING
--shielded-secure-boot=SHIELDED_SECURE_BOOT
--shielded-vtpm=SHIELDED_VTPM] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for creating an instance.
EXAMPLES
To create an instance from a VmImage family, run:
$ gcloud workbench instances create example-instance \
--vm-image-project=deeplearning-platform-release \
--vm-image-family=workbench-image-family \
--machine-type=n1-standard-4 --location=us-central1-b
To create an instance from a VmImage name, run:
$ gcloud workbench instances create example-instance \
--vm-image-project=deeplearning-platform-release \
--vm-image-name=workbench-image-name \
--machine-type=n1-standard-4 --location=us-central1-b
To create an instance from a Container Repository, run:
$ gcloud workbench instances create example-instance \
--container-repository=gcr.io/deeplearning-platform-release/\
base-cpu --container-tag=test-tag --machine-type=n1-standard-4 \
--location=us-central1-b
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--disable-proxy-access
If true, the notebook instance will not register with the proxy.
--instance-owners=INSTANCE_OWNERS
The owners of this instance after creation. Format: alias@example.com.
Currently supports one owner only. If not specified, all of the service
account users of the VM instance's service account can use the
instance.
--labels=[KEY=VALUE,...]
Labels to apply to this instance. These can be later modified by the
setLabels method.
Gce Setup for the instance
--disable-public-ip
If specified, no public IP will be assigned to this instance.
--enable-ip-forwarding
If specified, IP forwarding will be enabled for this instance.
--machine-type=MACHINE_TYPE; default="n1-standard-4"
The Compute Engine machine type
(https://cloud.google.com/sdk/gcloud/reference/compute/machine-types)
of this instance.
--metadata=[KEY=VALUE,...]
Custom metadata to apply to this instance.
The service account on this instance, giving access to other Google
Cloud services. You can use any service account within the same project,
but you must grant the service account user permission to use the
instance. If not specified, the Compute Engine default service account
is used.
--service-account-email=SERVICE_ACCOUNT_EMAIL
The service account on this instance, giving access to other Google
Cloud services. You can use any service account within the same
project, but you must grant the service account user permission to
use the instance. If not specified, the Compute Engine default
service account is used.
--tags=[TAGS,...]
Tags to apply to this instance.
The hardware accelerator used on this instance. If you use accelerators,
make sure that your configuration has enough vCPUs and memory to support
the `machine_type` you have selected.
--accelerator-core-count=ACCELERATOR_CORE_COUNT
Count of cores of this accelerator.
--accelerator-type=ACCELERATOR_TYPE
Type of this accelerator. ACCELERATOR_TYPE must be one of:
NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100,
NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_A100,
NVIDIA_TESLA_A100_80GB, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS,
NVIDIA_TESLA_P4_VWS.
Boot disk configurations.
--boot-disk-encryption=BOOT_DISK_ENCRYPTION
Disk encryption method used on the boot disk, defaults to GMEK.
BOOT_DISK_ENCRYPTION must be one of: GMEK, CMEK.
--boot-disk-size=BOOT_DISK_SIZE
Size of boot disk in GB attached to this instance, up to a maximum
of 64000 GB (64 TB). The minimum recommended value is 100 GB. If
not specified, this defaults to 100.
--boot-disk-type=BOOT_DISK_TYPE
Type of boot disk attached to this instance, defaults to standard
persistent disk (PD_STANDARD). BOOT_DISK_TYPE must be one of:
PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
Key resource - The Cloud KMS (Key Management Service) cryptokey that
will be used to protect the boot_disk. The 'Compute Engine 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.
--boot-disk-kms-key=BOOT_DISK_KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◇ provide the argument --boot-disk-kms-key on the command line.
This flag argument must be specified if any of the other
arguments in this group are specified.
--boot-disk-encryption-key-keyring=BOOT_DISK_ENCRYPTION_KEY_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◇ provide the argument --boot-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --boot-disk-encryption-key-keyring on
the command line.
--boot-disk-encryption-key-location=BOOT_DISK_ENCRYPTION_KEY_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◇ provide the argument --boot-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --boot-disk-encryption-key-location on
the command line.
--boot-disk-encryption-key-project=BOOT_DISK_ENCRYPTION_KEY_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◇ provide the argument --boot-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --boot-disk-encryption-key-project on
the command line;
◇ set the property core/project.
At most one of these can be specified:
--container-repository=CONTAINER_REPOSITORY
The path to the container image repository. For example:
gcr.io/{project_id}/{image_name}.
This flag argument must be specified if any of the other arguments
in this group are specified.
--container-tag=CONTAINER_TAG
The tag of the container image. If not specified, this defaults to
the latest tag.
--vm-image-project=VM_IMAGE_PROJECT; default="deeplearning-platform-release"
The ID of the Google Cloud project that this VM image belongs to.
Format: projects/{project_id}.
Exactly one of these must be specified:
--vm-image-family=VM_IMAGE_FAMILY
Use this VM image family to find the image; the newest image in
this family will be used.
--vm-image-name=VM_IMAGE_NAME
Use this VM image name to find the image.
GPU driver configurations.
--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH
Specify a custom Cloud Storage path where the GPU driver is stored.
If not specified, we'll automatically choose from official GPU
drivers.
--install-gpu-driver
Whether the end user authorizes Google Cloud to install a GPU
driver on this instance. If this field is empty or set to false,
the GPU driver won't be installed. Only applicable to instances
with GPUs.
Data disk configurations.
--data-disk-encryption=DATA_DISK_ENCRYPTION
Disk encryption method used on the data disk, defaults to GMEK.
DATA_DISK_ENCRYPTION must be one of: GMEK, CMEK.
--data-disk-size=DATA_DISK_SIZE
Size of data disk in GB attached to this instance, up to a maximum
of 64000 GB (64 TB). The minimum recommended value is 100 GB. If
not specified, this defaults to 100.
--data-disk-type=DATA_DISK_TYPE
Type of data disk attached to this instance, defaults to standard
persistent disk (PD_STANDARD). DATA_DISK_TYPE must be one of:
PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
Key resource - The Cloud KMS (Key Management Service) cryptokey that
will be used to protect the data_disk. The 'Compute Engine 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.
--data-disk-kms-key=DATA_DISK_KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◇ provide the argument --data-disk-kms-key on the command line.
This flag argument must be specified if any of the other
arguments in this group are specified.
--data-disk-encryption-key-keyring=DATA_DISK_ENCRYPTION_KEY_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◇ provide the argument --data-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --data-disk-encryption-key-keyring on
the command line.
--data-disk-encryption-key-location=DATA_DISK_ENCRYPTION_KEY_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◇ provide the argument --data-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --data-disk-encryption-key-location on
the command line.
--data-disk-encryption-key-project=DATA_DISK_ENCRYPTION_KEY_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◇ provide the argument --data-disk-kms-key on the command line
with a fully specified name;
◇ provide the argument --data-disk-encryption-key-project on
the command line;
◇ set the property core/project.
Network configs.
Network resource - The name of the VPC that this instance is in.
Format: projects/{project_id}/global/networks/{network_id}. 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 --network on the command line with a fully
specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
--network=NETWORK
ID of the network or fully qualified identifier for the network.
To set the network attribute:
◇ provide the argument --network on the command line.
--nic-type=NIC_TYPE
Type of the network interface card. NIC_TYPE must be one of:
VIRTIGO_NET, GVNIC.
Subnetwork resource - The name of the subnet that this instance is in.
Format:
projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.
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 --subnet on the command line with a fully
specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
--subnet=SUBNET
ID of the subnetwork or fully qualified identifier for the
subnetwork.
To set the subnet attribute:
◇ provide the argument --subnet on the command line.
This flag argument must be specified if any of the other
arguments in this group are specified.
--subnet-region=SUBNET_REGION
Google Cloud region of this subnetwork
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the subnet-region attribute:
◇ provide the argument --subnet on the command line with a
fully specified name;
◇ provide the argument --subnet-region on the command line.
Shielded VM configurations.
--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING
Enable monitoring of the boot integrity of the instance
--shielded-secure-boot=SHIELDED_SECURE_BOOT
Boot instance with secure boot enabled
--shielded-vtpm=SHIELDED_VTPM
Boot instance with TPM (Trusted Platform Module) enabled
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.

64
gcloud/workbench/instances/delete Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud workbench instances delete - request for deleting instances
SYNOPSIS
gcloud workbench instances delete (INSTANCE : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for deleting workbench instances.
EXAMPLES
To delete an instance, run:
$ gcloud workbench instances delete example-instance \
--location=us-central1-b
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

59
gcloud/workbench/instances/describe Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud workbench instances describe - request for describing instances
SYNOPSIS
gcloud workbench instances describe (INSTANCE : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for describing workbench instances.
EXAMPLES
To describe an instance, run:
$ gcloud workbench instances describe example-instance \
--location=us-central1-b
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

100
gcloud/workbench/instances/diagnose Normal file
View file

@ -0,0 +1,100 @@
NAME
gcloud workbench instances diagnose - request for diagnosing instances
SYNOPSIS
gcloud workbench instances diagnose (INSTANCE : --location=LOCATION)
--gcs-bucket=GCS_BUCKET [--async] [--enable-copy-home-files]
[--enable-packet-capture] [--enable-repair]
[--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for diagnosing workbench instances.
EXAMPLES
To diagnose an instance, run:
$ gcloud workbench instances diagnose example-instance \
--location=us-west1-b --gcs-bucket=gs://example-bucket
To diagnose an instance with a relative path:
$ gcloud workbench instances diagnose example-instance \
--location=us-west1-b --gcs-bucket=gs://example-bucket \
--relative-path=logs
To diagnose an instance, with packet capture:
$ gcloud workbench instances diagnose example-instance \
--location=us-west1-b --gcs-bucket=gs://example-bucket \
--enable-packet-capture
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
REQUIRED FLAGS
--gcs-bucket=GCS_BUCKET
The Cloud Storage bucket where the log files generated from the
diagnose command will be stored. storage.buckets.writer permissions
must be given to project's service account or user credential. Format:
gs://{gcs_bucket}
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--enable-copy-home-files
Enables flag to copy all /home/jupyter folder contents
--enable-packet-capture
Enables flag to capture packets from the instance for 30 seconds
--enable-repair
Enables flag to repair service for instance
--relative-path=RELATIVE_PATH
Defines the relative storage path in the Cloud Storage bucket where the
diagnostic logs will be written. Default path will be the root
directory of the Cloud Storage bucketFormat of full path:
gs://{gcs_bucket}/{relative_path}/
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.

90
gcloud/workbench/instances/get-iam-policy Normal file
View file

@ -0,0 +1,90 @@
NAME
gcloud workbench instances get-iam-policy - get IAM policy for an instance
SYNOPSIS
gcloud workbench instances get-iam-policy (INSTANCE : --location=LOCATION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud workbench instances get-iam-policy displays the IAM policy
associated with an instance. If formatted as JSON, the output can be edited
and used as a policy file for set-iam-policy. The output includes an "etag"
field identifying the version emitted and allowing detection of concurrent
policy updates; see $ {parent} set-iam-policy for additional details.
EXAMPLES
To print the IAM policy for a given instance, run:
$ gcloud workbench instances get-iam-policy my-instance \
--location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - The ID of the instance for which to display the IAM
policy. 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 instance on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the workbench instance.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.
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 notebooks/v2 API. The full documentation for this API
can be found at: https://cloud.google.com/notebooks/docs/

42
gcloud/workbench/instances/help
View file

@ -15,5 +15,47 @@ GCLOUD WIDE FLAGS
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
Add IAM policy binding for an instance.
check-instance-upgradability
Request for checking if an instance is upgradeable.
create
Request for creating an instance.
delete
Request for deleting instances.
describe
Request for describing instances.
diagnose
Request for diagnosing instances.
get-iam-policy
Get IAM policy for an instance.
list
Request for listing instances.
remove-iam-policy-binding
Remove IAM policy binding for an instance.
reset
Request for resetting instances.
set-iam-policy
Set the IAM policy for an Instance.
start
Request for starting instances.
stop
Request for stopping instances.
update
Request for updating instances.
upgrade
Request for upgrading instances.

89
gcloud/workbench/instances/remove-iam-policy-binding Normal file
View file

@ -0,0 +1,89 @@
NAME
gcloud workbench instances remove-iam-policy-binding - remove IAM policy
binding for an instance
SYNOPSIS
gcloud workbench instances remove-iam-policy-binding
(INSTANCE : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Removes a policy binding to the IAM policy of an instance, given an
instance ID and the binding.
EXAMPLES
To remove an IAM policy binding for the role of roles/editor for the user
'test-user@gmail.com' on the instance 'instance-id', run:
$ gcloud workbench instances remove-iam-policy-binding \
example-instance --member='user:test-user@gmail.com' \
--role='roles/editor' --location=us-central1-a
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Instance resource - The ID of the instance to remove the IAM binding. 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 instance on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the workbench instance.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
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 notebooks/v2 API. The full documentation for this API
can be found at: https://cloud.google.com/notebooks/docs/

64
gcloud/workbench/instances/reset Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud workbench instances reset - request for resetting instances
SYNOPSIS
gcloud workbench instances reset (INSTANCE : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for resetting workbench instances.
EXAMPLES
To reset an instance, run:
$ gcloud workbench instances reset example-instance \
--location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

77
gcloud/workbench/instances/set-iam-policy Normal file
View file

@ -0,0 +1,77 @@
NAME
gcloud workbench instances set-iam-policy - set the IAM policy for an
Instance
SYNOPSIS
gcloud workbench instances set-iam-policy (INSTANCE : --location=LOCATION)
POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud workbench instances set-iam-policy sets the IAM policy for a
Notebook instance given an instance ID and a JSON or YAML file that
describes the IAM policy.
Note: Setting the IAM policy for an Instance replaces existing IAM bindings
for that account.
EXAMPLES
The following command reads an IAM policy defined in the JSON file
policy.json and sets it for Instance ID my_instance at the specified
location:
$ gcloud workbench instances set-iam-policy my_instance \
--location=us-central1-a policy.json
See https://cloud.google.com/iam/docs/managing-policies for policy file
format and content details.
POSITIONAL ARGUMENTS
Instance resource - The ID of the instance for which to set the IAM
policy. 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 instance on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the workbench instance.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
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 notebooks/v2 API. The full documentation for this API
can be found at: https://cloud.google.com/notebooks/docs/

64
gcloud/workbench/instances/start Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud workbench instances start - request for starting instances
SYNOPSIS
gcloud workbench instances start (INSTANCE : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for starting workbench instances.
EXAMPLES
To start an instance, run:
$ gcloud workbench instances start example-instance \
--location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

64
gcloud/workbench/instances/stop Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud workbench instances stop - request for stopping instances
SYNOPSIS
gcloud workbench instances stop (INSTANCE : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for stopping workbench instances.
EXAMPLES
To stop an instance, run:
$ gcloud workbench instances stop example-instance \
--location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.

122
gcloud/workbench/instances/update Normal file
View file

@ -0,0 +1,122 @@
NAME
gcloud workbench instances update - request for updating instances
SYNOPSIS
gcloud workbench instances update (INSTANCE : --location=LOCATION)
[--async] [--labels=[KEY=VALUE,...]]
[--machine-type=MACHINE_TYPE --metadata=[KEY=VALUE,...]
--accelerator-core-count=ACCELERATOR_CORE_COUNT
--accelerator-type=ACCELERATOR_TYPE
--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH
--install-gpu-driver=INSTALL_GPU_DRIVER
--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING
--shielded-secure-boot=SHIELDED_SECURE_BOOT
--shielded-vtpm=SHIELDED_VTPM] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for updating workbench instances.
EXAMPLES
To update machine type for an instance, run:
$ gcloud workbench instances update example-instance \
--machine-type=n1-standard-8 --location=us-central1-a
To update labels for an instance, run:
$ gcloud workbench instances update example-instance \
--labels=k1=v1,k2=v2 --location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--labels=[KEY=VALUE,...]
Labels to apply to this instance. These can be later modified by the
setLabels method.
Gce Setup for the instance
--machine-type=MACHINE_TYPE
The Compute Engine machine type
(https://cloud.google.com/sdk/gcloud/reference/compute/machine-types)
of this instance.
--metadata=[KEY=VALUE,...]
Custom metadata to apply to this instance.
Accelerator configurations.
--accelerator-core-count=ACCELERATOR_CORE_COUNT
Count of cores of this accelerator.
--accelerator-type=ACCELERATOR_TYPE
Type of this accelerator. ACCELERATOR_TYPE must be one of:
NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100,
NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_A100,
NVIDIA_TESLA_A100_80GB, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS,
NVIDIA_TESLA_P4_VWS.
GPU driver configurations.
--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH
custom gpu driver path
--install-gpu-driver=INSTALL_GPU_DRIVER
Install gpu driver
Shielded VM configurations.
--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING
Enable monitoring of the boot integrity of the instance
--shielded-secure-boot=SHIELDED_SECURE_BOOT
Boot instance with secure boot enabled
--shielded-vtpm=SHIELDED_VTPM
Boot instance with TPM (Trusted Platform Module) enabled
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.

64
gcloud/workbench/instances/upgrade Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud workbench instances upgrade - request for upgrading instances
SYNOPSIS
gcloud workbench instances upgrade (INSTANCE : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Request for upgrading workbench instances.
EXAMPLES
To upgrade an instance, run:
$ gcloud workbench instances upgrade example-instance \
--location=us-central1-a
POSITIONAL ARGUMENTS
Instance resource - User-defined unique name of this instance. The
instance name must be 1 to 63 characters long and contain only lowercase
letters, numeric characters, and dashes. The first character must be a
lowercase letter and the last character cannot be a dash. 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location of this environment
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property notebooks/location.
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.