From b6999a3e53109dbe8a525b42ab40cc1bc3aa801b Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 12:13:18 -0800
Subject: [PATCH 1/8] Update kublet topic

---
 .../components/discovery/discovery.kubelet.md | 156 +++++++++---------
 1 file changed, 80 insertions(+), 76 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.kubelet.md b/docs/sources/reference/components/discovery/discovery.kubelet.md
index 1ee44a6f94..94040742f2 100644
--- a/docs/sources/reference/components/discovery/discovery.kubelet.md
+++ b/docs/sources/reference/components/discovery/discovery.kubelet.md
@@ -8,39 +8,39 @@ title: discovery.kubelet
 
 # discovery.kubelet
 
-`discovery.kubelet` discovers Kubernetes pods running on the specified Kubelet and exposes them as scrape targets.
+`discovery.kubelet` discovers Kubernetes pods running on the specified kubelet and exposes them as scrape targets.
 
 ## Usage
 
 ```alloy
-discovery.kubelet "LABEL" {
+discovery.kubelet "<LABEL>" {
 }
 ```
 
 ## Requirements
 
-* The Kubelet must be reachable from the `alloy` pod network.
-* Follow the [Kubelet authorization][] documentation to configure authentication to the Kubelet API.
+* The kubelet must be reachable from the `alloy` Pod network.
+* Follow the [kubelet authorization][] documentation to configure authentication to the kubelet API.
 
-[Kubelet authorization]: https://kubernetes.io/docs/reference/access-authn-authz/kubelet-authn-authz/#kubelet-authorization
+[kubelet authorization]: https://kubernetes.io/docs/reference/access-authn-authz/kubelet-authn-authz/#kubelet-authorization
 
 ## Arguments
 
 The following arguments are supported:
 
-Name                     | Type                | Description                                                                                      | Default                   | Required
--------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------------------------|---------
-`url`                    | `string`            | URL of the Kubelet server.                                                                       | "https://localhost:10250" | no
-`refresh_interval`       | `duration`          | How often the Kubelet should be polled for scrape targets                                        | `5s`                      | no
-`namespaces`             | `list(string)`      | A list of namespaces to extract target pods from                                                 |                           | no
-`bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |                           | no
-`bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |                           | 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
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |                           | 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
+Name                     | Type                | Description                                                                                      | Default                     | Required
+-------------------------|---------------------|--------------------------------------------------------------------------------------------------|-----------------------------|---------
+`bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |                             | no
+`bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |                             | 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
+`namespaces`             | `list(string)`      | A list of namespaces to extract target pods from                                                 |                             | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |                             | 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`          | How often the kubelet should be polled for scrape targets                                        | `5s`                        | no
+`url`                    | `string`            | URL of the kubelet server.                                                                       | `"https://localhost:10250"` | no
 
 The `namespaces` list limits the namespaces to discover resources in.
 If omitted, all namespaces are searched.
@@ -50,11 +50,12 @@ You can have additional paths in the `url`.
 For example, if `url` is `https://kubernetes.default.svc.cluster.local:443/api/v1/nodes/cluster-node-1/proxy`, then `discovery.kubelet` sends a request on `https://kubernetes.default.svc.cluster.local:443/api/v1/nodes/cluster-node-1/proxy/pods`
 
  At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`authorization` block][authorization]
+* [`basic_auth` block][basic_auth]
+* [`bearer_token_file` argument][arguments]
+* [`bearer_token` argument][arguments]
+* [`oauth2` block][oauth2]
 
  [arguments]: #arguments
 
@@ -62,38 +63,37 @@ For example, if `url` is `https://kubernetes.default.svc.cluster.local:443/api/v
 
 ## Blocks
 
-The following blocks are supported inside the definition of
-`discovery.kubelet`:
+The following blocks are supported inside the definition of `discovery.kubelet`:
 
-Hierarchy           | Block             | Description                                              | Required
---------------------|-------------------|----------------------------------------------------------|---------
-basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no
-authorization       | [authorization][] | Configure generic authorization to the endpoint.         | 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
+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 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
 
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -103,35 +103,35 @@ 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 Kubelet API.
+`targets` | `list(map(string))` | The set of targets discovered from the kubelet API.
 
 Each target includes the following labels:
 
-* `__address__`: The target address to scrape derived from the pod IP and container port.
-* `__meta_kubernetes_namespace`: The namespace of the pod object.
-* `__meta_kubernetes_pod_name`: The name of the pod object.
-* `__meta_kubernetes_pod_ip`: The pod IP of the pod object.
-* `__meta_kubernetes_pod_label_<labelname>`: Each label from the pod object.
-* `__meta_kubernetes_pod_labelpresent_<labelname>`: `true` for each label from the pod object.
-* `__meta_kubernetes_pod_annotation_<annotationname>`: Each annotation from the pod object.
-* `__meta_kubernetes_pod_annotationpresent_<annotationname>`: `true` for each annotation from the pod object.
-* `__meta_kubernetes_pod_container_init`: `true` if the container is an `InitContainer`.
-* `__meta_kubernetes_pod_container_name`: Name of the container the target address points to.
+* `__address__`: The target address to scrape derived from the Pod IP and container port.
+* `__meta_kubernetes_namespace`: The namespace of the Pod object.
+* `__meta_kubernetes_pod_annotation_<annotationname>`: Each annotation from the Pod object.
+* `__meta_kubernetes_pod_annotationpresent_<annotationname>`: `true` for each annotation from the Pod object.
 * `__meta_kubernetes_pod_container_id`: ID of the container the target address points to. The ID is in the form `<type>://<container_id>`.
 * `__meta_kubernetes_pod_container_image`: The image the container is using.
+* `__meta_kubernetes_pod_container_init`: `true` if the container is an `InitContainer`.
+* `__meta_kubernetes_pod_container_name`: Name of the container the target address points to.
 * `__meta_kubernetes_pod_container_port_name`: Name of the container port.
 * `__meta_kubernetes_pod_container_port_number`: Number of the container port.
 * `__meta_kubernetes_pod_container_port_protocol`: Protocol of the container port.
-* `__meta_kubernetes_pod_ready`: Set to `true` or `false` for the pod's ready state.
+* `__meta_kubernetes_pod_controller_kind`: Object kind of the Pod controller.
+* `__meta_kubernetes_pod_controller_name`: Name of the Pod controller.
+* `__meta_kubernetes_pod_host_ip`: The current host IP of the Pod object.
+* `__meta_kubernetes_pod_ip`: The Pod IP of the Pod object.
+* `__meta_kubernetes_pod_label_<labelname>`: Each label from the Pod object.
+* `__meta_kubernetes_pod_labelpresent_<labelname>`: `true` for each label from the Pod object.
+* `__meta_kubernetes_pod_name`: The name of the Pod object.
+* `__meta_kubernetes_pod_node_name`: The name of the node the Pod is scheduled onto.
 * `__meta_kubernetes_pod_phase`: Set to `Pending`, `Running`, `Succeeded`, `Failed` or `Unknown` in the lifecycle.
