/terraform-kubernetes-redis

Deploy containerized Redis service on Kubernetes.

Primary LanguageShellApache License 2.0Apache-2.0

Kubernetes Redis Template

Terraform module which deploys containerized Redis on Kubernetes, powered by Bitnami Charts/Redis.

  • Support standalone(one read-write instance) and replication(one read-write instance and multiple read-only instances, for read write splitting).

Usage

module "redis" {
  source = "..."

  infrastructure = {
    namespace = "default"
  }

  architecture   = "replication"
  engine_version = "7.0"         # https://hub.docker.com/r/bitnami/redis/tags
}

Examples

Contributing

Please read our contributing guide if you're interested in contributing to Walrus template.

Requirements

Name Version
terraform >= 1.0
helm >= 2.0.0
random >= 3.5.1

Providers

Name Version
random >= 3.5.1
helm >= 2.0.0

Modules

No modules.

Resources

Name Type
helm_release.redis resource
random_password.password resource
random_string.name_suffix resource

Inputs

Name Description Type Default Required
context Receive contextual information. When Walrus deploys, Walrus will inject specific contextual information into this field.

Examples:
context:
  project:
    name: string
    id: string
  environment:
    name: string
    id: string
  resource:
    name: string
    id: string
 map(any) {} no
infrastructure Specify the infrastructure information for deploying.

Examples:
infrastructure:
  namespace: string, optional
  image_registry: string, optional
  domain_suffix: string, optional
  service_type: string, optional
 
object({
    namespace      = optional(string)
    image_registry = optional(string, "registry-1.docker.io")
    domain_suffix  = optional(string, "cluster.local")
    service_type   = optional(string, "NodePort")
  })
 {} no
architecture Specify the deployment architecture, select from standalone or replication. string "standalone" no
replication_readonly_replicas Specify the number of read-only replicas under the replication deployment. number 1 no
engine_version Specify the deployment engine version, select from https://hub.docker.com/r/bitnami/redis/tags. string "7.0" no
password Specify the account password. The password must be 16-32 characters long and start with any letter, number, or the following symbols: ! # $ % ^ & * ( ) _ + - =.
If not specified, it will generate a random password.		 string null no
resources Specify the computing resources.

Examples:
resources:
  cpu: number, optional
  memory: number, optional       # in megabyte
 
object({
    cpu    = optional(number, 0.25)
    memory = optional(number, 1024)
  })
 
{
  "cpu": 0.25,
  "memory": 1024
}
 no
storage Specify the storage resources.

Examples:
storage:                         # convert to empty_dir volume or dynamic volume claim template
  class: string, optional
  size: number, optional         # in megabyte
 
object({
    class = optional(string)
    size  = optional(number, 10 * 1024)
  })
 null no

Outputs

Name Description
context The input context, a map, which is used for orchestration.
refer The refer, a map, including hosts, ports and account, which is used for dependencies or collaborations.
connection The connection, a string combined host and port, might be a comma separated string or a single string.
connection_readonly The readonly connection, a string combined host and port, might be a comma separated string or a single string.
address The address, a string only has host, might be a comma separated string or a single string.
address_readonly The readonly host, a string only has host, might be a comma separated string or a single string.
port The port of the service.
password The password of the account to access the service.
endpoints The endpoints, a list of string combined host and port.
endpoints_readonly The readonly endpoints, a list of string combined host and port.

License

Copyright (c) 2023 Seal, 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 LICENSE file for details.

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.