Skip to content

Commit

Permalink
chore(userconfig): improve naming and docs (#1420)
Browse files Browse the repository at this point in the history
  • Loading branch information
Serpentiel authored and byashimov committed Nov 3, 2023
1 parent 1f1e28f commit 5fc61fe
Show file tree
Hide file tree
Showing 74 changed files with 6,260 additions and 301 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ nav_order: 1

# Changelog

## [X.Y.Z] - YYYY-MM-DD
## [4.10.0] - YYYY-MM-DD

- Add new user config generator
- Use `TypeSet` for arrays with scalar values

- Fix unmarshalling empty userconfig crash

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `backup_hour` (Number)
- `backup_minute` (Number)
- `cassandra` (List of Object) (see [below for nested schema](#nestedobjatt--cassandra_user_config--cassandra))
- `cassandra_version` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--cassandra_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `migrate_sstableloader` (Boolean)
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--cassandra_user_config--private_access))
- `project_to_fork_from` (String)
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `ip_filter` (List of String)
- `additional_backup_regions` (Set of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--clickhouse_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--clickhouse_user_config--private_access))
- `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--clickhouse_user_config--privatelink_access))
- `project_to_fork_from` (String)
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ Read-Only:
Read-Only:

- `flink_version` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--flink_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `number_of_task_slots` (Number)
- `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--flink_user_config--privatelink_access))

Expand Down
24 changes: 12 additions & 12 deletions docs/data-sources/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `alerting_enabled` (Boolean)
- `alerting_error_or_timeout` (String)
- `alerting_max_annotations_to_keep` (Number)
Expand All @@ -106,9 +106,9 @@ Read-Only:
- `editors_can_admin` (Boolean)
- `external_image_storage` (List of Object) (see [below for nested schema](#nestedobjatt--grafana_user_config--external_image_storage))
- `google_analytics_ua_id` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--grafana_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `metrics_enabled` (Boolean)
- `oauth_allow_insecure_email_lookup` (Boolean)
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--grafana_user_config--private_access))
Expand All @@ -129,8 +129,8 @@ Read-Only:
Read-Only:

- `allow_sign_up` (Boolean)
- `allowed_domains` (List of String)
- `allowed_groups` (List of String)
- `allowed_domains` (Set of String)
- `allowed_groups` (Set of String)
- `auth_url` (String)
- `client_id` (String)
- `client_secret` (String)
Expand All @@ -143,15 +143,15 @@ Read-Only:
Read-Only:

- `allow_sign_up` (Boolean)
- `allowed_domains` (List of String)
- `allowed_organizations` (List of String)
- `allowed_domains` (Set of String)
- `allowed_organizations` (Set of String)
- `api_url` (String)
- `auth_url` (String)
- `auto_login` (Boolean)
- `client_id` (String)
- `client_secret` (String)
- `name` (String)
- `scopes` (List of String)
- `scopes` (Set of String)
- `token_url` (String)


Expand All @@ -161,10 +161,10 @@ Read-Only:
Read-Only:

- `allow_sign_up` (Boolean)
- `allowed_organizations` (List of String)
- `allowed_organizations` (Set of String)
- `client_id` (String)
- `client_secret` (String)
- `team_ids` (List of Number)
- `team_ids` (Set of Number)


<a id="nestedobjatt--grafana_user_config--auth_gitlab"></a>
Expand All @@ -173,7 +173,7 @@ Read-Only:
Read-Only:

- `allow_sign_up` (Boolean)
- `allowed_groups` (List of String)
- `allowed_groups` (Set of String)
- `api_url` (String)
- `auth_url` (String)
- `client_id` (String)
Expand All @@ -187,7 +187,7 @@ Read-Only:
Read-Only:

