1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00

gcloud: Wed Jun 8 09:13:38 UTC 2022

This commit is contained in:
Automated 2022-06-08 09:13:38 +00:00
parent 82063cbb03
commit 28d031b3c1
Failed to extract signature
240 changed files with 3156 additions and 1115 deletions

View file

@ -6,26 +6,34 @@ SYNOPSIS
gcloud database-migration connection-profiles create cloudsql
(CONNECTION_PROFILE : --region=REGION)
--database-version=DATABASE_VERSION --source-id=SOURCE_ID --tier=TIER
[--activation-policy=ACTIVATION_POLICY]
[--activation-policy=ACTIVATION_POLICY] [--no-async]
[--authorized-networks=NETWORK,[NETWORK,...]]
[--no-auto-storage-increase] [--data-disk-size=DATA_DISK_SIZE]
[--data-disk-type=DATA_DISK_TYPE] [--database-flags=[KEY=VALUE,...]]
[--data-disk-type=DATA_DISK_TYPE] [--database-flags=[FLAG=VALUE,...]]
[--display-name=DISPLAY_NAME] [--no-enable-ip-v4]
[--labels=[KEY=VALUE,...]] [--private-network=PRIVATE_NETWORK]
[--provider=PROVIDER] [--require-ssl]
[--provider=PROVIDER] [--require-ssl] [--root-password=ROOT_PASSWORD]
[--storage-auto-resize-limit=STORAGE_AUTO_RESIZE_LIMIT]
[--user-labels=[KEY=VALUE,...]] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a Database Migration Service connection profile for Cloud SQL.
Create a Database Migration Service destination connection profile for
Cloud SQL. This will create a Cloud SQL replica.
EXAMPLES
To create a connection profile for Cloud SQL with database version MySQL
5.6:
$ gcloud database-migration connection-profiles create cloudsql \
CONNECTION_PROFILE --region=us-central1 \
--display-name=my-profile --database-version=MYSQL_5_6
my-profile --region=us-central1 --database-version=MYSQL_5_6 \
--source-id=cp1 --tier=db-n1-standard-1
To create a connection profile for Cloud SQL and a Cloud SQL replica with
database version PostgreSQL 10:
$ gcloud database-migration connection-profiles create cloudsql \
my-profile --region=us-central1 --database-version=POSTGRES_10 \
--source-id=cp1 --tier=db-custom-1-3840 --zone=us-central1-a
POSITIONAL ARGUMENTS
Connection profile resource - The connection profile to create. The
@ -56,10 +64,9 @@ POSITIONAL ARGUMENTS
REQUIRED FLAGS
--database-version=DATABASE_VERSION
Database engine type and version (MYSQL_5_7, MYSQL_5_6, MYSQL_8_0,
POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13).
DATABASE_VERSION must be one of: MYSQL_5_7, MYSQL_5_6, MYSQL_8_0,
POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13.
Database engine type and version. DATABASE_VERSION must be one of:
MYSQL_5_7, MYSQL_5_6, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10,
POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14.
Connection profile resource - Database Migration Service source connection
profile ID. This represents a Cloud resource. (NOTE) Some attributes are
@ -82,7 +89,7 @@ REQUIRED FLAGS
--tier=TIER
Tier (or machine type) for this instance, for example: db-n1-standard-1
(MySQL instances) of db-custom-1-3840 (PostgreSQL instances). For more
(MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more
information, see Cloud SQL Instance Settings
(https://cloud.google.com/sql/docs/mysql/instance-settings).
@ -99,18 +106,20 @@ OPTIONAL FLAGS
ACTIVATION_POLICY must be one of: ALWAYS, NEVER.
--no-async
Waits for the operation in progress to complete before returning.
--authorized-networks=NETWORK,[NETWORK,...]
List of external networks that are allowed to connect to the instance
using the IP. See
https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known
as 'slash' notation (e.g.192.168.100.0/24).
List of external networks that are allowed to connect to the instance.
Specify values in CIDR notation, also known as 'slash' notation
(e.g.192.168.100.0/24).
--auto-storage-increase
If you enable this setting, Cloud SQL checks your available storage
every 30 seconds. If the available storage falls below a threshold
size, Cloud SQL automatically adds additional storage capacity. If the
available storage repeatedly falls below the threshold size, Cloud SQL
continues to add storage until it reaches the maximum of 30 TB.
continues to add storage until it reaches the maximum of 64 TB.
Default: ON. Enabled by default, use --no-auto-storage-increase to
disable.
@ -119,16 +128,20 @@ OPTIONAL FLAGS
default) size is 10GB.
--data-disk-type=DATA_DISK_TYPE
Type of storage: PD_SSD (default) or PD_HDD. DATA_DISK_TYPE must be one
of: PD_SSD, PD_HDD.
Type of storage. DATA_DISK_TYPE must be one of: PD_SSD, PD_HDD.
--database-flags=[KEY=VALUE,...]
Database flags passed to the Cloud SQL instance at startup. An object
containing a list of "key": value pairs. Example: { "name": "wrench",
"mass": "1.3kg", "count": "3" }.
--database-flags=[FLAG=VALUE,...]
Comma-separated list of database flags to set on the instance. Use an
equals sign to separate the flag name and value. Flags without values,
like skip_grant_tables, can be written out without a value, e.g.,
skip_grant_tables=. Use on/off values for booleans. View the Instance
Resource API for allowed flags. (e.g., --database-flags
max_allowed_packet=55555 skip_grant_tables=,log_output=1).
--display-name=DISPLAY_NAME
Friendly name for the connection profile.
A user-friendly name for the connection profile. The display name can
include letters, numbers, spaces, and hyphens, and must start with a
letter.
--enable-ip-v4
Whether the instance should be assigned an IPv4 address or not. Enabled
@ -149,12 +162,15 @@ OPTIONAL FLAGS
updated, but it cannot be removed after it is set.
--provider=PROVIDER
Database provider (CLOUDSQL or RDS). PROVIDER must be one of: RDS,
Database provider, for managed databases. PROVIDER must be one of: RDS,
CLOUDSQL.
--require-ssl
Whether SSL connections over IP should be enforced or not.
--root-password=ROOT_PASSWORD
Root Cloud SQL user's password.
--storage-auto-resize-limit=STORAGE_AUTO_RESIZE_LIMIT
Maximum size to which storage capacity can be automatically increased.
The default value is 0, which specifies that there is no limit.

View file

@ -8,6 +8,11 @@ SYNOPSIS
DESCRIPTION
Commands for creating Database Migration Service connection profiles.
▪ Create a source connection profile with the mysql or postgresql
commands.
▪ Create a destination connection profile for a Cloud SQL instance with
the cloudsql command. For Cloud SQL instance as a source, use the
create command for the relevant engine type (e.g. mysql).
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.

View file

@ -6,8 +6,9 @@ SYNOPSIS
gcloud database-migration connection-profiles create mysql
(CONNECTION_PROFILE : --region=REGION) --host=HOST --port=PORT
--username=USERNAME (--password=PASSWORD | --prompt-for-password)
[--cloudsql-instance=CLOUDSQL_INSTANCE] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--provider=PROVIDER]
[--no-async] [--cloudsql-instance=CLOUDSQL_INSTANCE]
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
[--provider=PROVIDER]
[--ca-certificate=CA_CERTIFICATE
: --client-certificate=CLIENT_CERTIFICATE --private-key=PRIVATE_KEY]
[GCLOUD_WIDE_FLAG ...]
@ -19,16 +20,15 @@ EXAMPLES
To create a connection profile for MySQL:
$ gcloud database-migration connection-profiles create mysql \
CONNECTION_PROFILE --region=us-central1 --password=123456 \
--username=fakeuser --display-name=my-profile --host=1.2.3.4 \
--port=1111
my-profile --region=us-central1 --password=123456 \
--username=my-user --host=1.2.3.4 --port=3306
If the source is a Cloud SQL database, run:
$ gcloud database-migration connection-profiles create mysql \
CONNECTION_PROFILE --region=us-central1 --password=123456 \
--username=fakeuser --display-name=my-profile --host=1.2.3.4 \
--port=1111 --cloudsql-instance=my-instance
my-profile --region=us-central1 --password=123456 \
--username=my-user --host=1.2.3.4 --port=3306 \
--cloudsql-instance=my-instance --provider=CLOUDSQL
POSITIONAL ARGUMENTS
Connection profile resource - The connection profile to create. The
@ -65,27 +65,32 @@ REQUIRED FLAGS
Network port of the source database.
--username=USERNAME
Username that Database Migration Service will use to connect to the
database. The value is encrypted when stored in Database Migration
Service.
Username that Database Migration Service uses to connect to the
database. Database Migration Service encrypts the value when storing
it.
Exactly one of these must be specified:
--password=PASSWORD
Password for the user that Database Migration Service will be using
to connect to the database. This field is not returned on request,
and the value is encrypted when stored in Database Migration Service.
Password for the user that Database Migration Service uses to connect
to the source database. Database Migration Service encrypts the value
when storing it, and the field is not returned on request.
--prompt-for-password
Prompt for the password used to connect to the database.
OPTIONAL FLAGS
--no-async
Waits for the operation in progress to complete before returning.
--cloudsql-instance=CLOUDSQL_INSTANCE
If the source is a Cloud SQL database, use this field to provide the
Cloud SQL instance ID of the source.
--display-name=DISPLAY_NAME
Friendly name for the connection profile.
A user-friendly name for the connection profile. The display name can
include letters, numbers, spaces, and hyphens, and must start with a
letter.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
@ -96,21 +101,24 @@ OPTIONAL FLAGS
numbers.
--provider=PROVIDER
Database provider (CLOUDSQL or RDS). PROVIDER must be one of: RDS,
Database provider, for managed databases. PROVIDER must be one of: RDS,
CLOUDSQL.
--ca-certificate=CA_CERTIFICATE
x509 PEM-encoded certificate of the CA that signed the source database
server's certificate. The replica will use this certificate to verify
it's connecting to the right host.
it's connecting to the correct host. Database Migration Service
encrypts the value when storing it.
--client-certificate=CLIENT_CERTIFICATE
x509 PEM-encoded certificate that will be used by the replica to
authenticate against the source database server.
authenticate against the source database server. Database Migration
Service encrypts the value when storing it.
--private-key=PRIVATE_KEY
Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with
the Client Certificate.
the Client Certificate. Database Migration Service encrypts the value
when storing it.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

