Link Search Menu Expand Document

overrides

Description

The overrides module exists for specific settings that are often used to maintain backwards-compatibility with older versions of Provose. They should not be used in newer versions of Provose.

Sometimes a new version of Provose changes the name of a Terraform resource, which often requires that resource to be destroyed and recreated when upgrading to the newer version of Provose. This recreation may cause data loss, so to prevent it, an override key can be set to retain the old name.

Examples

module "myproject" {
  source = "github.com/provose/provose?ref=v2.0.0"
  provose_config = {
    authentication = {
      aws = {
        region = "us-east-1"
      }
    }
    name                 = "myproject"
    internal_root_domain = "example-internal.com"
    internal_subdomain   = "production"
  }
  overrides = {
    # `mysql-subnets` and `postgresql-subnets` are older names for the
    # AWS RDS database subnet groups in early versions of Provose.
    mysql_clusters__aws_db_subnet_group      = "mysql-subnets"
    postgresql_clusters__aws_db_subnet_group = "postgresql-subnets"
  }
}

Inputs

  • mysql_clusters__aws_db_subnet_group – Sets the name for the MySQL database subnet group. This name must be unique within the AWS account. No other database subnet group must have this name.

  • postgresql_clusters__aws_db_subnet_group – Sets the name for the PostgreSQL database subnet group. This name must be unique within the AWS account. No other database subnet group must have this name.

  • redis_clusters__aws_elasticache_subnet_group – Sets the name for the ElastiCache Redis subnet group. This name must be unique within the AWS account. No other Redis cluster subnet group must have this name.

Outputs

There are no Terraform outputs for the overrides module. This is purely for setting configurations.