terraform-yc-mysql

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #golang #android #machine-learning #deep-learning #linux #java #cli #vue #security #ios #mcp

terraform-yc-mysql

(★ 9)

No description available.

terraform-yc-mysql Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Yandex Cloud Managed MySQL Cluster

## Features

- Create a Managed MySQL cluster with predefined number of DB hosts
- Create a list of users and databases with permissions
- Easy to use in other resources via outputs

## MySQL cluster definition

At first you need to create VPC network with three subnets!

MySQL module requires a following input variables:
 - VPC network id
 - VPC network subnets ids
 - MySQL hosts definitions - a list of maps with DB host name, zone name and subnet id.
 - Databases - a list of databases with database name
 - Users - a list users with a list of grants to databases.

Notes:
1. `users` variable defines a list of separate db users with a `permissions` list, which indicates to a list of databases and grants for each of them. Default grant is the "ALL_PRIVILEGES". The user may also have `global_permissions` without any database permissions.
2. Database `mysql_config` parameter might be null, in this case default values will be used.

### Example

See [examples section](./examples/)

### Configure Terraform for Yandex Cloud

- Install [YC CLI](https://cloud.yandex.com/docs/cli/quickstart)
- Add environment variables for terraform auth in Yandex.Cloud

```
export YC_TOKEN=$(yc iam create-token)
export YC_CLOUD_ID=$(yc config get cloud-id)
export YC_FOLDER_ID=$(yc config get folder-id)
export TF_VAR_network_id=_vpc id here_
```

## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
| <a name="requirement_random"></a> [random](#requirement\_random) | > 3.3 |
| <a name="requirement_yandex"></a> [yandex](#requirement\_yandex) | > 0.8 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_random"></a> [random](#provider\_random) | 3.5.1 |
| <a name="provider_yandex"></a> [yandex](#provider\_yandex) | 0.89.0 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
| [yandex_mdb_mysql_cluster.this](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/resources/mdb_mysql_cluster) | resource |
| [yandex_mdb_mysql_database.database](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/resources/mdb_mysql_database) | resource |
| [yandex_mdb_mysql_user.user](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/resources/mdb_mysql_user) | resource |
| [yandex_client_config.client](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/data-sources/client_config) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_access_policy"></a> [access\_policy](#input\_access\_policy) | Access policy from other services to the MySQL cluster. | <pre>object({ data_lens = optional(bool, null) web_sql = optional(bool, null) data_transfer = optional(bool, null) })</pre> | `{}` | no |
| <a name="input_backup_retain_period_days"></a> [backup\_retain\_period\_days](#input\_backup\_retain\_period\_days) | (Optional) The period in days during which backups are stored. | `number` | `null` | no |
| <a name="input_backup_window_start"></a> [backup\_window\_start](#input\_backup\_window\_start) | (Optional) Time to start the daily backup, in the UTC timezone. | <pre>object({ hours = string minutes = optional(string, "00") })</pre> | `null` | no |
| <a name="input_databases"></a> [databases](#input\_databases) | A list of MySQL databases. Required values: - name - The name of the database. | <pre>list(object({ name = string }))</pre> | `[]` | no |
| <a name="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection) | Inhibits deletion of the cluster. | `bool` | `false` | no |
| <a name="input_description"></a> [description](#input\_description) | MySQL cluster description | `string` | `"Managed MySQL cluster"` | no |
| <a name="input_disk_size"></a> [disk\_size](#input\_disk\_size) | Disk size for hosts | `number` | `20` | no |
| <a name="input_disk_type"></a> [disk\_type](#input\_disk\_type) | Disk type for hosts | `string` | `"network-ssd"` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Environment type: PRODUCTION or PRESTABLE | `string` | `"PRODUCTION"` | no |
| <a name="input_folder_id"></a> [folder\_id](#input\_folder\_id) | Folder id that contains the MySQL cluster | `string` | `null` | no |
| <a name="input_hosts_definition"></a> [hosts\_definition](#input\_hosts\_definition) | A list of MySQL hosts. | <pre>list(object({ name = optional(string, null) zone = string subnet_id = optional(string, null) assign_public_ip = optional(bool, false) replication_source_name = optional(string, null) priority = optional(number, null) backup_priority = optional(number, null) }))</pre> | `[]` | no |
| <a name="input_labels"></a> [labels](#input\_labels) | A set of label pairs to assing to the MySQL cluster. | `map(any)` | `{}` | no |
| <a name="input_maintenance_window"></a> [maintenance\_window](#input\_maintenance\_window) | (Optional) Maintenance policy of the MySQL cluster. - type - (Required) Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window. - day - (Optional) Day of the week (in DDD format). Allowed values: "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" - hour - (Optional) Hour of the day in UTC (in HH format). Allowed value is between 0 and 23. | <pre>object({ type = string day = optional(string, null) hour = optional(string, null) })</pre> | <pre>{ "type": "ANYTIME" }</pre> | no |
| <a name="input_mysql_config"></a> [mysql\_config](#input\_mysql\_config) | A map of MySQL cluster configuration. Details info in a 'MySQL cluster settings' of official documentation. Link: https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/resources/mdb_mysql_cluster#mysql-config | `map(any)` | `null` | no |
| <a name="input_mysql_version"></a> [mysql\_version](#input\_mysql\_version) | MySQL version | `string` | `"8.0"` | no |
| <a name="input_name"></a> [name](#input\_name) | Name of MySQL cluster | `string` | `"mysql-cluster"` | no |
| <a name="input_network_id"></a> [network\_id](#input\_network\_id) | MySQL cluster network id | `string` | n/a | yes |
| <a name="input_performance_diagnostics"></a> [performance\_diagnostics](#input\_performance\_diagnostics) | (Optional) MySQL cluster performance diagnostics settings. | <pre>object({ enabled = optional(bool, null) sessions_sampling_interval = optional(number, 60) statements_sampling_interval = optional(number, 600) })</pre> | `{}` | no |
| <a name="input_resource_preset_id"></a> [resource\_preset\_id](#input\_resource\_preset\_id) | Preset for hosts | `string` | `"s2.micro"` | no |
| <a name="input_restore_parameters"></a> [restore\_parameters](#input\_restore\_parameters) | The cluster will be created from the specified backup. NOTES: - backup\_id must be specified to create a new MySQL cluster from a backup. - Time format is 'yyyy-mm-ddThh:mi:ss', where T is a delimeter, e.g. "2022-02-22T11:33:44". | <pre>object({ backup_id = string time = optional(string, null) })</pre> | `null` | no |
| <a name="input_security_groups_ids_list"></a> [security\_groups\_ids\_list](#input\_security\_groups\_ids\_list) | A list of security group IDs to which the MySQL cluster belongs | `list(string)` | `[]` | no |
| <a name="input_users"></a> [users](#input\_users) | This is a list for additional MySQL users with own permissions. Required values: - name - The name of the user. - password - (Optional) The user's password. If it's omitted a random password will be generated - authentication\_plugin - (Optional) User authn method. The default value could be set via the 'mysql\_config.default\_authentication\_plugin' variable. - global\_permissions - (Optional) A list of the user's global\_permissions. Default empty. - connection\_limits - (Optional) The object with user connection limits { max\_questions\_per\_hour, max\_updates\_per\_hour, max\_connections\_per\_hour, max\_user\_connections }. Default unlimited. - permissions - (Optional) A list of objects { databases\_name, grants[] } for an access. 'roles' is a optional list of permissions, the default values is ["ALL"] | <pre>list(object({ name = string password = optional(string, null) authentication_plugin = optional(string, null) global_permissions = optional(list(string), []) connection_limits = optional(object({ max_questions_per_hour = optional(number, -1) max_updates_per_hour = optional(number, -1) max_connections_per_hour = optional(number, -1) max_user_connections = optional(number, -1) }), null) permissions = optional(list(object({ database_name = string roles = optional(list(string), ["ALL"]) })), []) }))</pre> | `[]` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_cluster_fqdns_list"></a> [cluster\_fqdns\_list](#output\_cluster\_fqdns\_list) | MySQL cluster nodes FQDN list |
| <a name="output_cluster_host_names_list"></a> [cluster\_host\_names\_list](#output\_cluster\_host\_names\_list) | MySQL cluster host name |
| <a name="output_cluster_id"></a> [cluster\_id](#output\_cluster\_id) | MySQL cluster ID |
| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | MySQL cluster name |
| <a name="output_connection_step_1"></a> [connection\_step\_1](#output\_connection\_step\_1) | 1 step - Install certificate |
| <a name="output_connection_step_2"></a> [connection\_step\_2](#output\_connection\_step\_2) | How connect to MySQL cluster? 1. Install certificate mkdir --parents \~/.mysql && \\ curl -fsL 'https://storage.yandexcloud.net/cloud-certs/CA.pem' -o \~/.mysql/root.crt && \\ chmod 0600 \~/.mysql/root.crt 2. Run connection string from the output value, for example mysql --host=rc1a-ud9hj90vwqkw05js.mdb.yandexcloud.net \\ --port=3306 \\ --ssl-ca=\~/.mysql/root.crt \\ --ssl-mode=VERIFY\_IDENTITY \\ --user=test1-owner \\ --password \\ test1 |
| <a name="output_databases"></a> [databases](#output\_databases) | A list of databases names. |
| <a name="output_users_data"></a> [users\_data](#output\_users\_data) | A list of users with passwords. |

terraform-yc-mysql

terraform-yc-mysql Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

terraform-yc-mysql

terraform-yc-mysql Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README