azure-redis.yml

# Copyright 2020 Pivotal Software, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http:#www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
version: 1
name: csb-azure-redis
id: 349d89ac-2051-468b-b10f-9f537cc580c0
description: Redis is a fully managed service for the Azure Platform
display_name: Azure Cache for Redis
image_url: file://service-images/csb.png
documentation_url: https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/
support_url: https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/
tags: [azure, redis, preview]
plan_updateable: true
plans:
- name: deprecated-small
  id: 6b9ca24e-1dec-4e6f-8c8a-dc6e11ab5bef
  description: 'Deprecated - A basic plan with 1GB cache and no failover. High Availability is not provided, update WILL result in loss of data.'
  display_name: "Deprecated - Small"
  properties:
    sku_name: Basic
    family: C
    capacity: 1
    tls_min_version: "1.2"
    firewall_rules: []
- name: deprecated-medium
  id: 6b272c43-2116-4483-9a99-de9262c0a7d6
  description: 'Deprecated - A v4 Redis basic plan with 6GB cache and no failover. High Availability is not provided, update WILL result in loss of data.'
  display_name: "Deprecated - Medium"
  properties:
    sku_name: Basic
    family: C
    capacity: 3
    tls_min_version: "1.2"
    firewall_rules: []
- name: deprecated-large
  id: c3e34abc-a820-457c-b723-1c342ef42c50
  description: 'Deprecated - A v4 Redis basic plan with 26GB cache and no failover. High Availability is not provided, update WILL result in loss of data.'
  display_name: "Deprecated - Large"
  properties:
    sku_name: Basic
    family: C
    capacity: 5
    firewall_rules: []
    tls_min_version: "1.2"
- name: deprecated-ha-small
  id: d27a8e60-3724-49d1-b668-44b03d99b3b3
  description: 'Deprecated - A v4 Redis standard plan with 1GB cache with high availability and no failover.'
  display_name: "Deprecated - High Availability Small"
  properties:
    sku_name: Standard
    family: C
    capacity: 1
    firewall_rules: []
    tls_min_version: "1.2"
- name: deprecated-ha-medium
  id: 421b932a-b86f-48a3-97e4-64bb13d3ec13
  description: 'Deprecated - A v4 Redis standard plan with 6GB cache with high availability and no failover.'
  display_name: "Deprecated - High Availability Medium"
  properties:
    sku_name: Standard
    family: C
    capacity: 3
    firewall_rules: []
    tls_min_version: "1.2"
- name: deprecated-ha-large
  id: e919b281-9661-465d-82cf-0a0a6e1f195a
  description: 'Deprecated - A v4 Redis standard plan with 26GB cache with high availability and no failover.'
  display_name: "Deprecated - High Availability Large"
  properties:
    sku_name: Standard
    family: C
    capacity: 5
    firewall_rules: []
    tls_min_version: "1.2"
- name: deprecated-ha-P1
  id: 2a63e092-ab5c-4804-abd6-2d951240f0f6
  description: "Deprecated - A v4 Redis High Availability plan with 1GB cache and no failover"
  display_name: "Deprecated - High Availability P1"
  properties:
    sku_name: Premium
    family: P
    capacity: 1
    tls_min_version: "1.2"
    firewall_rules: []
provision:
  plan_inputs:
  - field_name: sku_name
    type: string
    details: The SKU of Redis to use.
    enum:
      Basic: Basic
      Standard: Standard
      Premium: Premium
  - field_name: family
    type: string
    details: The SKU family/pricing group to use.
    enum:
      C: Basic/Standard
      P: Premium
  - field_name: capacity
    type: integer
    details: The size of the Redis cache to deploy.
    constraints:
      maximum: 6
      minimum: 0
  - field_name: tls_min_version
    type: string
    details: Minimum enforced TLS version. Possible values are 1.0, 1.1, 1.2
  - field_name: firewall_rules
    type: array
    details: Array of firewall rule start/end IP pairs (e.g. [["1.2.3.4", "2.3.4.5"], ["5.6.7.8", "6.7.8.9"]])
  - field_name: private_endpoint_subnet_id
    type: string
    details: The ID of the Subnet within which Private Endpoint for the Redis cache will be created.
  - field_name: private_dns_zone_ids
    type: array
    details: Array of Private DNS Zone IDs to create private DNS zone groups for when using Private Endpoints
  user_inputs:
  - field_name: redis_version
    type: string
    details: The version of Redis to use. If not set it will use the default Azure-defined Redis version.
    nullable: true
    default: null
  - field_name: instance_name
    type: string
    details: Name for your redis instance
    default: csb-redis-${request.instance_id}
    constraints:
      maxLength: 98
      minLength: 6
      pattern: ^[a-z][a-z0-9-]+$
    prohibit_update: true
  - field_name: resource_group
    type: string
    details: Name for the resource group for this instance
    default: ''
    constraints:
      maxLength: 64
      minLength: 0
      pattern: ^[a-z][a-z0-9-]+$|^$
    prohibit_update: true
  - field_name: subnet_id
    type: string
    details: The ID of the Subnet within which the Redis Cache should be deployed, valid only for Premium SKU
    default: ""
    prohibit_update: true
  - field_name: location
    type: string
    details: The region of the Redis instance.
    default: westus
    constraints:
      examples:
      - westus2
      - uksouth
      pattern: ^[a-z][a-z0-9]+$
    prohibit_update: true
  - field_name: azure_tenant_id
    type: string
    details: Azure Tenant to create resource in
    default: ${config("azure.tenant_id")}
  - field_name: azure_subscription_id
    type: string
    details: Azure Subscription to create resource in
    default: ${config("azure.subscription_id")}
  - field_name: azure_client_id
    type: string
    details: Client ID of Azure principal
    default: ${config("azure.client_id")}
  - field_name: azure_client_secret
    type: string
    details: Client secret for Azure principal
    default: ${config("azure.client_secret")}
  - field_name: skip_provider_registration
    type: boolean
    details: Skip automatic Azure provider registration, set to true if service principal being used does not have rights to register providers
    default: false
  - field_name: maxmemory_policy
    type: string
    details: Max memory eviction policy. Possible values are volatile-lru (default), allkeys-lru, volatile-random, allkeys-random, volatile-ttl, noeviction
    default: volatile-lru
  computed_inputs:
  - name: labels
    default: ${json.marshal(request.default_labels)}
    overwrite: true
    type: object
  template_refs:
    data: terraform/azure-redis/provision/data.tf
    main: terraform/azure-redis/provision/main.tf
    moved: terraform/azure-redis/provision/moved-azure-redis.tf
    outputs: terraform/azure-redis/provision/outputs.tf
    provider: terraform/azure-redis/provision/provider.tf
    variables: terraform/azure-redis/provision/variables.tf
    versions: terraform/azure-redis/provision/versions.tf
  outputs:
  - field_name: name
    type: string
    details: The name of the redis.
  - field_name: host
    type: string
    details: Hostname or IP address of the exposed redis endpoint used by clients to connect to the service.
  # - field_name: port
  #   type: integer
  #   details: The port number of the exposed redis instance.
  - field_name: tls_port
    type: integer
    details: The tls_port number of the exposed redis instance.
  - field_name: password
    type: string
    details: The password to authenticate to the redis instance.
bind:
  plan_inputs: []
  user_inputs: []
  computed_inputs: []
  template_refs:
    noop: terraform/azure-redis/bind/noop.tf
  outputs: []