Skip to content

Commit

Permalink
Update uyuni topic
Browse files Browse the repository at this point in the history
  • Loading branch information
@clayton-cornell
clayton-cornell committed Jan 17, 2025
1 parent 9b715cf commit 57e7b90
Showing 1 changed file with 35 additions and 33 deletions.
68 changes: 35 additions & 33 deletions docs/sources/reference/components/discovery/discovery.uyuni.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ title: discovery.uyuni
## Usage

```alloy
discovery.uyuni "LABEL" {
server = SERVER
username = USERNAME
password = PASSWORD
discovery.uyuni "<LABEL>" {
server = <SERVER>
username = <USERNAME>
password = <PASSWORD>
}
```

Expand All @@ -28,32 +28,32 @@ The following arguments are supported:

Name | Type | Description | Default | Required
-------------------------|---------------------|--------------------------------------------------------------------------------------------------|-------------------------|---------
`password` | `Secret` | The password to use for authentication to the Uyuni API. | | yes
`server` | `string` | The primary Uyuni Server. | | yes
`username` | `string` | The username to use for authentication to the Uyuni API. | | yes
`password` | `Secret` | The password to use for authentication to the Uyuni API. | | yes
`enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no
`entitlement` | `string` | The entitlement to filter on when listing targets. | `"monitoring_entitled"` | no
`separator` | `string` | The separator to use when building the `__meta_uyuni_groups` label. | `","` | no
`refresh_interval` | `duration` | Interval at which to refresh the list of targets. | `1m` | no
`proxy_url` | `string` | HTTP proxy to send requests through. | | 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
`proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no
`proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no
`follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no
`enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | 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. | `1m` | no
`separator` | `string` | The separator to use when building the `__meta_uyuni_groups` label. | `","` | no

{{< 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.uyuni`:

The following blocks are supported inside the definition of `discovery.uyuni`:

Hierarchy | Block | Description | Required
-----------|----------------|--------------------------------------------------|---------
tls_config | [tls_config][] | TLS configuration for requests to the Uyuni API. | no

[tls_config]: #tls_config-block
[tls_config]: #tls_config

### tls_config block
### tls_config

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

Expand All @@ -67,15 +67,15 @@ Name | Type | Description

Each target includes the following labels:

* `__meta_uyuni_minion_hostname`: The hostname of the Uyuni Minion.
* `__meta_uyuni_primary_fqdn`: The FQDN of the Uyuni primary.
* `__meta_uyuni_system_id`: The system ID of the Uyuni Minion.
* `__meta_uyuni_groups`: The groups the Uyuni Minion belongs to.
* `__meta_uyuni_endpoint_name`: The name of the endpoint.
* `__meta_uyuni_exporter`: The name of the exporter.
* `__meta_uyuni_proxy_module`: The name of the Uyuni module.
* `__meta_uyuni_groups`: The groups the Uyuni Minion belongs to.
* `__meta_uyuni_metrics_path`: The path to the metrics endpoint.
* `__meta_uyuni_scheme`: `https` if TLS is enabled on the endpoint, `http` otherwise.
* `__meta_uyuni_minion_hostname`: The hostname of the Uyuni Minion.
* `__meta_uyuni_primary_fqdn`: The FQDN of the Uyuni primary.
* `__meta_uyuni_proxy_module`: The name of the Uyuni module.
* `__meta_uyuni_scheme`: `https` If TLS is enabled on the endpoint, `http` otherwise.
* `__meta_uyuni_system_id`: The system ID of the Uyuni Minion.

These labels are largely derived from a [listEndpoints][] API call to the Uyuni Server.

Expand All @@ -88,19 +88,19 @@ In those cases, exported fields retain their last healthy values.

## Debug information

`discovery.uyuni` does not expose any component-specific debug information.
`discovery.uyuni` doesn't expose any component-specific debug information.

## Debug metrics

`discovery.uyuni` does not expose any component-specific debug metrics.
`discovery.uyuni` doesn't expose any component-specific debug metrics.

## Example

```alloy
discovery.uyuni "example" {
server = "https://127.0.0.1/rpc/api"
username = UYUNI_USERNAME
password = UYUNI_PASSWORD
username = <UYUNI_USERNAME>
password = <UYUNI_PASSWORD>
}
prometheus.scrape "demo" {
Expand All @@ -110,21 +110,23 @@ prometheus.scrape "demo" {
prometheus.remote_write "demo" {
endpoint {
url = PROMETHEUS_REMOTE_WRITE_URL
url = <PROMETHEUS_REMOTE_WRITE_URL>
basic_auth {
username = USERNAME
password = PASSWORD
username = <USERNAME>
password = <PASSWORD>
}
}
}
```

Replace the following:
- `UYUNI_USERNAME`: The username to use for authentication to the Uyuni server.
- `UYUNI_PASSWORD`: The password to use for authentication to the Uyuni server.
- `PROMETHEUS_REMOTE_WRITE_URL`: The URL of the Prometheus remote_write-compatible server to send metrics to.
- `USERNAME`: The username to use for authentication to the remote_write API.
- `PASSWORD`: The password to use for authentication to the remote_write API.

* _`<UYUNI_USERNAME>`_: The username to use for authentication to the Uyuni server.
* _`<UYUNI_PASSWORD>`_: The password to use for authentication to the Uyuni server.
* _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to.
* _`<USERNAME>`_: The username to use for authentication to the `remote_write` API.
* _`<PASSWORD>`_: The password to use for authentication to the `remote_write` API.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

Expand Down

0 comments on commit 57e7b90

Please sign in to comment.