-* `__meta_kubernetes_pod_node_name`: The name of the node the pod is scheduled onto.
-* `__meta_kubernetes_pod_host_ip`: The current host IP of the pod object.
-* `__meta_kubernetes_pod_uid`: The UID of the pod object.
-* `__meta_kubernetes_pod_controller_kind`: Object kind of the pod controller.
-* `__meta_kubernetes_pod_controller_name`: Name of the pod controller.
+* `__meta_kubernetes_pod_ready`: Set to `true` or `false` for the Pod's ready state.
+* `__meta_kubernetes_pod_uid`: The UID of the Pod object.
 
 {{< admonition type="note" >}}
-The Kubelet API used by this component is an internal API and therefore the data in the response returned from the API can't be guaranteed between different versions of the Kubelet.
+The kubelet API used by this component is an internal API and therefore the data in the response returned from the API can't be guaranteed between different versions of the kubelet.
 {{< /admonition >}}
 
 ## Component health
@@ -141,17 +141,17 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.kubelet` does not expose any component-specific debug information.
+`discovery.kubelet` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.kubelet` does not expose any component-specific debug metrics.
+`discovery.kubelet` doesn't expose any component-specific debug metrics.
 
 ## Examples
 
 ### Bearer token file authentication
 
-This example uses a bearer token file to authenticate to the Kubelet API:
+This example uses a bearer token file to authenticate to the kubelet API:
 
 ```alloy
 discovery.kubelet "k8s_pods" {
@@ -165,23 +165,25 @@ 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:
-  - `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.
+
+* _`<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.
 
 ### Limit searched namespaces
 
-This example limits the namespaces where pods are discovered using the `namespaces` argument:
+This example limits the namespaces where Pods are discovered using the `namespaces` argument:
 
 ```alloy
 discovery.kubelet "k8s_pods" {
@@ -196,19 +198,21 @@ 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:
-  - `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.
+
+* _`<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 -->
 

From c265264e4be08c235c3ca760956b8164e8396afe Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 12:26:48 -0800
Subject: [PATCH 2/8] Update Kubernetes topic

---
 .../discovery/discovery.kubernetes.md         | 262 +++++++++---------
 1 file changed, 137 insertions(+), 125 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.kubernetes.md b/docs/sources/reference/components/discovery/discovery.kubernetes.md
index ef91983747..5d18b2ea1a 100644
--- a/docs/sources/reference/components/discovery/discovery.kubernetes.md
+++ b/docs/sources/reference/components/discovery/discovery.kubernetes.md
@@ -17,8 +17,8 @@ A kubeconfig file or manual connection settings can be used to override the defa
 ## Usage
 
 ```alloy
-discovery.kubernetes "LABEL" {
-  role = DISCOVERY_ROLE
+discovery.kubernetes "<LABEL>" {
+  role = <DISCOVERY_ROLE>
 }
 ```
 
@@ -28,24 +28,25 @@ 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
-`kubeconfig_file`        | `string`            | Path of kubeconfig file to use for connecting to Kubernetes.                                     |         | no
+`api_server`             | `string`            | URL of Kubernetes API server.                                                                    |         | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |         | 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
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |         | no
+`kubeconfig_file`        | `string`            | Path of kubeconfig file to use for connecting to Kubernetes.                                     |         | 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
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.                                            | `false` | no
+`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |         | no
 
  At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`authorization` block][authorization].
+* [`basic_auth` block][basic_auth].
+* [`bearer_token_file` argument][arguments]
+* [`bearer_token` argument][arguments]
+* [`oauth2` block][oauth2]
 
  [arguments]: #arguments
 
@@ -55,26 +56,26 @@ The `role` argument is required to specify what type of targets to discover. `ro
 
 ### node role
 
-The `node` role discovers one target per cluster node with the address defaulting to the HTTP port of the Kubelet daemon.
-The target address defaults to the first existing address of the Kubernetes node object in the address type order of `NodeInternalIP`, `NodeExternalIP`, `NodeLegacyHostIP`, and `NodeHostName`.
+The `node` role discovers one target per cluster node with the address defaulting to the HTTP port of the kubelet daemon.
+The target address defaults to the first address of the Kubernetes node object in the address type order of `NodeInternalIP`, `NodeExternalIP`, `NodeLegacyHostIP`, and `NodeHostName`.
 
 The following labels are included for discovered nodes:
 
-* `__meta_kubernetes_node_name`: The name of the node object.
-* `__meta_kubernetes_node_provider_id`: The cloud provider's name for the node object.
-* `__meta_kubernetes_node_label_<labelname>`: Each label from the node object.
-* `__meta_kubernetes_node_labelpresent_<labelname>`: Set to `true` for each label from the node object.
+* `__meta_kubernetes_node_address_<address_type>`: The first address for each node address type, if it exists.
 * `__meta_kubernetes_node_annotation_<annotationname>`: Each annotation from the node object.
 * `__meta_kubernetes_node_annotationpresent_<annotationname>`: Set to `true` for each annotation from the node object.
-* `__meta_kubernetes_node_address_<address_type>`: The first address for each node address type, if it exists.
+* `__meta_kubernetes_node_label_<labelname>`: Each label from the node object.
+* `__meta_kubernetes_node_labelpresent_<labelname>`: Set to `true` for each label from the node object.
+* `__meta_kubernetes_node_name`: The name of the node object.
+* `__meta_kubernetes_node_provider_id`: The cloud provider's name for the node object.
 
-In addition, the `instance` label for the node will be set to the node name as retrieved from the API server.
+In addition, the `instance` label for the node is set to the node name as retrieved from the API server.
 
 ### service role
 
 The `service` role discovers a target for each service port for each service.
 This is generally useful for externally monitoring a service.
-The address will be set to the Kubernetes DNS name of the service and respective service port.
+The address is set to the Kubernetes DNS name of the service and respective service port.
 
 The following labels are included for discovered services:
 
@@ -101,53 +102,54 @@ These targets must have a port manually injected using a [`discovery.relabel` co
 
 [discovery.relabel]: ../discovery.relabel/
 
-The following labels are included for discovered pods:
+The following labels are included for discovered Pods:
 
-* `__meta_kubernetes_namespace`: The namespace of the pod object.
-* `__meta_kubernetes_pod_name`: The name of the pod object.
-* `__meta_kubernetes_pod_ip`: The pod IP of the pod object.
-* `__meta_kubernetes_pod_label_<labelname>`: Each label from the pod object.
-* `__meta_kubernetes_pod_labelpresent_<labelname>`: `true` for each label from the pod object.
-* `__meta_kubernetes_pod_annotation_<annotationname>`: Each annotation from the pod object.
-* `__meta_kubernetes_pod_annotationpresent_<annotationname>`: `true` for each annotation from the pod object.
-* `__meta_kubernetes_pod_container_init`: `true` if the container is an `InitContainer`.
-* `__meta_kubernetes_pod_container_name`: Name of the container the target address points to.
+* `__meta_kubernetes_namespace`: The namespace of the Pod object.
+* `__meta_kubernetes_pod_annotation_<annotationname>`: Each annotation from the Pod object.
+* `__meta_kubernetes_pod_annotationpresent_<annotationname>`: `true` for each annotation from the Pod object.
 * `__meta_kubernetes_pod_container_id`: ID of the container the target address points to. The ID is in the form `<type>://<container_id>`.
 * `__meta_kubernetes_pod_container_image`: The image the container is using.
+* `__meta_kubernetes_pod_container_init`: `true` if the container is an `InitContainer`.
+* `__meta_kubernetes_pod_container_name`: Name of the container the target address points to.
 * `__meta_kubernetes_pod_container_port_name`: Name of the container port.
 * `__meta_kubernetes_pod_container_port_number`: Number of the container port.
 * `__meta_kubernetes_pod_container_port_protocol`: Protocol of the container port.
-* `__meta_kubernetes_pod_ready`: Set to `true` or `false` for the pod's ready state.
+* `__meta_kubernetes_pod_controller_kind`: Object kind of the Pod controller.
+* `__meta_kubernetes_pod_controller_name`: Name of the Pod controller.
+* `__meta_kubernetes_pod_host_ip`: The current host IP of the Pod object.
+* `__meta_kubernetes_pod_ip`: The Pod IP of the Pod object.
+* `__meta_kubernetes_pod_label_<labelname>`: Each label from the Pod object.
+* `__meta_kubernetes_pod_labelpresent_<labelname>`: `true` for each label from the Pod object.
+* `__meta_kubernetes_pod_name`: The name of the Pod object.
+* `__meta_kubernetes_pod_node_name`: The name of the node the Pod is scheduled onto.
 * `__meta_kubernetes_pod_phase`: Set to `Pending`, `Running`, `Succeeded`, `Failed` or `Unknown` in the lifecycle.
-* `__meta_kubernetes_pod_node_name`: The name of the node the pod is scheduled onto.
-* `__meta_kubernetes_pod_host_ip`: The current host IP of the pod object.
-* `__meta_kubernetes_pod_uid`: The UID of the pod object.
-* `__meta_kubernetes_pod_controller_kind`: Object kind of the pod controller.
-* `__meta_kubernetes_pod_controller_name`: Name of the pod controller.
+* `__meta_kubernetes_pod_ready`: Set to `true` or `false` for the Pod's ready state.
+* `__meta_kubernetes_pod_uid`: The UID of the Pod object.
 
 ### endpoints role
 
-The `endpoints` role discovers targets from listed endpoints of a service. For
-each endpoint address one target is discovered per port. If the endpoint is
-backed by a pod, all container ports of a pod are discovered as targets even if
-they are not bound to an endpoint port.
+The `endpoints` role discovers targets from listed endpoints of a service.
+For each endpoint address one target is discovered per port.
+If the endpoint is backed by a Pod, all container ports of a Pod are discovered as targets even if they aren't bound to an endpoint port.
 
 The following labels are included for discovered endpoints:
 
-* `__meta_kubernetes_namespace:` The namespace of the endpoints object.
-* `__meta_kubernetes_endpoints_name:` The names of the endpoints object.
 * `__meta_kubernetes_endpoints_label_<labelname>`: Each label from the endpoints object.
 * `__meta_kubernetes_endpoints_labelpresent_<labelname>`: `true` for each label from the endpoints object.
+* `__meta_kubernetes_endpoints_name:` The names of the endpoints object.
+* `__meta_kubernetes_namespace:` The namespace of the endpoints object.
+
 * The following labels are attached for all targets discovered directly from the endpoints list:
+  * `__meta_kubernetes_endpoint_address_target_kind`: Kind of the endpoint address target.
+  * `__meta_kubernetes_endpoint_address_target_name`: Name of the endpoint address target.
   * `__meta_kubernetes_endpoint_hostname`: Hostname of the endpoint.
   * `__meta_kubernetes_endpoint_node_name`: Name of the node hosting the endpoint.
-  * `__meta_kubernetes_endpoint_ready`: Set to `true` or `false` for the endpoint's ready state.
   * `__meta_kubernetes_endpoint_port_name`: Name of the endpoint port.
   * `__meta_kubernetes_endpoint_port_protocol`: Protocol of the endpoint port.
-  * `__meta_kubernetes_endpoint_address_target_kind`: Kind of the endpoint address target.
-  * `__meta_kubernetes_endpoint_address_target_name`: Name of the endpoint address target.
+  * `__meta_kubernetes_endpoint_ready`: Set to `true` or `false` for the endpoint's ready state.
+
 * If the endpoints belong to a service, all labels of the `service` role discovery are attached.
-* For all targets backed by a pod, all labels of the `pod` role discovery are attached.
+* For all targets backed by a Pod, all labels of the `pod` role discovery are attached.
 
 ### endpointslice role
 
@@ -157,91 +159,115 @@ If the endpoint is backed by a Pod, all container ports of a Pod are discovered
 
 The following labels are included for discovered endpoint slices:
 
-* `__meta_kubernetes_namespace`: The namespace of the endpoints object.
 * `__meta_kubernetes_endpointslice_name`: The name of endpoint slice object.
+* `__meta_kubernetes_namespace`: The namespace of the endpoints object.
+
 * The following labels are attached for all targets discovered directly from the endpoint slice list:
+
   * `__meta_kubernetes_endpointslice_address_target_kind`: Kind of the referenced object.
   * `__meta_kubernetes_endpointslice_address_target_name`: Name of referenced object.
   * `__meta_kubernetes_endpointslice_address_type`: The IP protocol family of the address of the target.
   * `__meta_kubernetes_endpointslice_endpoint_conditions_ready`: Set to `true` or `false` for the referenced endpoint's ready state.
   * `__meta_kubernetes_endpointslice_endpoint_topology_kubernetes_io_hostname`: Name of the node hosting the referenced endpoint.
   * `__meta_kubernetes_endpointslice_endpoint_topology_present_kubernetes_io_hostname`: `true` if the referenced object has a `kubernetes.io/hostname` annotation.
-  * `__meta_kubernetes_endpointslice_port`: Port of the referenced endpoint.
   * `__meta_kubernetes_endpointslice_port_name`: Named port of the referenced endpoint.
   * `__meta_kubernetes_endpointslice_port_protocol`: Protocol of the referenced endpoint.
+  * `__meta_kubernetes_endpointslice_port`: Port of the referenced endpoint.
+
 * If the endpoints belong to a service, all labels of the `service` role discovery are attached.
-* For all targets backed by a pod, all labels of the `pod` role discovery are attached.
+* For all targets backed by a Pod, all labels of the `pod` role discovery are attached.
 
 ### ingress role
 
 The `ingress` role discovers a target for each path of each ingress.
 This is generally useful for externally monitoring an ingress.
-The address will be set to the host specified in the Kubernetes `Ingress`'s `spec` block.
+The address is set to the host specified in the Kubernetes `Ingress`'s `spec` block.
 
 The following labels are included for discovered ingress objects:
 
-* `__meta_kubernetes_namespace`: The namespace of the ingress object.
-* `__meta_kubernetes_ingress_name`: The name of the ingress object.
-* `__meta_kubernetes_ingress_label_<labelname>`: Each label from the ingress object.
-* `__meta_kubernetes_ingress_labelpresent_<labelname>`: `true` for each label from the ingress object.
 * `__meta_kubernetes_ingress_annotation_<annotationname>`: Each annotation from the ingress object.
 * `__meta_kubernetes_ingress_annotationpresent_<annotationname>`: `true` for each annotation from the ingress object.
 * `__meta_kubernetes_ingress_class_name`: Class name from ingress spec, if present.
-* `__meta_kubernetes_ingress_scheme`: Protocol scheme of ingress, `https` if TLS config is set. Defaults to `http`.
+* `__meta_kubernetes_ingress_label_<labelname>`: Each label from the ingress object.
+* `__meta_kubernetes_ingress_labelpresent_<labelname>`: `true` for each label from the ingress object.
+* `__meta_kubernetes_ingress_name`: The name of the ingress object.
 * `__meta_kubernetes_ingress_path`: Path from ingress spec. Defaults to /.
+* `__meta_kubernetes_ingress_scheme`: Protocol scheme of ingress, `https` if TLS config is set. Defaults to `http`.
+* `__meta_kubernetes_namespace`: The namespace of the ingress object.
 
 ## Blocks
 
 The following blocks are supported inside the definition of
 `discovery.kubernetes`:
 
-Hierarchy           | Block               | Description                                              | Required
---------------------|---------------------|----------------------------------------------------------|---------
-namespaces          | [namespaces][]      | Information about which Kubernetes namespaces to search. | no
-selectors           | [selectors][]       | Selectors to filter discovered Kubernetes resources.     | no
-attach_metadata     | [attach_metadata][] | Optional metadata to attach to discovered targets.       | no
-basic_auth          | [basic_auth][]      | Configure basic_auth for authenticating to the endpoint. | no
-authorization       | [authorization][]   | Configure generic authorization to the endpoint.         | 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
+Hierarchy           | Block               | Description                                                | Required
+--------------------|---------------------|------------------------------------------------------------|---------
+attach_metadata     | [attach_metadata][] | Optional metadata to attach to discovered targets.         | no
+authorization       | [authorization][]   | Configure generic authorization to the endpoint.           | no
+basic_auth          | [basic_auth][]      | Configure `basic_auth` for authenticating to the endpoint. | no
+namespaces          | [namespaces][]      | Information about which Kubernetes namespaces to search.   | 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
+selectors           | [selectors][]       | Selectors to filter discovered Kubernetes resources.       | 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.
 
-[namespaces]: #namespaces-block
-[selectors]: #selectors-block
-[attach_metadata]: #attach_metadata-block
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[attach_metadata]: #attach_metadata
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[namespaces]: #namespaces
+[oauth2]: #oauth2
+[selectors]: #selectors
+[tls_config]: #tls_config
+
+### attach_metadata
+
+The `attach_metadata` block allows to attach node metadata to discovered targets.
+Valid for roles: pod, endpoints, endpointslice.
+
+Name   | Type   | Description           | Default | Required
+-------|--------|-----------------------|---------|---------
+`node` | `bool` | Attach node metadata. |         | no
+
+### authorization
 
-### namespaces block
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+
+### basic_auth
+
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+
+### namespaces
 
 The `namespaces` block limits the namespaces to discover resources in.
 If omitted, all namespaces are searched.
 
 Name            | Type           | Description                                                       | Default | Required
 ----------------|----------------|-------------------------------------------------------------------|---------|---------
-`own_namespace` | `bool`         | Include the namespace {{< param "PRODUCT_NAME" >}} is running in. |         | no
 `names`         | `list(string)` | List of namespaces to search.                                     |         | no
+`own_namespace` | `bool`         | Include the namespace {{< param "PRODUCT_NAME" >}} is running in. |         | no
+
+### oauth2
+
+{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### selectors block
+### selectors
 
 The `selectors` block contains optional label and field selectors to limit the discovery process to a subset of resources.
 
 Name    | Type     | Description            | Default | Required
 --------|----------|------------------------|---------|---------
 `role`  | `string` | Role of the selector.  |         | yes
-`label` | `string` | Label selector string. |         | no
 `field` | `string` | Field selector string. |         | no
+`label` | `string` | Label selector string. |         | no
 
 See Kubernetes' documentation for [Field selectors][] and [Labels and selectors][] to learn more about the possible filters that can be used.
 
 The endpoints role supports Pod, service, and endpoints selectors.
 The Pod role supports node selectors when configured with `attach_metadata: {node: true}`.
-Other roles only support selectors matching the role itself (e.g. node role can only contain node selectors).
+Other roles only support selectors matching the role itself. For example, node role can only contain node selectors.
 
 {{< admonition type="note" >}}
 Using multiple `discovery.kubernetes` components with different selectors may result in a bigger load against the Kubernetes API.
@@ -255,28 +281,7 @@ Smaller clusters are recommended to avoid selectors in favor of filtering with [
 [Field selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
 [Labels and selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
 
-### attach_metadata block
-
-The `attach_metadata` block allows to attach node metadata to discovered targets.
-Valid for roles: pod, endpoints, endpointslice.
-
-Name   | Type   | Description           | Default | Required
--------|--------|-----------------------|---------|---------
-`node` | `bool` | Attach node metadata. |         | no
-
-### basic_auth block
-
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
-### authorization block
-
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
-### oauth2 block
-
-{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -295,11 +300,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.kubernetes` does not expose any component-specific debug information.
+`discovery.kubernetes` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.kubernetes` does not expose any component-specific debug metrics.
+`discovery.kubernetes` doesn't expose any component-specific debug metrics.
 
 ## Examples
 
@@ -319,19 +324,21 @@ 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:
-  - `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.
+
+* _`<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.
 
 ### Kubeconfig authentication
 
@@ -350,19 +357,21 @@ 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:
-  - `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.
+
+* _`<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.
 
 ### Limit searched namespaces and filter by labels value
 
@@ -389,19 +398,21 @@ 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:
-  - `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.
+
+* _`<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.
 
 ### Limit to only pods on the same node
 
@@ -429,20 +440,21 @@ 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:
-  - `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.
+
+* _`<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 -->
 

From 7a1d413e54e2f4a437ceb1b8d0f077b78fa7fecc Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 12:31:33 -0800
Subject: [PATCH 3/8] Update Kuma topic

---
 .../components/discovery/discovery.kuma.md    | 97 ++++++++++---------
 1 file changed, 49 insertions(+), 48 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.kuma.md b/docs/sources/reference/components/discovery/discovery.kuma.md
index 6490e4cafe..920bc746e7 100644
--- a/docs/sources/reference/components/discovery/discovery.kuma.md
+++ b/docs/sources/reference/components/discovery/discovery.kuma.md
@@ -27,62 +27,61 @@ The following arguments are supported:
 Name                     | Type                | Description                                                                                      | Default | Required
 -------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|---------
 `server`                 | `string`            | Address of the Kuma Control Plane's MADS xDS server.                                             |         | yes
-`refresh_interval`       | `duration`          | The time to wait between polling update requests.                                                | `"30s"` | no
-`fetch_timeout`          | `duration`          | The time after which the monitoring assignments are refreshed.                                   | `"2m"`  | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |         | no
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                                                         | `true`  | no
+`fetch_timeout`          | `duration`          | The time after which the monitoring assignments are refreshed.                                   | `"2m"`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.                                     | `true`  | no
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |         | 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
+`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`          | The time to wait between polling update requests.                                                | `"30s"` | no
 
  At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`bearer_token` argument](#arguments).
+* [`bearer_token_file` argument](#arguments).
+* [`basic_auth` block][basic_auth].
+* [`authorization` block][authorization].
+* [`oauth2` block][oauth2].
 
 {{< docs/shared lookup="reference/components/http-client-proxy-config-description.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-The following blocks are supported inside the definition of
-`discovery.kuma`:
+The following blocks are supported inside the definition of `discovery.kuma`:
 
-Hierarchy           | Block             | Description                                              | Required
---------------------|-------------------|----------------------------------------------------------|---------
-basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no
-authorization       | [authorization][] | Configure generic authorization to the endpoint.         | 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
+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 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
 
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-
 ## Exported fields
 
 The following fields are exported and can be referenced by other components:
@@ -91,11 +90,12 @@ Name      | Type                | Description
 ----------|---------------------|-------------------------------------------------
 `targets` | `list(map(string))` | The set of targets discovered from the Kuma API.
 
-The following meta labels are available on targets and can be used by the discovery.relabel component:
-* `__meta_kuma_mesh`: the name of the proxy's Mesh
-* `__meta_kuma_dataplane`: the name of the proxy
-* `__meta_kuma_service`: the name of the proxy's associated Service
-* `__meta_kuma_label_<tagname>`: each tag of the proxy
+The following meta labels are available on targets and can be used by the `discovery.relabel` component:
+
+* `__meta_kuma_dataplane`: The name of the proxy.
+* `__meta_kuma_label_<tagname>`: Each tag of the proxy.
+* `__meta_kuma_mesh`: The name of the proxy's Mesh.
+* `__meta_kuma_service`: The name of the proxy's associated Service.
 
 ## Component health
 
@@ -104,11 +104,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.kuma` does not expose any component-specific debug information.
+`discovery.kuma` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.kuma` does not expose any component-specific debug metrics.
+`discovery.kuma` doesn't expose any component-specific debug metrics.
 
 ## Example
 
@@ -117,24 +117,25 @@ discovery.kuma "example" {
     server     = "http://kuma-control-plane.kuma-system.svc:5676"
 }
 prometheus.scrape "demo" {
-	targets    = discovery.kuma.example.targets
-	forward_to = [prometheus.remote_write.demo.receiver]
+    targets    = discovery.kuma.example.targets
+    forward_to = [prometheus.remote_write.demo.receiver]
 }
 prometheus.remote_write "demo" {
-	endpoint {
-		url = PROMETHEUS_REMOTE_WRITE_URL
-		basic_auth {
-			username = USERNAME
-			password = PASSWORD
-		}
-	}
+    endpoint {
+        url = <PROMETHEUS_REMOTE_WRITE_URL>
+        basic_auth {
+            username = <USERNAME>
+            password = <PASSWORD>
+        }
+    }
 }
 ```
+
 Replace the following:
-  - `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.
 
+* _`<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 -->
 

From 39e9a3f3512acee7b02b6bf0b72b8759fe4f2086 Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 13:03:19 -0800
Subject: [PATCH 4/8] Update Lightsail topic

---
 .../discovery/discovery.lightsail.md          | 71 ++++++++++---------
 1 file changed, 37 insertions(+), 34 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.lightsail.md b/docs/sources/reference/components/discovery/discovery.lightsail.md
index 1189073a0c..e513bf6b27 100644
--- a/docs/sources/reference/components/discovery/discovery.lightsail.md
+++ b/docs/sources/reference/components/discovery/discovery.lightsail.md
@@ -13,7 +13,7 @@ title: discovery.lightsail
 ## Usage
 
 ```alloy
-discovery.lightsail "LABEL" {
+discovery.lightsail "<LABEL>" {
 }
 ```
 
@@ -23,29 +23,30 @@ The following arguments are supported:
 
 Name                     | Type                | Description                                                                                                             | Default | Required
 -------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------|---------|---------
-`endpoint`               | `string`            | Custom endpoint to be used.                                                                                             |         | no
-`region`                 | `string`            | The AWS region. If blank, the region from the instance metadata is used.                                                |         | no
 `access_key`             | `string`            | The AWS API key ID. If blank, the environment variable `AWS_ACCESS_KEY_ID` is used.                                     |         | no
-`secret_key`             | `string`            | The AWS API key secret. If blank, the environment variable `AWS_SECRET_ACCESS_KEY` is used.                             |         | no
-`profile`                | `string`            | Named AWS profile used to connect to the API.                                                                           |         | no
-`role_arn`               | `string`            | AWS Role ARN, an alternative to using AWS API keys.                                                                     |         | no
-`refresh_interval`       | `string`            | Refresh interval to re-read the instance list.                                                                          | 60s     | no
-`port`                   | `int`               | The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. | 80      | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                                                    |         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                                                      |         | no
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                                                                                | `true`  | no
+`endpoint`               | `string`            | Custom endpoint to be used.                                                                                             |         | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.                                                            | `true`  | no
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                                                    |         | 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
+`port`                   | `int`               | The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. | 80      | no
+`profile`                | `string`            | Named AWS profile used to connect to the API.                                                                           |         | 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`       | `string`            | Refresh interval to re-read the instance list.                                                                          | 60s     | no
+`region`                 | `string`            | The AWS region. If blank, the region from the instance metadata is used.                                                |         | no
+`role_arn`               | `string`            | AWS Role ARN, an alternative to using AWS API keys.                                                                     |         | no
+`secret_key`             | `string`            | The AWS API key secret. If blank, the environment variable `AWS_SECRET_ACCESS_KEY` is used.                             |         | no
 
 At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`authorization` block][authorization]
+* [`basic_auth` block][basic_auth]
+* [`bearer_token_file` argument][arguments]
+* [`bearer_token` argument][arguments]
+* [`oauth2` block][oauth2]
 
  [arguments]: #arguments
 
@@ -58,8 +59,8 @@ The following blocks are supported inside the definition of
 
 Hierarchy           | Block             | Description                                              | Required
 --------------------|-------------------|----------------------------------------------------------|---------
-basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no
 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 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
@@ -67,24 +68,24 @@ tls_config          | [tls_config][]    | Configure TLS settings for connecting
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -117,11 +118,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.lightsail` does not expose any component-specific debug information.
+`discovery.lightsail` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.lightsail` does not expose any component-specific debug metrics.
+`discovery.lightsail` doesn't expose any component-specific debug metrics.
 
 ## Example
 
@@ -137,19 +138,21 @@ 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:
-  - `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.
+
+* _`<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 -->
 

From 8bbeaf02febb18904183f5353f2a27a993658209 Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 13:11:16 -0800
Subject: [PATCH 5/8] Update linode topic

---
 .../components/discovery/discovery.linode.md  | 171 +++++++++---------
 1 file changed, 89 insertions(+), 82 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.linode.md b/docs/sources/reference/components/discovery/discovery.linode.md
index 3811b74a07..8cc2b0c15e 100644
--- a/docs/sources/reference/components/discovery/discovery.linode.md
+++ b/docs/sources/reference/components/discovery/discovery.linode.md
@@ -16,13 +16,13 @@ This service discovery uses the public IPv4 address by default, but that can be
 ## Usage
 
 ```alloy
-discovery.linode "LABEL" {
-	bearer_token = LINODE_API_TOKEN
+discovery.linode "<LABEL>" {
+    bearer_token = <LINODE_API_TOKEN>
 }
 ```
 
 {{< admonition type="note" >}}
-The linode APIv4 Token must be created with the scopes: `linodes:read_only`, `ips:read_only`, and `events:read_only`.
+The Linode APIv4 Token must be created with the scopes: `linodes:read_only`, `ips:read_only`, and `events:read_only`.
 {{< /admonition >}}
 
 ## Arguments
@@ -31,65 +31,64 @@ The following arguments are supported:
 
 Name                     | Type                | Description                                                                                      | Default | Required
 -------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|---------
-`refresh_interval`       | `duration`          | The time to wait between polling update requests.                                                | `"60s"` | no
-`port`                   | `int`               | Port that metrics are scraped from.                                                              | `80`    | no
-`tag_separator`          | `string`            | The string by which Linode Instance tags are joined into the tag label.                          | `,`     | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |         | 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
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |         | 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
+`port`                   | `int`               | Port that metrics are scraped from.                                                              | `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`          | The time to wait between polling update requests.                                                | `"60s"` | no
+`tag_separator`          | `string`            | The string by which Linode Instance tags are joined into the tag label.                          | `,`     | no
 
  At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`authorization` block][authorization]
+* [`basic_auth` block][basic_auth]
+* [`bearer_token_file` argument](#arguments)
+* [`bearer_token` argument](#arguments)
+* [`oauth2` block][oauth2]
 
 {{< 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.linode`:
+The following blocks are supported inside the definition of `discovery.linode`:
 
-Hierarchy           | Block             | Description                                              | Required
---------------------|-------------------|----------------------------------------------------------|---------
-basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no
-authorization       | [authorization][] | Configure generic authorization to the endpoint.         | 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
+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 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
 
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-
 ## Exported fields
 
 The following fields are exported and can be referenced by other components:
@@ -100,24 +99,24 @@ Name      | Type                | Description
 
 The following meta labels are available on targets and can be used by the discovery.relabel component:
 
-* `__meta_linode_instance_id`: the id of the Linode instance
-* `__meta_linode_instance_label`: the label of the Linode instance
-* `__meta_linode_image`: the slug of the Linode instance's image
-* `__meta_linode_private_ipv4`: the private IPv4 of the Linode instance
-* `__meta_linode_public_ipv4`: the public IPv4 of the Linode instance
-* `__meta_linode_public_ipv6`: the public IPv6 of the Linode instance
-* `__meta_linode_region`: the region of the Linode instance
-* `__meta_linode_type`: the type of the Linode instance
-* `__meta_linode_status`: the status of the Linode instance
-* `__meta_linode_tags`: a list of tags of the Linode instance joined by the tag separator
-* `__meta_linode_group`: the display group a Linode instance is a member of
-* `__meta_linode_hypervisor`: the virtualization software powering the Linode instance
-* `__meta_linode_backups`: the backup service status of the Linode instance
-* `__meta_linode_specs_disk_bytes`: the amount of storage space the Linode instance has access to
-* `__meta_linode_specs_memory_bytes`: the amount of RAM the Linode instance has access to
-* `__meta_linode_specs_vcpus`: the number of VCPUS this Linode has access to
-* `__meta_linode_specs_transfer_bytes`: the amount of network transfer the Linode instance is allotted each month
-* `__meta_linode_extra_ips`: a list of all extra IPv4 addresses assigned to the Linode instance joined by the tag separator
+* `__meta_linode_backups`: The backup service status of the Linode instance.
+* `__meta_linode_extra_ips`: A list of all extra IPv4 addresses assigned to the Linode instance joined by the tag separator.
+* `__meta_linode_group`: The display group a Linode instance is a member of.
+* `__meta_linode_hypervisor`: The virtualization software powering the Linode instance.
+* `__meta_linode_image`: The slug of the Linode instance's image.
+* `__meta_linode_instance_id`: The ID of the Linode instance.
+* `__meta_linode_instance_label`: The label of the Linode instance.
+* `__meta_linode_private_ipv4`: The private IPv4 of the Linode instance.
+* `__meta_linode_public_ipv4`: The public IPv4 of the Linode instance.
+* `__meta_linode_public_ipv6`: The public IPv6 of the Linode instance.
+* `__meta_linode_region`: The region of the Linode instance.
+* `__meta_linode_specs_disk_bytes`: The amount of storage space the Linode instance has access to.
+* `__meta_linode_specs_memory_bytes`: The amount of RAM the Linode instance has access to.
+* `__meta_linode_specs_transfer_bytes`: The amount of network transfer the Linode instance is allotted each month.
+* `__meta_linode_specs_vcpus`: The number of VCPUS this Linode has access to.
+* `__meta_linode_status`: The status of the Linode instance.
+* `__meta_linode_tags`: A list of tags of the Linode instance joined by the tag separator.
+* `__meta_linode_type`: The type of the Linode instance.
 
 ## Component health
 
@@ -126,11 +125,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.linode` does not expose any component-specific debug information.
+`discovery.linode` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.linode` does not expose any component-specific debug metrics.
+`discovery.linode` doesn't expose any component-specific debug metrics.
 
 ## Example
 
@@ -140,54 +139,62 @@ discovery.linode "example" {
     port = 8876
 }
 prometheus.scrape "demo" {
-	targets    = discovery.linode.example.targets
-	forward_to = [prometheus.remote_write.demo.receiver]
+    targets    = discovery.linode.example.targets
+    forward_to = [prometheus.remote_write.demo.receiver]
 }
 prometheus.remote_write "demo" {
-	endpoint {
-		url = PROMETHEUS_REMOTE_WRITE_URL
-		basic_auth {
-			username = USERNAME
-			password = PASSWORD
-		}
-	}
+    endpoint {
+        url = <PROMETHEUS_REMOTE_WRITE_URL>
+        basic_auth {
+            username = <USERNAME>
+            password = <PASSWORD>
+        }
+    }
 }
 ```
+
 Replace the following:
-  - `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.
 
-### Using private IP address:
+* _`<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.
 
-```
+### Use a private IP address
+
+```alloy
 discovery.linode "example" {
     bearer_token = sys.env("LINODE_TOKEN")
     port = 8876
 }
 discovery.relabel "private_ips" {
-	targets = discovery.linode.example.targets
-	rule {
-    	source_labels = ["__meta_linode_private_ipv4"]
-    	replacement     = "[$1]:8876"
-    	target_label  = "__address__"
-  	}
+    targets = discovery.linode.example.targets
+    rule {
+        source_labels = ["__meta_linode_private_ipv4"]
+        replacement     = "[$1]:8876"
+        target_label  = "__address__"
+    }
 }
 prometheus.scrape "demo" {
-	targets    = discovery.relabel.private_ips.targets
-	forward_to = [prometheus.remote_write.demo.receiver]
+    targets    = discovery.relabel.private_ips.targets
+    forward_to = [prometheus.remote_write.demo.receiver]
 }
 prometheus.remote_write "demo" {
-	endpoint {
-		url = PROMETHEUS_REMOTE_WRITE_URL
-		basic_auth {
-			username = USERNAME
-			password = PASSWORD
-		}
-	}
+    endpoint {
+        url = <PROMETHEUS_REMOTE_WRITE_URL>
+        basic_auth {
+            username = <USERNAME>
+            password = <PASSWORD>
+        }
+    }
 }
 ```
 
+Replace the following:
+
+* _`<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 -->
 
 ## Compatible components

From fbed1bc0eede0c7213af4e053b1696c51872c160 Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 13:21:10 -0800
Subject: [PATCH 6/8] Update marathon topic

---
 .../discovery/discovery.marathon.md           | 100 +++++++++---------
 1 file changed, 50 insertions(+), 50 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.marathon.md b/docs/sources/reference/components/discovery/discovery.marathon.md
index 42da0cf6f4..427a22187c 100644
--- a/docs/sources/reference/components/discovery/discovery.marathon.md
+++ b/docs/sources/reference/components/discovery/discovery.marathon.md
@@ -13,8 +13,8 @@ title: discovery.marathon
 ## Usage
 
 ```alloy
-discovery.marathon "LABEL" {
-  servers = [MARATHON_SERVER1, MARATHON_SERVER2...]
+discovery.marathon "<LABEL>" {
+  servers = [<MARATHON_SERVER1>, <MARATHON_SERVER2>...]
 }
 ```
 
@@ -25,26 +25,27 @@ The following arguments are supported:
 Name                     | Type                | Description                                                                                      | Default | Required
 -------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------|---------
 `servers`                | `list(string)`      | List of Marathon servers.                                                                        |         | yes
-`refresh_interval`       | `duration`          | Interval at which to refresh the list of targets.                                                | `"30s"` | no
-`auth_token`             | `secret`            | Auth token to authenticate with.                                                                 |         | no
 `auth_token_file`        | `string`            | File containing an auth token to authenticate with.                                              |         | no
+`auth_token`             | `secret`            | Auth token to authenticate with.                                                                 |         | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |         | 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
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |         | 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
+`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.                                                | `"30s"` | no
 
  At most, one of the following can be provided:
-- [`auth_token` argument](#arguments).
-- [`auth_token_file` argument](#arguments).
-- [`bearer_token_file` argument](#arguments).
-- [`bearer_token` argument](#arguments).
-- [`basic_auth` block][basic_auth].
-- [`authorization` block][authorization].
-- [`oauth2` block][oauth2].
+
+- [`auth_token_file` argument][arguments]
+- [`auth_token` argument][arguments]
+- [`authorization` block][authorization]
+- [`basic_auth` block][basic_auth]
+- [`bearer_token_file` argument][arguments]
+- [`bearer_token` argument][arguments]
+- [`oauth2` block][oauth2]
 
 [arguments]: #arguments
 
@@ -52,38 +53,37 @@ Name                     | Type                | Description
 
 ## Blocks
 
-The following blocks are supported inside the definition of
-`discovery.marathon`:
+The following blocks are supported inside the definition of `discovery.marathon`:
 
-| Hierarchy           | Block             | Description                                              | Required |
-| ------------------- | ----------------- | -------------------------------------------------------- | -------- |
-| basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no       |
-| authorization       | [authorization][] | Configure generic authorization to the endpoint.         | 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       |
+Hierarchy           | Block             | Description                                                | Required
+--------------------|-------------------|------------------------------------------------------------|---------
+basic_auth          | [basic_auth][]    | Configure `basic_auth` for authenticating to the endpoint. | no
+authorization       | [authorization][] | Configure generic authorization to the endpoint.           | 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
 
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -91,19 +91,19 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 
 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 Marathon servers. |
+Name      | Type                | Description
+----------|---------------------|---------------------------------------------------------
+`targets` | `list(map(string))` | The set of targets discovered from the Marathon servers.
 
 Each target includes the following labels:
 
-- `__meta_marathon_app`: the name of the app (with slashes replaced by dashes).
-- `__meta_marathon_image`: the name of the Docker image used (if available).
-- `__meta_marathon_task`: the ID of the Mesos task.
-- `__meta_marathon_app_label_<labelname>`: any Marathon labels attached to the app.
-- `__meta_marathon_port_definition_label_<labelname>`: the port definition labels.
-- `__meta_marathon_port_mapping_label_<labelname>`: the port mapping labels.
-- `__meta_marathon_port_index`: the port index number (e.g. 1 for PORT1).
+* `__meta_marathon_app_label_<labelname>`: Any Marathon labels attached to the app.
+* `__meta_marathon_app`: The name of the app, with slashes replaced by dashes.
+* `__meta_marathon_image`: The name of the Docker image used, if available.
+* `__meta_marathon_port_definition_label_<labelname>`: The port definition labels.
+* `__meta_marathon_port_index`: The port index number, for example 1 for PORT1.
+* `__meta_marathon_port_mapping_label_<labelname>`: The port mapping labels.
+* `__meta_marathon_task`: The ID of the Mesos task.
 
 ## Component health
 
@@ -112,11 +112,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.marathon` does not expose any component-specific debug information.
+`discovery.marathon` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.marathon` does not expose any component-specific debug metrics.
+`discovery.marathon` doesn't expose any component-specific debug metrics.
 
 ## Example
 
@@ -134,11 +134,11 @@ 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>
     }
   }
 }
@@ -146,9 +146,9 @@ prometheus.remote_write "demo" {
 
 Replace the following:
 
-- `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.
+* _`<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 -->
 

From e8da6c1783390dc1e82c0fd8f64d4cbdca163aef Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 13:28:28 -0800
Subject: [PATCH 7/8] Update nerve topic

---
 .../components/discovery/discovery.nerve.md   | 65 ++++++++++---------
 1 file changed, 33 insertions(+), 32 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.nerve.md b/docs/sources/reference/components/discovery/discovery.nerve.md
index f741dd9cc9..b0681840e3 100644
--- a/docs/sources/reference/components/discovery/discovery.nerve.md
+++ b/docs/sources/reference/components/discovery/discovery.nerve.md
@@ -15,9 +15,9 @@ title: discovery.nerve
 ## Usage
 
 ```alloy
-discovery.nerve "LABEL" {
-	servers = [SERVER_1, SERVER_2]
-	paths   = [PATH_1, PATH_2]
+discovery.nerve "<LABEL>" {
+    servers = [<SERVER_1>, <SERVER_2>]
+    paths   = [<PATH_1>, <PATH_2>]
 }
 ```
 
@@ -25,32 +25,32 @@ discovery.nerve "LABEL" {
 
 The following arguments are supported:
 
-Name               | Type           | Description                          | Default       | Required
------------------- | -------------- | ------------------------------------ | ------------- | --------
-`servers`          | `list(string)` | The Zookeeper servers.               |               | yes
-`paths`            | `list(string)` | The paths to look for targets at.    |               | yes
-`timeout`          | `duration`     | The timeout to use.                  | `"10s"`       | no
-
+Name      | Type           | Description                       | Default | Required
+----------|----------------|-----------------------------------|---------|---------
+`paths`   | `list(string)` | The paths to look for targets at. |         | yes
+`servers` | `list(string)` | The Zookeeper servers.            |         | yes
+`timeout` | `duration`     | The timeout to use.               | `"10s"` | no
 
 Each element in the `path` list can either point to a single service, or to the root of a tree of services.
 
 ## Blocks
 
-The `discovery.nerve` component does not support any blocks, and is configured fully through arguments.
+The `discovery.nerve` component doesn't support any blocks, and is configured fully through arguments.
 
 ## Exported fields
 
 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 Nerve's API.
 
 The following meta labels are available on targets and can be used by the discovery.relabel component
-* `__meta_nerve_path`: the full path to the endpoint node in Zookeeper
-* `__meta_nerve_endpoint_host`: the host of the endpoint
-* `__meta_nerve_endpoint_port`: the port of the endpoint
-* `__meta_nerve_endpoint_name`: the name of the endpoint
+
+* `__meta_nerve_endpoint_host`: The host of the endpoint.
+* `__meta_nerve_endpoint_name`: The name of the endpoint.
+* `__meta_nerve_endpoint_port`: The port of the endpoint.
+* `__meta_nerve_path`: The full path to the endpoint node in Zookeeper.
 
 ## Component health
 
@@ -59,39 +59,40 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.nerve` does not expose any component-specific debug information.
+`discovery.nerve` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.nerve` does not expose any component-specific debug metrics.
+`discovery.nerve` doesn't expose any component-specific debug metrics.
 
 ## Example
 
 ```alloy
 discovery.nerve "example" {
-	servers = ["localhost"]
-	paths   = ["/monitoring"]
-	timeout = "1m"
+    servers = ["localhost"]
+    paths   = ["/monitoring"]
+    timeout = "1m"
 }
 prometheus.scrape "demo" {
-	targets    = discovery.nerve.example.targets
-	forward_to = [prometheus.remote_write.demo.receiver]
+    targets    = discovery.nerve.example.targets
+    forward_to = [prometheus.remote_write.demo.receiver]
 }
 prometheus.remote_write "demo" {
-	endpoint {
-		url = PROMETHEUS_REMOTE_WRITE_URL
-		basic_auth {
-			username = USERNAME
-			password = PASSWORD
-		}
-	}
+    endpoint {
+        url = <PROMETHEUS_REMOTE_WRITE_URL>
+        basic_auth {
+            username = <USERNAME>
+            password = <PASSWORD>
+        }
+    }
 }
 ```
 
 Replace the following:
-  - `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.
+
+* _`<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 -->
 

From e091584acb65c023985398951c7f4901d44e287b Mon Sep 17 00:00:00 2001
From: Clayton Cornell <clayton.cornell@grafana.com>
Date: Thu, 16 Jan 2025 13:33:03 -0800
Subject: [PATCH 8/8] Update nomad topic

---
 .../components/discovery/discovery.nomad.md   | 100 +++++++++---------
 1 file changed, 51 insertions(+), 49 deletions(-)

diff --git a/docs/sources/reference/components/discovery/discovery.nomad.md b/docs/sources/reference/components/discovery/discovery.nomad.md
index a2eaf224c4..3837f0a136 100644
--- a/docs/sources/reference/components/discovery/discovery.nomad.md
+++ b/docs/sources/reference/components/discovery/discovery.nomad.md
@@ -13,7 +13,7 @@ title: discovery.nomad
 ## Usage
 
 ```alloy
-discovery.nomad "LABEL" {
+discovery.nomad "<LABEL>" {
 }
 ```
 
@@ -23,27 +23,28 @@ The following arguments are supported:
 
 Name                     | Type                | Description                                                                                      | Default                 | Required
 -------------------------|---------------------|--------------------------------------------------------------------------------------------------|-------------------------|---------
-`server`                 | `string`            | Address of nomad server.                                                                         | `http://localhost:4646` | no
-`namespace`              | `string`            | Nomad namespace to use.                                                                          | `default`               | no
-`region`                 | `string`            | Nomad region to use.                                                                             | `global`                | no
 `allow_stale`            | `bool`              | Allow reading from non-leader nomad instances.                                                   | `true`                  | no
-`tag_separator`          | `string`            | Seperator to join nomad tags into Prometheus labels.                                             | `,`                     | no
-`refresh_interval`       | `duration`          | Frequency to refresh list of containers.                                                         | `"30s"`                 | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.                                             |                         | no
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                                                               |                         | 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
-`proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |                         | no
+`namespace`              | `string`            | Nomad namespace to use.                                                                          | `default`               | 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
+`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
+`region`                 | `string`            | Nomad region to use.                                                                             | `global`                | no
+`server`                 | `string`            | Address of nomad server.                                                                         | `http://localhost:4646` | no
+`tag_separator`          | `string`            | Separator to join nomad tags into Prometheus labels.                                             | `,`                     | no
 
  At most, one of the following can be provided:
- - [`bearer_token` argument](#arguments).
- - [`bearer_token_file` argument](#arguments).
- - [`basic_auth` block][basic_auth].
- - [`authorization` block][authorization].
- - [`oauth2` block][oauth2].
+
+* [`authorization` block][authorization]
+* [`basic_auth` block][basic_auth]
+* [`bearer_token_file` argument][arguments]
+* [`bearer_token` argument][arguments]
+* [`oauth2` block][oauth2]
 
 [arguments]: #arguments
 
@@ -51,38 +52,37 @@ Name                     | Type                | Description
 
 ## Blocks
 
-The following blocks are supported inside the definition of
-`discovery.nomad`:
+The following blocks are supported inside the definition of `discovery.nomad`:
 
-Hierarchy           | Block             | Description                                              | Required
---------------------|-------------------|----------------------------------------------------------|---------
-basic_auth          | [basic_auth][]    | Configure basic_auth for authenticating to the endpoint. | no
-authorization       | [authorization][] | Configure generic authorization to the endpoint.         | 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
+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 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
 
 The `>` symbol indicates deeper levels of nesting.
 For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.
 
-[basic_auth]: #basic_auth-block
-[authorization]: #authorization-block
-[oauth2]: #oauth2-block
-[tls_config]: #tls_config-block
+[authorization]: #authorization
+[basic_auth]: #basic_auth
+[oauth2]: #oauth2
+[tls_config]: #tls_config
 
-### basic_auth block
+### authorization
 
-{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### authorization block
+### basic_auth
 
-{{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
+{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2 block
+### oauth2
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config block
+### tls_config
 
 {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -96,15 +96,15 @@ Name      | Type                | Description
 
 Each target includes the following labels:
 
-* `__meta_nomad_address`: the service address of the target.
-* `__meta_nomad_dc`: the datacenter name for the target.
-* `__meta_nomad_namespace`: the namespace of the target.
-* `__meta_nomad_node_id`: the node name defined for the target.
-* `__meta_nomad_service`: the name of the service the target belongs to.
-* `__meta_nomad_service_address`: the service address of the target.
-* `__meta_nomad_service_id`: the service ID of the target.
-* `__meta_nomad_service_port`: the service port of the target.
-* `__meta_nomad_tags`: the list of tags of the target joined by the tag separator.
+* `__meta_nomad_address`: The service address of the target.
+* `__meta_nomad_dc`: The data center name for the target.
+* `__meta_nomad_namespace`: The namespace of the target.
+* `__meta_nomad_node_id`: The node name defined for the target.
+* `__meta_nomad_service_address`: The service address of the target.
+* `__meta_nomad_service_id`: The service ID of the target.
+* `__meta_nomad_service_port`: The service port of the target.
+* `__meta_nomad_service`: The name of the service the target belongs to.
+* `__meta_nomad_tags`: The list of tags of the target joined by the tag separator.
 
 ## Component health
 
@@ -113,11 +113,11 @@ In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 
-`discovery.nomad` does not expose any component-specific debug information.
+`discovery.nomad` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.nomad` does not expose any component-specific debug metrics.
+`discovery.nomad` doesn't expose any component-specific debug metrics.
 
 ## Example
 
@@ -134,19 +134,21 @@ 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:
-  - `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.
+
+* _`<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 -->