Skip to content

Commit

Permalink
Documentation updates: updated descriptions for new arguments, update…
Browse files Browse the repository at this point in the history
…d terms, other minor updates (#282)

* Documentation updates

---------

Co-authored-by: butrimova.a <butrimova.a@selectel.ru>
  • Loading branch information
Vasilek15 and butrimova.a authored Jul 5, 2024
1 parent 2958ae3 commit c45464b
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion website/docs/d/dbaas_available_extension_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_available_extension_v1

Provides a list of extensions available for Managed Databases. Applicable to PostgreSQL, PostgreSQL for 1C, PostgreSQL TimescaleDB. For more information about extensions, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/add-extensions/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/extensions-1c/), and [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/add-extensions/).
Provides a list of extensions available for Managed Databases. Applicable to PostgreSQL and PostgreSQL TimescaleDB. For more information about extensions, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/add-extensions/) and [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/add-extensions/).

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/dbaas_configuration_parameter_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ data "selectel_dbaas_configuration_parameter_v1" "configuration_parameter_1" {

* `default_value` - Default value of the configuration parameter. Might be empty.

* `choices` - Available choices for the configuration parameter. Some parameters have list of available options.
* `choices` - Available choices for the configuration parameter. Some parameters have a list of available options.

* `invalid_values` - Invalid values for the configuration parameter.
Some parameters have list of values within a range that are not available for the parameter.
Some parameters have a list of values within a range that are not available for the parameter.

* `is_restart_required` - Shows if the database needs a restart to apply changes.

Expand Down
10 changes: 5 additions & 5 deletions website/docs/d/dbaas_datastore_type_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Provides a list of available datastore types in Managed Databases. For more info
## Example Usage for PostgreSQL

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
data "selectel_dbaas_datastore_type_v1" "datastore_type_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
Expand All @@ -26,7 +26,7 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
## Example Usage for PostgreSQL for 1C

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
data "selectel_dbaas_datastore_type_v1" "datastore_type_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
Expand All @@ -39,7 +39,7 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
## Example Usage for PostgreSQL TimescaleDB

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
data "selectel_dbaas_datastore_type_v1" "datastore_type_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
Expand Down Expand Up @@ -109,9 +109,9 @@ data "selectel_dbaas_datastore_type_v1" "datastore_type_1" {

* `filter` - (Optional) Values to filter available datastore types:

* `engine` - (Optional) Engine of the datastore type to search. Available values are `postgresql` (for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/)), `mysql` (for [MySQL sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/)), `mysql_native` (for [MySQL semi-sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-semi-sync/)), and `redis`(for [Redis](https://docs.selectel.ru/en/cloud/managed-databases/redis/)).
* `engine` - (Optional) Engine of the datastore type to search. Available values are `postgresql` (for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/)), `mysql` (for [MySQL sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/)), `mysql_native` (for [MySQL semi-sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-semi-sync/)), `redis` (for [Redis](https://docs.selectel.ru/en/cloud/managed-databases/redis/)), and `kafka` (for [Kafka](https://docs.selectel.ru/en/cloud/managed-databases/kafka/)).

* `version` - (Optional) Version of the datastore type to search. For PostgreSQL for 1C, the versions are in the format `<version_number>-1C`. For PostgreSQL TimescaleDB, the versions are in the format `<version_number>-TimescaleDB`. Learn more about available versions for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/configurations/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/configurations-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/configurations/), [MySQL semi-sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-semi-sync/configurations/), [MySQL sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/configurations/), and [Redis](https://docs.selectel.ru/en/cloud/managed-databases/redis/configurations/).
* `version` - (Optional) Version of the datastore type to search. For PostgreSQL for 1C, the versions are in the format `<version_number>-1C`. For PostgreSQL TimescaleDB, the versions are in the format `<version_number>-TimescaleDB`. Learn more about available versions for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/configurations/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/configurations-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/configurations/), [MySQL semi-sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-semi-sync/configurations/), [MySQL sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/configurations/), [Redis](https://docs.selectel.ru/en/cloud/managed-databases/redis/configurations/), and [Kafka](https://docs.selectel.ru/en/cloud/managed-databases/kafka/configurations/).

## Attributes Reference

Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/dbaas_flavor_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ data "selectel_dbaas_flavor_v1" "flavor" {

* `disk` - (Optional) Volume size in GB.

* `fl_size` - (Optional) Fl size of the flavor.
* `fl_size` - (Optional) Line of flavors. Available values are `standard` (for the Standard, CPU, and Memory lines) and `high_freq` (for the HighFreq line). Learn more about available lines for [PostgreSQL](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/configurations/), [PostgreSQL for 1C](https://docs.selectel.ru/en/cloud/managed-databases/postgresql-for-1c/configurations-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/en/cloud/managed-databases/timescaledb/configurations/), [MySQL semi-sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-semi-sync/configurations/), [MySQL sync](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/configurations/), [Redis](https://docs.selectel.ru/en/cloud/managed-databases/redis/configurations/), and [Kafka](https://docs.selectel.ru/en/cloud/managed-databases/kafka/configurations/).

* `datastore_type_id` - (Optional) Unique identifier of the datastore type.

Expand All @@ -53,6 +53,6 @@ data "selectel_dbaas_flavor_v1" "flavor" {

* `disk` - Volume size in GB.

* `fl_size` - Fl size of the flavor.
* `fl_size` - Line of flavors.

* `datastore_type_ids` - List of datastore types that support this flavor.
2 changes: 1 addition & 1 deletion website/docs/d/mks_kubeconfig_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ output "kubeconfig" {

* `project_id` - (Required) Unique identifier of the associated project. Retrieved from the [selectel_vpc_project_v2](https://registry.terraform.io/providers/selectel/selectel/latest/docs/resources/vpc_project_v2) resource. Learn more about [Projects](https://docs.selectel.ru/en/control-panel-actions/projects/about-projects/).

* `region` - (Required) Pool where the cluster is located, for example, `ru-3`. In a pool, you can create two clusters for a project. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/en/control-panel-actions/availability-matrix/#managed-kubernetes).
* `region` - (Required) Pool where the cluster is located, for example, `ru-3`. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/en/control-panel-actions/availability-matrix/#managed-kubernetes).

## Attributes Reference

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/dbaas_mysql_datastore_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ resource "selectel_dbaas_mysql_datastore_v1" "datastore_1" {

* `config` - (Optional) Configuration parameters for the datastore. You can retrieve information about available configuration parameters with the [selectel_dbaas_configuration_parameter_v1](https://registry.terraform.io/providers/selectel/selectel/latest/docs/data-sources/dbaas_configuration_parameter_v1) data source.

* `floating_ips` - (Optional) Assigns floating IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [floating IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/public-ip/).
* `floating_ips` - (Optional) Assigns public IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [public IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/mysql-sync/public-ip/).

* master - (Required) Number of floating IPs associated with the master. Available values are `0` and `1`.
* master - (Required) Number of public IPs associated with the master. Available values are `0` and `1`.

* replica - (Required) Number of floating IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less that the value of the `node_count` argument.
* replica - (Required) Number of public IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less than the value of the `node_count` argument.

## Attributes Reference

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/dbaas_postgresql_datastore_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ resource "selectel_dbaas_postgresql_datastore_v1" "datastore_1" {

* `config` - (Optional) Configuration parameters for the datastore. You can retrieve information about available configuration parameters with the [selectel_dbaas_configuration_parameter_v1](https://registry.terraform.io/providers/selectel/selectel/latest/docs/data-sources/dbaas_configuration_parameter_v1) data source.

* `floating_ips` - (Optional) Assigns floating IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [floating IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/public-ip/).
* `floating_ips` - (Optional) Assigns public IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [public IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/postgresql/public-ip/).

* master - (Required) Number of floating IPs associated with the master. Available values are `0` and `1`.
* master - (Required) Number of public IPs associated with the master. Available values are `0` and `1`.

* replica - (Required) Number of floating IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less that the value of the `node_count` argument.
* replica - (Required) Number of public IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less than the value of the `node_count` argument.

## Attributes Reference

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/dbaas_redis_datastore_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ resource "selectel_dbaas_redis_datastore_v1" "datastore_1" {

* `redis_password` - (Required, Sensitive) Datastore password.

* `floating_ips` - (Optional) Assigns floating IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [floating IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/redis/public-ip/).
* `floating_ips` - (Optional) Assigns public IP addresses to the nodes in the datastore. The network configuration must meet the requirements. Learn more about [public IP addresses and the required network configuration](https://docs.selectel.ru/en/cloud/managed-databases/redis/public-ip/).

* master - (Required) Number of floating IPs associated with the master. Available values are `0` and `1`.
* master - (Required) Number of public IPs associated with the master. Available values are `0` and `1`.

* replica - (Required) Number of floating IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less than the value of the `node_count` argument.
* replica - (Required) Number of public IPs associated with the replicas. The minimum value is `0`. The maximum value must be 1 less than the value of the `node_count` argument.

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/mks_nodegroup_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ resource "selectel_mks_nodegroup_v1" "nodegroup_1" {

* `nodes` - List of nodes in the node group.

* `nodegroup_type` - Type of the node group. Available values are `STANDARD`, `GPU`, `SGX`.
* `nodegroup_type` - Type of the node group. Available values are `STANDARD`, `GPU`, and `SGX`.

## Import

Expand Down

0 comments on commit c45464b

Please sign in to comment.