gcp_sql_instance – Creates a GCP Instance

New in version 2.7.

Synopsis

  • Represents 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.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
backend_type
-
    Choices:
  • FIRST_GEN
  • SECOND_GEN
  • EXTERNAL
* 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.
connection_name
-
Connection name of the Cloud SQL instance used in connection strings.
database_version
-
    Choices:
  • MYSQL_5_5
  • MYSQL_5_6
  • MYSQL_5_7
  • POSTGRES_9_6
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.
failover_replica
-
The name and status of the failover replica. This property is applicable only to Second Generation instances.
name
-
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.
instance_type
-
    Choices:
  • CLOUD_SQL_INSTANCE
  • ON_PREMISES_INSTANCE
  • READ_REPLICA_INSTANCE
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.
ipv6_address
-
The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
master_instance_name
-
The name of the instance which will act as master in the replication setup.
max_disk_size
-
The maximum disk size of the instance in bytes.
name
- / required
Name of the Cloud SQL instance. This does not include the project ID.
project
string
The Google Cloud Platform project to use.
region
-
The geographical region. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation/PostgreSQL).
replica_configuration
-
Configuration specific to failover replicas and read replicas.
failover_target
boolean
    Choices:
  • no
  • yes
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.
mysql_replica_configuration
-
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.
ca_certificate
-
PEM representation of the trusted CA's x509 certificate.
client_certificate
-
PEM representation of the slave's x509 certificate .
client_key
-
PEM representation of the slave's private key. The corresponding public key is encoded in the client's certificate.
connect_retry_interval
-
Seconds to wait between connect retries. MySQL's default is 60 seconds.
dump_file_path
-
Path to a SQL dump file in Google Cloud Storage from which the slave 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 co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
master_heartbeat_period
-
Interval in milliseconds between replication heartbeats.
password
-
The password for the replication connection.
ssl_cipher
-
A list of permissible ciphers to use for SSL encryption.
username
-
The username for the replication connection.
verify_server_certificate
boolean
    Choices:
  • no
  • yes
Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
replica_names
-
The replicas of the instance.
service_account_email_address
-
The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
scopes
list
Array of scopes to be used.
service_account_contents
string
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
The path of a Service Account JSON file if serviceaccount is selected as type.
settings
-
The user settings.
availability_type
-
    Choices:
  • ZONAL
  • REGIONAL
The availabilityType define if your postgres instance is run zonal or regional.
backup_configuration
-
The daily backup configuration for the instance.
binary_log_enabled
boolean
    Choices:
  • no
  • yes
Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. MySQL only.
enabled
boolean
    Choices:
  • no
  • yes
Enable Autobackup for your instance.
start_time
-
Define the backup start time in UTC (HH:MM) .
ip_configuration
-
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.
authorized_networks
-
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).
expiration_time
-
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
name
-
An optional label to identify this entry.
value
-
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.
ipv4_enabled
boolean
    Choices:
  • no
  • yes
Whether the instance should be assigned an IP address or not.
require_ssl
boolean
    Choices:
  • no
  • yes
Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
tier
-
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.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP

Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a instance
  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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
backendType
string
success
* 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.

connectionName
string
success
Connection name of the Cloud SQL instance used in connection strings.

databaseVersion
string
success
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.

failoverReplica
complex
success
The name and status of the failover replica. This property is applicable only to Second Generation instances.

  available
boolean
success
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.

  name
string
success
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.

instanceType
string
success
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.

ipAddresses
complex
success
The assigned IP addresses for the instance.

  ipAddress
string
success
The IP address assigned.

  timeToRetire
string
success
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.

  type
string
success
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.

ipv6Address
string
success
The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.

masterInstanceName
string
success
The name of the instance which will act as master in the replication setup.

maxDiskSize
integer
success
The maximum disk size of the instance in bytes.

name
string
success
Name of the Cloud SQL instance. This does not include the project ID.

region
string
success
The geographical region. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation/PostgreSQL).

replicaConfiguration
complex
success
Configuration specific to failover replicas and read replicas.

  failoverTarget
boolean
success
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.

  mysqlReplicaConfiguration
complex
success
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.

    caCertificate
string
success
PEM representation of the trusted CA's x509 certificate.

    clientCertificate
string
success
PEM representation of the slave's x509 certificate .

    clientKey
string
success
PEM representation of the slave's private key. The corresponding public key is encoded in the client's certificate.

    connectRetryInterval
integer
success
Seconds to wait between connect retries. MySQL's default is 60 seconds.

    dumpFilePath
string
success
Path to a SQL dump file in Google Cloud Storage from which the slave 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 co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.

    masterHeartbeatPeriod
integer
success
Interval in milliseconds between replication heartbeats.

    password
string
success
The password for the replication connection.

    sslCipher
string
success
A list of permissible ciphers to use for SSL encryption.

    username
string
success
The username for the replication connection.

    verifyServerCertificate
boolean
success
Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.

  replicaNames
list
success
The replicas of the instance.

  serviceAccountEmailAddress
string
success
The service account email address assigned to the instance. This property is applicable only to Second Generation instances.

settings
complex
success
The user settings.

  availabilityType
string
success
The availabilityType define if your postgres instance is run zonal or regional.

  backupConfiguration
complex
success
The daily backup configuration for the instance.

    binaryLogEnabled
boolean
success
Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. MySQL only.

    enabled
boolean
success
Enable Autobackup for your instance.

    startTime
string
success
Define the backup start time in UTC (HH:MM) .

  ipConfiguration
complex
success
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.

    authorizedNetworks
complex
success
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).

      expirationTime
string
success
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

      name
string
success
An optional label to identify this entry.

      value
string
success
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.

    ipv4Enabled
boolean
success
Whether the instance should be assigned an IP address or not.

    requireSsl
boolean
success
Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.

  settingsVersion
integer
success
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.

  tier
string
success
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.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.