AnsibleFest is going virtual with two days of expert speakers, live demos and hands-on labs Oct 13-14!
gcp_spanner_database – Creates a GCP Database
- A Cloud Spanner Database which is hosted on a Spanner instance.
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameter |
Choices/Defaults |
Comments |
auth_kind
string
/ required
|
Choices:
- application
- machineaccount
- serviceaccount
|
The type of credential used.
|
env_type
string
|
|
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.
|
extra_statements
list
|
|
An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
|
instance
dictionary
/ required
|
|
The instance to create the database on.
This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp_spanner_instance task and then set this instance field to "{{ name-of-resource }}"
|
name
string
/ required
|
|
A unique identifier for the database, which cannot be changed after the instance is created. Values are of the form [a-z][-a-z0-9]*[a-z0-9].
|
project
string
|
|
The Google Cloud Platform project to use.
|
scopes
list
|
|
Array of scopes to be used.
|
service_account_contents
jsonarg
|
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
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.
|
state
string
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|
Note
- API Reference: https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances.databases
- Official Documentation: https://cloud.google.com/spanner/
- for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
- for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS) 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.
- name: create a instance
gcp_spanner_instance:
name: instance-database
display_name: My Spanner Instance
node_count: 2
labels:
cost_center: ti-1700004
config: regional-us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: instance
- name: create a database
gcp_spanner_database:
name: webstore
instance: "{{ instance }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
extraStatements
list
|
success |
An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
|
instance
dictionary
|
success |
The instance to create the database on.
|
name
string
|
success |
A unique identifier for the database, which cannot be changed after the instance is created. Values are of the form [a-z][-a-z0-9]*[a-z0-9].
|
Authors
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.