Skip to content

Commit

Permalink
Documentation: Outdated fluentd image name, UID details, link update (#…
Browse files Browse the repository at this point in the history
…2112)

* documentation update: Fluentd docker image name, UID for docker image, and link to installing as container

* Reverted to fix the name of the Ruby gem while keeping name change for Docker image
  • Loading branch information
nileshcs authored May 25, 2020
1 parent f984e71 commit a0546a3
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ simplifies the operation and significantly lowers the cost of Loki.
2. [Installation](installation/README.md)
1. [Installing with Tanka](installation/tanka.md)
2. [Installing with Helm](installation/helm.md)
3. [Installing Locally](installation/local.md)
3. [Installing with Docker](installation/docker.md)
4. [Installing locally](installation/local.md)
3. [Getting Started](getting-started/README.md)
1. [Grafana](getting-started/grafana.md)
2. [LogCLI](getting-started/logcli.md)
Expand Down
6 changes: 4 additions & 2 deletions docs/clients/fluentd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,18 +119,20 @@ This plugin automatically adds a `fluentd_thread` label with the name of the buf

## Docker Image

There is a Docker image `grafana/fluent-plugin-grafana-loki:master` which contains [default configuration files](https://github.com/grafana/loki/tree/master/fluentd/fluent-plugin-grafana-loki/docker/conf). By default, fluentd containers use the configurations but you can also specify your `fluentd.conf` with `FLUENTD_CONF` environment variable.
There is a Docker image `grafana/fluent-plugin-loki:master` which contains [default configuration files](https://github.com/grafana/loki/tree/master/fluentd/fluent-plugin-loki/docker/conf). By default, fluentd containers use the configurations but you can also specify your `fluentd.conf` with `FLUENTD_CONF` environment variable.

This image also uses `LOKI_URL`, `LOKI_USERNAME`, and `LOKI_PASSWORD` environment variables to specify the Loki's endpoint, user, and password (you can leave the USERNAME and PASSWORD blank if they're not used).

This image will start an instance of Fluentd to forward incoming logs to the specified Loki url. As an alternate, containerized applications can also use [docker driver plugin](../docker-driver/README.md) to ship logs without needing Fluentd.

### Example

A Docker Compose configuration that will work looks like:

```
services:
fluentd:
image: grafana/fluent-plugin-grafana-loki:master
image: grafana/fluent-plugin-loki:master
command:
- "fluentd"
- "-v"
Expand Down
5 changes: 4 additions & 1 deletion docs/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ docker run -v $(pwd):/mnt/config -v /var/log:/var/log grafana/promtail:1.5.0 -co

When finished, loki-config.yaml and promtail-config.yaml are downloaded in the directory you chose. Docker containers are running Loki and Promtail using those config files.

Navigate to http://localhost:3100/metrics to view the output.
Navigate to http://localhost:3100/metrics to view the metrics and http://localhost:3100/ready for readiness.

As of v1.5.0, image is configured to run by default as user loki with UID `10001` and GID `10001`. You can use a different user, specially if you are using bind mounts, by specifying uid with docker run command
by specifying `--user=UID` with numeric UID suited to your needs.

**Windows**

Expand Down

0 comments on commit a0546a3

Please sign in to comment.