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: Thu Jan 19 00:56:33 UTC 2023

Browse source
This commit is contained in:
Automated 2023-01-19 00:56:33 +00:00
parent 348d9760ee
commit 1248f773ec
1462 changed files with 51835 additions and 5402 deletions
Download patch file Download diff file Expand all files Collapse all files

4
gcloud/alpha/composer/environments/check-upgrade
View file

@ -61,6 +61,7 @@ FLAGS
Upgrade the environment to a later Apache Airflow version in-place.
Must be of the form X[.Y[.Z]], where [] denotes optional fragments.
Examples: 2, 2.3, 2.3.4.
The Apache Airflow version is a semantic version or an alias in the
form of major or major.minor version numbers, resolved to the latest
@ -76,6 +77,9 @@ FLAGS
composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional
fragments.
Examples: composer-2-airflow-2, composer-2-airflow-2.2,
composer-2.1.2-airflow-2.3.4.
The Cloud Composer portion of the image version is a semantic version
or an alias in the form of major version number or latest, resolved
to the current Cloud Composer version. The Apache Airflow portion of

105
gcloud/alpha/composer/environments/create
View file

@ -6,7 +6,8 @@ SYNOPSIS
gcloud alpha composer environments create
(ENVIRONMENT : --location=LOCATION) [--airflow-configs=[KEY=VALUE,...]]
[--async] [--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE]
[--disk-size=DISK_SIZE] [--env-variables=[NAME=VALUE,...]]
[--disk-size=DISK_SIZE] [--enable-cloud-data-lineage-integration]
[--env-variables=[NAME=VALUE,...]]
[--environment-size=ENVIRONMENT_SIZE] [--labels=[KEY=VALUE,...]]
[--machine-type=MACHINE_TYPE] [--node-count=NODE_COUNT]
[--oauth-scopes=[SCOPE,...]] [--python-version=PYTHON_VERSION]
@ -16,8 +17,8 @@ SYNOPSIS
[--cloud-sql-ipv4-cidr=CLOUD_SQL_IPV4_CIDR
--composer-network-ipv4-cidr=COMPOSER_NETWORK_IPV4_CIDR
--connection-subnetwork=CONNECTION_SUBNETWORK
--enable-private-endpoint --enable-private-environment
--enable-privately-used-public-ips
--connection-type=CONNECTION_TYPE --enable-private-endpoint
--enable-private-environment --enable-privately-used-public-ips
--master-ipv4-cidr=MASTER_IPV4_CIDR
--web-server-ipv4-cidr=WEB_SERVER_IPV4_CIDR]
[--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR
@ -28,6 +29,12 @@ SYNOPSIS
--services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME]
[--enable-master-authorized-networks
--master-authorized-networks=[NETWORK,...]]
[--enable-scheduled-snapshot-creation
--snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE
--snapshot-location=SNAPSHOT_LOCATION
--snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE]
[--enable-triggerer
--triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[--maintenance-window-end=MAINTENANCE_WINDOW_END
@ -103,7 +110,9 @@ FLAGS
complete.
--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE
Cloud SQL machine type used by the Airflow database.
Cloud SQL machine type used by the Airflow database. The list of
available machine types is available here:
https://cloud.google.com/composer/pricing#db-machine-types.
--disk-size=DISK_SIZE
The disk size for each VM node in the environment. The minimum size is
@ -111,6 +120,12 @@ FLAGS
multiple of gigabytes. Cannot be updated after the environment has been
created. If units are not provided, defaults to GB.
Group of arguments for setting Cloud Data Lineage integration
configuration in Composer 2.
--enable-cloud-data-lineage-integration
Enable Cloud Data Lineage integration.
--env-variables=[NAME=VALUE,...]
A comma-delimited list of environment variable NAME=VALUE pairs to
provide to the Airflow scheduler, worker, and webserver processes. NAME
@ -180,6 +195,7 @@ FLAGS
Version of Apache Airflow to run in the environment.
Must be of the form `X[.Y[.Z]]`, where `[]` denotes optional fragments.
Examples: `2`, `2.3`, `2.3.4`.
The current Cloud Composer version will be used within the created
environment. The Apache Airflow version is a semantic version or an alias
@ -196,6 +212,9 @@ FLAGS
`composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]]`, where `[]` denotes optional
fragments.
Examples: `composer-2-airflow-2`, `composer-2-airflow-2.2`,
`composer-2.1.2-airflow-2.3.4`.
The Cloud Composer portion of the image version is a semantic version or
an alias in the form of major version number or `latest`, resolved to the
current Cloud Composer version. The Apache Airflow portion of the image
@ -229,6 +248,17 @@ FLAGS
Can be specified for Composer 2.X or greater. Cannot be specified
unless --enable-private-environment is also specified.
--connection-type=CONNECTION_TYPE
Mode of internal communication within the Composer environment. Must
be one of VPC_PEERING or PRIVATE_SERVICE_CONNECT.
Can be specified for Composer 2.X or greater. Cannot be specified
unless --enable-private-environment is also specified. Cannot be set
to VPC_PEERING if --connection-subnetwork is also specified.
CONNECTION_TYPE must be one of: connection-type-unspecified,
private-service-connect, vpc-peering.
--enable-private-endpoint
Environment cluster is managed using the private IP address of the
master API endpoint. Therefore access to the master endpoint must be
@ -246,7 +276,8 @@ FLAGS
If not specified, cluster nodes will be assigned public IP addresses.
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
--enable-privately-used-public-ips
When enabled GKE pods and services may use public(non-RFC1918) IP
@ -276,14 +307,16 @@ FLAGS
IP address range for the pods in this cluster in CIDR notation (e.g.
10.0.0.0/14).
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
--cluster-secondary-range-name=CLUSTER_SECONDARY_RANGE_NAME
Secondary range to be used as the source for pod IPs. Alias ranges
will be allocated from this secondary range. NAME must be the name of
an existing secondary range in the cluster subnetwork.
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
--enable-ip-alias
Enable use of alias IPs
@ -299,7 +332,8 @@ FLAGS
node's IP address. This is done when sending traffic to destinations
outside the cluster's pod CIDR range.
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
--max-pods-per-node=MAX_PODS_PER_NODE
Maximum number of pods that can be assigned to a single node, can be
@ -318,13 +352,15 @@ FLAGS
If unspecified, the services CIDR range will be chosen with a default
mask size.
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
--services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME
Secondary range to be used for services (e.g. ClusterIPs). NAME must
be the name of an existing secondary range in the cluster subnetwork.
Cannot be specified unless --enable-ip-alias is also specified.
When used with Composer 1.x, cannot be specified unless
--enable-ip-alias is also specified.
Master Authorized Networks configuration
@ -340,6 +376,55 @@ FLAGS
Cannot be specified unless --enable-master-authorized-networks is
also specified.
Group of arguments for setting scheduled snapshots settings in Composer
2.0.32 or greater.
--enable-scheduled-snapshot-creation
When specified, snapshots of the environment will be created
according to a schedule. Can be specified for Composer 2.0.32 or
greater.
This flag argument must be specified if any of the other arguments in
this group are specified.
--snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE
Cron expression specifying when snapshots of the environment should
be created. Can be specified for Composer 2.0.32 or greater.
This flag argument must be specified if any of the other arguments in
this group are specified.
--snapshot-location=SNAPSHOT_LOCATION
The Cloud Storage location for storing automatically created
snapshots. Can be specified for Composer 2.0.32 or greater.
This flag argument must be specified if any of the other arguments in
this group are specified.
--snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE
Timezone that sets the context to interpret
snapshot_creation_schedule. Can be specified for Composer 2.0.32 or
greater.
This flag argument must be specified if any of the other arguments in
this group are specified.
Group of arguments for setting triggerer settings in Composer 2.0.31 or
greater.
--enable-triggerer
Enable use of a triggerer, supported in the Environments with
Composer 2.0.31 and Airflow 2.2.5 and greater.
--triggerer-cpu=TRIGGERER_CPU
CPU allocated to Airflow triggerer. Supported in the Environments
with Composer 2.0.31 and Airflow 2.2.5 and greater.
--triggerer-memory=TRIGGERER_MEMORY
Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If units
are not provided, defaults to GB. Supported in the Environments with
Composer 2.0.31 and Airflow 2.2.5 and greater.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the environment. The 'Cloud Composer Service Agent'
service account must hold permission 'Cloud KMS CryptoKey

2
gcloud/alpha/composer/environments/help
View file

@ -22,7 +22,7 @@ GROUPS
GROUP is one of the following:
snapshots
(ALPHA) Saves and loads snapshots of environment.
(ALPHA) Save and load snapshots of environment.
storage
(ALPHA) Manage Cloud Storage objects stored as part of Cloud Composer

20
gcloud/alpha/composer/environments/run
View file

@ -64,16 +64,16 @@ POSITIONAL ARGUMENTS
The Airflow CLI subcommand to run. Available subcommands include
(listed with Airflow versions that support): backfill [**, 2.0.0),
clear [**, 2.0.0), connections [**, 3.0.0), dag_state [**, 2.0.0), dags
[1.10.14, 3.0.0), delete_dag [1.10.1, 2.0.0), kerberos [**, 3.0.0),
kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2, 2.0.0), list_dags
[**, 2.0.0), list_tasks [**, 2.0.0), next_execution [1.10.2, 2.0.0),
pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, 3.0.0), render
[**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0), sync-perm [1.10.14,
3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps [**, 2.0.0),
task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**, 2.0.0),
trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check [1.10.15,
2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0), version [**,
3.0.0) (see
[1.10.14, 3.0.0), db [2.3.0, 3.0.0), delete_dag [1.10.1, 2.0.0),
kerberos [**, 3.0.0), kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2,
2.0.0), list_dags [**, 2.0.0), list_tasks [**, 2.0.0), next_execution
[1.10.2, 2.0.0), pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14,
3.0.0), render [**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0),
sync-perm [1.10.14, 3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps
[**, 2.0.0), task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**,
2.0.0), trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check
[1.10.15, 2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0),
version [**, 3.0.0) (see
https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html
for more info).

