Improve description for default fields (#369)

This commit is contained in:
Vicente Pinto 2024-05-21 11:14:16 +01:00 committed by GitHub
parent e4bbcfd50a
commit e2e5f19a29
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 26 additions and 26 deletions

View file

@ -47,10 +47,10 @@ resource "stackit_argus_scrapeconfig" "example" {
- `basic_auth` (Attributes) A basic authentication block. (see [below for nested schema](#nestedatt--basic_auth))
- `saml2` (Attributes) A SAML2 configuration block. (see [below for nested schema](#nestedatt--saml2))
- `sample_limit` (Number) Specifies the scrape sample limit. Upper limit depends on the service plan. Default is `5000`.
- `scheme` (String) Specifies the http scheme. E.g. `https`.
- `scrape_interval` (String) Specifies the scrape interval as duration string. E.g. `5m`.
- `scrape_timeout` (String) Specifies the scrape timeout as duration string. E.g.`2m`.
- `sample_limit` (Number) Specifies the scrape sample limit. Upper limit depends on the service plan. Defaults to `5000`.
- `scheme` (String) Specifies the http scheme. Defaults to `https`.
- `scrape_interval` (String) Specifies the scrape interval as duration string. Defaults to `5m`.
- `scrape_timeout` (String) Specifies the scrape timeout as duration string. Defaults to `2m`.
### Read-Only
@ -82,4 +82,4 @@ Required:
Optional:
- `enable_url_parameters` (Boolean) Specifies if URL parameters are enabled.
- `enable_url_parameters` (Boolean) Specifies if URL parameters are enabled. Defaults to `true`

View file

@ -35,7 +35,7 @@ resource "stackit_dns_record_set" "example" {
### Optional
- `active` (Boolean) Specifies if the record set is active or not.
- `active` (Boolean) Specifies if the record set is active or not. Defaults to `true`
- `comment` (String) Comment.
- `ttl` (Number) Time to live. E.g. 3600
- `type` (String) The record set type. E.g. `A` or `CNAME`

View file

@ -42,12 +42,12 @@ resource "stackit_dns_zone" "example" {
- `default_ttl` (Number) Default time to live. E.g. 3600.
- `description` (String) Description of the zone.
- `expire_time` (Number) Expire time. E.g. 1209600.
- `is_reverse_zone` (Boolean) Specifies, if the zone is a reverse zone or not.
- `is_reverse_zone` (Boolean) Specifies, if the zone is a reverse zone or not. Defaults to `false`
- `negative_cache` (Number) Negative caching. E.g. 60
- `primaries` (List of String) Primary name server for secondary zone. E.g. ["1.2.3.4"]
- `refresh_time` (Number) Refresh time. E.g. 3600
- `retry_time` (Number) Retry time. E.g. 600
- `type` (String) Zone type. E.g. `primary`
- `type` (String) Zone type. Defaults to `primary`
### Read-Only

View file

@ -75,16 +75,16 @@ Required:
Optional:
- `cri` (String) Specifies the container runtime. E.g. `containerd`
- `cri` (String) Specifies the container runtime. Defaults to `containerd`
- `labels` (Map of String) Labels to add to each node.
- `max_surge` (Number) Maximum number of additional VMs that are created during an update.
- `max_unavailable` (Number) Maximum number of VMs that that can be unavailable during an update.
- `os_name` (String) The name of the OS image. E.g. `flatcar`.
- `os_name` (String) The name of the OS image. Defaults to `flatcar`.
- `os_version` (String, Deprecated) This field is deprecated, use `os_version_min` to configure the version and `os_version_used` to get the currently used version instead
- `os_version_min` (String) The minimum OS image version. This field will be used to set the minimum OS image version on creation/update of the cluster. If unset, the latest supported OS image version will be used. SKE automatically updates the cluster Kubernetes version if you have set `maintenance.enable_kubernetes_version_updates` to true or if there is a mandatory update, as described in [Updates for Kubernetes versions and Operating System versions in SKE](https://docs.stackit.cloud/stackit/en/version-updates-in-ske-10125631.html). To get the current OS image version being used for the node pool, use the read-only `os_version_used` field.
- `taints` (Attributes List) Specifies a taint list as defined below. (see [below for nested schema](#nestedatt--node_pools--taints))
- `volume_size` (Number) The volume size in GB. E.g. `20`
- `volume_type` (String) Specifies the volume type. E.g. `storage_premium_perf1`.
- `volume_size` (Number) The volume size in GB. Defaults to `20`
- `volume_type` (String) Specifies the volume type. Defaults to `storage_premium_perf1`.
Read-Only:

View file

@ -30,7 +30,7 @@ resource "stackit_ske_kubeconfig" "example" {
### Optional
- `expiration` (Number) Expiration time of the kubeconfig, in seconds.
- `expiration` (Number) Expiration time of the kubeconfig, in seconds. Defaults to `3600`
- `refresh` (Boolean) If set to true, the provider will check if the kubeconfig has expired and will generated a new valid one in-place
### Read-Only