Skip to content

Commit fcae58b

Browse files
committed
update README.md
1 parent 6636d9a commit fcae58b

File tree

2 files changed

+34
-15
lines changed

2 files changed

+34
-15
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,15 @@
1414
<a href="https://www.terraform.io">
1515
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
1616
</a>
17+
<a href="https://github.com/clouddrove/terraform-azure-flexible-mysql/actions/workflows/tfsec.yml">
18+
<img src="https://github.com/clouddrove/terraform-azure-flexible-mysql/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
19+
</a>
1720
<a href="LICENSE.md">
1821
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
1922
</a>
23+
<a href="CHANGELOG.md">
24+
<img src="https://img.shields.io/badge/Changelog-blue" alt="Changelog">
25+
</a>
2026

2127

2228
</p>
@@ -39,14 +45,23 @@
3945
<hr>
4046

4147

42-
We are a group of DevOps engineers & architects, joining hands in this ever evolving digital landscape. With our strong belief in Automation; just like microservices, always on the lookout to split the the infrastructure into smaller connected resources (database, cluster and more) which could be standardized, are manageable, scalable, secure & follow industry best practices.
48+
We are a group of DevOps engineers & architects, joining hands in this ever evolving digital landscape. With our strong belief in Automation; just like microservices, always on the lookout to split the the infrastructure into smaller connected resources (database, cluster and more) which could be standardized, are manageable, scalable, secure & follow industry best practices.
4349

4450

4551
This module includes Terraform open source, examples, and automation tests (for better understanding), which would help you create and improve your infrastructure with minimalistic coding.
4652

4753

4854

4955

