W3cubDocs

/Ansible 2.10

google.cloud.gcp_kms_key_ring – Creates a GCP KeyRing

Note

This plugin is part of the google.cloud collection.

To install it use: ansible-galaxy collection install google.cloud.

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

Synopsis

  • A KeyRing is a toplevel logical grouping of CryptoKeys.

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.
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.
location
string / required
The location for the KeyRing.
A full list of valid locations can be found by running `gcloud kms locations list`.
name
string / required
The resource name for the KeyRing.
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

Notes

Note

  • API Reference: https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings
  • Creating a key ring: https://cloud.google.com/kms/docs/creating-keys#create_a_key_ring
  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.
  • for authentication, you can set service_account_contents using the 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.

Examples

- name: create a key ring
  google.cloud.gcp_kms_key_ring:
    name: test_object
    location: us-central1
    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
createTime
string
success
The time that this resource was created on the server.
This is in RFC3339 text format.

location
string
success
The location for the KeyRing.
A full list of valid locations can be found by running `gcloud kms locations list`.

name
string
success
The resource name for the KeyRing.



Authors

  • Google Inc. (@googlecloudplatform)

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