Skip to content
Merged
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
82 changes: 41 additions & 41 deletions oci/loki/documentation.yaml
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
version: 1
# --- OVERVIEW INFORMATION ---
version: 2

application: loki
description: >
description: |
Loki is a horizontally scalable, highly available, multi-tenant log
aggregation system inspired by Prometheus. It is designed to be very cost
effective and easy to operate. It does not index the contents of the logs,
but rather a set of labels for each log stream.
Read more on the [official website](https://grafana.com/oss/loki/).

Please note that the images tagged up to 2.4 are Dockerfile-base images,
whereas from version 2.8.4 onward the images are now rocks. As such the
entrypoint is now Pebble. Read more on the
[Rockcraft docs](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/).
Comment thread
asanvaq marked this conversation as resolved.
# --- USAGE INFORMATION ---
website: https://grafana.com/oss/loki/
issues: https://github.com/canonical/loki-rock/issues
source-code: https://github.com/canonical/loki-rock

docker:
parameters:
- -p 3100:3100
access: Access your Loki instance at `http://localhost:3100`.
parameters:
- type: -e
value: 'TZ=UTC'
description: Timezone.
- type: -p
value: '3100:3100'
description: Expose Loki on `localhost:3100`.
- type: -v
value: "/path/to/config/file:/etc/loki/local-config.yaml"
description: Local configuration file `local-config.yml`.
- type: -v
value: "lokidata:/loki"
description: "Persist data in a docker volume named `lokidata`"
debug:
text: |
### Debugging

To debug the container:
parameters: >-
-e TZ=UTC
-p 3100:3100
-v /path/to/config/file:/etc/loki/local-config.yaml
-v lokidata:/loki
run_conclusion: |
Access the Loki instance at http://localhost:3100.
legacy:
parameters: >-
-e TZ=UTC
-p 3100:3100
-v /path/to/config/file:/etc/loki/loki.yaml
-v lokidata:/loki
run_conclusion: |
Access the legacy Loki instance at http://localhost:3100.

```bash
docker logs -f loki-container
```
Legacy tags up to 2.4 are Dockerfile-based images. To open an
interactive shell in one of these containers, use:

To get an interactive shell:
```bash
docker exec -it loki-container /bin/bash
```

```bash
# For Dockerfile-based images
docker exec -it loki-container /bin/bash
# For rocks
docker exec -it loki-container exec /bin/bash
```
config:
TZ:
type: env
description: Timezone.
default: 'UTC'
'`-v <path>:/etc/loki/local-config.yaml`':
type: mount
description: Local configuration file.
'`-v <path>:/loki`':
type: mount
description: Persist data in a docker volume named lokidata.
'`-p <port>:3100`':
type: port
description: Expose the container's port `3100` on the host's `<port>`.
Loading