Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Outdated fluentd image name, UID details, link update #2112

Merged
merged 2 commits into from
May 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

However this is correct :) now ! the docker image is grafana/fluent-plugin-loki:master


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