gcp_redis_instance – Creates a GCP Instance
gcp_redis_instance – Creates a GCP Instance
New in version 2.8.
Synopsis
- A Google Cloud Redis 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 |
---|---|---|
alternative_location_id - |
Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId]. | |
auth_kind string / required |
|
The type of credential used. |
authorized_network - |
The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used. | |
display_name - |
An arbitrary and optional user-provided name for the instance. | |
labels - |
Resource labels to represent user provided metadata. | |
location_id - |
The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId]. | |
memory_size_gb - / required |
Redis memory size in GiB. | |
name - / required |
The ID of the instance or a fully qualified identifier for the instance. . | |
project string |
The Google Cloud Platform project to use. | |
redis_configs - |
Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs . | |
redis_version - |
The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are REDIS_3_2 for Redis 3.2. | |
region - / required |
The name of the Redis region of the instance. | |
reserved_ip_range - |
The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. | |
scopes list |
Array of scopes to be used. | |
service_account_contents string |
A string representing the contents of a Service Account JSON file. This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON) | |
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 - |
|
Whether the given object should exist in GCP |
tier - |
|
The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances . |
Notes
Note
- API Reference: https://cloud.google.com/memorystore/docs/redis/reference/rest/
- Official Documentation: https://cloud.google.com/memorystore/docs/redis/
- For authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILE
env variable. - For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable. - For authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
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 network
gcp_compute_network:
name: network-instance
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a instance
gcp_redis_instance:
name: instance37
tier: STANDARD_HA
memory_size_gb: 1
region: us-central1
location_id: us-central1-a
redis_version: REDIS_3_2
display_name: Ansible Test Instance
reserved_ip_range: 192.168.0.0/29
labels:
my_key: my_val
other_key: other_val
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 |
---|---|---|
alternativeLocationId string |
success |
Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
|
authorizedNetwork string |
success |
The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
|
createTime string |
success |
The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
|
currentLocationId string |
success |
The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
|
displayName string |
success |
An arbitrary and optional user-provided name for the instance.
|
host string |
success |
Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
|
labels dictionary |
success |
Resource labels to represent user provided metadata.
|
locationId string |
success |
The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
|
memorySizeGb integer |
success |
Redis memory size in GiB.
|
name string |
success |
The ID of the instance or a fully qualified identifier for the instance. .
|
port integer |
success |
The port number of the exposed Redis endpoint.
|
redisConfigs dictionary |
success |
Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs .
|
redisVersion string |
success |
The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are REDIS_3_2 for Redis 3.2.
|
region string |
success |
The name of the Redis region of the instance.
|
reservedIpRange string |
success |
The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
|
tier string |
success |
The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances .
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
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.8/modules/gcp_redis_instance_module.html