Skip to content

Commit

Permalink
docs: add enum values (#1733)
Browse files Browse the repository at this point in the history
  • Loading branch information
byashimov authored May 22, 2024
1 parent 3ea197e commit b404d1e
Show file tree
Hide file tree
Showing 40 changed files with 165 additions and 147 deletions.
2 changes: 1 addition & 1 deletion docs/resources/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Optional:
- `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_version` (String) Cassandra version.
- `cassandra_version` (String) Enum: `3`, `4`, `4.1`. Cassandra version.
- `ip_filter` (Set of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block Set, 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'.
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/dragonfly.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Read-Only:
Optional:

- `cache_mode` (Boolean) Evict entries when getting close to maxmemory limit. The default value is `false`.
- `dragonfly_persistence` (String) When persistence is 'rdb', Dragonfly does RDB dumps each 10 minutes. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
- `dragonfly_persistence` (String) Enum: `off`, `rdb`. When persistence is 'rdb', Dragonfly does RDB dumps each 10 minutes. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.
- `dragonfly_ssl` (Boolean) Require SSL to access Dragonfly. The default value is `true`.
- `ip_filter` (Set of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block Set, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' (see [below for nested schema](#nestedblock--dragonfly_user_config--ip_filter_object))
Expand Down Expand Up @@ -126,7 +126,7 @@ Optional:

- `dbname` (String) Database name for bootstrapping the initial connection.
- `ignore_dbs` (String) Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).
- `method` (String) The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
- `method` (String) Enum: `dump`, `replication`. The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types).
- `password` (String, Sensitive) Password for authentication with the server where to migrate data from.
- `ssl` (Boolean) The server where to migrate data from is secured with SSL. The default value is `true`.
- `username` (String) User name for authentication with the server where to migrate data from.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Optional:
Optional:

- `additional_backup_regions` (List of String, Deprecated) Additional Cloud Regions for Backup Replication.
- `flink_version` (String) Flink major version.
- `flink_version` (String) Enum: `1.16`. Flink major version.
- `ip_filter` (Set of String, Deprecated) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.
- `ip_filter_object` (Block Set, Max: 1024) Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' (see [below for nested schema](#nestedblock--flink_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'.
Expand Down
12 changes: 6 additions & 6 deletions docs/resources/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,17 @@ Optional:

- `additional_backup_regions` (List of String) Additional Cloud Regions for Backup Replication.
- `alerting_enabled` (Boolean) Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
- `alerting_error_or_timeout` (String) Default error or timeout setting for new alerting rules.
- `alerting_error_or_timeout` (String) Enum: `alerting`, `keep_state`. Default error or timeout setting for new alerting rules.
- `alerting_max_annotations_to_keep` (Number) Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations.
- `alerting_nodata_or_nullvalues` (String) Default value for 'no data or null values' for new alerting rules.
- `alerting_nodata_or_nullvalues` (String) Enum: `alerting`, `no_data`, `keep_state`, `ok`. Default value for 'no data or null values' for new alerting rules.
- `allow_embedding` (Boolean) Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking.
- `auth_azuread` (Block List, Max: 1) Azure AD OAuth integration (see [below for nested schema](#nestedblock--grafana_user_config--auth_azuread))
- `auth_basic_enabled` (Boolean) Enable or disable basic authentication form, used by Grafana built-in login.
- `auth_generic_oauth` (Block List, Max: 1) Generic OAuth integration (see [below for nested schema](#nestedblock--grafana_user_config--auth_generic_oauth))
- `auth_github` (Block List, Max: 1) Github Auth integration (see [below for nested schema](#nestedblock--grafana_user_config--auth_github))
- `auth_gitlab` (Block List, Max: 1) GitLab Auth integration (see [below for nested schema](#nestedblock--grafana_user_config--auth_gitlab))
- `auth_google` (Block List, Max: 1) Google Auth integration (see [below for nested schema](#nestedblock--grafana_user_config--auth_google))
- `cookie_samesite` (String) Cookie SameSite attribute: 'strict' prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. 'lax' is the default value.
- `cookie_samesite` (String) Enum: `lax`, `strict`, `none`. Cookie SameSite attribute: 'strict' prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. 'lax' is the default value.
- `custom_domain` (String) Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- `dashboard_previews_enabled` (Boolean) This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
- `dashboards_min_refresh_interval` (String) Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h.
Expand Down Expand Up @@ -126,7 +126,7 @@ Optional:
- `static_ips` (Boolean) Use static public IP addresses.
- `unified_alerting_enabled` (Boolean) Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts/ for more details.
- `user_auto_assign_org` (Boolean) Auto-assign new users on signup to main organization. Defaults to false.
- `user_auto_assign_org_role` (String) Set role for new signups. Defaults to Viewer.
- `user_auto_assign_org_role` (String) Enum: `Viewer`, `Admin`, `Editor`. Set role for new signups. Defaults to Viewer.
- `viewers_can_edit` (Boolean) Users with view-only permission can edit but not save dashboards.

<a id="nestedblock--grafana_user_config--auth_azuread"></a>
Expand Down Expand Up @@ -237,7 +237,7 @@ Required:

- `access_key` (String) S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions.
- `bucket_url` (String) Bucket URL for S3.
- `provider` (String) Provider type.
- `provider` (String) Enum: `s3`. Provider type.
- `secret_key` (String) S3 secret key.


Expand Down Expand Up @@ -291,7 +291,7 @@ Optional:
- `from_name` (String) Name used in outgoing emails, defaults to Grafana.
- `password` (String, Sensitive) Password for SMTP authentication.
- `skip_verify` (Boolean) Skip verifying server certificate. Defaults to false.
- `starttls_policy` (String) Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
- `starttls_policy` (String) Enum: `OpportunisticStartTLS`, `MandatoryStartTLS`, `NoStartTLS`. Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.
- `username` (String) Username for SMTP authentication.


Expand Down
Loading

0 comments on commit b404d1e

Please sign in to comment.