Skip to content

Commit

Permalink
Tidy up formatting, syntax and tweak grammar (#6336)
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell authored Feb 8, 2024
1 parent 8549349 commit d5a04e9
Showing 1 changed file with 28 additions and 23 deletions.
51 changes: 28 additions & 23 deletions docs/sources/flow/get-started/install/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -43,39 +43,44 @@ 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:
- `<path-to-config-file-on-localhost>` 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.
- _`<path-to-config-file-on-localhost>`_: 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:
<!-- vale Grafana.ReferTo = NO -->
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

- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

{{% docs/reference %}}

[Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-linux.md"
[Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux.md"
{{% /docs/reference %}}
{{% /docs/reference %}}

0 comments on commit d5a04e9

Please sign in to comment.