Skip to content

Commit

Permalink
Add missing descriptions and add OSS badge
Browse files Browse the repository at this point in the history
  • Loading branch information
@clayton-cornell
clayton-cornell committed Jan 21, 2025
1 parent 5664283 commit 4f01dda
Show file tree
Hide file tree
Showing 9 changed files with 103 additions and 65 deletions.
3 changes: 3 additions & 0 deletions docs/sources/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ cascade:
SNMP_VERSION: v0.26.0
FULL_PRODUCT_NAME: Grafana Alloy
PRODUCT_NAME: Alloy
labels:
products:
- oss
hero:
title: Grafana Alloy
level: 1
Expand Down
3 changes: 3 additions & 0 deletions docs/sources/_index.md.t
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ cascade:
SNMP_VERSION: v0.26.0
FULL_PRODUCT_NAME: Grafana Alloy
PRODUCT_NAME: Alloy
labels:
products:
- oss
hero:
title: Grafana Alloy
level: 1
Expand Down
16 changes: 9 additions & 7 deletions docs/sources/reference/components/discovery/discovery.azure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Name | Type | Description

## Blocks

The following blocks are supported inside the definition of `discovery.azure`:
You can use the following blocks with `discovery.azure`:

Hierarchy | 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

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

[managed_identity]: #managed_identity
[oauth]: #oauth
Expand All @@ -74,6 +74,8 @@ Name | Type | Description | Default | Required

### tls_config

