Skip to content

Commit

Permalink
Fix extensions for kafka resource docs (#250)
Browse files Browse the repository at this point in the history
- Removed extra .md extension for the Kafka resource docs
- Replaced user_id with topic_id for topic's resource doc
- Added information about Kafka to resource's and data source's docs
  • Loading branch information
Gogen120 authored Feb 12, 2024
1 parent b75ae33 commit 50ebb21
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_configuration_parameter_v1

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/).
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/), [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/eviction-policy/), and [Kafka](https://docs.selectel.ru/cloud/managed-databases/kafka/settings/).

## Example Usage

Expand Down
19 changes: 16 additions & 3 deletions website/docs/d/dbaas_datastore_type_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
## Example Usage for MySQL semi-sync

```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 @@ -65,7 +65,7 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
## Example Usage for MySQL sync

```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 @@ -78,7 +78,7 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
## Example Usage for Redis

```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 @@ -88,6 +88,19 @@ data "selectel_dbaas_datastore_type_v1" "dt" {
}
```

## Example Usage for Kafka

```hcl
data "selectel_dbaas_datastore_type_v1" "datastore_type_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
filter {
engine = "kafka"
version = "3.5"
}
}
```

## Argument Reference

* `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/).
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/dbaas_flavor_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_flavors_v1

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/).
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/), [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/configurations/), and [Kafka](https://docs.selectel.ru/cloud/managed-databases/kafka/configurations/).

## Example Usage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_prometheus_metric_token_v1

Provides a list of tokens for Prometheus available in Managed Databases. For more information about tokens for Prometheus, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/monitoring/#экспортировать-метрики-в-формате-prometheus), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/monitoring-1c/#экспортировать-метрики-в-формате-prometheus), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/monitoring/#экспортировать-метрики-в-формате-prometheus), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/monitoring/#экспортировать-метрики-в-формате-prometheus), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/monitoring/#экспортировать-метрики-в-формате-prometheus), and [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/monitoring/#экспортировать-метрики-в-формате-prometheus).
Provides a list of tokens for Prometheus available in Managed Databases. For more information about tokens for Prometheus, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/monitoring/#export-metrics-in-prometheus-format), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/monitoring-1c/#export-metrics-in-prometheus-format), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/monitoring/#export-metrics-in-prometheus-format), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/monitoring/#export-metrics-in-prometheus-format), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/monitoring/#export-metrics-in-prometheus-format), [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/monitoring/#export-metrics-in-prometheus-format), and [Kafka](https://docs.selectel.ru/cloud/managed-databases/kafka/monitoring/#export-metrics-in-prometheus-format).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/dbaas_grant_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_grant\_v1

Grants privileges to the users in Managed Databases using public API v1. Not applicable to Redis. Learn more about Managed Databases in the [official Selectel documentation](https://docs.selectel.ru/cloud/managed-databases/).
Grants privileges to the users in Managed Databases using public API v1. Not applicable to Redis and Kafka. Learn more about Managed Databases in the [official Selectel documentation](https://docs.selectel.ru/cloud/managed-databases/).

## Example usage

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/dbaas_kafka_topic_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ resource "selectel_dbaas_kafka_topic_v1" "topic_1" {

* `partitions` - (Required) Number of partitions in a topic. The available range is from 1 to 4 000. You cannot increase the number of partitions in the existing topic. Learn more about [Partitions](https://docs.selectel.ru/cloud/managed-databases/kafka/manage-topics/#partitions)

* `project_id` - (Required) Unique identifier of the associated Cloud Platform project. Changing this creates a new user. 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/managed-databases/about/projects/).
* `project_id` - (Required) Unique identifier of the associated Cloud Platform project. Changing this creates a new topic. 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/managed-databases/about/projects/).

* `region` - (Required) Pool where the database is located, for example, `ru-3`. Changing this creates a new topic. Learn more about available pools in the [Availability matrix](https://docs.selectel.ru/control-panel-actions/availability-matrix/#managed-databases).

Expand Down Expand Up @@ -63,4 +63,4 @@ where:

* `<selectel_pool>` — Pool where the cluster is located, for example, `ru-3`. To get information about the pool, in the [Control panel](https://my.selectel.ru/vpc/dbaas/), go to **Cloud Platform****Managed Databases**. The pool is in the **Pool** column.

* `<user_id>` — Unique identifier of the user, for example, `b311ce58-2658-46b5-b733-7a0f418703f2`. To get the user ID in the [Control panel](https://my.selectel.ru/vpc/dbaas/), go to **Cloud Platform****Managed Databases** ⟶ the cluster page ⟶ the **Users** tab. The user ID is under the user name.
* `<topic_id>` — Unique identifier of the topic, for example, `b311ce58-2658-46b5-b733-7a0f418703f2`. To get the topic ID in the [Control panel](https://my.selectel.ru/vpc/dbaas/), go to **Cloud Platform****Managed Databases** ⟶ the cluster page ⟶ the **Topics** tab. The topic ID is under the topic name.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_prometheus_metric_token_v1

Creates and manages tokens required to get access to the metrics in the Prometheus format using public API v1. For more information about export of Prometheus metrics, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/monitoring/#экспортировать-метрики-в-формате-prometheus), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/monitoring-1c/#экспортировать-метрики-в-формате-prometheus), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/monitoring/#экспортировать-метрики-в-формате-prometheus), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/monitoring/#экспортировать-метрики-в-формате-prometheus), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/monitoring/#экспортировать-метрики-в-формате-prometheus), and [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/monitoring/#экспортировать-метрики-в-формате-prometheus).
Creates and manages tokens required to get access to the metrics in the Prometheus format using public API v1. For more information about export of Prometheus metrics, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/monitoring/#export-metrics-in-prometheus-format), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/monitoring-1c/#export-metrics-in-prometheus-format), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/monitoring/#export-metrics-in-prometheus-format), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/monitoring/#export-metrics-in-prometheus-format), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/monitoring/#export-metrics-in-prometheus-format), [Redis](https://docs.selectel.ru/cloud/managed-databases/redis/monitoring/#export-metrics-in-prometheus-format) and [Kafka](https://docs.selectel.ru/cloud/managed-databases/kafka/monitoring/#export-metrics-in-prometheus-format).

## Example Usage

Expand Down
14 changes: 13 additions & 1 deletion website/docs/r/dbaas_user_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# selectel\_dbaas\_user\_v1

Creates and manages a user in Managed Databases using public API v1. Not applicable to Redis. For more information about managing users in Managed Databases, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/manage-users/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/manage-users-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/manage-users/), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/manage-users/), and [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/manage-users/).
Creates and manages a user in Managed Databases using public API v1. Not applicable to Redis. For more information about managing users in Managed Databases, see the official Selectel documentation for [PostgreSQL](https://docs.selectel.ru/cloud/managed-databases/postgresql/manage-users/), [PostgreSQL for 1C](https://docs.selectel.ru/cloud/managed-databases/postgresql-for-1c/manage-users-1c/), [PostgreSQL TimescaleDB](https://docs.selectel.ru/cloud/managed-databases/timescaledb/manage-users/), [MySQL semi-sync](https://docs.selectel.ru/cloud/managed-databases/mysql-semi-sync/manage-users/), [MySQL sync](https://docs.selectel.ru/cloud/managed-databases/mysql-sync/manage-users/), and [Kafka](https://docs.selectel.ru/cloud/managed-databases/kafka/manage-users/).

## Example usage

Expand Down Expand Up @@ -36,6 +36,18 @@ resource "selectel_dbaas_user_v1" "user_1" {
}
```

### Kafka

```hcl
resource "selectel_dbaas_user_v1" "user_1" {
project_id = selectel_vpc_project_v2.project_1.id
region = "ru-3"
datastore_id = selectel_dbaas_kafka_datastore_v1.datastore_1.id
name = "user"
password = "secret"
}
```

## Argument Reference

* `name` - (Required, Sensitive) User name. Changing this creates a new user.
Expand Down

0 comments on commit 50ebb21

Please sign in to comment.