Skip to content

Commit

Permalink
docs(userconfig): add reset options warning (#1888)
Browse files Browse the repository at this point in the history
  • Loading branch information
byashimov authored Nov 5, 2024
1 parent 11d2206 commit dc039bb
Show file tree
Hide file tree
Showing 87 changed files with 159 additions and 146 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ data "aiven_cassandra" "example_cassandra" {

- `additional_disk_space` (String) Add [disk storage](https://aiven.io/docs/platform/howto/add-storage-space) in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- `cassandra` (List of Object, Sensitive) Values provided by the Cassandra server. (see [below for nested schema](#nestedatt--cassandra))
- `cassandra_user_config` (List of Object) Cassandra user configurable settings (see [below for nested schema](#nestedatt--cassandra_user_config))
- `cassandra_user_config` (List of Object) Cassandra 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--cassandra_user_config))
- `cloud_name` (String) Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (`aws`, `azure`, `do` `google`, `upcloud`, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like [here for Google](https://cloud.google.com/compute/docs/regions-zones/) and [here for AWS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
- `components` (List of Object) Service component information objects (see [below for nested schema](#nestedatt--components))
- `disk_space` (String) Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ data "aiven_clickhouse" "example_clickhouse" {

- `additional_disk_space` (String) Add [disk storage](https://aiven.io/docs/platform/howto/add-storage-space) in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- `clickhouse` (List of Object, Sensitive) Values provided by the ClickHouse server. (see [below for nested schema](#nestedatt--clickhouse))
- `clickhouse_user_config` (List of Object) Clickhouse user configurable settings (see [below for nested schema](#nestedatt--clickhouse_user_config))
- `clickhouse_user_config` (List of Object) Clickhouse 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--clickhouse_user_config))
- `cloud_name` (String) Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (`aws`, `azure`, `do` `google`, `upcloud`, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like [here for Google](https://cloud.google.com/compute/docs/regions-zones/) and [here for AWS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
- `components` (List of Object) Service component information objects (see [below for nested schema](#nestedatt--components))
- `disk_space` (String) Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dragonfly.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "aiven_dragonfly" "example_dragonfly" {
- `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size.
- `disk_space_used` (String) Disk space that service is currently using
- `dragonfly` (List of Object, Sensitive) Dragonfly server provided values (see [below for nested schema](#nestedatt--dragonfly))
- `dragonfly_user_config` (List of Object) Dragonfly user configurable settings (see [below for nested schema](#nestedatt--dragonfly_user_config))
- `dragonfly_user_config` (List of Object) Dragonfly 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--dragonfly_user_config))
- `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "aiven_flink" "example_flink" {
- `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size.
- `disk_space_used` (String) Disk space that service is currently using
- `flink` (List of Object, Sensitive) Values provided by the Flink server. (see [below for nested schema](#nestedatt--flink))
- `flink_user_config` (List of Object) Flink user configurable settings (see [below for nested schema](#nestedatt--flink_user_config))
- `flink_user_config` (List of Object) Flink 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--flink_user_config))
- `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "aiven_grafana" "example_grafana" {
- `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size.
- `disk_space_used` (String) Disk space that service is currently using
- `grafana` (List of Object, Sensitive) Values provided by the Grafana server. (see [below for nested schema](#nestedatt--grafana))
- `grafana_user_config` (List of Object) Grafana user configurable settings (see [below for nested schema](#nestedatt--grafana_user_config))
- `grafana_user_config` (List of Object) Grafana 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--grafana_user_config))
- `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ data "aiven_kafka" "example_kafka" {
- `disk_space_used` (String) Disk space that service is currently using
- `id` (String) The ID of this resource.
- `kafka` (List of Object, Sensitive) Kafka server connection details. (see [below for nested schema](#nestedatt--kafka))
- `kafka_user_config` (List of Object) Kafka user configurable settings (see [below for nested schema](#nestedatt--kafka_user_config))
- `kafka_user_config` (List of Object) Kafka 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--kafka_user_config))
- `karapace` (Boolean) Switch the service to use [Karapace](https://aiven.io/docs/products/kafka/karapace) for schema registry and REST proxy.
- `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/kafka_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "aiven_kafka_connect" "example_kafka_connect" {
- `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size.
- `disk_space_used` (String) Disk space that service is currently using
- `id` (String) The ID of this resource.
- `kafka_connect_user_config` (List of Object) KafkaConnect user configurable settings (see [below for nested schema](#nestedatt--kafka_connect_user_config))
- `kafka_connect_user_config` (List of Object) KafkaConnect 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--kafka_connect_user_config))
- `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.
- `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).
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/kafka_mirrormaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "aiven_kafka_mirrormaker" "mm1" {
- `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size.
- `disk_space_used` (String) Disk space that service is currently using
- `id` (String) The ID of this resource.
- `kafka_mirrormaker_user_config` (List of Object) KafkaMirrormaker user configurable settings (see [below for nested schema](#nestedatt--kafka_mirrormaker_user_config))
- `kafka_mirrormaker_user_config` (List of Object) KafkaMirrormaker 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--kafka_mirrormaker_user_config))
- `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.
- `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).
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/m3aggregator.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "aiven_m3aggregator" "m3a" {
- `disk_space_used` (String) Disk space that service is currently using
- `id` (String) The ID of this resource.
- `m3aggregator` (List of Object, Sensitive) M3 Aggregator server provided values (see [below for nested schema](#nestedatt--m3aggregator))
- `m3aggregator_user_config` (List of Object) M3aggregator user configurable settings (see [below for nested schema](#nestedatt--m3aggregator_user_config))
- `m3aggregator_user_config` (List of Object) M3aggregator 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--m3aggregator_user_config))
- `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.
- `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).
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/m3db.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "aiven_m3db" "example_m3db" {
- `disk_space_used` (String) Disk space that service is currently using
- `id` (String) The ID of this resource.
- `m3db` (List of Object, Sensitive) Values provided by the M3DB server. (see [below for nested schema](#nestedatt--m3db))
- `m3db_user_config` (List of Object) M3db user configurable settings (see [below for nested schema](#nestedatt--m3db_user_config))
- `m3db_user_config` (List of Object) M3db 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--m3db_user_config))
- `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.
- `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).
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ data "aiven_mysql" "mysql1" {
- `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_user_config` (List of Object) Mysql user configurable settings (see [below for nested schema](#nestedatt--mysql_user_config))
- `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.
- `service_host` (String) The hostname of the service.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ data "aiven_opensearch" "os1" {
- `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.
- `opensearch` (List of Object, Sensitive) OpenSearch server provided values (see [below for nested schema](#nestedatt--opensearch))
- `opensearch_user_config` (List of Object) Opensearch user configurable settings (see [below for nested schema](#nestedatt--opensearch_user_config))
- `opensearch_user_config` (List of Object) Opensearch 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--opensearch_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.
- `service_host` (String) The hostname of the service.
Expand Down
Loading

0 comments on commit dc039bb

Please sign in to comment.