{"id":19129451,"url":"https://github.com/launchbynttdata/tf-azurerm-module_reference-redis_cache","last_synced_at":"2026-04-21T03:31:48.950Z","repository":{"id":243913675,"uuid":"811041464","full_name":"launchbynttdata/tf-azurerm-module_reference-redis_cache","owner":"launchbynttdata","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-14T20:04:08.000Z","size":95,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-14T22:09:03.346Z","etag":null,"topics":["azure","infrastructure-as-code","platform-automation","reference","terraform"],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/launchbynttdata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-05T20:36:02.000Z","updated_at":"2025-04-08T19:13:39.000Z","dependencies_parsed_at":"2024-06-12T02:45:31.119Z","dependency_job_id":"f15a8915-2456-4e51-95ac-56e102dc14fc","html_url":"https://github.com/launchbynttdata/tf-azurerm-module_reference-redis_cache","commit_stats":null,"previous_names":["launchbynttdata/tf-azurerm-module_reference-redis_cache"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/launchbynttdata/tf-azurerm-module_reference-redis_cache","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-redis_cache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-redis_cache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-redis_cache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-redis_cache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchbynttdata","download_url":"https://codeload.github.com/launchbynttdata/tf-azurerm-module_reference-redis_cache/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-redis_cache/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32075224,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T02:38:07.213Z","status":"ssl_error","status_checked_at":"2026-04-21T02:38:06.559Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","infrastructure-as-code","platform-automation","reference","terraform"],"created_at":"2024-11-09T06:07:32.962Z","updated_at":"2026-04-21T03:31:48.907Z","avatar_url":"https://github.com/launchbynttdata.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-azurerm-module_reference-redis_cache\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)\n\n## Overview\n\nThis terraform module provisions an Azure Redis Cache with all its dependencies.\n\nThis reference module is built as a wrapper around the primitive module tf-azurerm-module_primitive-redis_cache\n\n## Pre-Commit hooks\n\n[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.\n\n`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:\n\n- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).\n- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).\n- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.\nfooters other than BREAKING CHANGE: \u003cdescription\u003e may be provided and follow a convention similar to git trailer format.\n- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)\n- **chore**: a commit of the type `chore` adds changes that don't modify src or test files\n- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)\n- **docs**: a commit of the type `docs` adds documentation only changes\n- **perf**: a commit of the type `perf` adds code change that improves performance\n- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature\n- **revert**: a commit of the type `revert` reverts a previous commit\n- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n- **test**: a commit of the type `test` adds missing tests or correcting existing tests\n\nBase configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)\n\nIf you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.\n\n`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS\n\nIn order for `pre-commit` hooks to work properly\n\n- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.\n- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below\n\n```\npre-commit install --hook-type commit-msg\n```\n\n## To test the resource group module locally\n\n1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.\n\n```\nmake configure\n```\n\nThis adds in several files and directories that are ignored by `git`. They expose many new Make targets.\n\n2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.\n\n`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.\n\nThese environment variables are used by `terratest` integration suit.\n\nService principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.\n\n```\n\"Microsoft.Resources/subscriptions/resourceGroups/write\"\n\"Microsoft.Resources/subscriptions/resourceGroups/read\"\n\"Microsoft.Resources/subscriptions/resourceGroups/delete\"\n```\n\nThen run this make target to set the environment variables on developer workstation.\n\n```\nmake env\n```\n\n3. The first target you care about is `check`.\n\n**Pre-requisites**\nBefore running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.\n\n- A file named `provider.tf` with contents below\n\n```\nprovider \"azurerm\" {\n  features {}\n}\n```\n\n- A file named `terraform.tfvars` which contains key value pair of variables used.\n\nNote that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.\n\nAfter creating these files, for running tests associated with the primitive/segment, run\n\n```\nmake check\n```\n\nIf `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.\n\n`make check` target\n\n- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.\n- runs `conftests`. `conftests` make sure `policy` checks are successful.\n- runs `terratest`. This is integration test suit.\n- runs `opa` tests\n\u003c!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.5.0, \u003c= 1.5.5 |\n| \u003ca name=\"requirement_azurerm\"\u003e\u003c/a\u003e [azurerm](#requirement\\_azurerm) | \u003e=3.67.0 |\n\n## Providers\n\nNo providers.\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_resource_names\"\u003e\u003c/a\u003e [resource\\_names](#module\\_resource\\_names) | terraform.registry.launch.nttdata.com/module_library/resource_name/launch | ~\u003e 1.0 |\n| \u003ca name=\"module_resource_group\"\u003e\u003c/a\u003e [resource\\_group](#module\\_resource\\_group) | terraform.registry.launch.nttdata.com/module_primitive/resource_group/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_redis_cache\"\u003e\u003c/a\u003e [redis\\_cache](#module\\_redis\\_cache) | terraform.registry.launch.nttdata.com/module_primitive/redis_cache/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_private_dns_zone\"\u003e\u003c/a\u003e [private\\_dns\\_zone](#module\\_private\\_dns\\_zone) | terraform.registry.launch.nttdata.com/module_primitive/private_dns_zone/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_vnet_link\"\u003e\u003c/a\u003e [vnet\\_link](#module\\_vnet\\_link) | terraform.registry.launch.nttdata.com/module_primitive/private_dns_vnet_link/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_additional_vnet_links\"\u003e\u003c/a\u003e [additional\\_vnet\\_links](#module\\_additional\\_vnet\\_links) | terraform.registry.launch.nttdata.com/module_primitive/private_dns_vnet_link/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_private_endpoint\"\u003e\u003c/a\u003e [private\\_endpoint](#module\\_private\\_endpoint) | terraform.registry.launch.nttdata.com/module_primitive/private_endpoint/azurerm | ~\u003e 1.0 |\n\n## Resources\n\nNo resources.\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_resource_names_map\"\u003e\u003c/a\u003e [resource\\_names\\_map](#input\\_resource\\_names\\_map) | A map of key to resource\\_name that will be used by tf-launch-module\\_library-resource\\_name to generate resource names | \u003cpre\u003emap(object({\u003cbr\u003e    name       = string\u003cbr\u003e    max_length = optional(number, 60)\u003cbr\u003e  }))\u003c/pre\u003e | \u003cpre\u003e{\u003cbr\u003e  \"private_endpoint\": {\u003cbr\u003e    \"max_length\": 80,\u003cbr\u003e    \"name\": \"pe\"\u003cbr\u003e  },\u003cbr\u003e  \"private_service_connection\": {\u003cbr\u003e    \"max_length\": 80,\u003cbr\u003e    \"name\": \"pesc\"\u003cbr\u003e  },\u003cbr\u003e  \"redis_cache\": {\u003cbr\u003e    \"max_length\": 80,\u003cbr\u003e    \"name\": \"redis\"\u003cbr\u003e  },\u003cbr\u003e  \"resource_group\": {\u003cbr\u003e    \"max_length\": 80,\u003cbr\u003e    \"name\": \"rg\"\u003cbr\u003e  }\u003cbr\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_instance_env\"\u003e\u003c/a\u003e [instance\\_env](#input\\_instance\\_env) | Number that represents the instance of the environment. | `number` | `0` | no |\n| \u003ca name=\"input_instance_resource\"\u003e\u003c/a\u003e [instance\\_resource](#input\\_instance\\_resource) | Number that represents the instance of the resource. | `number` | `0` | no |\n| \u003ca name=\"input_logical_product_family\"\u003e\u003c/a\u003e [logical\\_product\\_family](#input\\_logical\\_product\\_family) | (Required) Name of the product family for which the resource is created.\u003cbr\u003e    Example: org\\_name, department\\_name. | `string` | `\"launch\"` | no |\n| \u003ca name=\"input_logical_product_service\"\u003e\u003c/a\u003e [logical\\_product\\_service](#input\\_logical\\_product\\_service) | (Required) Name of the product service for which the resource is created.\u003cbr\u003e    For example, backend, frontend, middleware etc. | `string` | `\"redis\"` | no |\n| \u003ca name=\"input_class_env\"\u003e\u003c/a\u003e [class\\_env](#input\\_class\\_env) | (Required) Environment where resource is going to be deployed. For example. dev, qa, uat | `string` | `\"dev\"` | no |\n| \u003ca name=\"input_resource_group_name\"\u003e\u003c/a\u003e [resource\\_group\\_name](#input\\_resource\\_group\\_name) | Name of the resource group where the resources will be created | `string` | `null` | no |\n| \u003ca name=\"input_use_azure_region_abbr\"\u003e\u003c/a\u003e [use\\_azure\\_region\\_abbr](#input\\_use\\_azure\\_region\\_abbr) | Whether to use the Azure region abbreviation in the resource name. e.g. eastus -\u003e eus | `bool` | `true` | no |\n| \u003ca name=\"input_location\"\u003e\u003c/a\u003e [location](#input\\_location) | target resource group resource mask | `string` | `\"eastus\"` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Custom tags for the Redis cache | `map(string)` | `{}` | no |\n| \u003ca name=\"input_capacity\"\u003e\u003c/a\u003e [capacity](#input\\_capacity) | The size of the Redis cache | `number` | `1` | no |\n| \u003ca name=\"input_family\"\u003e\u003c/a\u003e [family](#input\\_family) | The SKU family/pricing group to use | `string` | `\"C\"` | no |\n| \u003ca name=\"input_sku_name\"\u003e\u003c/a\u003e [sku\\_name](#input\\_sku\\_name) | The type of SKU to use | `string` | `\"Basic\"` | no |\n| \u003ca name=\"input_enable_non_ssl_port\"\u003e\u003c/a\u003e [enable\\_non\\_ssl\\_port](#input\\_enable\\_non\\_ssl\\_port) | Enable the non-SSL port (6379) | `bool` | `false` | no |\n| \u003ca name=\"input_identity_ids\"\u003e\u003c/a\u003e [identity\\_ids](#input\\_identity\\_ids) | Specifies a list of user managed identity ids to be assigned. | `list(string)` | `null` | no |\n| \u003ca name=\"input_minimum_tls_version\"\u003e\u003c/a\u003e [minimum\\_tls\\_version](#input\\_minimum\\_tls\\_version) | The minimum TLS version. Defaults to 1.2 | `string` | `\"1.2\"` | no |\n| \u003ca name=\"input_patch_schedule\"\u003e\u003c/a\u003e [patch\\_schedule](#input\\_patch\\_schedule) | Window of time when the Redis cache can be patched | \u003cpre\u003elist(object({\u003cbr\u003e    day_of_week        = string\u003cbr\u003e    start_hour_utc     = optional(string)\u003cbr\u003e    maintenance_window = optional(string)\u003cbr\u003e  }))\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_public_network_access_enabled\"\u003e\u003c/a\u003e [public\\_network\\_access\\_enabled](#input\\_public\\_network\\_access\\_enabled) | Allow public network access to the redis cache | `bool` | `true` | no |\n| \u003ca name=\"input_redis_configuration\"\u003e\u003c/a\u003e [redis\\_configuration](#input\\_redis\\_configuration) | Additional options for the Redis cache | \u003cpre\u003eobject({\u003cbr\u003e    aof_backup_enabled                      = optional(bool)\u003cbr\u003e    aof_storage_connection_string_0         = optional(string)\u003cbr\u003e    aof_storage_connection_string_1         = optional(string)\u003cbr\u003e    enable_authentication                   = optional(bool)\u003cbr\u003e    active_directory_authentication_enabled = optional(bool)\u003cbr\u003e    maxmemory_reserved                      = optional(number)\u003cbr\u003e    maxmemory_delta                         = optional(number)\u003cbr\u003e    maxmemory_policy                        = optional(string)\u003cbr\u003e    data_persistence_authentication_method  = optional(string)\u003cbr\u003e    maxfragmentationmemory_reserved         = optional(number)\u003cbr\u003e    rdb_backup_enabled                      = optional(bool)\u003cbr\u003e    rdb_backup_frequency                    = optional(number)\u003cbr\u003e    rdb_backup_max_snapshot_count           = optional(number)\u003cbr\u003e    rdb_storage_connection_string           = optional(string)\u003cbr\u003e    storage_account_subscription_id         = optional(string)\u003cbr\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_redis_version\"\u003e\u003c/a\u003e [redis\\_version](#input\\_redis\\_version) | Major version of redis to use. Defaults to 6 | `string` | `\"6\"` | no |\n| \u003ca name=\"input_subnet_id\"\u003e\u003c/a\u003e [subnet\\_id](#input\\_subnet\\_id) | ID of the subnet where the Redis cache should be deployed. Requires `sku_name` to be `Premium` | `string` | `null` | no |\n| \u003ca name=\"input_private_static_ip_address\"\u003e\u003c/a\u003e [private\\_static\\_ip\\_address](#input\\_private\\_static\\_ip\\_address) | The private IP address to use when `subnet_id` is set | `string` | `null` | no |\n| \u003ca name=\"input_replicas_per_master\"\u003e\u003c/a\u003e [replicas\\_per\\_master](#input\\_replicas\\_per\\_master) | Number of replicas to create per master | `number` | `null` | no |\n| \u003ca name=\"input_replicas_per_primary\"\u003e\u003c/a\u003e [replicas\\_per\\_primary](#input\\_replicas\\_per\\_primary) | Number of replicas to create per primary | `number` | `null` | no |\n| \u003ca name=\"input_shard_count\"\u003e\u003c/a\u003e [shard\\_count](#input\\_shard\\_count) | The number of shards to create on the cluster | `number` | `null` | no |\n| \u003ca name=\"input_zones\"\u003e\u003c/a\u003e [zones](#input\\_zones) | List of availability zones where the Redis cache should be located | `list(string)` | `null` | no |\n| \u003ca name=\"input_private_dns_zone_suffix\"\u003e\u003c/a\u003e [private\\_dns\\_zone\\_suffix](#input\\_private\\_dns\\_zone\\_suffix) | The DNS Zone suffix for Azure Redis cache. Default is `privatelink.redis.cache.windows.net` for Public Cloud\u003cbr\u003e    For US gov cloud it should be `privatelink.redis.cache.usgovcloudapi.net` | `string` | `\"privatelink.redis.cache.windows.net\"` | no |\n| \u003ca name=\"input_additional_vnet_links\"\u003e\u003c/a\u003e [additional\\_vnet\\_links](#input\\_additional\\_vnet\\_links) | A map of names to VNET IDs to create links with the private redis cache DNS Zone\u003cbr\u003e    Applicable only when `public_network_access_enabled` is set to false | `map(string)` | `{}` | no |\n| \u003ca name=\"input_private_endpoint_subnet_id\"\u003e\u003c/a\u003e [private\\_endpoint\\_subnet\\_id](#input\\_private\\_endpoint\\_subnet\\_id) | ID of the subnet where the private endpoint should be deployed\u003cbr\u003e    Required when `public_network_access_enabled` is set to false | `string` | `null` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_redis_cache_id\"\u003e\u003c/a\u003e [redis\\_cache\\_id](#output\\_redis\\_cache\\_id) | n/a |\n| \u003ca name=\"output_redis_cache_hostname\"\u003e\u003c/a\u003e [redis\\_cache\\_hostname](#output\\_redis\\_cache\\_hostname) | n/a |\n| \u003ca name=\"output_redis_cache_primary_access_key\"\u003e\u003c/a\u003e [redis\\_cache\\_primary\\_access\\_key](#output\\_redis\\_cache\\_primary\\_access\\_key) | n/a |\n| \u003ca name=\"output_redis_cache_secondary_access_key\"\u003e\u003c/a\u003e [redis\\_cache\\_secondary\\_access\\_key](#output\\_redis\\_cache\\_secondary\\_access\\_key) | n/a |\n| \u003ca name=\"output_redis_cache_primary_connection_string\"\u003e\u003c/a\u003e [redis\\_cache\\_primary\\_connection\\_string](#output\\_redis\\_cache\\_primary\\_connection\\_string) | n/a |\n| \u003ca name=\"output_redis_cache_secondary_connection_string\"\u003e\u003c/a\u003e [redis\\_cache\\_secondary\\_connection\\_string](#output\\_redis\\_cache\\_secondary\\_connection\\_string) | n/a |\n\u003c!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-redis_cache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-redis_cache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-redis_cache/lists"}