diff --git a/docs/sources/flow/reference/components/discovery.kubernetes.md b/docs/sources/flow/reference/components/discovery.kubernetes.md index 40643aaebb9d..73b2cd8c98f0 100644 --- a/docs/sources/flow/reference/components/discovery.kubernetes.md +++ b/docs/sources/flow/reference/components/discovery.kubernetes.md @@ -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. diff --git a/docs/sources/flow/reference/components/discovery.relabel.md b/docs/sources/flow/reference/components/discovery.relabel.md index 5699a2b00951..71073f893f95 100644 --- a/docs/sources/flow/reference/components/discovery.relabel.md +++ b/docs/sources/flow/reference/components/discovery.relabel.md @@ -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 diff --git a/docs/sources/flow/reference/components/local.file.md b/docs/sources/flow/reference/components/local.file.md index 476558e7ea6c..17f6f46377b2 100644 --- a/docs/sources/flow/reference/components/local.file.md +++ b/docs/sources/flow/reference/components/local.file.md @@ -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 diff --git a/docs/sources/flow/reference/components/otelcol.processor.batch.md b/docs/sources/flow/reference/components/otelcol.processor.batch.md index 38915544f1bb..e7934679a89c 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.batch.md +++ b/docs/sources/flow/reference/components/otelcol.processor.batch.md @@ -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 diff --git a/docs/sources/flow/reference/components/otelcol.receiver.otlp.md b/docs/sources/flow/reference/components/otelcol.receiver.otlp.md index 78693ec7ba9c..3247fc1af3cd 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.otlp.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.otlp.md @@ -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. diff --git a/docs/sources/flow/reference/components/prometheus.relabel.md b/docs/sources/flow/reference/components/prometheus.relabel.md index ccc4ca135fa4..997afa1ba1cd 100644 --- a/docs/sources/flow/reference/components/prometheus.relabel.md +++ b/docs/sources/flow/reference/components/prometheus.relabel.md @@ -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 diff --git a/docs/sources/flow/reference/components/prometheus.remote_write.md b/docs/sources/flow/reference/components/prometheus.remote_write.md index 963da74fd6af..a79e4e722228 100644 --- a/docs/sources/flow/reference/components/prometheus.remote_write.md +++ b/docs/sources/flow/reference/components/prometheus.remote_write.md @@ -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 diff --git a/docs/sources/flow/reference/components/prometheus.scrape.md b/docs/sources/flow/reference/components/prometheus.scrape.md index bb43fe954861..497507d6bf8b 100644 --- a/docs/sources/flow/reference/components/prometheus.scrape.md +++ b/docs/sources/flow/reference/components/prometheus.scrape.md @@ -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 diff --git a/docs/sources/flow/reference/components/remote.s3.md b/docs/sources/flow/reference/components/remote.s3.md index 054d6ae832ea..cec3d378b479 100644 --- a/docs/sources/flow/reference/components/remote.s3.md +++ b/docs/sources/flow/reference/components/remote.s3.md @@ -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