6
gcloud/alpha/composer/environments/snapshots/help
View file

@ -1,5 +1,5 @@
NAME
gcloud alpha composer environments snapshots - saves and loads snapshots of
gcloud alpha composer environments snapshots - save and load snapshots of
environment
SYNOPSIS
@ -27,7 +27,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud composer environments snapshots
$ gcloud beta composer environments snapshots

18
gcloud/alpha/composer/environments/snapshots/load
View file

@ -5,7 +5,9 @@ NAME
SYNOPSIS
gcloud alpha composer environments snapshots load
(ENVIRONMENT : --location=LOCATION) --snapshot-path=SNAPSHOT_PATH
[--async] [--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...]
[--async] [--skip-airflow-overrides-setting]
[--skip-environment-variables-setting] [--skip-gcs-data-copying]
[--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Load a snapshot into the environment.
@ -55,6 +57,16 @@ OPTIONAL FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--skip-airflow-overrides-setting
When specified, skips setting Airflow overrides from the snapshot.
--skip-environment-variables-setting
When specified, skips setting environment variables from the snapshot.
--skip-gcs-data-copying
When specified, skips copying dags, plugins and data folders from the
snapshot.
--skip-pypi-packages-installation
When specified, skips the installation of custom PyPI packages from the
snapshot.
@ -71,7 +83,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud composer environments snapshots load
$ gcloud beta composer environments snapshots load

4
gcloud/alpha/composer/environments/snapshots/save
View file

@ -65,7 +65,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud composer environments snapshots save
$ gcloud beta composer environments snapshots save

101
gcloud/alpha/composer/environments/update
View file

@ -9,9 +9,16 @@ SYNOPSIS
| --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT
| --web-server-machine-type=WEB_SERVER_MACHINE_TYPE
| --airflow-version=AIRFLOW_VERSION | --image-version=IMAGE_VERSION
| --disable-cloud-data-lineage-integration
| --enable-cloud-data-lineage-integration
| --disable-master-authorized-networks
--enable-master-authorized-networks
--master-authorized-networks=[NETWORK,...]
| --disable-scheduled-snapshot-creation
| --enable-scheduled-snapshot-creation
--snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE
--snapshot-location=SNAPSHOT_LOCATION
--snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE
| --maintenance-window-end=MAINTENANCE_WINDOW_END
--maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE
--maintenance-window-start=MAINTENANCE_WINDOW_START
@ -21,7 +28,10 @@ SYNOPSIS
--scheduler-storage=SCHEDULER_STORAGE --web-server-cpu=WEB_SERVER_CPU
--web-server-memory=WEB_SERVER_MEMORY
--web-server-storage=WEB_SERVER_STORAGE --worker-cpu=WORKER_CPU
--worker-memory=WORKER_MEMORY --worker-storage=WORKER_STORAGE
--worker-memory=WORKER_MEMORY
--worker-storage=WORKER_STORAGE --disable-triggerer
| --enable-triggerer
--triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY
| --update-airflow-configs=[KEY=VALUE,...] --clear-airflow-configs
| --remove-airflow-configs=[KEY,...]
| --update-env-variables=[NAME=VALUE,...] --clear-env-variables
@ -79,7 +89,9 @@ REQUIRED FLAGS
Exactly one of these must be specified:
--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE
Cloud SQL machine type used by the Airflow database.
Cloud SQL machine type used by the Airflow database. The list of
available machine types is available here:
https://cloud.google.com/composer/pricing#db-machine-types.
--environment-size=ENVIRONMENT_SIZE
Size of the environment. Unspecified means that the default option
@ -102,6 +114,7 @@ REQUIRED FLAGS
Upgrade the environment to a later Apache Airflow version in-place.
Must be of the form X[.Y[.Z]], where [] denotes optional fragments.
Examples: 2, 2.3, 2.3.4.
The Apache Airflow version is a semantic version or an alias in the
form of major or major.minor version numbers, resolved to the
@ -117,6 +130,9 @@ REQUIRED FLAGS
composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional
fragments.
Examples: composer-2-airflow-2, composer-2-airflow-2.2,
composer-2.1.2-airflow-2.3.4.
The Cloud Composer portion of the image version is a semantic
version or an alias in the form of major version number or latest,
resolved to the current Cloud Composer version. The Apache Airflow
@ -126,6 +142,17 @@ REQUIRED FLAGS
Composer version. The resolved versions are stored in the upgraded
environment.
Group of arguments for setting Cloud Data Lineage integration
configuration in Composer 2.
At most one of these can be specified:
--disable-cloud-data-lineage-integration
Disable Cloud Data Lineage integration.
--enable-cloud-data-lineage-integration
Enable Cloud Data Lineage integration.
Group of arguments for setting master authorized networks configuration.
--disable-master-authorized-networks
@ -145,6 +172,49 @@ REQUIRED FLAGS
Cannot be specified unless --enable-master-authorized-networks is
also specified.
Group of arguments used during update of scheduled snapshots settings in
Composer 2.0.32 or greater.
At most one of these can be specified:
--disable-scheduled-snapshot-creation
Disables automated snapshots creation. Can be specified for
Composer 2.0.32 or greater.
Group of arguments for setting scheduled snapshots settings in
Composer 2.0.32 or greater.
--enable-scheduled-snapshot-creation
When specified, snapshots of the environment will be created
according to a schedule. Can be specified for Composer 2.0.32 or
greater.
This flag argument must be specified if any of the other
arguments in this group are specified.
--snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE
Cron expression specifying when snapshots of the environment
should be created. Can be specified for Composer 2.0.32 or
greater.
This flag argument must be specified if any of the other
arguments in this group are specified.
--snapshot-location=SNAPSHOT_LOCATION
The Cloud Storage location for storing automatically created
snapshots. Can be specified for Composer 2.0.32 or greater.
This flag argument must be specified if any of the other
arguments in this group are specified.
--snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE
Timezone that sets the context to interpret
snapshot_creation_schedule. Can be specified for Composer 2.0.32
or greater.
This flag argument must be specified if any of the other
arguments in this group are specified.
Group of arguments for setting the maintenance window value.
--maintenance-window-end=MAINTENANCE_WINDOW_END
@ -223,6 +293,33 @@ REQUIRED FLAGS
Storage allocated to Airflow worker, ex. 600MB, 3GB, 2. If units
are not provided, defaults to GB.
Group of arguments for setting triggerer settings in Composer 2.0.31
or greater.
At most one of these can be specified:
--disable-triggerer
Disable a triggerer, supported in the Environments with Composer
2.0.31 and Airflow 2.2.5 and greater.
Group of arguments for setting triggerer settings during update in
Composer 2.0.31 or greater.
--enable-triggerer
Enable use of a triggerer, supported in the Environments with
Composer 2.0.31 and Airflow 2.2.5 and greater.
--triggerer-cpu=TRIGGERER_CPU
CPU allocated to Airflow triggerer. Supported in the
Environments with Composer 2.0.31 and Airflow 2.2.5 and
greater.
--triggerer-memory=TRIGGERER_MEMORY
Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If
units are not provided, defaults to GB. Supported in the
Environments with Composer 2.0.31 and Airflow 2.2.5 and
greater.
Group of arguments for modifying the Airflow configuration.
--update-airflow-configs=[KEY=VALUE,...]