W3cubDocs

/Ansible

google.cloud.gcp_bigtable_instance – Creates a GCP Instance

Note

This plugin is part of the google.cloud collection (version 1.0.2).

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.

To use it in a playbook, specify: google.cloud.gcp_bigtable_instance.

Synopsis
Requirements
Parameters
Examples
Return Values

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		Choices/Defaults	Comments
auth_kind string / required		Choices: application machineaccount serviceaccount	The type of credential used.
clusters list / elements=dictionary			An array of clusters. Maximum 4.
	default_storage_type string		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"
	location string		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>`.
	name string		The unique name of the cluster.
	serve_nodes integer		The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
display_name string			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.
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.
labels dictionary			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.
name string			The unique name of the instance.
project string			The Google Cloud Platform project to use.
scopes list / elements=string			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
type string			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		Returned	Description
clusters complex		success	An array of clusters. Maximum 4.
	defaultStorageType string	success	The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
	location string	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>`.
	name string	success	The unique name of the cluster.
	serveNodes integer	success	The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
	state string	success	The current state of the cluster.
displayName string		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.
labels dictionary		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.
name string		success	The unique name of the instance.
state string		success	The current state of the instance.
type string		success	The type of the instance. Defaults to `PRODUCTION`.

Authors

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_bigtable_instance_module.html