azure-postgresql-flexible-server

Azure PostgreSQL Flexible Server is a fully managed database service designed to provide more control and flexibility over database management functions and configurations.

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

addons (object)
- pgbouncer (boolean): PgBouncer is a connection pooler for PostgreSQL. It reduces the number of connections to the database, which can improve performance. Default: False.
- pgvector (boolean): PgVector extension adds an open-source vector similarity search to PostgreSQL. Default: False.
backup (object)
- backup_retention_days (integer): How many days to retain PostgreSQL database backups (minimum of 7, maximum of 35). Minimum: 7. Maximum: 35. Default: 7.
database (object)
- high_availability (boolean): Default: False.
- postgres_version (string): The version of PostgreSQL to use. The version cannot be changed. Must be one of: ['16', '15', '14', '13', '12', '11'].
- sku_name (string): Select the amount of cores, memory, and iops you need for your workload (D = General Purpose, E = Memory Optimized).
- storage_mb (integer): The amount of storage capacity available to your Azure Database for PostgreSQL server. Storage size cannot be scaled down.
  - One of
    - 32GB
    - 64GB
    - 128GB
    - 256GB
    - 512GB
    - 1TB
    - 2TB
    - 4TB
    - 8TB
    - 16TB
    - 32TB
- username (string): The administrator login for the PostgreSQL Flexible Server. Username cannot be changed after creation. (Username cannot be 'admin', 'root', 'administrator', 'username', 'azure_superuser', 'azure_pg_admin', 'guest', or 'public'.).
monitoring (object)
- mode (string): Enable and customize Function App metric alarms. Default: AUTOMATED.
  - One of
    - Automated
    - Custom
    - Disabled
network (object)
- auto (boolean): Enabling this will automatically select an available CIDR range for your database. Unchecking will require you to specify the CIDR. Default: True.

Examples

{
    "__name": "Development",
    "backup": {
        "backup_retention_days": 7
    },
    "database": {
        "high_availability": false,
        "storage_mb": 32768
    }
}

{
    "__name": "Production",
    "backup": {
        "backup_retention_days": 30
    },
    "database": {
        "high_availability": true,
        "storage_mb": 262144
    }
}

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): Authentication parameters for a PostgreSQL database. Cannot contain additional properties.
- data (object): Cannot contain additional properties.
  - authentication (object)
    - hostname (string)
    - password (string)
    - port (integer): Port number. Minimum: 0. Maximum: 65535.
    - username (string)
  - infrastructure (object): Cloud specific PostgreSQL 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 Nameobject: GCP Infrastructure Config For Resources With A Name Not A GRN. Cannot contain additional properties.
        
        name (string): Name Of GCP Resource.
        
        Examples:
        
        "my-cloud-function"
        
        "my-sql-instance"
      - 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"
      - Kuberenetes infrastructure configobject: . Cannot contain additional properties.
        
        kubernetes_namespace (string)
        
        kubernetes_service (string)
  - 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: 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.
      - 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"
- specs (object): Cannot contain additional properties.
  - 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"
  - rdbms (object): Common metadata for relational databases.
    - engine (string): The type of database server.
      
      Examples:
      "postgresql"
      "mysql"
    - engine_version (string): The cloud provider's database version.
      
      Examples:
      "5.7.mysql_aurora.2.03.2"
    - version (string): The database version. Default: ``.
      
      Examples:
      "12.2"
      "5.7"
    Examples:
```
{
    "engine": "postgresql",
    "engine_version": "10.14",
    "version": "10.14"
}
```
```
{
    "engine": "mysql",
    "engine_version": "5.7.mysql_aurora.2.03.2",
    "version": "5.7"
}
```

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!