azure-cache-redis

Azure Redis Cache is low-latency, scalable, secure, and highly available in-memory Redis data store available for Azure.

---

Design

For detailed information, check out our Operator Guide for this bundle.

Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the Massdriver platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

• cluster (object)
  • enable_cluster (boolean): Redis cluster automatically shards data across multiple Redis nodes, so you can create workloads of bigger memory sizes and get better performance. This cannot be disabled after deployment. Default: False.
• monitoring (object)
  • mode (string): Enable and customize Function App metric alarms. Default: AUTOMATED.
    • One of
      • Automated
      • Custom
      • Disabled
• redis (object)
  • capacity (integer): The size of the Redis memory cache.
    • One of
      • 6GB
      • 13GB
      • 26GB
      • 53GB
      • 120GB
  • non_ssl_port (boolean): Enable the non-SSL (6379) port. SSL port (6380) is enabled by default. Enabling this is not recommended as it will allow unencrypted communication, which poses a security risk. Default: False.
  • persistence (string): Redis persistence allows you to persist data stored in Redis in the event of an outage. This cannot be changed after deployment. Default: Disabled.
    • One of
      • Disabled
      • AOF (single storage account)
      • AOF (dual storage accounts)
      • RDB
  • redis_version (string): Azure Cache for Redis offers the latest major version of Redis and at least one previous version. The version can be upgraded, but not downgraded. Must be one of: ['4', '6']. Default: 6.
  • replicas_per_primary (integer): Number of read replicas per primary node. When the primary VM becomes unavailable, the replica detects that and takes over as the new primary automatically. This cannot be changed after deployment. Must be one of: [1, 2, 3].

Examples

{
    "__name": "Development",
    "redis": {
        "capacity": 1,
        "replicas_per_primary": 1
    }
}

{
    "__name": "Production",
    "redis": {
        "capacity": 3,
        "replicas_per_primary": 2
    }
}

Connections

Connections from other bundles that this bundle depends on.

View

Properties

• azure_service_principal (object): . Cannot contain additional properties.

  • data (object)

    • client_id (string): A valid UUID field.

      Examples:

      "123xyz99-ab34-56cd-e7f8-456abc1q2w3e"

    • client_secret (string)

    • subscription_id (string): A valid UUID field.

      Examples:

      "123xyz99-ab34-56cd-e7f8-456abc1q2w3e"

    • tenant_id (string): A valid UUID field.

      Examples:

      "123xyz99-ab34-56cd-e7f8-456abc1q2w3e"

  • specs (object)

• azure_virtual_network (object): . Cannot contain additional properties.

  • data (object)

    • infrastructure (object)

      • cidr (string)

        Examples:

        "10.100.0.0/16"

        "192.24.12.0/22"

      • default_subnet_id (string): Azure Resource ID.

        Examples:

        "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"

      • id (string): Azure Resource ID.

        Examples:

        "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"

  • specs (object)

    • azure (object): .
      • region (string): Select the Azure region you'd like to provision your resources in.

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

• authentication (object): Redis cluster authentication and cloud-specific configuration. Cannot contain additional properties.
  • data (object)

    • authentication (object)

      • hostname (string)
      • password (string)
      • port (integer): Port number. Minimum: 0. Maximum: 65535.
      • username (string)

    • infrastructure (object): Cloud specific Redis configuration data.

      • One of

        • AWS Infrastructure ARNobject: Minimal AWS Infrastructure Config. Cannot contain additional properties.

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

        • GCP Infrastructure GRNobject: Minimal GCP Infrastructure Config. Cannot contain additional properties.

          • grn (string): GCP Resource Name (GRN).

            Examples:

            "projects/my-project/global/networks/my-global-network"

            "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"

            "projects/my-project/topics/my-pubsub-topic"

            "projects/my-project/subscriptions/my-pubsub-subscription"

            "projects/my-project/locations/us-west2/instances/my-redis-instance"

            "projects/my-project/locations/us-west2/clusters/my-gke-cluster"

        • Azure Redis Cache infrastructure configobject: . Cannot contain additional properties.

          • ari (string): Azure Resource ID.

            Examples:

            "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"

    • security (object): TBD.

      • Any of

        • AWS Security informationobject: Informs downstream services of network and/or IAM policies. Cannot contain additional properties.

          • iam (object): IAM Policies. Cannot contain additional properties.

            • ^[a-z]+[a-z_]*[a-z]+$ (object)

              • policy_arn (string): AWS IAM policy ARN.

                Examples:

                "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

                "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          • identity (object): For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.

            • role_arn (string): ARN for this resources IAM Role.

              Examples:

              "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

              "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          • network (object): AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.

            • ^[a-z-]+$ (object)

              • arn (string): Amazon Resource Name.

                Examples:

                "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

                "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

              • port (integer): Port number. Minimum: 0. Maximum: 65535.

              • protocol (string): Must be one of: ['tcp', 'udp'].

        • Securityobject: GCP Security Configuration. Cannot contain additional properties.

          • iam (object): IAM Roles And Conditions. Cannot contain additional properties.
            • ^[a-z]+[a-z_]*[a-z]$ (object)

              • condition (string): GCP IAM Condition.

              • role: GCP Role.

                Examples:

                "roles/owner"

                "roles/redis.editor"

                "roles/storage.objectCreator"

                "roles/storage.legacyObjectReader"

        • Securityobject: Azure Security Configuration. Cannot contain additional properties.

          • iam (object): IAM Roles And Scopes. Cannot contain additional properties.
            • ^[a-z]+[a-z_]*[a-z]$ (object)

              • role: Azure Role.

                Examples:

                "Storage Blob Data Reader"

              • scope (string): Azure IAM Scope.

  • specs (object)

    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

    • azure (object): .

      • region (string): Select the Azure region you'd like to provision your resources in.

    • cache (object): The root schema comprises the entire JSON document.

      • engine (string): The cache engine. Default: ``.

        Examples:

        "redis"

      • version (string): The version of the engine. Default: ``.

        Examples:

        "6.2"

      Examples:

      {
          "engine": "redis",
          "version": "6.2"
      }

    • gcp (object): .

      • project (string)

      • region (string): The GCP region to provision resources in.

        Examples:

        "us-east1"

        "us-east4"

        "us-west1"

        "us-west2"

        "us-west3"

        "us-west4"

        "us-central1"

Contributing

Bug Reports & Feature Requests

Did we miss something? Please submit an issue to report any bugs or request additional features.

Developing

Note: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the Massdriver platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our contribution guidelines.

Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or create your own bundle from scratch!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!