diff --git a/docs/sources/flow/setup/configure/configure-linux.md b/docs/sources/flow/setup/configure/configure-linux.md index 28073f7fbe84..ad8f02135d32 100644 --- a/docs/sources/flow/setup/configure/configure-linux.md +++ b/docs/sources/flow/setup/configure/configure-linux.md @@ -65,8 +65,6 @@ the following steps: To see the list of valid command-line flags that can be passed to the service, refer to the documentation for the [run][] command. -[run]: {{< relref "../../reference/cli/run.md" >}} - ## Expose the UI to other machines By default, Grafana Agent listens on the local network for its HTTP @@ -91,4 +89,9 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `LISTEN_ADDR` with `0.0.0.0`. -[UI]: {{< relref "../../monitoring/debugging.md#grafana-agent-flow-ui" >}} +{{% docs/reference %}} +[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" +[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/cli/run.md" +[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/configure/configure-macos.md b/docs/sources/flow/setup/configure/configure-macos.md index 8f3e3529f65a..ee9bf74dbf79 100644 --- a/docs/sources/flow/setup/configure/configure-macos.md +++ b/docs/sources/flow/setup/configure/configure-macos.md @@ -80,4 +80,7 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `127.0.0.1` with `0.0.0.0`. -[UI]: {{< relref "../../monitoring/debugging.md#grafana-agent-flow-ui" >}} +{{% docs/reference %}} +[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/configure/configure-windows.md b/docs/sources/flow/setup/configure/configure-windows.md index bf992f46081b..ca73255c3483 100644 --- a/docs/sources/flow/setup/configure/configure-windows.md +++ b/docs/sources/flow/setup/configure/configure-windows.md @@ -88,4 +88,8 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `LISTEN_ADDR` with `0.0.0.0`. -[UI]: {{< relref "../../monitoring/debugging.md#grafana-agent-flow-ui" >}} +{{% docs/reference %}} +[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +{{% /docs/reference %}} + diff --git a/docs/sources/flow/setup/install/binary.md b/docs/sources/flow/setup/install/binary.md index 35098d00fd34..f8fb920e9a93 100644 --- a/docs/sources/flow/setup/install/binary.md +++ b/docs/sources/flow/setup/install/binary.md @@ -42,5 +42,12 @@ To download Grafana Agent as a standalone binary, perform the following steps. ## Next steps -* [Start Grafana Agent]({{< relref "../start-agent#standalone-binary" >}}) -* [Configure Grafana Agent]({{< relref "../configure" >}}) +* [Start Grafana Agent][] +* [Configure Grafana Agent][] + +{{% docs/reference %}} +[Start Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md#standalone-binary" +[Start Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start-agent.md#standalone-binary" +[Configure Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure" +[Configure Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/install/docker.md b/docs/sources/flow/setup/install/docker.md index b55d0d6823a1..7497c104c9d8 100644 --- a/docs/sources/flow/setup/install/docker.md +++ b/docs/sources/flow/setup/install/docker.md @@ -18,9 +18,6 @@ Grafana Agent is available as a Docker container image on the following platform * [Linux containers][] for AMD64 and ARM64. * [Windows containers][] for AMD64. -[Linux containers]: #run-a-linux-docker-container -[Windows containers]: #run-a-windows-docker-container - ## Before you begin * Install [Docker][] on your computer. @@ -33,8 +30,6 @@ Grafana Agent is available as a Docker container image on the following platform } ``` -[Docker]: https://docker.io - ## Run a Linux Docker container To run Grafana Agent in flow mode as a Linux Docker container, run the following command in a terminal window: @@ -53,12 +48,9 @@ Replace `CONFIG_FILE_PATH` with the path of the configuration file on your host You can modify the last line to change the arguments passed to the Grafana Agent binary. Refer to the documentation for [run][] for more information about the options available to the `run` command. -{{% admonition type="note" %}} -Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. -If you don't pass this argument, the [debugging UI]({{< relref "../../monitoring/debugging#grafana-agent-flow-ui" >}}) won't be available outside of the Docker container. -{{% /admonition %}} +> **Note:** Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. +> If you don't pass this argument, the [debugging UI][UI] won't be available outside of the Docker container. -[run]: {{< relref "../../reference/cli/run.md" >}} ## Run a Windows Docker container @@ -78,15 +70,21 @@ Replace `CONFIG_FILE_PATH` with the path of the configuration file on your host You can modify the last line to change the arguments passed to the Grafana Agent binary. Refer to the documentation for [run][] for more information about the options available to the `run` command. -{{% admonition type="note" %}} -Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. -If you don't pass this argument, the [debugging UI]({{< relref "../../monitoring/debugging#grafana-agent-flow-ui" >}}) won't be available outside of the Docker container. -{{% /admonition %}} -[run]: {{< relref "../../reference/cli/run.md" >}} +> **Note:** Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. +> If you don't pass this argument, the [debugging UI][UI] won't be available outside of the Docker container. ## Verify -To verify that Grafana Agent is running successfully, navigate to and make sure the Grafana Agent [UI][] loads without error. +To verify that Grafana Agent is running successfully, navigate to and make sure the [Grafana Agent UI][UI] loads without error. + +[Linux containers]: #run-a-linux-docker-container +[Windows containers]: #run-a-windows-docker-container +[Docker]: https://docker.io -[UI]: {{< relref "../../monitoring/debugging.md#grafana-agent-flow-ui" >}} +{{% docs/reference %}} +[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" +[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/cli/run.md" +[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/install/kubernetes.md b/docs/sources/flow/setup/install/kubernetes.md index 85c6e19c6122..bf2307dd5bfd 100644 --- a/docs/sources/flow/setup/install/kubernetes.md +++ b/docs/sources/flow/setup/install/kubernetes.md @@ -21,8 +21,6 @@ Grafana Agent can be deployed on Kubernetes by using the Helm chart for Grafana * Configure a Kubernetes cluster that you can use for Grafana Agent. * Configure your local Kubernetes context to point to the cluster. -[Helm]: https://helm.sh - ## Deploy {{% admonition type="note" %}} @@ -59,5 +57,11 @@ For more information on the Grafana Agent Helm chart, refer to the Helm chart do ## Next steps -- [Start Grafana Agent]({{< relref "../start-agent" >}}) -- [Configure Grafana Agent]({{< relref "../configure/configure-kubernetes" >}}) +- [Configure Grafana Agent][] + +[Helm]: https://helm.sh + +{{% docs/reference %}} +[Configure Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure/configure-kubernetes.md" +[Configure Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-kubernetes.md" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/install/linux.md b/docs/sources/flow/setup/install/linux.md index f18cab7a297c..0c7feaa0940a 100644 --- a/docs/sources/flow/setup/install/linux.md +++ b/docs/sources/flow/setup/install/linux.md @@ -118,5 +118,12 @@ To uninstall Grafana Agent on Linux, run the following commands in a terminal wi ## Next steps -- [Start Grafana Agent]({{< relref "../start-agent#linux" >}}) -- [Configure Grafana Agent]({{< relref "../configure/configure-linux" >}}) +- [Start Grafana Agent][] +- [Configure Grafana Agent][] + +{{% docs/reference %}} +[Start Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md#linux" +[Start Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start-agent.md#linux" +[Configure Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure/configure-linux.md" +[Configure Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-linux.md" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/install/macos.md b/docs/sources/flow/setup/install/macos.md index 94ecd9ff1cea..8527a7ee0841 100644 --- a/docs/sources/flow/setup/install/macos.md +++ b/docs/sources/flow/setup/install/macos.md @@ -23,8 +23,6 @@ The default prefix for Homebrew on Intel is `/usr/local`. The default prefix for * Install [Homebrew][] on your computer. -[Homebrew]: https://brew.sh - ## Install To install Grafana Agent on macOS, run the following commands in a terminal window. @@ -67,5 +65,14 @@ brew uninstall grafana-agent-flow ## Next steps -- [Start Grafana Agent]({{< relref "../start-agent#macos" >}}) -- [Configure Grafana Agent]({{< relref "../configure/configure-macos" >}}) +- [Start Grafana Agent][] +- [Configure Grafana Agent][] + +[Homebrew]: https://brew.sh + +{{% docs/reference %}} +[Start Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md#macos" +[Start Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start-agent.md#macos" +[Configure Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure/configure-macos.md" +[Configure Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-macos.md" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/install/windows.md b/docs/sources/flow/setup/install/windows.md index a75069351435..90ab0cca5904 100644 --- a/docs/sources/flow/setup/install/windows.md +++ b/docs/sources/flow/setup/install/windows.md @@ -31,8 +31,6 @@ To do a standard graphical install of Grafana Agent on Windows, perform the foll Grafana Agent is installed into the default directory `C:\Program Files\Grafana Agent Flow`. -[latest]: https://github.com/grafana/agent/releases/latest - ## Silent install To do a silent install of Grafana Agent on Windows, perform the following steps. @@ -53,15 +51,22 @@ To do a silent install of Grafana Agent on Windows, perform the following steps. Replace `PATH_TO_INSTALLER` with the path where the unzipped installer executable is located. -[latest]: https://github.com/grafana/agent/releases/latest - ## Uninstall -You can uninstall Grafana Agent with Windows Remove Programs or `C:\Program Files\Grafana Agent\uninstaller.exe`. Uninstalling Grafana Agent will stop the service and remove it from disk. This includes any configuration files in the installation directory. +You can uninstall Grafana Agent with Windows Remove Programs or `C:\Program Files\Grafana Agent\uninstaller.exe`. Uninstalling Grafana Agent stops the service and removes it from disk. This includes any configuration files in the installation directory. Grafana Agent can also be silently uninstalled by running `uninstall.exe /S` as Administrator. ## Next steps -- [Start Grafana Agent]({{< relref "../start-agent#windows" >}}) -- [Configure Grafana Agent]({{< relref "../configure/configure-windows" >}}) +- [Start Grafana Agent][] +- [Configure Grafana Agent][] + +[latest]: https://github.com/grafana/agent/releases/latest + +{{% docs/reference %}} +[Start Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md#windows" +[Start Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/start-agent.md#windows" +[Configure Grafana Agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure/configure-windows.md" +[Configure Grafana Agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-windows.md" +{{% /docs/reference %}} diff --git a/docs/sources/flow/setup/start-agent.md b/docs/sources/flow/setup/start-agent.md index a09dfb2e72e9..b76f728732a9 100644 --- a/docs/sources/flow/setup/start-agent.md +++ b/docs/sources/flow/setup/start-agent.md @@ -107,8 +107,8 @@ brew services stop grafana-agent-flow By default, logs are written to `$(brew --prefix)/var/log/grafana-agent-flow.log` and `$(brew --prefix)/var/log/grafana-agent-flow.err.log`. -If you followed [Configure the Grafana Agent service]({{< relref "./configure/configure-macos#configure-the-grafana-agent-service" >}}) -and changed the path where logs are written, refer to your current copy of the Grafana Agent formula to locate your log files. +If you followed [Configure the Grafana Agent service][] and changed the path where logs are written, +refer to your current copy of the Grafana Agent formula to locate your log files. ## Windows @@ -249,3 +249,8 @@ These steps assume you have a default systemd and Grafana Agent configuration. 1. Use the [Linux](#linux) systemd commands to manage your standalone Linux installation of Grafana Agent. [release]: https://github.com/grafana/agent/releases/latest + +{{% docs/reference %}} +[Configure the Grafana Agent service]: "/docs/agent/ -> /docs/agent//flow/setup/configure/configure-macos.md#configure-the-grafana-agent-service" +[Configure the Grafana Agent service]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-macos.md#configure-the-grafana-agent-service" +{{% /docs/reference %}}