The `tls_config` block configures TLS settings for requests to the Azure API.

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Exported fields
Expand Down
38 changes: 23 additions & 15 deletions docs/sources/reference/components/discovery/discovery.consul.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ discovery.consul "<LABEL>" {

## Arguments

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

Name | Type | Description | Default | Required
-------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------|------------------|---------
Expand Down Expand Up @@ -51,11 +51,11 @@ Name | Type | Description

At most, one of the following can be provided:

* [`authorization` block][authorization]
* [`basic_auth` block][basic_auth]
* [`bearer_token_file` argument][arguments]
* [`bearer_token` argument][arguments]
* [`oauth2` block][oauth2]
* [`authorization`][authorization] block
* [`basic_auth`][basic_auth] block
* [`bearer_token_file`][arguments] argument
* [`bearer_token`][arguments] argument
* [`oauth2`][oauth2] block

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

Expand All @@ -64,17 +64,17 @@ Name | Type | Description

## Blocks

The following blocks are supported inside the definition of `discovery.consul`:
You can use the following blocks with `discovery.consul`:

Hierarchy | 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][] | Configure generic authorization to the endpoint. | no
[basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no
[oauth2][] | Configure OAuth 2.0 for authenticating to the endpoint. | no
oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
[tls_config][] | Configure TLS settings for connecting to the endpoint. | no

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

[authorization]: #authorization
Expand All @@ -84,18 +84,26 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside

### authorization

The `authorization` block configures generic authorization to the endpoint.

{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### basic_auth

The `basic_auth` block configures basic authentication to the endpoint.

{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### oauth2

The `oauth` block configures OAuth 2.0 authentication to the endpoint.

{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### tls_config

The `tls_config` block configures TLS settings for connecting to the endpoint.

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Exported fields
Expand Down
12 changes: 7 additions & 5 deletions docs/sources/reference/components/discovery/discovery.consulagent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ discovery.consulagent "<LABEL>" {

## Arguments

The following arguments are supported:
You can use the following arguments with `discovery.consulagent`:

Name | Type | Description | Default | Required
-------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------|---------
Expand All @@ -41,16 +41,18 @@ Name | Type | Description

## Blocks

The following blocks are supported inside the definition of `discovery.consulagent`:
You can use the following blocks with `discovery.consulagent`:

Hierarchy | Block | Description | Required
-----------|----------------|--------------------------------------------------------|---------
tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
Block | Description | Required
---------------|--------------------------------------------------------|---------
[tls_config][] | Configure TLS settings for connecting to the endpoint. | no

[tls_config]: #tls_config

### tls_config

The `tls_config` block configures TLS settings for connecting to the endpoint.

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Exported fields
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/reference/components/discovery/discovery.digitalocean.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ discovery.digitalocean "<LABEL>" {

## Arguments

The following arguments are supported:
You can use the following arguments with `discovery.digitalocean`:

Name | Type | Description | Default | Required
-------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|---------
Expand All @@ -49,7 +49,7 @@ Exactly one of the [`bearer_token`][arguments] and [`bearer_token_file`][argumen

## Blocks

The `discovery.digitalocean` component doesn't support any blocks, and is configured fully through arguments.
The `discovery.digitalocean` component doesn't support any blocks. You can configure this component with arguments.

## Exported fields

Expand Down
6 changes: 5 additions & 1 deletion docs/sources/reference/components/discovery/discovery.dns.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ discovery.dns "<LABEL>" {

## Arguments

The following arguments are supported:
You can use the following arguments with `discovery.dns`:

Name | Type | Description | Default | Required
-------------------|----------------|----------------------------------------------------------------------|---------|---------
Expand All @@ -29,6 +29,10 @@ Name | Type | Description
`refresh_interval` | `duration` | How often to query DNS for updates. | `"30s"` | no
`type` | `string` | Type of DNS record to query. Must be one of SRV, A, AAAA, MX, or NS. | `"SRV"` | no

## Blocks

The `discovery.dns` component doesn't support any blocks. You can configure this component with arguments.

## Exported fields

The following field is exported and can be referenced by other components:
Expand Down
42 changes: 25 additions & 17 deletions docs/sources/reference/components/discovery/discovery.docker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ discovery.docker "<LABEL>" {

## Arguments

The following arguments are supported:
TYou can use the following arguments with `discovery.docker`:

Name | Type | Description | Default | Required
-------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------------|---------
Expand All @@ -41,28 +41,28 @@ Name | Type | Description

At most, one of the following can be provided:

* [`authorization` block][authorization]
* [`basic_auth` block][basic_auth]
* [`bearer_token_file` argument][arguments]
* [`bearer_token` argument][arguments]
* [`oauth2` block][oauth2]
* [`authorization`][authorization] block
* [`basic_auth`][basic_auth] block
* [`bearer_token_file`][arguments] argument
* [`bearer_token`][arguments] argument
* [`oauth2`][oauth2] block

[arguments]: #arguments

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

## Blocks

The following blocks are supported inside the definition of `discovery.docker`:
You can use the following blocks with `discovery.docker`:

Hierarchy | 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
filter | [filter][] | Filters discoverable resources. | 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][] | Configure generic authorization to the endpoint. | no
[basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no
[filter][] | Filters discoverable resources. | no
[oauth2][] | Configure OAuth 2.0 for authenticating to the endpoint. | no
oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
[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.
Expand All @@ -75,16 +75,20 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside

### authorization

The `authorization` block configures generic authorization to the endpoint.

{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### basic_auth

The `basic_auth` block configures basic authentication to the endpoint.

{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### filter

The `filter` block configures a filter to pass to the Docker Engine to limit the amount of containers returned.
The `filter` block can be specified multiple times to provide more than one filter.
You can use the `filter` block to configure a filter to pass to the Docker Engine to limit the amount of containers returned.
You can specify the `filter` block multiple times to provide more than one filter.

Name | Type | Description | Default | Required
---------|----------------|-------------------------------|---------|---------
Expand All @@ -97,10 +101,14 @@ Refer to [List containers][List containers] from the Docker Engine API documenta

### oauth2

The `oauth` block configures OAuth 2.0 authentication to the endpoint.

{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### tls_config

The `tls_config` block configures TLS settings for connecting to the endpoint.

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Exported fields
Expand Down
44 changes: 26 additions & 18 deletions docs/sources/reference/components/discovery/discovery.dockerswarm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ discovery.dockerswarm "<LABEL>" {

## Arguments

The following arguments are supported:
You can use the following arguments with `discovery.dockerswarm`:

Name | Type | Description | Default | Required
-------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------|---------|---------
Expand All @@ -40,28 +40,28 @@ Name | Type | Description

At most, one of the following can be provided:

* [`authorization` block][authorization]
* [`basic_auth` block][basic_auth]
* [`bearer_token_file` argument][arguments]
* [`bearer_token` argument][arguments]
* [`oauth2` block][oauth2]
* [`authorization`][authorization] block
* [`basic_auth`][basic_auth] block
* [`bearer_token_file`][arguments] argument
* [`bearer_token`][arguments] argument
* [`oauth2`][oauth2] block

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

[arguments]: #arguments

## Blocks

The following blocks are supported inside the definition of `discovery.dockerswarm`:
You can use the following blocks with `discovery.dockerswarm`:

Hierarchy | 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
filter | [filter][] | Optional filter to limit the discovery process to a subset of available resources. | no
oauth2 | [oauth2][] | Configure OAuth2 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][] | Configure generic authorization to the endpoint. | no
[basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no
[filter][] | Optional filter to limit the discovery process to a subset of available resources. | no
[oauth2][] | Configure OAuth2 for authenticating to the endpoint. | no
oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
[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.
Expand All @@ -74,23 +74,27 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside

### authorization

The `authorization` block configures generic authorization to the endpoint.

{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### basic_auth

The `basic_auth` block configures basic authentication to the endpoint.

{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### filter

Filters can be used to limit the discovery process to a subset of available resources.
It's possible to define multiple `filter` blocks within the `discovery.dockerswarm` block.
You can use the `filter` block to limit the discovery process to a subset of available resources.
You can define multiple `filter` blocks within the `discovery.dockerswarm` block.
The list of available filters depends on the `role`:

* [nodes filters](https://docs.docker.com/engine/api/v1.40/#operation/NodeList)
* [services filters](https://docs.docker.com/engine/api/v1.40/#operation/ServiceList)
* [tasks filters](https://docs.docker.com/engine/api/v1.40/#operation/TaskList)

The following arguments can be used to configure a filter.
You can use the following arguments to configure a filter.

Name | Type | Description | Default | Required
---------|----------------|--------------------------------------------|---------|---------
Expand All @@ -99,10 +103,14 @@ Name | Type | Description | Default

### oauth2

The `oauth` block configures OAuth 2.0 authentication to the endpoint.

{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

### tls_config

The `tls_config` block configures TLS settings for connecting to the endpoint.

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

## Exported fields
Expand Down

0 comments on commit 4f01dda

Please sign in to comment.