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.

Sign up for GitHub

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

[release/v1.4] Update markdown styles in discovery docs #2659

Merged
merged 1 commit into from
Feb 11, 2025
Merged

[release/v1.4] Update markdown styles in discovery docs #2659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: discovery
weight: 100
---

# discovery
# `discovery`

This section contains reference documentation for the `discovery` components.

Expand Down
56 changes: 28 additions & 28 deletions docs/sources/reference/components/discovery/discovery.azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,30 @@ discovery.azure "<LABEL>" {

You can use the following arguments with `discovery.azure`:

Name | Type | Description | Default | Required
-------------------------|---------------------|--------------------------------------------------------------------------------------------------|----------------------|---------
`enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no
`environment` | `string` | Azure environment. | `"AzurePublicCloud"` | no
`follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no
`no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
`port` | `number` | The port appended to the `__address__` label for each target. | `80` | no
`proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no
`proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no
`proxy_url` | `string` | HTTP proxy to send requests through. | | no
`refresh_interval` | `duration` | Interval at which to refresh the list of targets. | `5m` | no
`subscription_id` | `string` | Azure subscription ID. | | no
| Name | Type | Description | Default | Required |
| ------------------------ | ------------------- | ------------------------------------------------------------------------------------------------ | -------------------- | -------- |
| `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no |
| `environment` | `string` | Azure environment. | `"AzurePublicCloud"` | no |
| `follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no |
| `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no |
| `port` | `number` | The port appended to the `__address__` label for each target. | `80` | no |
| `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no |
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | Interval at which to refresh the list of targets. | `5m` | no |
| `subscription_id` | `string` | Azure subscription ID. | | no |

{{< docs/shared lookup="reference/components/http-client-proxy-config-description.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Blocks

You can use the following blocks with `discovery.azure`:

Block | Description | Required
---------------------------------------|--------------------------------------------------|---------
[`managed_identity`][managed_identity] | Managed Identity configuration for Azure API. | no
[`oauth`][oauth] | OAuth 2.0 configuration for Azure API. | no
[`tls_config`][tls_config] | TLS configuration for requests to the Azure API. | no
| Block | Description | Required |
| -------------------------------------- | ------------------------------------------------ | -------- |
| [`managed_identity`][managed_identity] | Managed Identity configuration for Azure API. | no |
| [`oauth`][oauth] | OAuth 2.0 configuration for Azure API. | no |
| [`tls_config`][tls_config] | TLS configuration for requests to the Azure API. | no |

You must specify exactly one of the `oauth` or `managed_identity` blocks.

Expand All @@ -60,19 +60,19 @@ You must specify exactly one of the `oauth` or `managed_identity` blocks.

The `managed_identity` block configures Managed Identity authentication for the Azure API.

Name | Type | Description | Default | Required
------------|----------|-----------------------------|---------|---------
`client_id` | `string` | Managed Identity client ID. | | yes
| Name | Type | Description | Default | Required |
| ----------- | -------- | --------------------------- | ------- | -------- |
| `client_id` | `string` | Managed Identity client ID. | | yes |

### `oauth`

The `oauth` block configures OAuth 2.0 authentication for the Azure API.

Name | Type | Description | Default | Required
----------------|----------|--------------------------|---------|---------
`client_id` | `string` | OAuth 2.0 client ID. | | yes
`client_secret` | `string` | OAuth 2.0 client secret. | | yes
`tenant_id` | `string` | OAuth 2.0 tenant ID. | | yes
| Name | Type | Description | Default | Required |
| --------------- | -------- | ------------------------ | ------- | -------- |
| `client_id` | `string` | OAuth 2.0 client ID. | | yes |
| `client_secret` | `string` | OAuth 2.0 client secret. | | yes |
| `tenant_id` | `string` | OAuth 2.0 tenant ID. | | yes |

### `tls_config`

Expand All @@ -84,9 +84,9 @@ The `tls_config` block configures TLS settings for requests to the Azure API.

The following fields are exported and can be referenced by other components:

Name | Type | Description
----------|---------------------|--------------------------------------------------
`targets` | `list(map(string))` | The set of targets discovered from the Azure API.
| Name | Type | Description |
| --------- | ------------------- | ------------------------------------------------- |
| `targets` | `list(map(string))` | The set of targets discovered from the Azure API. |

Each target includes the following labels:

Expand Down
70 changes: 35 additions & 35 deletions docs/sources/reference/components/discovery/discovery.consul.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,30 @@ discovery.consul "<LABEL>" {

You can use the following arguments with `discovery.consul`:

Name | Type | Description | Default | Required
-------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------|------------------|---------
`allow_stale` | `bool` | Allow stale Consul results. Reduces load on Consul. Refer to the [Consul documentation][] for more information. | `true` | no
`bearer_token_file` | `string` | File containing a bearer token to authenticate with. | | no
`bearer_token` | `secret` | Bearer token to authenticate with. | | no
`datacenter` | `string` | Data center to query. If not provided, the default is used. | | no
`enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no
`follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no
`namespace` | `string` | Namespace to use. Only supported in Consul Enterprise. | | no
`no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
`node_meta` | `map(string)` | Node metadata key/value pairs to filter nodes for a given service. | | no
`partition` | `string` | Admin partition to use. Only supported in Consul Enterprise. | | no
`password` | `secret` | The password to use. Deprecated in favor of the `basic_auth` configuration. | | no
`proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no
`proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no
`proxy_url` | `string` | HTTP proxy to send requests through. | | no
`refresh_interval` | `duration` | Frequency to refresh list of containers. | `"30s"` | no
`scheme` | `string` | The scheme to use when talking to Consul. | `http` | no
`server` | `string` | Host and port of the Consul API. | `localhost:8500` | no
`services` | `list(string)` | A list of services for which targets are retrieved. If omitted, all services are scraped. | | no
`tag_separator` | `string` | The string by which Consul tags are joined into the tag label. | `,` | no
`tags` | `list(string)` | An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. | | no
`token` | `secret` | Secret token used to access the Consul API. | | no
`username` | `string` | The username to use. Deprecated in favor of the `basic_auth` configuration. | | no
| Name | Type | Description | Default | Required |
| ------------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------- | -------- |
| `allow_stale` | `bool` | Allow stale Consul results. Reduces load on Consul. Refer to the [Consul documentation][] for more information. | `true` | no |
| `bearer_token_file` | `string` | File containing a bearer token to authenticate with. | | no |
| `bearer_token` | `secret` | Bearer token to authenticate with. | | no |
| `datacenter` | `string` | Data center to query. If not provided, the default is used. | | no |
| `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no |
| `follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no |
| `namespace` | `string` | Namespace to use. Only supported in Consul Enterprise. | | no |
| `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no |
| `node_meta` | `map(string)` | Node metadata key/value pairs to filter nodes for a given service. | | no |
| `partition` | `string` | Admin partition to use. Only supported in Consul Enterprise. | | no |
| `password` | `secret` | The password to use. Deprecated in favor of the `basic_auth` configuration. | | no |
| `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no |
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | Frequency to refresh list of containers. | `"30s"` | no |
| `scheme` | `string` | The scheme to use when talking to Consul. | `http` | no |
| `server` | `string` | Host and port of the Consul API. | `localhost:8500` | no |
| `services` | `list(string)` | A list of services for which targets are retrieved. If omitted, all services are scraped. | | no |
| `tag_separator` | `string` | The string by which Consul tags are joined into the tag label. | `,` | no |
| `tags` | `list(string)` | An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. | | no |
| `token` | `secret` | Secret token used to access the Consul API. | | no |
| `username` | `string` | The username to use. Deprecated in favor of the `basic_auth` configuration. | | no |

At most, one of the following can be provided:

Expand All @@ -68,16 +68,16 @@ Name | Type | Description

You can use the following blocks with `discovery.consul`:

Block | Description | Required
--------------------------------------|------------------------------------------------------------|---------
[`authorization`][authorization] | Configure generic authorization to the endpoint. | no
[`basic_auth`][basic_auth] | Configure `basic_auth` for authenticating to the endpoint. | no
[`oauth2`][oauth2] | Configure OAuth 2.0 for authenticating to the endpoint. | no
`oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
[`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
| [`basic_auth`][basic_auth] | Configure `basic_auth` for authenticating to the endpoint. | no |
| [`oauth2`][oauth2] | Configure OAuth 2.0 for authenticating to the endpoint. | no |
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
Expand Down Expand Up @@ -112,9 +112,9 @@ The `tls_config` block configures TLS settings for connecting to the endpoint.

The following fields are exported and can be referenced by other components:

Name | Type | Description
----------|---------------------|-----------------------------------------------------------
`targets` | `list(map(string))` | The set of targets discovered from the Consul catalog API.
| Name | Type | Description |
| --------- | ------------------- | ---------------------------------------------------------- |
| `targets` | `list(map(string))` | The set of targets discovered from the Consul catalog API. |

Each target includes the following labels:

Expand Down
Loading