Massdriver

mongodbatlas-cluster-aws

Release Contributors Forks Stargazers Issues MIT License

MongoDB Atlas allows you to run a fully managed MongoDB cluster alongside your other resources in AWS, offering low-latency, high-availability with minimal maintenance.


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

Security and compliance scanning of our bundles is performed using Bridgecrew. Massdriver also offers security and compliance scanning of operational infrastructure configured and deployed using the platform.

Benchmark Description
Infrastructure Security Infrastructure Security Compliance
PCI-DSS Payment Card Industry Data Security Standards Compliance
NIST-800-53 National Institute of Standards and Technology Compliance
ISO27001 Information Security Management System, ISO/IEC 27001 Compliance
SOC2 Service Organization Control 2 Compliance
HIPAA Health Insurance Portability and Accountability Compliance

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

  • backup (object)
  • database (object)
    • autoscaling (object)
      • instance_size_max (string): Must be one of: ['M10', 'M20', 'M30', 'M40', 'M50', 'M60', 'M80', 'M140', 'M200', 'M300', 'M400', 'M700']. Default: M40.
      • instance_size_min (string): Must be one of: ['M10', 'M20', 'M30', 'M40', 'M50', 'M60', 'M80', 'M140', 'M200', 'M300', 'M400', 'M700']. Default: M10.
    • cluster_type (string): Must be one of: ['REPLICASET', 'SHARDED']. Default: REPLICASET.
    • electable_node_count (integer): Must be one of: [3, 5, 7]. Default: 3.
    • termination_protection_enabled (boolean): Termination protection will protect the cluster from accidental termination (must be disabled before deletion is allowed). Default: False.
    • version (string): Must be one of: ['4.2', '4.4', '5.0', '6.0']. Default: 5.0.
  • mongodbatlas_creds (object)
    • organization_id (string)
    • private_key (string)
    • public_key (string)
  • storage (object)
    • ebs_volume_type (string): Type of storage you want to attach to your cluster. Must be one of: ['STANDARD', 'PROVISIONED']. Default: STANDARD.
    • size_gb (integer): The initial disk size (in GB) of the cluster. Disk autoscaling is enabled, so this value may increase as needed. Minimum: 10. Maximum: 4096. Default: 10.

Examples

{
    "__name": "Development",
    "backup": {
        "enabled": false
    },
    "database": {
        "autoscaling": {
            "instance_size_max": "M40",
            "instance_size_min": "M10"
        },
        "cluster_type": "REPLICASET",
        "termination_protection_enabled": false
    },
    "storage": {
        "size_gb": 10
    }
}
{
    "__name": "Production",
    "backup": {
        "continuous": true,
        "enabled": true
    },
    "database": {
        "autoscaling": {
            "instance_size_max": "M80",
            "instance_size_min": "M10"
        },
        "cluster_type": "REPLICASET",
        "termination_protection_enabled": true
    },
    "storage": {
        "size_gb": 50
    }
}
{
    "__name": "Sharded",
    "backup": {
        "continuous": true,
        "enabled": true
    },
    "database": {
        "autoscaling": {
            "instance_size_max": "M80",
            "instance_size_min": "M30"
        },
        "cluster_type": "REPLICASET",
        "num_shards": 2,
        "termination_protection_enabled": true
    },
    "storage": {
        "size_gb": 50
    }
}

Connections

Connections from other bundles that this bundle depends on.

View

Properties

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

    • data (object)
      • arn (string): Amazon Resource Name.

        Examples:

        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
      • external_id (string): An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.

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

          Examples:

          "us-west-2"
  • vpc (object): . Cannot contain additional properties.

    • data (object)
      • infrastructure (object)
        • arn (string): Amazon Resource Name.

          Examples:

          "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
          "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
        • cidr (string)

          Examples:

          "10.100.0.0/16"
          "192.24.12.0/22"
        • internal_subnets (array)

          • Items (object): AWS VCP Subnet.

            • arn (string): Amazon Resource Name.

              Examples:

              "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
              "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
            • aws_zone (string): AWS Availability Zone.

              Examples:

            • cidr (string)

              Examples:

              "10.100.0.0/16"
              "192.24.12.0/22"

            Examples:

        • private_subnets (array)

          • Items (object): AWS VCP Subnet.

            • arn (string): Amazon Resource Name.

              Examples:

              "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
              "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
            • aws_zone (string): AWS Availability Zone.

              Examples:

            • cidr (string)

              Examples:

              "10.100.0.0/16"
              "192.24.12.0/22"

            Examples:

        • public_subnets (array)

          • Items (object): AWS VCP Subnet.

            • arn (string): Amazon Resource Name.

              Examples:

              "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
              "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
            • aws_zone (string): AWS Availability Zone.

              Examples:

            • cidr (string)

              Examples:

              "10.100.0.0/16"
              "192.24.12.0/22"

            Examples:

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

          Examples:

          "us-west-2"

Artifacts

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

View

Properties

  • mongodb (object): mongo cluster authentication and cloud-specific configuration. Cannot contain additional properties.
    • data (object)
      • authentication: Mongo connection string. Cannot contain additional properties.
        • hostname (string)
        • password (string)
        • port (integer): Port number. Minimum: 0. Maximum: 65535.
        • username (string)
      • infrastructure (object): Mongo cluster infrastructure configuration.
        • One of
          • Kuberenetes infrastructure configobject: . Cannot contain additional properties.

            • kubernetes_namespace (string)
            • kubernetes_service (string)
          • Azure Infrastructure Resource IDobject: Minimal Azure Infrastructure Config. 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"
          • MongoDB Atlas Cluster Infrastructureobject: Minimal MongoDB Atlas cluster infrastructure config. Cannot contain additional properties.

            • cluster_id (string)
            • project_id (string)
    • 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.
      • 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"
      • mongo (object): Informs downstream bundles of Mongo specific data. Cannot contain additional properties.

        • version (string): Currently deployed Mongo version.

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!

Email GitHub LinkedIn Twitter YouTube Reddit