From d5a04e92d71fecde680d3c4fdd8bbc0dc7ac761d Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Thu, 8 Feb 2024 09:51:10 -0800 Subject: [PATCH] Tidy up formatting, syntax and tweak grammar (#6336) --- .../flow/get-started/install/ansible.md | 51 ++++++++++--------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/docs/sources/flow/get-started/install/ansible.md b/docs/sources/flow/get-started/install/ansible.md index e4ac6cdf195d..837f5553eb31 100644 --- a/docs/sources/flow/get-started/install/ansible.md +++ b/docs/sources/flow/get-started/install/ansible.md @@ -17,15 +17,15 @@ You can use Ansible to install and manage {{< param "PRODUCT_NAME" >}} on Linux ## Before you begin -- These steps assume you already have a working [Ansible](https://www.ansible.com/) setup, -and a pre-existing inventory. -- You can add the tasks below to any new or existing Role you choose. +- These steps assume you already have a working [Ansible](https://www.ansible.com/) setup and a pre-existing inventory. +- You can add the tasks below to any new or existing role. ## Steps To add {{% param "PRODUCT_NAME" %}} to a host: 1. Create a file named `grafana-agent.yml` and add the following: + ```yaml - name: Install Grafana Agent Flow hosts: all @@ -43,31 +43,37 @@ To add {{% param "PRODUCT_NAME" %}} to a host: grafana_agent_flags_extra: server.http.listen-addr: '0.0.0.0:12345' ``` -1. Replace the following field values: - - `` with the path to river configuration file on the Ansible Controller (Localhost). + Replace the following: -1. Run the Ansible playbook - In the Linux machine's terminal, run the following command from the directory where the Ansible playbook is located. + - _``_: The path to the River configuration file on the Ansible Controller (Localhost). + +1. Run the Ansible playbook. Open a terminal window and run the following command from the Ansible playbook directory. + + ```shell + ansible-playbook grafana-agent.yml + ``` - ```shell - ansible-playbook grafana-agent.yml - ``` ## Validate -1. Grafana Agent service on the target machine should be `active` and `running`. You should see a similar output: - +To verify that the {{< param "PRODUCT_NAME" >}} service on the target machine is `active` and `running`, open a terminal window and run the following command: + ```shell $ sudo systemctl status grafana-agent.service - grafana-agent.service - Grafana Agent - Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled) - Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago - Main PID: 3176 (agent-linux-amd) - Tasks: 8 (limit: 515) - Memory: 92.5M - CPU: 380ms - CGroup: /system.slice/grafana-agent.service - └─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml +``` + +If the service is `active` and `running`, the output should look similar to this: + +``` +grafana-agent.service - Grafana Agent + Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled) + Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago +Main PID: 3176 (agent-linux-amd) + Tasks: 8 (limit: 515) + Memory: 92.5M + CPU: 380ms + CGroup: /system.slice/grafana-agent.service + └─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml ``` ## Next steps @@ -75,7 +81,6 @@ $ sudo systemctl status grafana-agent.service - [Configure {{< param "PRODUCT_NAME" >}}][Configure] {{% docs/reference %}} - [Configure]: "/docs/agent/ -> /docs/agent//flow/tasks/configure/configure-linux.md" [Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux.md" -{{% /docs/reference %}} \ No newline at end of file +{{% /docs/reference %}}