Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/sources/flow: unbold yes when an attribute/block is required #2344

Merged
merged 1 commit into from
Oct 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following arguments are supported:
Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`api_server` | `string` | URL of Kubernetes API server. | | no
`role` | `string` | Type of Kubernetes resource to query. | | **yes**
`role` | `string` | Type of Kubernetes resource to query. | | yes
`kubeconfig_file` | `string` | Path of kubeconfig file to use for connecting to Kubernetes. | | no

The `role` argument is required to specify what type of targets to discover.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`targets` | `list(map(string))` | Targets to relabel | | **yes**
`targets` | `list(map(string))` | Targets to relabel | | yes

## Blocks

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/local.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`filename` | `string` | Path of the file on disk to watch | | **yes**
`filename` | `string` | Path of the file on disk to watch | | yes
`detector` | `string` | Which file change detector to use (fsnotify, poll) | `"fsnotify"` | no
`poll_frequency` | `duration` | How often to poll for file changes | `"1m"` | no
`is_secret` | `bool` | Marks the file as containing a [secret][] | `false` | no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following blocks are supported inside the definition of

Hierarchy | Block | Description | Required
--------- | ----- | ----------- | --------
output | [output][] | Configures where to send received telemetry data. | **yes**
output | [output][] | Configures where to send received telemetry data. | yes

[output]: #output-block

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ grpc > keepalive > enforcement_policy | [enforcement_policy][] | Enforcement pol
http | [http][] | Configures the HTTP server to receive telemetry data. | no
http > tls | [tls][] | Configures TLS for the HTTP server. | no
http > cors | [cors][] | Configures CORS for the HTTP server. | no
output | [output][] | Configures where to send received telemetry data. | **yes**
output | [output][] | Configures where to send received telemetry data. | yes

The `>` symbol indicates deeper levels of nesting. For example, `grpc > tls`
refers to a `tls` block defined inside a `grpc` block.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`forward_to` | `list(receiver)` | Where the metrics should be forwarded to, after relabeling takes place. | | **yes**
`forward_to` | `list(receiver)` | Where the metrics should be forwarded to, after relabeling takes place. | | yes

## Blocks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`url` | `string` | Full URL to send metrics to. | | **yes**
`url` | `string` | Full URL to send metrics to. | | yes
`name` | `string` | Optional name to identify the endpoint in metrics. | | no
`remote_timeout` | `duration` | Timeout for requests made to the URL. | `"30s"` | no
`headers` | `map(string)` | Extra headers to deliver with the request. | | no
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/prometheus.scrape.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`targets` | `list(map(string))` | List of targets to scrape. | | **yes**
`forward_to` | `list(MetricsReceiver)` | List of receivers to send scraped metrics to. | | **yes**
`targets` | `list(map(string))` | List of targets to scrape. | | yes
`forward_to` | `list(MetricsReceiver)` | List of receivers to send scraped metrics to. | | yes
`job_name` | `string` | The job name to override the job label with. | component name | no
`extra_metrics` | `bool` | Whether extra metrics should be generated for scrape targets. | `false` | no
`honor_labels` | `bool` | Indicator whether the scraped metrics should remain unmodified. | `false` | no
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/remote.s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`path` | `string` | Path in the format of `"s3://bucket/file"`. | | **yes**
`path` | `string` | Path in the format of `"s3://bucket/file"`. | | yes
`poll_frequency` | `duration` | How often to poll the file for changes. Must be greater than 30 seconds. | `"10m"` | no
`is_secret` | `bool` | Marks the file as containing a [secret][]. | `false` | no

Expand Down