google.cloud.gcp_bigtable_instance module – Creates a GCP Instance
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_bigtable_instance
.
Synopsis
A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
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 |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
An array of clusters. Maximum 4. |
|
The type of storage used by this cluster to serve its parent instance’s tables, unless explicitly overridden. Some valid choices include: “STORAGE_TYPE_UNSPECIFIED”, “SSD”, “HDD” |
|
The location where this cluster’s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. |
|
The unique name of the cluster. |
|
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. |
|
The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. |
|
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. |
|
Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer’s organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. |
|
The unique name of the instance. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Whether the given object should exist in GCP Choices:
|
|
The type of the instance. Defaults to `PRODUCTION`. Some valid choices include: “TYPE_UNSPECIFIED”, “PRODUCTION”, “DEVELOPMENT” |
Examples
- name: create a instance
google.cloud.gcp_bigtable_instance:
name: my-instance
display_name: My Test Cluster
clusters:
- name: mycluster
location: projects/test_project/locations/us-central1-a
serve_nodes: 1
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 |
Description |
---|---|
An array of clusters. Maximum 4. Returned: success |
|
The type of storage used by this cluster to serve its parent instance’s tables, unless explicitly overridden. Returned: success |
|
The location where this cluster’s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. Returned: success |
|
The unique name of the cluster. Returned: success |
|
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. Returned: success |
|
The current state of the cluster. Returned: success |
|
The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. Returned: success |
|
Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer’s organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. Returned: success |
|
The unique name of the instance. Returned: success |
|
The current state of the instance. Returned: success |
|
The type of the instance. Defaults to `PRODUCTION`. Returned: success |