Try SpotterCreates a GCP Instance
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2Represents a Cloud SQL instance. Cloud SQL instances are SQL databases hosted in Google's cloud. The Instances resource provides methods for common configuration and management tasks.
- name: create a instance
google.cloud.gcp_sql_instance:
name: "{{resource_name}}-2"
settings:
ip_configuration:
authorized_networks:
- name: google dns server
value: 8.8.8.8/32
tier: db-n1-standard-1
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
name:
description:
- Name of the Cloud SQL instance. This does not include the project ID.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
region:
description:
- The geographical region. Defaults to us-central or us-central1 depending on the
instance type (First Generation or Second Generation/PostgreSQL).
required: false
type: str
scopes:
description:
- Array of scopes to be used
elements: str
type: list
project:
description:
- The Google Cloud Platform project to use.
type: str
env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str
settings:
description:
- The user settings.
required: false
suboptions:
availability_type:
description:
- The availabilityType define if your postgres instance is run zonal or regional.
- 'Some valid choices include: "ZONAL", "REGIONAL"'
required: false
type: str
backup_configuration:
description:
- The daily backup configuration for the instance.
required: false
suboptions:
binary_log_enabled:
description:
- Whether binary log is enabled. If backup configuration is disabled, binary
log must be disabled as well. MySQL only.
required: false
type: bool
enabled:
description:
- Enable Autobackup for your instance.
required: false
type: bool
start_time:
description:
- Define the backup start time in UTC (HH:MM) .
required: false
type: str
type: dict
database_flags:
description:
- The database flags passed to the instance at startup.
elements: dict
required: false
suboptions:
name:
description:
- The name of the flag. These flags are passed at instance startup, so include
both server options and system variables for MySQL. Flags should be specified
with underscores, not hyphens.
required: false
type: str
value:
description:
- The value of the flag. Booleans should be set to on for true and off for
false. This field must be omitted if the flag doesn't take a value.
required: false
type: str
type: list
ip_configuration:
description:
- The settings for IP Management. This allows to enable or disable the instance
IP and manage which external networks can connect to the instance. The IPv4
address cannot be disabled for Second Generation instances.
required: false
suboptions:
authorized_networks:
description:
- The list of external networks that are allowed to connect to the instance
using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
elements: dict
required: false
suboptions:
expiration_time:
description:
- The time when this access control entry expires in RFC 3339 format,
for example 2012-11-15T16:19:00.094Z.
required: false
type: str
name:
description:
- An optional label to identify this entry.
required: false
type: str
value:
description:
- The whitelisted value for the access control list. For example, to grant
access to a client from an external IP (IPv4 or IPv6) address or subnet,
use that address or subnet here.
required: false
type: str
type: list
ipv4_enabled:
description:
- Whether the instance should be assigned an IP address or not.
required: false
type: bool
require_ssl:
description:
- Whether the mysqld should default to 'REQUIRE X509' for users connecting
over IP.
required: false
type: bool
type: dict
tier:
description:
- The tier or machine type for this instance, for example db-n1-standard-1. For
MySQL instances, this field determines whether the instance is Second Generation
(recommended) or First Generation.
required: false
type: str
user_labels:
description:
- User-provided labels, represented as a dictionary where each label is a single
key value pair.
required: false
type: dict
type: dict
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
backend_type:
description:
- '* FIRST_GEN: First Generation instance. MySQL only.'
- '* SECOND_GEN: Second Generation instance or PostgreSQL instance.'
- '* EXTERNAL: A database server that is not managed by Google.'
- 'Some valid choices include: "FIRST_GEN", "SECOND_GEN", "EXTERNAL"'
required: false
type: str
ipv6_address:
description:
- The IPv6 address assigned to the instance. This property is applicable only to First
Generation instances.
required: false
type: str
instance_type:
description:
- The instance type. This can be one of the following.
- '* CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.'
- '* ON_PREMISES_INSTANCE: An instance running on the customer''s premises.'
- '* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.'
- 'Some valid choices include: "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", "READ_REPLICA_INSTANCE"'
required: false
type: str
max_disk_size:
description:
- The maximum disk size of the instance in bytes.
required: false
type: int
connection_name:
description:
- Connection name of the Cloud SQL instance used in connection strings.
required: false
type: str
database_version:
description:
- The database engine type and version. For First Generation instances, can be MYSQL_5_5,
or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7. Defaults
to MYSQL_5_6.
- 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed
after instance creation.'
- 'Some valid choices include: "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "POSTGRES_9_6"'
required: false
type: str
failover_replica:
description:
- The name and status of the failover replica. This property is applicable only to
Second Generation instances.
required: false
suboptions:
name:
description:
- The name of the failover replica. If specified at instance creation, a failover
replica is created for the instance. The name doesn't include the project ID.
This property is applicable only to Second Generation instances.
required: false
type: str
type: dict
master_instance_name:
description:
- The name of the instance which will act as master in the replication setup.
required: false
type: str
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
replica_configuration:
description:
- Configuration specific to failover replicas and read replicas.
required: false
suboptions:
failover_target:
description:
- Specifies if the replica is the failover target. If the field is set to true
the replica will be designated as a failover replica.
- In case the master instance fails, the replica instance will be promoted as
the new master instance.
- Only one replica can be specified as failover target, and the replica has to
be in different zone with the master instance.
required: false
type: bool
mysql_replica_configuration:
description:
- MySQL specific configuration when replicating from a MySQL on-premises master.
Replication configuration information such as the username, password, certificates,
and keys are not stored in the instance metadata. The configuration information
is used only to set up the replication connection and is stored by MySQL in
a file named master.info in the data directory.
required: false
suboptions:
ca_certificate:
description:
- PEM representation of the trusted CA's x509 certificate.
required: false
type: str
client_certificate:
description:
- PEM representation of the replica's x509 certificate .
required: false
type: str
client_key:
description:
- PEM representation of the replica's private key. The corresponding public
key is encoded in the client's certificate.
required: false
type: str
connect_retry_interval:
description:
- Seconds to wait between connect retries. MySQL's default is 60 seconds.
required: false
type: int
dump_file_path:
description:
- Path to a SQL dump file in Google Cloud Storage from which the replica instance
is to be created. The URI is in the form gs://bucketName/fileName. Compressed
gzip files (.gz) are also supported. Dumps should have the binlog coordinates
from which replication should begin. This can be accomplished by setting
--master-data to 1 when using mysqldump.
required: false
type: str
master_heartbeat_period:
description:
- Interval in milliseconds between replication heartbeats.
required: false
type: int
password:
description:
- The password for the replication connection.
required: false
type: str
ssl_cipher:
description:
- A list of permissible ciphers to use for SSL encryption.
required: false
type: str
username:
description:
- The username for the replication connection.
required: false
type: str
verify_server_certificate:
description:
- Whether or not to check the master's Common Name value in the certificate
that it sends during the SSL handshake.
required: false
type: bool
type: dict
replica_names:
description:
- The replicas of the instance.
elements: str
required: false
type: list
service_account_email_address:
description:
- The service account email address assigned to the instance. This property is
applicable only to Second Generation instances.
required: false
type: str
type: dict
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
disk_encryption_status:
description:
- Disk encryption status.
required: false
suboptions:
kms_key_version_name:
description:
- The KMS key version used to encrypt the Cloud SQL instance .
required: false
type: str
type: dict
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
disk_encryption_configuration:
description:
- Disk encryption settings.
required: false
suboptions:
kms_key_name:
description:
- The KMS key used to encrypt the Cloud SQL instance .
required: false
type: str
type: dict
backendType:
description:
- '* FIRST_GEN: First Generation instance. MySQL only.'
- '* SECOND_GEN: Second Generation instance or PostgreSQL instance.'
- '* EXTERNAL: A database server that is not managed by Google.'
returned: success
type: str
connectionName:
description:
- Connection name of the Cloud SQL instance used in connection strings.
returned: success
type: str
databaseVersion:
description:
- The database engine type and version. For First Generation instances, can be MYSQL_5_5,
or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7.
Defaults to MYSQL_5_6.
- 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed
after instance creation.'
returned: success
type: str
diskEncryptionConfiguration:
contains:
kmsKeyName:
description:
- The KMS key used to encrypt the Cloud SQL instance .
returned: success
type: str
description:
- Disk encryption settings.
returned: success
type: complex
diskEncryptionStatus:
contains:
kmsKeyVersionName:
description:
- The KMS key version used to encrypt the Cloud SQL instance .
returned: success
type: str
description:
- Disk encryption status.
returned: success
type: complex
failoverReplica:
contains:
available:
description:
- The availability status of the failover replica. A false status indicates
that the failover replica is out of sync. The master can only failover to
the failover replica when the status is true.
returned: success
type: bool
name:
description:
- The name of the failover replica. If specified at instance creation, a failover
replica is created for the instance. The name doesn't include the project
ID. This property is applicable only to Second Generation instances.
returned: success
type: str
description:
- The name and status of the failover replica. This property is applicable only
to Second Generation instances.
returned: success
type: complex
gceZone:
description:
- The Compute Engine zone that the instance is currently serving from. This value
could be different from the zone that was specified when the instance was created
if the instance has failed over to its secondary zone.
returned: success
type: str
instanceType:
description:
- The instance type. This can be one of the following.
- '* CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.'
- '* ON_PREMISES_INSTANCE: An instance running on the customer''s premises.'
- '* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.'
returned: success
type: str
ipAddresses:
contains:
ipAddress:
description:
- The IP address assigned.
returned: success
type: str
timeToRetire:
description:
- The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
This field is only available when the IP is scheduled to be retired.
returned: success
type: str
type:
description:
- The type of this IP address. A PRIMARY address is an address that can accept
incoming connections. An OUTGOING address is the source address of connections
originating from the instance, if supported.
returned: success
type: str
description:
- The assigned IP addresses for the instance.
returned: success
type: complex
ipv6Address:
description:
- The IPv6 address assigned to the instance. This property is applicable only to
First Generation instances.
returned: success
type: str
masterInstanceName:
description:
- The name of the instance which will act as master in the replication setup.
returned: success
type: str
maxDiskSize:
description:
- The maximum disk size of the instance in bytes.
returned: success
type: int
name:
description:
- Name of the Cloud SQL instance. This does not include the project ID.
returned: success
type: str
region:
description:
- The geographical region. Defaults to us-central or us-central1 depending on the
instance type (First Generation or Second Generation/PostgreSQL).
returned: success
type: str
replicaConfiguration:
contains:
failoverTarget:
description:
- Specifies if the replica is the failover target. If the field is set to true
the replica will be designated as a failover replica.
- In case the master instance fails, the replica instance will be promoted as
the new master instance.
- Only one replica can be specified as failover target, and the replica has
to be in different zone with the master instance.
returned: success
type: bool
mysqlReplicaConfiguration:
contains:
caCertificate:
description:
- PEM representation of the trusted CA's x509 certificate.
returned: success
type: str
clientCertificate:
description:
- PEM representation of the replica's x509 certificate .
returned: success
type: str
clientKey:
description:
- PEM representation of the replica's private key. The corresponding public
key is encoded in the client's certificate.
returned: success
type: str
connectRetryInterval:
description:
- Seconds to wait between connect retries. MySQL's default is 60 seconds.
returned: success
type: int
dumpFilePath:
description:
- Path to a SQL dump file in Google Cloud Storage from which the replica
instance is to be created. The URI is in the form gs://bucketName/fileName.
Compressed gzip files (.gz) are also supported. Dumps should have the
binlog coordinates from which replication should begin. This can be accomplished
by setting --master-data to 1 when using mysqldump.
returned: success
type: str
masterHeartbeatPeriod:
description:
- Interval in milliseconds between replication heartbeats.
returned: success
type: int
password:
description:
- The password for the replication connection.
returned: success
type: str
sslCipher:
description:
- A list of permissible ciphers to use for SSL encryption.
returned: success
type: str
username:
description:
- The username for the replication connection.
returned: success
type: str
verifyServerCertificate:
description:
- Whether or not to check the master's Common Name value in the certificate
that it sends during the SSL handshake.
returned: success
type: bool
description:
- MySQL specific configuration when replicating from a MySQL on-premises master.
Replication configuration information such as the username, password, certificates,
and keys are not stored in the instance metadata. The configuration information
is used only to set up the replication connection and is stored by MySQL in
a file named master.info in the data directory.
returned: success
type: complex
replicaNames:
description:
- The replicas of the instance.
returned: success
type: list
serviceAccountEmailAddress:
description:
- The service account email address assigned to the instance. This property
is applicable only to Second Generation instances.
returned: success
type: str
description:
- Configuration specific to failover replicas and read replicas.
returned: success
type: complex
serverCaCert:
contains:
cert:
description:
- PEM representation of the X.509 certificate.
returned: success
type: str
certSerialNumber:
description:
- Serial number, as extracted from the certificate.
returned: success
type: str
commonName:
description:
- User supplied name. Constrained to [a-zA-Z.-_ ]+.
returned: success
type: str
createTime:
description:
- The time when the certificate was created in RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
returned: success
type: str
expirationTime:
description:
- The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
returned: success
type: str
sha1Fingerprint:
description:
- SHA-1 fingerprint of the certificate.
returned: success
type: str
description:
- SSL configuration.
returned: success
type: complex
settings:
contains:
availabilityType:
description:
- The availabilityType define if your postgres instance is run zonal or regional.
returned: success
type: str
backupConfiguration:
contains:
binaryLogEnabled:
description:
- Whether binary log is enabled. If backup configuration is disabled, binary
log must be disabled as well. MySQL only.
returned: success
type: bool
enabled:
description:
- Enable Autobackup for your instance.
returned: success
type: bool
startTime:
description:
- Define the backup start time in UTC (HH:MM) .
returned: success
type: str
description:
- The daily backup configuration for the instance.
returned: success
type: complex
databaseFlags:
contains:
name:
description:
- The name of the flag. These flags are passed at instance startup, so include
both server options and system variables for MySQL. Flags should be specified
with underscores, not hyphens.
returned: success
type: str
value:
description:
- The value of the flag. Booleans should be set to on for true and off for
false. This field must be omitted if the flag doesn't take a value.
returned: success
type: str
description:
- The database flags passed to the instance at startup.
returned: success
type: complex
ipConfiguration:
contains:
authorizedNetworks:
contains:
expirationTime:
description:
- The time when this access control entry expires in RFC 3339 format,
for example 2012-11-15T16:19:00.094Z.
returned: success
type: str
name:
description:
- An optional label to identify this entry.
returned: success
type: str
value:
description:
- The whitelisted value for the access control list. For example, to
grant access to a client from an external IP (IPv4 or IPv6) address
or subnet, use that address or subnet here.
returned: success
type: str
description:
- The list of external networks that are allowed to connect to the instance
using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
returned: success
type: complex
ipv4Enabled:
description:
- Whether the instance should be assigned an IP address or not.
returned: success
type: bool
requireSsl:
description:
- Whether the mysqld should default to 'REQUIRE X509' for users connecting
over IP.
returned: success
type: bool
description:
- The settings for IP Management. This allows to enable or disable the instance
IP and manage which external networks can connect to the instance. The IPv4
address cannot be disabled for Second Generation instances.
returned: success
type: complex
settingsVersion:
description:
- The version of instance settings. This is a required field for update method
to make sure concurrent updates are handled properly.
- During update, use the most recent settingsVersion value for this instance
and do not try to update this value.
returned: success
type: int
tier:
description:
- The tier or machine type for this instance, for example db-n1-standard-1.
For MySQL instances, this field determines whether the instance is Second
Generation (recommended) or First Generation.
returned: success
type: str
userLabels:
description:
- User-provided labels, represented as a dictionary where each label is a single
key value pair.
returned: success
type: dict
description:
- The user settings.
returned: success
type: complex
state:
description:
- The current serving state of the database instance.
returned: success
type: str