From ce084b398ec81976b07ca17e290000bfd0957ec3 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Sun, 26 Jan 2025 18:56:22 +0100 Subject: [PATCH] docs: update descriptions for mysql resources and data sources --- docs/data-sources/mysql.md | 12 +++---- docs/data-sources/mysql_database.md | 16 ++++----- docs/data-sources/mysql_user.md | 22 ++++++------ docs/resources/mysql.md | 36 +++++++++---------- docs/resources/mysql_database.md | 18 +++++----- docs/resources/mysql_user.md | 24 ++++++------- .../data-sources/aiven_mysql/data-source.tf | 6 ++-- .../aiven_mysql_database/data-source.tf | 8 ++--- .../aiven_mysql_user/data-source.tf | 8 ++--- examples/resources/aiven_mysql/import.sh | 2 +- examples/resources/aiven_mysql/resource.tf | 6 ++-- .../resources/aiven_mysql_database/import.sh | 2 +- .../aiven_mysql_database/resource.tf | 8 ++--- .../resources/aiven_mysql_user/resource.tf | 10 +++--- internal/sdkprovider/service/mysql/mysql.go | 26 +++++++------- .../service/mysql/mysql_data_source.go | 2 +- .../service/mysql/mysql_database.go | 6 ++-- .../mysql/mysql_database_data_source.go | 2 +- .../sdkprovider/service/mysql/mysql_user.go | 12 +++---- .../service/mysql/mysql_user_data_source.go | 2 +- 20 files changed, 114 insertions(+), 114 deletions(-) diff --git a/docs/data-sources/mysql.md b/docs/data-sources/mysql.md index 2cc3128ca..65185f433 100644 --- a/docs/data-sources/mysql.md +++ b/docs/data-sources/mysql.md @@ -3,19 +3,19 @@ page_title: "aiven_mysql Data Source - terraform-provider-aiven" subcategory: "" description: |- - The MySQL data source provides information about the existing Aiven MySQL service. + Gets information about an Aiven for MySQL® service. --- # aiven_mysql (Data Source) -The MySQL data source provides information about the existing Aiven MySQL service. +Gets information about an Aiven for MySQL® service. ## Example Usage ```terraform -data "aiven_mysql" "mysql1" { - project = data.aiven_project.foo.project - service_name = "my-mysql1" +data "aiven_mysql" "example_mysql" { + project = aiven_project.example_project.project + service_name = "example-mysql" } ``` @@ -40,7 +40,7 @@ data "aiven_mysql" "mysql1" { - `id` (String) The ID of this resource. - `maintenance_window_dow` (String) Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc. - `maintenance_window_time` (String) Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format. -- `mysql` (List of Object, Sensitive) MySQL specific server provided values (see [below for nested schema](#nestedatt--mysql)) +- `mysql` (List of Object, Sensitive) MySQL server-provided values. (see [below for nested schema](#nestedatt--mysql)) - `mysql_user_config` (List of Object) Mysql user configurable settings. **Warning:** There's no way to reset advanced configuration options to default. Options that you add cannot be removed later (see [below for nested schema](#nestedatt--mysql_user_config)) - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the [Aiven pricing page](https://aiven.io/pricing). - `project_vpc_id` (String) Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data. diff --git a/docs/data-sources/mysql_database.md b/docs/data-sources/mysql_database.md index 769fcd0e1..693e91c4b 100644 --- a/docs/data-sources/mysql_database.md +++ b/docs/data-sources/mysql_database.md @@ -3,20 +3,20 @@ page_title: "aiven_mysql_database Data Source - terraform-provider-aiven" subcategory: "" description: |- - The MySQL Database data source provides information about the existing Aiven MySQL Database. + Gets information about an Aiven for MySQL® database. --- # aiven_mysql_database (Data Source) -The MySQL Database data source provides information about the existing Aiven MySQL Database. +Gets information about an Aiven for MySQL® database. ## Example Usage ```terraform -data "aiven_mysql_database" "mydatabase" { - project = aiven_project.myproject.project - service_name = aiven_mysql.mymysql.service_name - database_name = "" +data "aiven_mysql_database" "example_database" { + project = aiven_project.example_project.project + service_name = aiven_mysql.example_mysql.service_name + database_name = "example-database" } ``` @@ -25,11 +25,11 @@ data "aiven_mysql_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service database. Changing this property forces recreation of the resource. +- `database_name` (String) The name of the database. Changing this property forces recreation of the resource. - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `service_name` (String) The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only - `id` (String) The ID of this resource. -- `termination_protection` (Boolean) It is a Terraform client-side deletion protections, which prevents the database from being deleted by Terraform. It is recommended to enable this for any production databases containing critical data. The default value is `false`. +- `termination_protection` (Boolean) Client-side deletion protection that prevents the database from being deleted by Terraform. Enable this for production databases containing critical data. The default value is `false`. diff --git a/docs/data-sources/mysql_user.md b/docs/data-sources/mysql_user.md index ccc4e4389..365d0c5e4 100644 --- a/docs/data-sources/mysql_user.md +++ b/docs/data-sources/mysql_user.md @@ -3,20 +3,20 @@ page_title: "aiven_mysql_user Data Source - terraform-provider-aiven" subcategory: "" description: |- - The MySQL User data source provides information about the existing Aiven MySQL User. + Gets information about an Aiven for MySQL® service user. --- # aiven_mysql_user (Data Source) -The MySQL User data source provides information about the existing Aiven MySQL User. +Gets information about an Aiven for MySQL® service user. ## Example Usage ```terraform -data "aiven_mysql_user" "user" { - service_name = "my-service" - project = "my-project" - username = "user1" +data "aiven_mysql_user" "example_mysql_user" { + service_name = aiven_mysql.example_mysql.service_name + project = aiven_project.example_project.project + username = "example-mysql-user" } ``` @@ -27,13 +27,13 @@ data "aiven_mysql_user" "user" { - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `service_name` (String) The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. -- `username` (String) The actual name of the MySQL User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. +- `username` (String) The name of the MySQL service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only -- `access_cert` (String, Sensitive) Access certificate for the user -- `access_key` (String, Sensitive) Access certificate key for the user +- `access_cert` (String, Sensitive) Access certificate for the user. +- `access_key` (String, Sensitive) Access certificate key for the user. - `authentication` (String) Authentication details. The possible values are `null`, `caching_sha2_password` and `mysql_native_password`. - `id` (String) The ID of this resource. -- `password` (String, Sensitive) The password of the MySQL User ( not applicable for all services ). -- `type` (String) Type of the user account. Tells whether the user is the primary account or a regular account. +- `password` (String, Sensitive) The password of the MySQL service user. +- `type` (String) User account type, such as primary or regular account. diff --git a/docs/resources/mysql.md b/docs/resources/mysql.md index b27213ea3..d12ae88fd 100644 --- a/docs/resources/mysql.md +++ b/docs/resources/mysql.md @@ -3,21 +3,21 @@ page_title: "aiven_mysql Resource - terraform-provider-aiven" subcategory: "" description: |- - The MySQL resource allows the creation and management of Aiven MySQL services. + Creates and manages an Aiven for MySQL® https://aiven.io/docs/products/mysql service. --- # aiven_mysql (Resource) -The MySQL resource allows the creation and management of Aiven MySQL services. +Creates and manages an [Aiven for MySQL®](https://aiven.io/docs/products/mysql) service. ## Example Usage ```terraform -resource "aiven_mysql" "mysql1" { - project = data.aiven_project.foo.project +resource "aiven_mysql" "example_mysql" { + project = data.aiven_project.example_project.project cloud_name = "google-europe-west1" plan = "business-4" - service_name = "my-mysql1" + service_name = "example-mysql" maintenance_window_dow = "monday" maintenance_window_time = "10:00:00" @@ -52,7 +52,7 @@ resource "aiven_mysql" "mysql1" { - `disk_space` (String, Deprecated) Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. - `maintenance_window_dow` (String) Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc. - `maintenance_window_time` (String) Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format. -- `mysql` (Block List, Max: 1) MySQL specific server provided values (see [below for nested schema](#nestedblock--mysql)) +- `mysql` (Block List, Max: 1) MySQL server-provided values. (see [below for nested schema](#nestedblock--mysql)) - `mysql_user_config` (Block List, Max: 1) Mysql user configurable settings. **Warning:** There's no way to reset advanced configuration options to default. Options that you add cannot be removed later (see [below for nested schema](#nestedblock--mysql_user_config)) - `project_vpc_id` (String) Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data. - `service_integrations` (Block Set) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) @@ -83,26 +83,26 @@ resource "aiven_mysql" "mysql1" { Optional: -- `standby_uris` (List of String, Sensitive) MySQL standby connection URIs -- `syncing_uris` (List of String, Sensitive) MySQL syncing connection URIs -- `uris` (List of String, Sensitive) MySQL master connection URIs +- `standby_uris` (List of String, Sensitive) MySQL standby connection URIs. +- `syncing_uris` (List of String, Sensitive) MySQL syncing connection URIs. +- `uris` (List of String, Sensitive) MySQL connection URIs. Read-Only: -- `params` (Block List) MySQL connection parameters (see [below for nested schema](#nestedblock--mysql--params)) -- `replica_uri` (String, Sensitive) MySQL replica URI for services with a replica +- `params` (Block List) MySQL connection parameters. (see [below for nested schema](#nestedblock--mysql--params)) +- `replica_uri` (String, Sensitive) MySQL replica URI for services with a replica. ### Nested Schema for `mysql.params` Read-Only: -- `database_name` (String, Sensitive) Primary MySQL database name -- `host` (String, Sensitive) MySQL host IP or name -- `password` (String, Sensitive) MySQL admin user password -- `port` (Number, Sensitive) MySQL port -- `sslmode` (String, Sensitive) MySQL sslmode setting (currently always "require") -- `user` (String, Sensitive) MySQL admin user name +- `database_name` (String, Sensitive) Thr name of the primary MySQL database. +- `host` (String, Sensitive) MySQL host IP or name. +- `password` (String, Sensitive) The password for the admin service user. +- `port` (Number, Sensitive) MySQL port. +- `sslmode` (String, Sensitive) MySQL SSL mode setting. Always set to "require". +- `user` (String, Sensitive) The username for the admin service user. @@ -289,5 +289,5 @@ Read-Only: Import is supported using the following syntax: ```shell -terraform import aiven_mysql.mysql1 project/service_name +terraform import aiven_mysql.example_mysql PROJECT/SERVICE_NAME ``` diff --git a/docs/resources/mysql_database.md b/docs/resources/mysql_database.md index 53cf00aa7..de980f937 100644 --- a/docs/resources/mysql_database.md +++ b/docs/resources/mysql_database.md @@ -3,20 +3,20 @@ page_title: "aiven_mysql_database Resource - terraform-provider-aiven" subcategory: "" description: |- - The MySQL Database resource allows the creation and management of Aiven MySQL Databases. + Creates and manages an Aiven for MySQL® https://aiven.io/docs/products/mysql database. --- # aiven_mysql_database (Resource) -The MySQL Database resource allows the creation and management of Aiven MySQL Databases. +Creates and manages an [Aiven for MySQL®](https://aiven.io/docs/products/mysql) database. ## Example Usage ```terraform -resource "aiven_mysql_database" "mydatabase" { - project = aiven_project.myproject.project - service_name = aiven_mysql.mymysql.service_name - database_name = "" +resource "aiven_mysql_database" "example_mysql_database" { + project = data.aiven_project.example_project.project + service_name = aiven_mysql.example_mysql.service_name + database_name = "example-database" } ``` @@ -25,13 +25,13 @@ resource "aiven_mysql_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service database. Changing this property forces recreation of the resource. +- `database_name` (String) The name of the database. Changing this property forces recreation of the resource. - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `service_name` (String) The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional -- `termination_protection` (Boolean) It is a Terraform client-side deletion protections, which prevents the database from being deleted by Terraform. It is recommended to enable this for any production databases containing critical data. The default value is `false`. +- `termination_protection` (Boolean) Client-side deletion protection that prevents the database from being deleted by Terraform. Enable this for production databases containing critical data. The default value is `false`. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only @@ -54,5 +54,5 @@ Optional: Import is supported using the following syntax: ```shell -terraform import aiven_mysql_database.mydatabase PROJECT/SERVICE_NAME/DATABASE_NAME +terraform import aiven_mysql_database.example_database PROJECT/SERVICE_NAME/DATABASE_NAME ``` diff --git a/docs/resources/mysql_user.md b/docs/resources/mysql_user.md index 0e826241f..b9cae2e1a 100644 --- a/docs/resources/mysql_user.md +++ b/docs/resources/mysql_user.md @@ -3,21 +3,21 @@ page_title: "aiven_mysql_user Resource - terraform-provider-aiven" subcategory: "" description: |- - The MySQL User resource allows the creation and management of Aiven MySQL Users. + Creates and manages an Aiven for MySQL® service user. --- # aiven_mysql_user (Resource) -The MySQL User resource allows the creation and management of Aiven MySQL Users. +Creates and manages an Aiven for MySQL® service user. ## Example Usage ```terraform -resource "aiven_mysql_user" "foo" { - service_name = aiven_mysql.bar.service_name - project = "my-project" - username = "user-1" - password = "Test$1234" +resource "aiven_mysql_user" "example_mysql_user" { + service_name = aiven_mysql.example_mysql.service_name + project = data.aiven_project.example_project.project + username = "example-mysql-user" + password = var.service_user_pw } ``` @@ -28,20 +28,20 @@ resource "aiven_mysql_user" "foo" { - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `service_name` (String) The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. -- `username` (String) The actual name of the MySQL User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. +- `username` (String) The name of the MySQL service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional - `authentication` (String) Authentication details. The possible values are `null`, `caching_sha2_password` and `mysql_native_password`. -- `password` (String, Sensitive) The password of the MySQL User ( not applicable for all services ). +- `password` (String, Sensitive) The password of the MySQL service user. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only -- `access_cert` (String, Sensitive) Access certificate for the user -- `access_key` (String, Sensitive) Access certificate key for the user +- `access_cert` (String, Sensitive) Access certificate for the user. +- `access_key` (String, Sensitive) Access certificate key for the user. - `id` (String) The ID of this resource. -- `type` (String) Type of the user account. Tells whether the user is the primary account or a regular account. +- `type` (String) User account type, such as primary or regular account. ### Nested Schema for `timeouts` diff --git a/examples/data-sources/aiven_mysql/data-source.tf b/examples/data-sources/aiven_mysql/data-source.tf index 7c5be1c02..3997d8aaf 100644 --- a/examples/data-sources/aiven_mysql/data-source.tf +++ b/examples/data-sources/aiven_mysql/data-source.tf @@ -1,4 +1,4 @@ -data "aiven_mysql" "mysql1" { - project = data.aiven_project.foo.project - service_name = "my-mysql1" +data "aiven_mysql" "example_mysql" { + project = aiven_project.example_project.project + service_name = "example-mysql" } diff --git a/examples/data-sources/aiven_mysql_database/data-source.tf b/examples/data-sources/aiven_mysql_database/data-source.tf index 332de7123..b8666e79e 100644 --- a/examples/data-sources/aiven_mysql_database/data-source.tf +++ b/examples/data-sources/aiven_mysql_database/data-source.tf @@ -1,6 +1,6 @@ -data "aiven_mysql_database" "mydatabase" { - project = aiven_project.myproject.project - service_name = aiven_mysql.mymysql.service_name - database_name = "" +data "aiven_mysql_database" "example_database" { + project = aiven_project.example_project.project + service_name = aiven_mysql.example_mysql.service_name + database_name = "example-database" } diff --git a/examples/data-sources/aiven_mysql_user/data-source.tf b/examples/data-sources/aiven_mysql_user/data-source.tf index cf6bc9c86..9d3580cdf 100644 --- a/examples/data-sources/aiven_mysql_user/data-source.tf +++ b/examples/data-sources/aiven_mysql_user/data-source.tf @@ -1,5 +1,5 @@ -data "aiven_mysql_user" "user" { - service_name = "my-service" - project = "my-project" - username = "user1" +data "aiven_mysql_user" "example_mysql_user" { + service_name = aiven_mysql.example_mysql.service_name + project = aiven_project.example_project.project + username = "example-mysql-user" } \ No newline at end of file diff --git a/examples/resources/aiven_mysql/import.sh b/examples/resources/aiven_mysql/import.sh index 2ba61fed4..71e081715 100644 --- a/examples/resources/aiven_mysql/import.sh +++ b/examples/resources/aiven_mysql/import.sh @@ -1 +1 @@ -terraform import aiven_mysql.mysql1 project/service_name +terraform import aiven_mysql.example_mysql PROJECT/SERVICE_NAME diff --git a/examples/resources/aiven_mysql/resource.tf b/examples/resources/aiven_mysql/resource.tf index 3fedcbce3..f9d0467af 100644 --- a/examples/resources/aiven_mysql/resource.tf +++ b/examples/resources/aiven_mysql/resource.tf @@ -1,8 +1,8 @@ -resource "aiven_mysql" "mysql1" { - project = data.aiven_project.foo.project +resource "aiven_mysql" "example_mysql" { + project = data.aiven_project.example_project.project cloud_name = "google-europe-west1" plan = "business-4" - service_name = "my-mysql1" + service_name = "example-mysql" maintenance_window_dow = "monday" maintenance_window_time = "10:00:00" diff --git a/examples/resources/aiven_mysql_database/import.sh b/examples/resources/aiven_mysql_database/import.sh index 4569a1f40..f34364b7a 100644 --- a/examples/resources/aiven_mysql_database/import.sh +++ b/examples/resources/aiven_mysql_database/import.sh @@ -1 +1 @@ -terraform import aiven_mysql_database.mydatabase PROJECT/SERVICE_NAME/DATABASE_NAME +terraform import aiven_mysql_database.example_database PROJECT/SERVICE_NAME/DATABASE_NAME diff --git a/examples/resources/aiven_mysql_database/resource.tf b/examples/resources/aiven_mysql_database/resource.tf index d8b8439ae..38fe22d2f 100644 --- a/examples/resources/aiven_mysql_database/resource.tf +++ b/examples/resources/aiven_mysql_database/resource.tf @@ -1,5 +1,5 @@ -resource "aiven_mysql_database" "mydatabase" { - project = aiven_project.myproject.project - service_name = aiven_mysql.mymysql.service_name - database_name = "" +resource "aiven_mysql_database" "example_mysql_database" { + project = data.aiven_project.example_project.project + service_name = aiven_mysql.example_mysql.service_name + database_name = "example-database" } diff --git a/examples/resources/aiven_mysql_user/resource.tf b/examples/resources/aiven_mysql_user/resource.tf index ea48b56e6..d831ac45d 100644 --- a/examples/resources/aiven_mysql_user/resource.tf +++ b/examples/resources/aiven_mysql_user/resource.tf @@ -1,6 +1,6 @@ -resource "aiven_mysql_user" "foo" { - service_name = aiven_mysql.bar.service_name - project = "my-project" - username = "user-1" - password = "Test$1234" +resource "aiven_mysql_user" "example_mysql_user" { + service_name = aiven_mysql.example_mysql.service_name + project = data.aiven_project.example_project.project + username = "example-mysql-user" + password = var.service_user_pw } \ No newline at end of file diff --git a/internal/sdkprovider/service/mysql/mysql.go b/internal/sdkprovider/service/mysql/mysql.go index 4cf47835a..a6cea03b2 100644 --- a/internal/sdkprovider/service/mysql/mysql.go +++ b/internal/sdkprovider/service/mysql/mysql.go @@ -13,7 +13,7 @@ func aivenMySQLSchema() map[string]*schema.Schema { Type: schema.TypeList, MaxItems: 1, Computed: true, - Description: "MySQL specific server provided values", + Description: "MySQL server-provided values.", Optional: true, Sensitive: true, Elem: &schema.Resource{ @@ -21,7 +21,7 @@ func aivenMySQLSchema() map[string]*schema.Schema { "uris": { Type: schema.TypeList, Computed: true, - Description: "MySQL master connection URIs", + Description: "MySQL connection URIs.", Optional: true, Sensitive: true, Elem: &schema.Schema{ @@ -32,7 +32,7 @@ func aivenMySQLSchema() map[string]*schema.Schema { "params": { Type: schema.TypeList, Computed: true, - Description: "MySQL connection parameters", + Description: "MySQL connection parameters.", Optional: true, Sensitive: true, Elem: &schema.Resource{ @@ -41,37 +41,37 @@ func aivenMySQLSchema() map[string]*schema.Schema { Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "MySQL host IP or name", + Description: "MySQL host IP or name.", }, "port": { Type: schema.TypeInt, Computed: true, Sensitive: true, - Description: "MySQL port", + Description: "MySQL port.", }, "sslmode": { Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "MySQL sslmode setting (currently always \"require\")", + Description: "MySQL SSL mode setting. Always set to \"require\".", }, "user": { Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "MySQL admin user name", + Description: "The username for the admin service user.", }, "password": { Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "MySQL admin user password", + Description: "The password for the admin service user.", }, "database_name": { Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "Primary MySQL database name", + Description: "Thr name of the primary MySQL database.", }, }, }, @@ -79,13 +79,13 @@ func aivenMySQLSchema() map[string]*schema.Schema { "replica_uri": { Type: schema.TypeString, Computed: true, - Description: "MySQL replica URI for services with a replica", + Description: "MySQL replica URI for services with a replica.", Sensitive: true, }, "standby_uris": { Type: schema.TypeList, Computed: true, - Description: "MySQL standby connection URIs", + Description: "MySQL standby connection URIs.", Optional: true, Sensitive: true, Elem: &schema.Schema{ @@ -96,7 +96,7 @@ func aivenMySQLSchema() map[string]*schema.Schema { "syncing_uris": { Type: schema.TypeList, Computed: true, - Description: "MySQL syncing connection URIs", + Description: "MySQL syncing connection URIs.", Optional: true, Sensitive: true, Elem: &schema.Schema{ @@ -111,7 +111,7 @@ func aivenMySQLSchema() map[string]*schema.Schema { } func ResourceMySQL() *schema.Resource { return &schema.Resource{ - Description: "The MySQL resource allows the creation and management of Aiven MySQL services.", + Description: "Creates and manages an [Aiven for MySQL®](https://aiven.io/docs/products/mysql) service.", CreateContext: schemautil.ResourceServiceCreateWrapper(schemautil.ServiceTypeMySQL), ReadContext: schemautil.ResourceServiceRead, UpdateContext: schemautil.ResourceServiceUpdate, diff --git a/internal/sdkprovider/service/mysql/mysql_data_source.go b/internal/sdkprovider/service/mysql/mysql_data_source.go index a2a4fdf8b..32da93082 100644 --- a/internal/sdkprovider/service/mysql/mysql_data_source.go +++ b/internal/sdkprovider/service/mysql/mysql_data_source.go @@ -9,7 +9,7 @@ import ( func DatasourceMySQL() *schema.Resource { return &schema.Resource{ ReadContext: schemautil.DatasourceServiceRead, - Description: "The MySQL data source provides information about the existing Aiven MySQL service.", + Description: "Gets information about an Aiven for MySQL® service.", Schema: schemautil.ResourceSchemaAsDatasourceSchema(aivenMySQLSchema(), "project", "service_name"), } } diff --git a/internal/sdkprovider/service/mysql/mysql_database.go b/internal/sdkprovider/service/mysql/mysql_database.go index b447fd7c7..be8026da6 100644 --- a/internal/sdkprovider/service/mysql/mysql_database.go +++ b/internal/sdkprovider/service/mysql/mysql_database.go @@ -18,19 +18,19 @@ var aivenMySQLDatabaseSchema = map[string]*schema.Schema{ Type: schema.TypeString, Required: true, ForceNew: true, - Description: userconfig.Desc("The name of the service database.").ForceNew().Build(), + Description: userconfig.Desc("The name of the database.").ForceNew().Build(), }, "termination_protection": { Type: schema.TypeBool, Optional: true, Default: false, - Description: userconfig.Desc(`It is a Terraform client-side deletion protections, which prevents the database from being deleted by Terraform. It is recommended to enable this for any production databases containing critical data.`).DefaultValue(false).Build(), + Description: userconfig.Desc(`Client-side deletion protection that prevents the database from being deleted by Terraform. Enable this for production databases containing critical data.`).DefaultValue(false).Build(), }, } func ResourceMySQLDatabase() *schema.Resource { return &schema.Resource{ - Description: "The MySQL Database resource allows the creation and management of Aiven MySQL Databases.", + Description: "Creates and manages an [Aiven for MySQL®](https://aiven.io/docs/products/mysql) database.", CreateContext: resourceMySQLDatabaseCreate, ReadContext: resourceMySQLDatabaseRead, DeleteContext: resourceMySQLDatabaseDelete, diff --git a/internal/sdkprovider/service/mysql/mysql_database_data_source.go b/internal/sdkprovider/service/mysql/mysql_database_data_source.go index f304b96d2..0293d2a80 100644 --- a/internal/sdkprovider/service/mysql/mysql_database_data_source.go +++ b/internal/sdkprovider/service/mysql/mysql_database_data_source.go @@ -13,7 +13,7 @@ import ( func DatasourceMySQLDatabase() *schema.Resource { return &schema.Resource{ ReadContext: datasourceDatabaseRead, - Description: "The MySQL Database data source provides information about the existing Aiven MySQL Database.", + Description: "Gets information about an Aiven for MySQL® database.", Schema: schemautil.ResourceSchemaAsDatasourceSchema(aivenMySQLDatabaseSchema, "project", "service_name", "database_name"), } diff --git a/internal/sdkprovider/service/mysql/mysql_user.go b/internal/sdkprovider/service/mysql/mysql_user.go index 6022d60c6..08cc51a76 100644 --- a/internal/sdkprovider/service/mysql/mysql_user.go +++ b/internal/sdkprovider/service/mysql/mysql_user.go @@ -22,7 +22,7 @@ var aivenMySQLUserSchema = map[string]*schema.Schema{ Required: true, ForceNew: true, ValidateFunc: schemautil.GetServiceUserValidateFunc(), - Description: userconfig.Desc("The actual name of the MySQL User.").ForceNew().Referenced().Build(), + Description: userconfig.Desc("The name of the MySQL service user.").ForceNew().Referenced().Build(), }, "password": { Type: schema.TypeString, @@ -30,7 +30,7 @@ var aivenMySQLUserSchema = map[string]*schema.Schema{ Sensitive: true, Computed: true, DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc, - Description: "The password of the MySQL User ( not applicable for all services ).", + Description: "The password of the MySQL service user.", }, "authentication": { Type: schema.TypeString, @@ -44,25 +44,25 @@ var aivenMySQLUserSchema = map[string]*schema.Schema{ "type": { Type: schema.TypeString, Computed: true, - Description: "Type of the user account. Tells whether the user is the primary account or a regular account.", + Description: "User account type, such as primary or regular account.", }, "access_cert": { Type: schema.TypeString, Sensitive: true, Computed: true, - Description: "Access certificate for the user", + Description: "Access certificate for the user.", }, "access_key": { Type: schema.TypeString, Sensitive: true, Computed: true, - Description: "Access certificate key for the user", + Description: "Access certificate key for the user.", }, } func ResourceMySQLUser() *schema.Resource { return &schema.Resource{ - Description: "The MySQL User resource allows the creation and management of Aiven MySQL Users.", + Description: "Creates and manages an Aiven for MySQL® service user.", CreateContext: resourceMySQLUserCreate, UpdateContext: resourceMySQLUserUpdate, ReadContext: schemautil.ResourceServiceUserRead, diff --git a/internal/sdkprovider/service/mysql/mysql_user_data_source.go b/internal/sdkprovider/service/mysql/mysql_user_data_source.go index 55556b365..b444261e2 100644 --- a/internal/sdkprovider/service/mysql/mysql_user_data_source.go +++ b/internal/sdkprovider/service/mysql/mysql_user_data_source.go @@ -9,7 +9,7 @@ import ( func DatasourceMySQLUser() *schema.Resource { return &schema.Resource{ ReadContext: schemautil.DatasourceServiceUserRead, - Description: "The MySQL User data source provides information about the existing Aiven MySQL User.", + Description: "Gets information about an Aiven for MySQL® service user.", Schema: schemautil.ResourceSchemaAsDatasourceSchema(aivenMySQLUserSchema, "project", "service_name", "username"), }