56+
## Prerequisites and Providers
57+
58+
This table contains both Prerequisites and Providers:
59+
60+
| Description | Name | Version |
61+
|:-------------:|:-------------------------------------------:|:---------:|
62+
| **Prerequisite** | [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html) | >= 1.7.8 |
63+
| **Provider** | [azure](https://azure.microsoft.com/) | >= 3.39.0 |
64+
5065

5166

5267

@@ -64,7 +79,7 @@ This module includes Terraform open source, examples, and automation tests (for
6479
Refer to complete documentation: [here](docs/io.md)
6580

6681

67-
<!--
82+
<!--
6883
## Module Dependencies
6984
7085
This module has dependencies on:
@@ -77,6 +92,11 @@ This module has dependencies on:
7792
-->
7893

7994

95+
## Module Dependencies
96+
97+
This module has dependencies on:
98+
- [Labels Module](https://github.com/clouddrove/terraform-azure-labels): Provides resource tagging.
99+
80100

81101
## 📑 Changelog
82102

@@ -87,7 +107,7 @@ Refer [here](CHANGELOG.md).
87107

88108
## ✨ Contributors
89109

90-
Big thanks to our contributors for elevating our project with their dedication and expertise! But, we do not wish to stop there, would like to invite contributions from the community in improving these projects and making them more versatile for better reach. Remember, every bit of contribution is immensely valuable, as, together, we are moving in only 1 direction, i.e. forward.
110+
Big thanks to our contributors for elevating our project with their dedication and expertise! But, we do not wish to stop there, would like to invite contributions from the community in improving these projects and making them more versatile for better reach. Remember, every bit of contribution is immensely valuable, as, together, we are moving in only 1 direction, i.e. forward.
91111

92112
<a href="https://github.com/clouddrove/terraform-azure-flexible-mysql/graphs/contributors">
93113
<img src="https://contrib.rocks/image?repo=clouddrove/terraform-azure-flexible-mysql&max" />
@@ -115,7 +135,7 @@ Big thanks to our contributors for elevating our project with their dedication a
115135

116136

117137

118-
## Feedback
138+
## Feedback
119139
Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-azure-flexible-mysql/issues), feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
120140

121141
Show some love with a ★ on [our GitHub](https://github.com/clouddrove/terraform-azure-flexible-mysql)! if our work has brightened your day! – your feedback fuels our journey!
@@ -127,7 +147,7 @@ We have [*100+ Terraform modules*][terraform_modules] 🙌. You could consider t
127147

128148
- [Terraform Module Registry:](https://registry.terraform.io/namespaces/clouddrove) Discover our Terraform modules here.
129149

130-
- [Terraform Modules for AWS/Azure Modules:](https://github.com/clouddrove/toc) Explore our comprehensive Table of Contents for easy navigation through our documentation for modules pertaining to AWS, Azure & GCP.
150+
- [Terraform Modules for AWS/Azure Modules:](https://github.com/clouddrove/toc) Explore our comprehensive Table of Contents for easy navigation through our documentation for modules pertaining to AWS, Azure & GCP.
131151

132152
- [Terraform Modules for Digital Ocean:](https://github.com/terraform-do-modules/toc) Check out our specialized Terraform modules for Digital Ocean.
133153

@@ -153,7 +173,7 @@ Join our tech elites [Join Now][slack] 🚀
153173
Click [here][blog] :books: :star2:
154174

155175
## Tap into our capabilities
156-
We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions.
176+
We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions.
157177

158178
At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [business@clouddrove.com](mailto:business@clouddrove.com).
159179

docs/io.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44
|------|-------------|------|---------|:--------:|
55
| admin\_password | The password associated with the admin\_username user | `string` | `null` | no |
66
| admin\_password\_length | Length of random password generated. | `number` | `16` | no |
7-
| admin\_username | The administrator login name for the new SQL Server | `any` | `null` | no |
7+
| admin\_username | The administrator login name for the new SQL Server | `string` | `null` | no |
88
| auto\_grow\_enabled | Should Storage Auto Grow be enabled? Defaults to true. | `bool` | `false` | no |
99
| backup\_retention\_days | The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7 | `number` | `7` | no |
1010
| charset | Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created. | `string` | `""` | no |
11+
| cmk\_enabled | n/a | `bool` | `false` | no |
12+
| cmk\_key\_size | n/a | `number` | `2048` | no |
13+
| cmk\_key\_type | n/a | `string` | `"RSA"` | no |
1114
| collation | Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created. | `string` | `""` | no |
1215
| create\_mode | The creation mode. Can be used to restore or replicate existing servers. Possible values are `Default`, `Replica`, `GeoRestore`, and `PointInTimeRestore`. Defaults to `Default` | `string` | `"Default"` | no |
1316
| custom\_tags | n/a | `map(string)` | `{}` | no |
1417
| db\_name | Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created. | `string` | `""` | no |
1518
| delegated\_subnet\_id | The resource ID of the subnet | `string` | `""` | no |
1619
| enable\_diagnostic | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
17-
| enable\_private\_endpoint | Manages a Private Endpoint to Azure database for MySQL | `bool` | `false` | no |
1820
| enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
19-
| end\_ip\_address | n/a | `string` | `""` | no |
2021
| entra\_authentication | Azure Entra authentication configuration block for Azure MySQL Flexible Server | <pre>object({<br> user_assigned_identity_id = optional(string, null)<br> login = optional(string, null)<br> object_id = optional(string, null)<br> })</pre> | `{}` | no |
2122
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
2223
| eventhub\_authorization\_rule\_id | Eventhub authorization rule id to pass it to destination details of diagnosys setting of NSG. | `string` | `null` | no |
@@ -28,8 +29,8 @@
2829
| high\_availability | Map of high availability configuration: https://docs.microsoft.com/en-us/azure/mysql/flexible-server/concepts-high-availability. `null` to disable high availability | <pre>object({<br> mode = string<br> standby_availability_zone = optional(number)<br> })</pre> | `null` | no |
2930
| identity\_type | Type of managed identity to set | `string` | `null` | no |
3031
| iops | The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000. | `number` | `360` | no |
31-
| key\_vault\_id | Specifies the URL to a Key Vault Key (either from a Key Vault Key, or the Key URL for the Key Vault Secret | `string` | `""` | no |
32-
| key\_vault\_key\_id | The URL to a Key Vault Key | `string` | `null` | no |
32+
| key\_vault\_id | n/a | `string` | `null` | no |
33+
| key\_vault\_with\_rbac | n/a | `bool` | `false` | no |
3334
| label\_order | Label order, e.g. sequence of application name and environment `name`,`environment`,'attribute' [`webserver`,`qa`,`devops`,`public`,] . | `list(any)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no |
3435
| location | The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created. | `string` | `""` | no |
3536
| log\_analytics\_destination\_type | Possible values are AzureDiagnostics and Dedicated, default to AzureDiagnostics. When set to Dedicated, logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table. | `string` | `"AzureDiagnostics"` | no |
@@ -38,7 +39,7 @@
3839
| main\_rg\_name | n/a | `string` | `""` | no |
3940
| managedby | ManagedBy, eg ''. | `string` | `""` | no |
4041
| metric\_enabled | Whether metric diagnonsis should be enable in diagnostic settings for flexible Mysql. | `bool` | `true` | no |
41-
| mysql\_server\_name | n/a | `string` | `""` | no |
42+
| mysql\_server\_name | n/a | `string` | `null` | no |
4243
| mysql\_version | The version of the MySQL Flexible Server to use. Possible values are 5.7, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created. | `string` | `"5.7"` | no |
4344
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
4445
| point\_in\_time\_restore\_time\_in\_utc | The point in time to restore from creation\_source\_server\_id when create\_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created. | `string` | `null` | no |
@@ -51,7 +52,6 @@
5152
| size\_gb | The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384. | `string` | `"20"` | no |
5253
| sku\_name | The SKU Name for the MySQL Flexible Server. | `string` | `"GP_Standard_D8ds_v4"` | no |
5354
| source\_server\_id | The resource ID of the source MySQL Flexible Server to be restored. Required when create\_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created. | `string` | `null` | no |
54-
| start\_ip\_address | n/a | `string` | `""` | no |
5555
| storage\_account\_id | Storage account id to pass it to destination details of diagnosys setting of NSG. | `string` | `null` | no |
5656
| user\_assigned\_identity\_ids | List of user-assigned managed identity IDs | `list(string)` | `[]` | no |
5757
| values | Specifies the value of the MySQL Flexible Server Configuration. See the MySQL documentation for valid values. Changing this forces a new resource to be created. | `list(string)` | `[]` | no |
@@ -65,8 +65,7 @@
6565
| azurerm\_mysql\_flexible\_server\_configuration\_id | The ID of the MySQL Flexible Server Configuration. |
6666
| azurerm\_private\_dns\_zone\_id | The Private DNS Zone ID. |
6767
| azurerm\_private\_dns\_zone\_virtual\_network\_link\_id | The ID of the Private DNS Zone Virtual Network Link. |
68-
| existing\_private\_dns\_zone\_virtual\_network\_link\_id | The ID of the Private DNS Zone Virtual Network Link. |
68+
| existing\_private\_dns\_zone\_virtual\_network\_link\_id | n/a |
6969
| mysql\_flexible\_server\_id | The ID of the MySQL Flexible Server. |
70-
7170
| password\_result | Password Value |
7271

0 commit comments

Comments
 (0)