- `allow_sign_up` (Boolean)
- `allowed_domains` (List of String)
- `allowed_domains` (Set of String)
- `client_id` (String)
- `client_secret` (String)

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/influxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `custom_domain` (String)
- `influxdb` (List of Object) (see [below for nested schema](#nestedobjatt--influxdb_user_config--influxdb))
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--influxdb_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--influxdb_user_config--private_access))
- `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--influxdb_user_config--privatelink_access))
- `project_to_fork_from` (String)
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `custom_domain` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `kafka` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_user_config--kafka))
- `kafka_authentication_methods` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_user_config--kafka_authentication_methods))
- `kafka_connect` (Boolean)
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/kafka_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `ip_filter` (List of String)
- `additional_backup_regions` (Set of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_connect_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `kafka_connect` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_connect_user_config--kafka_connect))
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_connect_user_config--private_access))
- `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_connect_user_config--privatelink_access))
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/kafka_mirrormaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `ip_filter` (List of String)
- `additional_backup_regions` (Set of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_mirrormaker_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `kafka_mirrormaker` (List of Object) (see [below for nested schema](#nestedobjatt--kafka_mirrormaker_user_config--kafka_mirrormaker))
- `static_ips` (Boolean)

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/m3aggregator.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Read-Only:
Read-Only:

- `custom_domain` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--m3aggregator_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `m3_version` (String)
- `m3aggregator_version` (String)
- `static_ips` (Boolean)
Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/m3db.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `custom_domain` (String)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--m3db_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `limits` (List of Object) (see [below for nested schema](#nestedobjatt--m3db_user_config--limits))
- `m3` (List of Object) (see [below for nested schema](#nestedobjatt--m3db_user_config--m3))
- `m3_version` (String)
Expand Down Expand Up @@ -200,13 +200,13 @@ Read-Only:

Read-Only:

- `aggregations` (List of String)
- `aggregations` (Set of String)
- `drop` (Boolean)
- `filter` (String)
- `name` (String)
- `namespaces` (List of String)
- `namespaces` (Set of String)
- `namespaces_object` (List of Object) (see [below for nested schema](#nestedobjatt--m3db_user_config--rules--mapping--namespaces_object))
- `namespaces_string` (List of String)
- `namespaces_string` (Set of String)
- `tags` (List of Object) (see [below for nested schema](#nestedobjatt--m3db_user_config--rules--mapping--tags))

<a id="nestedobjatt--m3db_user_config--rules--mapping--namespaces_object"></a>
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `admin_password` (String)
- `admin_username` (String)
- `backup_hour` (Number)
- `backup_minute` (Number)
- `binlog_retention_period` (Number)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--mysql_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `migration` (List of Object) (see [below for nested schema](#nestedobjatt--mysql_user_config--migration))
- `mysql` (List of Object) (see [below for nested schema](#nestedobjatt--mysql_user_config--mysql))
- `mysql_version` (String)
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `custom_domain` (String)
- `disable_replication_factor_adjustment` (Boolean)
- `index_patterns` (List of Object) (see [below for nested schema](#nestedobjatt--opensearch_user_config--index_patterns))
- `index_template` (List of Object) (see [below for nested schema](#nestedobjatt--opensearch_user_config--index_template))
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--opensearch_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `keep_index_refresh_interval` (Boolean)
- `max_index_count` (Number)
- `openid` (List of Object) (see [below for nested schema](#nestedobjatt--opensearch_user_config--openid))
Expand Down Expand Up @@ -176,7 +176,7 @@ Read-Only:
- `indices_recovery_max_bytes_per_sec` (Number)
- `indices_recovery_max_concurrent_file_chunks` (Number)
- `override_main_response_version` (Boolean)
- `reindex_remote_whitelist` (List of String)
- `reindex_remote_whitelist` (Set of String)
- `script_max_compilations_rate` (String)
- `search_max_buckets` (Number)
- `thread_pool_analyze_queue_size` (Number)
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/pg.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `additional_backup_regions` (Set of String)
- `admin_password` (String)
- `admin_username` (String)
- `backup_hour` (Number)
- `backup_minute` (Number)
- `enable_ipv6` (Boolean)
- `ip_filter` (List of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--pg_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `migration` (List of Object) (see [below for nested schema](#nestedobjatt--pg_user_config--migration))
- `pg` (List of Object) (see [below for nested schema](#nestedobjatt--pg_user_config--pg))
- `pg_read_replica` (Boolean)
Expand Down Expand Up @@ -210,7 +210,7 @@ Read-Only:
- `autodb_max_db_connections` (Number)
- `autodb_pool_mode` (String)
- `autodb_pool_size` (Number)
- `ignore_startup_parameters` (List of String)
- `ignore_startup_parameters` (Set of String)
- `min_pool_size` (Number)
- `server_idle_timeout` (Number)
- `server_lifetime` (Number)
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ Read-Only:

Read-Only:

- `additional_backup_regions` (List of String)
- `ip_filter` (List of String)
- `additional_backup_regions` (Set of String)
- `ip_filter` (Set of String)
- `ip_filter_object` (List of Object) (see [below for nested schema](#nestedobjatt--redis_user_config--ip_filter_object))
- `ip_filter_string` (List of String)
- `ip_filter_string` (Set of String)
- `migration` (List of Object) (see [below for nested schema](#nestedobjatt--redis_user_config--migration))
- `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--redis_user_config--private_access))
- `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--redis_user_config--privatelink_access))
Expand Down
14 changes: 7 additions & 7 deletions docs/resources/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,18 @@ resource "aiven_cassandra" "bar" {

Optional:

- `additional_backup_regions` (List of String) Additional Cloud Regions for Backup Replication.
- `additional_backup_regions` (Set of String) Additional Cloud Regions for Backup Replication.
- `backup_hour` (Number) The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.
- `backup_minute` (Number) The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.
- `cassandra` (Block List, Max: 1) cassandra configuration values. (see [below for nested schema](#nestedblock--cassandra_user_config--cassandra))
- `cassandra` (Block List, Max: 1) cassandra configuration values (see [below for nested schema](#nestedblock--cassandra_user_config--cassandra))
- `cassandra_version` (String) Cassandra major version.
- `ip_filter` (List of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block List, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'. (see [below for nested schema](#nestedblock--cassandra_user_config--ip_filter_object))
- `ip_filter_string` (List of String) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter` (Set of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block List, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' (see [below for nested schema](#nestedblock--cassandra_user_config--ip_filter_object))
- `ip_filter_string` (Set of String) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `migrate_sstableloader` (Boolean) Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
- `private_access` (Block List, Max: 1) Allow access to selected service ports from private networks. (see [below for nested schema](#nestedblock--cassandra_user_config--private_access))
- `private_access` (Block List, Max: 1) Allow access to selected service ports from private networks (see [below for nested schema](#nestedblock--cassandra_user_config--private_access))
- `project_to_fork_from` (String) Name of another project to fork a service from. This has effect only when a new service is being created.
- `public_access` (Block List, Max: 1) Allow access to selected service ports from the public Internet. (see [below for nested schema](#nestedblock--cassandra_user_config--public_access))
- `public_access` (Block List, Max: 1) Allow access to selected service ports from the public Internet (see [below for nested schema](#nestedblock--cassandra_user_config--public_access))
- `service_to_fork_from` (String) Name of another service to fork from. This has effect only when a new service is being created.
- `service_to_join_with` (String) When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation.
- `static_ips` (Boolean) Use static public IP addresses.
Expand Down
14 changes: 7 additions & 7 deletions docs/resources/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ resource "aiven_clickhouse" "clickhouse" {

Optional:

- `additional_backup_regions` (List of String) Additional Cloud Regions for Backup Replication.
- `ip_filter` (List of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block List, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'. (see [below for nested schema](#nestedblock--clickhouse_user_config--ip_filter_object))
- `ip_filter_string` (List of String) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `private_access` (Block List, Max: 1) Allow access to selected service ports from private networks. (see [below for nested schema](#nestedblock--clickhouse_user_config--private_access))
- `privatelink_access` (Block List, Max: 1) Allow access to selected service components through Privatelink. (see [below for nested schema](#nestedblock--clickhouse_user_config--privatelink_access))
- `additional_backup_regions` (Set of String) Additional Cloud Regions for Backup Replication.
- `ip_filter` (Set of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block List, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' (see [below for nested schema](#nestedblock--clickhouse_user_config--ip_filter_object))
- `ip_filter_string` (Set of String) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `private_access` (Block List, Max: 1) Allow access to selected service ports from private networks (see [below for nested schema](#nestedblock--clickhouse_user_config--private_access))
- `privatelink_access` (Block List, Max: 1) Allow access to selected service components through Privatelink (see [below for nested schema](#nestedblock--clickhouse_user_config--privatelink_access))
- `project_to_fork_from` (String) Name of another project to fork a service from. This has effect only when a new service is being created.
- `public_access` (Block List, Max: 1) Allow access to selected service ports from the public Internet. (see [below for nested schema](#nestedblock--clickhouse_user_config--public_access))
- `public_access` (Block List, Max: 1) Allow access to selected service ports from the public Internet (see [below for nested schema](#nestedblock--clickhouse_user_config--public_access))
- `service_to_fork_from` (String) Name of another service to fork from. This has effect only when a new service is being created.
- `static_ips` (Boolean) Use static public IP addresses.

Expand Down
Loading

0 comments on commit 5fc61fe

Please sign in to comment.