Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates #237

Merged
merged 6 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 16 additions & 27 deletions website/docs/d/dbaas_available_extension_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,40 @@ layout: "selectel"
page_title: "Selectel: selectel_dbaas_available_extension_v1"
sidebar_current: "docs-selectel-datasource-dbaas-available-extension-v1"
description: |-
Get information on Selectel DBaaS available extensions.
Provides a list of extensions available for Selectel Managed Databases.
---

# selectel\_dbaas\_available_extension_v1

Use this data source to get all available extensions within Selectel DBaaS API Service
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/cloud/managed-databases/postgresql/add-extensions/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/extensions-1c/), and [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/add-extensions/).

## Example Usage

```hcl
resource "selectel_vpc_project_v2" "project_1" {
}

data "selectel_dbaas_available_extension_v1" "ae" {
project_id = "${selectel_vpc_project_v2.project_1.id}"
region = "ru-3"
filter {
name = "hstore"
}
data "selectel_dbaas_available_extension_v1" "available_extension_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
}
```

## Argument Reference

The folowing arguments are supported

* `project_id` - (Required) An associated Selectel VPC project.
* `project_id` - (Required) Unique identifier of the associated Cloud Platform 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 [Cloud Platform projects](https://docs.selectel.ru/cloud/servers/about/projects/).

* `region` - (Required) A Selectel VPC region.
* `region` - (Required) Pool where the database is located, for example, `ru-3`. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/control-panel-actions/availability-matrix/#облачные-базы-данных).

* `filter` - (Optional) One or more values used to look up available extensions

**filter**

- `name` - (Optional) Name of the available extension to lookup.
* `filter` - (Optional) Values to filter available extensions.

* `name` - (Optional) Name of the extension to search.

## Attributes Reference

The following attributes are exported:
* `available_extensions` - List of the available extensions:

* `id` - Unique identifier of the extension.

* `available_extensions` - Contains a list of the found available extensions.
* `name` - Extension name.

**available_extensions**
* `datastore_type_ids` - List of datastore types that support the extension.

- `id` - ID of the extension.
- `name` - Name of the extension.
- `datastore_type_ids` - List of datastore types that support this extension.
- `dependency_ids` - List of extensions that depend on this extension.
* `dependency_ids` - List of extensions that depend on this extension.
73 changes: 30 additions & 43 deletions website/docs/d/dbaas_configuration_parameter_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,56 @@ layout: "selectel"
page_title: "Selectel: selectel_dbaas_configuration_parameter_v1"
sidebar_current: "docs-selectel-datasource-dbaas-configuration-parameter-v1"
description: |-
Get information on Selectel DBaaS configuration parameters.
Provides a list of configuration parameters available for Selectel Managed Databases.
---

# selectel\_dbaas\_configuration_parameter_v1

Use this data source to get all available confguration parameters within Selectel DBaaS API Service
Provides a list of configuration parameters available for Managed Databases. For more information about configuration parameters, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/settings/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/settings-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/settings/), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/settings/), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/settings/), and [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/eviction-policy/).

## Example Usage

```hcl
resource "selectel_vpc_project_v2" "project_1" {
}

data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = "${selectel_vpc_project_v2.project_1.id}"
region = "ru-3"
filter {
engine = "postgresql"
version = "12"
}
}

data "selectel_dbaas_configuration_parameter_v1" "config" {
project_id = "${selectel_vpc_project_v2.project_1.id}"
region = "ru-3"
filter {
datastore_type_id = data.selectel_dbaas_datastore_type_v1.dt.datastore_types[0].id
name = "work_mem"
}
data "selectel_dbaas_configuration_parameter_v1" "configuration_parameter_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
}
```

## Argument Reference

