Code Monkey home page Code Monkey logo

aws-mq-rabbitmq's Introduction

Massdriver

aws-mq-rabbitmq

Release Contributors Forks Stargazers Issues MIT License

AWS MQ Broker for RabbitMQ is a managed message broker service that simplifies the deployment and maintenance of RabbitMQ in the AWS cloud.


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

  • broker (object)
    • apply_immediately (boolean): Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default: False.
    • deployment_mode (string): Single instance will provision a cost-effective single broker suitable for development, while a highly available cluster will create multiple brokers spread accross availability zones providing massive scalability and high availability even in the event of zonal outage. NOTE this setting cannot be changed after creation. Default: SINGLE_INSTANCE.
      • One of
        • Single Instance
        • Highly Available Cluster
    • engine_version (string): RabbitMQ engine version. Must be one of: ['3.10', '3.9', '3.8']. Default: 3.10.
    • instance_type (string): Note: You cannot downgrade a broker from any mq.m5.* instance type to the mq.t3.micro instance type.
  • monitoring (object)
    • general_logging (boolean): Enables cluster logging to AWS Cloudwatch. Default: False.
    • mode (string): Enable and customize CloudWatch metric alarms. Default: AUTOMATED.
      • One of
        • Automated
        • Custom
        • Disabled

Examples

{
    "__name": "Single-Broker (Development)",
    "broker": {
        "apply_immediately": false,
        "deployment_mode": "SINGLE_INSTANCE",
        "engine_version": "3.10",
        "instance_type": "mq.t3.micro"
    },
    "monitoring": {
        "general_logging": false,
        "mode": "AUTOMATED"
    }
}
{
    "__name": "Multi-Broker Cluster (Production)",
    "broker": {
        "apply_immediately": false,
        "deployment_mode": "CLUSTER_MULTI_AZ",
        "engine_version": "3.10",
        "instance_type": "mq.m5.large"
    },
    "monitoring": {
        "general_logging": true,
        "mode": "AUTOMATED"
    }
}

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

  • rabbitmq (object): RabbitMQ cluster authentication.
    • data (object)
      • authentication: RabbitMQ Authentication.
        • hostname (string)
        • password (string)
        • port (integer): Port number. Minimum: 0. Maximum: 65535.
        • username (string)
      • infrastructure (object): Cloud specific RabbitMQ infrastructure configuration.
        • 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"
          • Kuberenetes infrastructure configobject: . Cannot contain additional properties.

            • kubernetes_namespace (string)
            • kubernetes_service (string)
      • security (object)
        • 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'].

    • 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"
      • rabbitmq (object): RabbitMQ specific public information.

        • version (string): Currently deployed RabbitMQ 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

aws-mq-rabbitmq's People

Contributors

chrisghill avatar mclacore avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.