Skip to content

Commit

Permalink
docs: fix admonition, line spacing (#15462) (#15480)
Browse files Browse the repository at this point in the history
  • Loading branch information
JStickler authored Dec 18, 2024
1 parent 09144bb commit bc1794e
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions docs/sources/send-data/docker-driver/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,12 @@ Grafana Loki officially supports a Docker plugin that will read logs from Docker
containers and ship them to Loki. The plugin can be configured to send the logs
to a private Loki instance or [Grafana Cloud](/oss/loki).

{{% admonition type="note" %}}
{{< admonition type="note" >}}
Docker plugins are not supported on Windows; see the [Docker Engine managed plugin system](https://docs.docker.com/engine/extend) documentation for more information.
{{% /admonition %}}
{{< /admonition >}}

Documentation on configuring the Loki Docker Driver can be found on the
[configuration page]({{< relref "./configuration" >}}).

If you have any questions or issues using the Docker plugin, open an issue in
If you have any questions or issues using the Docker plugin, open an issue in
the [Loki repository](https://github.com/grafana/loki/issues).

## Install the Docker driver client
Expand All @@ -32,20 +30,25 @@ Run the following command to install the plugin, updating the release version if
docker plugin install grafana/loki-docker-driver:2.9.2 --alias loki --grant-all-permissions
```

To check installed plugins, use the `docker plugin ls` command.
{{< admonition type="note" >}}
Add `-arm64` to the image tag for AMR64 hosts.
{{< /admonition >}}

To check installed plugins, use the `docker plugin ls` command.
Plugins that have started successfully are listed as enabled:

```bash
$ docker plugin ls
docker plugin ls
```

You should see output similar to the following:

```bash
ID NAME DESCRIPTION ENABLED
ac720b8fcfdb loki Loki Logging Driver true
```

Once you have successfully installed the plugin you can [configure]({{< relref "./configuration" >}}) it.
Once you have successfully installed the plugin you can [configure](https://grafana.com/docs/loki/<LOKI_VERSION/configure/) it.

## Upgrade the Docker driver client

Expand All @@ -58,9 +61,10 @@ docker plugin upgrade loki grafana/loki-docker-driver:2.9.2 --grant-all-permissi
docker plugin enable loki
systemctl restart docker
```
{{% admonition type="note" %}}

{{< admonition type="note" >}}
Update the version number to the appropriate version.
{{% /admonition %}}
{{< /admonition >}}

## Uninstall the Docker driver client

Expand All @@ -77,4 +81,4 @@ The driver keeps all logs in memory and will drop log entries if Loki is not rea

The wait time can be lowered by setting `loki-retries=2`, `loki-max-backoff=800ms`, `loki-timeout=1s` and `keep-file=true`. This way the daemon will be locked only for a short time and the logs will be persisted locally when the Loki client is unable to re-connect.

To avoid this issue, use the Promtail [Docker target]({{< relref "../../send-data/promtail/configuration#docker" >}}) or [Docker service discovery]({{< relref "../../send-data/promtail/configuration#docker_sd_configs" >}}).
To avoid this issue, use the Promtail [Docker target](https://grafana.com/docs/loki/<LOKI_VERSION>/send-data/promtail/configuration/#docker) or [Docker service discovery](https://grafana.com/docs/loki/<LOKI_VERSION>/send-data/promtail/configuration/#docker_sd_configs).

0 comments on commit bc1794e

Please sign in to comment.