https://github.com/massdriver-cloud/azure-elasticpool-mssql
https://github.com/massdriver-cloud/azure-elasticpool-mssql
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/azure-elasticpool-mssql
- Owner: massdriver-cloud
- Created: 2023-05-12T18:59:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T17:45:52.000Z (over 1 year ago)
- Last Synced: 2025-01-23T03:13:48.042Z (over 1 year ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 44.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# azure-elasticpool-mssql
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
Azure SQL Database elastic pools are a simple, cost-effective solution for managing and scaling multiple databases that have varying and unpredictable usage demands. The databases in an elastic pool are on a single server and share a set number of resources at a set price. Elastic pools in SQL Database enable software as a service (SaaS) developers to optimize the price performance for a group of databases within a prescribed budget while delivering performance elasticity for each database.
---
## Design
For detailed information, check out our [Operator Guide](operator.md) 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][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`audit`** *(object)*
- **`data_protection`** *(integer)*: Set the number of days to allow data recovery if auditing data is deleted from storage account (minimum 0 [infinite], maximum 3285). Minimum: `0`. Maximum: `3285`. Default: `90`.
- **`database`** *(object)*
- **`max_capacity`** *(integer)*: Select an Elasticpool model to configure this setting.
- **`min_capacity`** *(integer)*: Select an Elasticpool model to configure this setting.
- **`elasticpool`** *(object)*
- **`model`** *(string)*: The model of the Azure SQL Elastic Pool. **Cannot be changed after deployment**. Must be one of: `['vCore', 'DTU']`.
- **`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`.
- **`server`** *(object)*
- **`admin_login`** *(string)*: The administrator username for the Azure SQL Server. **Cannot be changed after deployment**. (Username cannot be 'admin', 'root', 'administrator', 'username', 'azure_superuser', 'azure_pg_admin', 'guest', or 'public'.).
- **`version`** *(string)*: The version of the Azure SQL Server. **Cannot be changed after deployment**. Default: `12.0`.
- **One of**
- v11
- v12
## Examples
```json
{
"__name": "Development",
"audit": {
"data_protection": 7
},
"database": {
"max_capacity": 5,
"min_capacity": 0
},
"elasticpool": {
"capacity": 50,
"model": "DTU",
"tier": "Basic"
},
"server": {
"version": "12.0"
}
}
```
```json
{
"__name": "Production",
"audit": {
"data_protection": 90
},
"database": {
"max_capacity": 5,
"min_capacity": 0
},
"elasticpool": {
"capacity": 10,
"max_size": 500,
"model": "vCore",
"tier": "GP_Gen5"
},
"server": {
"version": "12.0"
}
}
```
### 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:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`client_secret`** *(string)*
- **`subscription_id`** *(string)*: A valid UUID field.
Examples:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`tenant_id`** *(string)*: A valid UUID field.
Examples:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`specs`** *(object)*
- **`azure_virtual_network`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`infrastructure`** *(object)*
- **`cidr`** *(string)*
Examples:
```json
"10.100.0.0/16"
```
```json
"192.24.12.0/22"
```
- **`default_subnet_id`** *(string)*: Azure Resource ID.
Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```
- **`id`** *(string)*: Azure Resource ID.
Examples:
```json
"/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
- **`mssql_authentication`** *(object)*: Authentication parameters for a MSSQL 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 MSSQL configuration data.
- **One of**
- AWS Infrastructure ARN*object*: Minimal AWS Infrastructure Config. Cannot contain additional properties.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- Azure Infrastructure Resource ID*object*: Minimal Azure Infrastructure Config. Cannot contain additional properties.
- **`ari`** *(string)*: Azure Resource ID.
Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```
- GCP Infrastructure Name*object*: GCP Infrastructure Config For Resources With A Name Not A GRN. Cannot contain additional properties.
- **`name`** *(string)*: Name Of GCP Resource.
Examples:
```json
"my-cloud-function"
```
```json
"my-sql-instance"
```
- **`security`** *(object)*: TBD.
- **Any of**
- AWS Security information*object*: 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:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"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:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"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:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`protocol`** *(string)*: Must be one of: `['tcp', 'udp']`.
- Security*object*: 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:
```json
"Storage Blob Data Reader"
```
- **`scope`** *(string)*: Azure IAM Scope.
- Security*object*: 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:
```json
"roles/owner"
```
```json
"roles/redis.editor"
```
```json
"roles/storage.objectCreator"
```
```json
"roles/storage.legacyObjectReader"
```
- **`specs`** *(object)*: Cannot contain additional properties.
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"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:
```json
"us-east1"
```
```json
"us-east4"
```
```json
"us-west1"
```
```json
"us-west2"
```
```json
"us-west3"
```
```json
"us-west4"
```
```json
"us-central1"
```
- **`rdbms`** *(object)*: Common metadata for relational databases.
- **`engine`** *(string)*: The type of database server.
Examples:
```json
"postgresql"
```
```json
"mysql"
```
- **`engine_version`** *(string)*: The cloud provider's database version.
Examples:
```json
"5.7.mysql_aurora.2.03.2"
```
- **`version`** *(string)*: The database version. Default: ``.
Examples:
```json
"12.2"
```
```json
"5.7"
```
Examples:
```json
{
"engine": "postgresql",
"engine_version": "10.14",
"version": "10.14"
}
```
```json
{
"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](https://github.com/massdriver-cloud/azure-elasticpool-mssql/issues) 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][website] 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](https://docs.massdriver.cloud/bundles/contributing).
### 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](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/issues
[release_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/azure-elasticpool-mssql.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/azure-elasticpool-mssql/blob/main/LICENSE
[email_url]: mailto:support@massdriver.cloud
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:support@massdriver.cloud
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=azure-elasticpool-mssql&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500