The folowing arguments are supported
* `project_id` - (Required) Unique identifier of the associated Cloud Platform 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 [Cloud Platform projects](https://docs.selectel.ru/cloud/servers/about/projects/).

* `project_id` - (Required) An associated Selectel VPC project.
* `region` - (Required) Pool where the database is located, for example, `ru-3`. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/control-panel-actions/availability-matrix/#облачные-базы-данных).

* `region` - (Required) A Selectel VPC region.
* `filter` - (Optional) Values to filter available extensions.

* `datastore_type_id` - (Optional) Unique identifier of the datastore type for which you get configuration parameters. You can retrieve information about available datastore types with the [selectel_dbaas_datastore_type_v1](https://registry.terraform.io/providers/selectel/selectel/latest/docs/data-sources/dbaas_datastore_type_v1) data source.

* `filter` - (Optional) One or more values used to look up configuration parameters
* `name` - (Optional) Name of the configuration parameter to search.

**filter**
## Attributes Reference

- `datastore_type_id` - (Optional) Datastore type id to lookup all available parameters for this type.
- `name` - (Optional) Name of the parameter to lookup.
* `configuration_parameters` - List of available configuration parameters.

## Attributes Reference
* `id` - Unique identifier of the configuration parameter.

* `datastore_type_id` - Unique identifier of the datastore type for which the configuration parameter is available.

* `name` - Name of the configuration parameter.

* `type` - Type of the configuration parameter.

* `unit` - Unit of the configuration parameter. Might be empty.

* `min` - Minimum value of the configuration parameter. Might be empty.

* `max` - Maximum value of the configuration parameter. Might be empty.

The following attributes are exported:
* `default_value` - Default value of the configuration parameter. Might be empty.

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

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

- `id` - ID of the configuration parameter.
- `datastore_type_id` - Datastore type id for which the configuration parameter is availabe.
- `name` - Name of the configuration parameter.
- `type` - Type of the configuration parameter.
- `unit` - Unit of the configuration parameter. Might be empty.
- `min` - Min value of the configuration parameter. Might be empty.
- `max` - Max value of the configuration parameter. Might be empty.
- `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.
- `is_restart_required` - Shows if database needs a restart to apply changes of this parameter.
- `is_changeable` - Shows if parameter can be changed.
* `is_changeable` - Shows if the parameter can be changed.
99 changes: 78 additions & 21 deletions website/docs/d/dbaas_datastore_type_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,52 +3,109 @@ layout: "selectel"
page_title: "Selectel: selectel_dbaas_datastore_type_v1"
sidebar_current: "docs-selectel-datasource-dbaas-datastore-type-v1"
description: |-
Get information on Selectel DBaaS datastore types.
Provides a list of available datastore types in Selectel Managed Databases.
---

# selectel\_dbaas\_datastore_type_v1

Use this data source to get all available datastore types within Selectel DBaaS API Service
Provides a list of available datastore types in Managed Databases. For more information about available datastore types, see the [official Selectel documentation](https://docs.selectel.ru/cloud/managed-databases/about/about-managed-databases/#поддерживаемые-облачные-базы-данных).

## Example Usage
## Example Usage for PostgreSQL

```hcl
resource "selectel_vpc_project_v2" "project_1" {
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "postgresql"
version = "14"
}
}
```

## Example Usage for PostgreSQL for 1C

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = "${selectel_vpc_project_v2.project_1.id}"
region = "ru-3"
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "postgresql"
version = "12"
version = "14-1C"
}
}
```

## Argument Reference
## Example Usage for PostgreSQL TimescaleDB

The folowing arguments are supported
```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "postgresql"
version = "14-TimescaleDB"
}
}
```

## Example Usage for MySQL semi-sync

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "mysql_native"
version = "8"
}
}
```

## Example Usage for MySQL sync

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "mysql"
version = "8"
}
}
```

## Example Usage for Redis

```hcl
data "selectel_dbaas_datastore_type_v1" "dt" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "redis"
version = "6"
}
}
```

## Argument Reference