View file

@ -6,8 +6,8 @@ SYNOPSIS
gcloud database-migration connection-profiles create postgresql
(CONNECTION_PROFILE : --region=REGION) --host=HOST --port=PORT
--username=USERNAME (--password=PASSWORD | --prompt-for-password)
[--cloudsql-instance=CLOUDSQL_INSTANCE] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]]
[--no-async] [--cloudsql-instance=CLOUDSQL_INSTANCE]
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
[--ca-certificate=CA_CERTIFICATE
: --client-certificate=CLIENT_CERTIFICATE --private-key=PRIVATE_KEY]
[GCLOUD_WIDE_FLAG ...]
@ -19,16 +19,15 @@ EXAMPLES
To create a connection profile for PostgreSQL:
$ gcloud database-migration connection-profiles create postgresql \
CONNECTION_PROFILE --region=us-central1 --password=123456 \
--username=fakeuser --display-name=my-profile --host=1.2.3.4 \
--port=1111
my-profile --region=us-central1 --password=123456 \
--username=my-user --host=1.2.3.4 --port=5432
If the source is a Cloud SQL database, run:
$ gcloud database-migration connection-profiles create postgresql \
CONNECTION_PROFILE --region=us-central1 --password=123456 \
--username=fakeuser --display-name=my-profile --host=1.2.3.4 \
--port=1111 --cloudsql-instance=my-instance
my-profile --region=us-central1 --password=123456 \
--username=my-user --host=1.2.3.4 --port=5432 \
--cloudsql-instance=my-instance
POSITIONAL ARGUMENTS
Connection profile resource - The connection profile to create. The
@ -65,27 +64,32 @@ REQUIRED FLAGS
Network port of the source database.
--username=USERNAME
Username that Database Migration Service will use to connect to the
database. The value is encrypted when stored in Database Migration
Service.
Username that Database Migration Service uses to connect to the
database. Database Migration Service encrypts the value when storing
it.
Exactly one of these must be specified:
--password=PASSWORD
Password for the user that Database Migration Service will be using
to connect to the database. This field is not returned on request,
and the value is encrypted when stored in Database Migration Service.
Password for the user that Database Migration Service uses to connect
to the source database. Database Migration Service encrypts the value
when storing it, and the field is not returned on request.
--prompt-for-password
Prompt for the password used to connect to the database.
OPTIONAL FLAGS
--no-async
Waits for the operation in progress to complete before returning.
--cloudsql-instance=CLOUDSQL_INSTANCE
If the source is a Cloud SQL database, use this field to provide the
Cloud SQL instance ID of the source.
--display-name=DISPLAY_NAME
Friendly name for the connection profile.
A user-friendly name for the connection profile. The display name can
include letters, numbers, spaces, and hyphens, and must start with a
letter.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
@ -98,15 +102,18 @@ OPTIONAL FLAGS
--ca-certificate=CA_CERTIFICATE
x509 PEM-encoded certificate of the CA that signed the source database
server's certificate. The replica will use this certificate to verify
it's connecting to the right host.
it's connecting to the correct host. Database Migration Service
encrypts the value when storing it.
--client-certificate=CLIENT_CERTIFICATE
x509 PEM-encoded certificate that will be used by the replica to
authenticate against the source database server.
authenticate against the source database server. Database Migration
Service encrypts the value when storing it.
--private-key=PRIVATE_KEY
Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with
the Client Certificate.
the Client Certificate. Database Migration Service encrypts the value
when storing it.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,