delowan.googlecloud.gcp_bigtable_instance (1.0.2) — module

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2

Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

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

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - The unique name of the instance.
    required: false
    type: str

type:
    description:
    - The type of the instance. Defaults to `PRODUCTION`.
    - 'Some valid choices include: "TYPE_UNSPECIFIED", "PRODUCTION", "DEVELOPMENT"'
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given object should exist in GCP
    type: str

labels:
    description:
    - 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.
    required: false
    type: dict

scopes:
    description:
    - Array of scopes to be used
    elements: str
    type: list

project:
    description:
    - The Google Cloud Platform project to use.
    type: str

clusters:
    description:
    - An array of clusters. Maximum 4.
    elements: dict
    required: false
    suboptions:
      default_storage_type:
        description:
        - 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"'
        required: false
        type: str
      location:
        description:
        - 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>`.
        required: false
        type: str
      name:
        description:
        - The unique name of the cluster.
        required: false
        type: str
      serve_nodes:
        description:
        - The number of nodes allocated to this cluster. More nodes enable higher throughput
          and more consistent performance.
        required: false
        type: int
    type: list

env_type:
    description:
    - 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.
    type: str

auth_kind:
    choices:
    - application
    - machineaccount
    - serviceaccount
    description:
    - The type of credential used.
    required: true
    type: str

display_name:
    description:
    - 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.
    required: false
    type: str

service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path

service_account_email:
    description:
    - An optional service account email address if machineaccount is selected and the
      user does not wish to use the default email.
    type: str

service_account_contents:
    description:
    - The contents of a Service Account JSON file, either in a dictionary or as a JSON
      string that represents it.
    type: jsonarg

Outputs

clusters:
  contains:
    defaultStorageType:
      description:
      - The type of storage used by this cluster to serve its parent instance's tables,
        unless explicitly overridden.
      returned: success
      type: str
    location:
      description:
      - 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
      type: str
    name:
      description:
      - The unique name of the cluster.
      returned: success
      type: str
    serveNodes:
      description:
      - The number of nodes allocated to this cluster. More nodes enable higher throughput
        and more consistent performance.
      returned: success
      type: int
    state:
      description:
      - The current state of the cluster.
      returned: success
      type: str
  description:
  - An array of clusters. Maximum 4.
  returned: success
  type: complex
displayName:
  description:
  - 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
  type: str
labels:
  description:
  - 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
  type: dict
name:
  description:
  - The unique name of the instance.
  returned: success
  type: str
state:
  description:
  - The current state of the instance.
  returned: success
  type: str
type:
  description:
  - The type of the instance. Defaults to `PRODUCTION`.
  returned: success
  type: str