* `project_id` - (Required) An associated Selectel VPC project.
* `project_id` - (Required) Unique identifier of the associated Cloud Platform 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 [Cloud Platform projects](https://docs.selectel.ru/cloud/servers/about/projects/).

* `region` - (Required) A Selectel VPC region.
* `region` - (Required) Pool where the database is located, for example, `ru-3`. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/control-panel-actions/availability-matrix/#облачные-базы-данных).

* `filter` - (Optional) One or more values used to look up datastore types
* `filter` - (Optional) Values to filter available datastore types:

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

- `engine` - (Optional) Engine of the datastore type to lookup.
- `version` - (Optional) Version of the datastore type to lookup.
* `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/cloud/managed-databases/postgresql/configurations/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/configurations-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/configurations/), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/configurations/), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/configurations/), and [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/configurations/).

## Attributes Reference

The following attributes are exported:
* `datastore_types` - List of available datastore types.

* `datastore_types` - Contains a list of the found datastore types.
* `id` - ID of the datastore type.

**datastore_types**
* `engine` - Engine of the datastore type.

- `id` - ID of the datastore type.
- `engine` - Engine of the datastore type.
- `version` - Version of the datastore type.
* `version` - Version of the datastore type.
55 changes: 24 additions & 31 deletions website/docs/d/dbaas_flavor_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,59 +3,52 @@ layout: "selectel"
page_title: "Selectel: selectel_dbaas_flavor_v1"
sidebar_current: "docs-selectel-datasource-dbaas-flavor-v1"
description: |-
Get information on Selectel DBaaS flavors.
Provides a list of flavors available in Selectel Managed Databases.
---

# selectel\_dbaas\_flavors_v1

Use this data source to get all available flavors within Selectel DBaaS API Service
Provides a list of flavors available in Managed Databases. For more information about available configurations, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/configurations/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/configurations-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/configurations/), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/configurations/), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/configurations/), and [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/configurations/).

## Example Usage

```hcl
resource "selectel_vpc_project_v2" "project_1" {
}

data "selectel_dbaas_flavor_v1" "flavor" {
project_id = "${selectel_vpc_project_v2.project_1.id}"
region = "ru-3"
filter {
vcpus = 2
ram = 4096
disk = 10
}
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
}
```

## Argument Reference

The folowing arguments are supported
* `project_id` - (Required) Unique identifier of the associated Cloud Platform 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 [Cloud Platform projects](https://docs.selectel.ru/cloud/servers/about/projects/).

* `project_id` - (Required) An associated Selectel VPC project.
* `region` - (Required) Pool where the database is located, for example, `ru-3`. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/control-panel-actions/availability-matrix/#облачные-базы-данных).

* `region` - (Required) A Selectel VPC region.
* `filter` - (Optional) Values to filter available flavors:

* `filter` - (Optional) One or more values used to look up flavors.
* `vcpus` - (Optional) Number of vCPU cores.

**filter**
* `ram` - (Optional) Amount of RAM in MB.

- `vcpus` - (Optional) vCPU of the flavor to lookup.
- `ram` - (Optional) RAM of the flavor to lookup.
- `disk` - (Optional) Disk of the flavor to lookup.
- `datastore_type_id` - (Optional) Datastore type ID of the flavor to lookup.
* `disk` - (Optional) Volume size in GB.

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

## Attributes Reference

The following attributes are exported:
* `flavors` - List of available flavors.

* `id` - Unique identifier of the flavor.

* `name` - Flavor name.

* `description` - Flavor description.

* `vcpus` - Number of vCPU cores.

* `flavors` - Contains a list of the found flavors.
* `ram` - Amount of RAM in MB.

**flavors**
* `disk` - Volume size in GB.

- `id` - ID of the flavor.
- `name` - Name of the flavor.
- `description` - Description of the flavor.
- `vcpus` - CPU count for the flavor.
- `ram` - RAM count for the flavor.
- `disk` - Disk size for the flavor.
- `datastore_type_ids` - List of datastore types that support this flavor.
* `datastore_type_ids` - List of datastore types that support this flavor.
Loading