Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 5.01 KB

google_redis_instance.md

File metadata and controls

97 lines (62 loc) · 5.01 KB
Raw
title platform
About the google_redis_instance resource
gcp

Syntax

A google_redis_instance is used to test a Google Instance resource

Beta Resource

This resource has beta fields available. To retrieve these fields, include beta: true in the constructor for the resource

Examples

describe google_redis_instance(project: 'chef-gcp-inspec', region: 'us-central1', name: 'my-redis-cache') do
  it { should exist }
  its('tier') { should cmp 'STANDARD_HA' }
  its('memory_size_gb') { should cmp '1' }
  its('alternative_location_id') { should cmp 'us-central1-f' }
  its('redis_version') { should cmp 'REDIS_3_2' }
  its('display_name') { should cmp 'InSpec test instance' }
  its('reserved_ip_range') { should cmp '192.168.0.0/29' }
  its('labels') { should include('key' => 'value') }
end

describe google_redis_instance(project: 'chef-gcp-inspec', region: 'us-central1', name: 'nonexistent') do
  it { should_not exist }
end

Properties

Properties that can be accessed from the google_redis_instance resource:

  • 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_enabled: Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

  • 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.

  • connect_mode: The connection mode of the Redis instance. Possible values:

    • DIRECT_PEERING
    • PRIVATE_SERVICE_ACCESS

  • create_time: The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.

  • current_location_id: 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.

  • display_name: An arbitrary and optional user-provided name for the instance.

  • host: Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

  • labels: Resource labels to represent user provided metadata.

  • 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

  • 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].

  • name: The ID of the instance or a fully qualified identifier for the instance.

  • memory_size_gb: Redis memory size in GiB.

  • port: The port number of the exposed Redis endpoint.

  • persistence_iam_identity: Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.

  • redis_version: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_5_0 for Redis 5.0 compatibility - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility

  • 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.

  • tier: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances Possible values:

    • BASIC
    • STANDARD_HA

  • transit_encryption_mode: (Beta only) The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance. - SERVER_AUTHENTICATION: Client to Server traffic encryption enabled with server authentcation Possible values:

    • SERVER_AUTHENTICATION
    • DISABLED

  • server_ca_certs: (Beta only) List of server CA certificates for the instance.

    • serial_number: Serial number, as extracted from the certificate.

    • cert: Serial number, as extracted from the certificate.

    • create_time: The time when the certificate was created.

    • expire_time: The time when the certificate expires.

    • sha1_fingerprint: Sha1 Fingerprint of the certificate.

  • region: The name of the Redis region of the instance.

GCP Permissions