Documentation

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
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
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.
available
bool
    Choices:
  • no
  • yes
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 falover replica when the status is true.
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 Default:
None
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.
service_account_email_address
The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
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.
username
The username for the replication connection.
client_key
PEM representation of the slave's private key. The corresponsing public key is encoded in the client's asf asd certificate.
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.
ca_certificate
PEM representation of the trusted CA's x509 certificate.
connect_retry_interval
Seconds to wait between connect retries. MySQL's default is 60 seconds.
verify_server_certificate
bool
    Choices:
  • no
  • yes
Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
master_heartbeat_period
Interval in milliseconds between replication heartbeats.
ssl_cipher
A list of permissible ciphers to use for SSL encryption.
password
The password for the replication connection.
client_certificate
PEM representation of the slave's x509 certificate .
replica_names
The replicas of the instance.
failover_target
bool
    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.
scopes
Array of scopes to be used.
service_account_email
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
The path of a Service Account JSON file if serviceaccount is selected as type.
settings
The user settings.
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.
require_ssl
bool
    Choices:
  • no
  • yes
Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
ipv4_enabled
bool
    Choices:
  • no
  • yes
Whether the instance should be assigned an IP address or not.
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.
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 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: "test_object"
      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: "service_account"
      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
backend_type
str
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.

connection_name
str
success
Connection name of the Cloud SQL instance used in connection strings.

database_version
str
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.

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

  available
bool
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 falover replica when the status is true.

  name
str
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.

instance_type
str
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.

ip_addresses
complex
success
The assigned IP addresses for the instance.

  ip_address
str
success
The IP address assigned.

  time_to_retire
str
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
str
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.

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

master_instance_name
str
success
The name of the instance which will act as master in the replication setup.

max_disk_size
int
success
The maximum disk size of the instance in bytes.

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

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

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

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

  mysql_replica_configuration
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.

    username
str
success
The username for the replication connection.

    client_key
str
success
PEM representation of the slave's private key. The corresponsing public key is encoded in the client's asf asd certificate.

    dump_file_path
str
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.

    ca_certificate
str
success
PEM representation of the trusted CA's x509 certificate.

    connect_retry_interval
int
success
Seconds to wait between connect retries. MySQL's default is 60 seconds.

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

    master_heartbeat_period
int
success
Interval in milliseconds between replication heartbeats.

    ssl_cipher
str
success
A list of permissible ciphers to use for SSL encryption.

    password
str
success
The password for the replication connection.

    client_certificate
str
success
PEM representation of the slave's x509 certificate .

  replica_names
list
success
The replicas of the instance.

  failover_target
bool
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.

settings
complex
success
The user settings.

  ip_configuration
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.

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

    ipv4_enabled
bool
success
Whether the instance should be assigned an IP address or not.

    authorized_networks
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).

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

      name
str
success
An optional label to identify this entry.

      value
str
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.

  tier
str
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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Google Inc. (@googlecloudplatform)

Hint

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