README
¶
Loki Operator
This is the Kubernetes Operator for Loki provided by the Grafana Loki SIG operator.
Hacking on Loki Operator on kind or OpenShift
- If you want to contribute to this repository, you might need a step-by-step guide on how to start hacking on Loki-operator with kind.
- Also, there is a step-by-step guide on how to test Loki-operator on OpenShift.
- There is also a basic troubleshooting guide if you run into some common problems.
- There is also a document which demonstrates how to use Loki Operator for development and testing locally without deploying the operator each time on Kind and OpenShift using the
make run
command.
Sending Logs to Loki
Sending Logs Through the Gateway Component
- The forwarding logs to LokiStack guide provides instructions for configuring forwarding clients to ship logs to Loki through the gateway component.
- This section details how to connect to OpenShift Logging installation to the gateway.
- This section details how to connect a Promtail installation to the gateway.
- This section details how to connect a Grafana Fluentd plugin installation to the gateway.
Sending Logs Directly to the Distributor Component
- The forwarding logs to LokiStack without LokiStack Gateway is used to send application, infrastructure, audit and network logs to the Loki Distributor as different tenants using Fluentd or Vector.
- The guide has a step-by-step guide to connect with OpenShift Logging or OpenShift Network for forwarding logs to LokiStack.
Installation of Storage Size Calculator on OpenShift
- Storage size calculator works out of the box on OpenShift. For non-openshift distributions you will need to create services like prometheus, serviceMonitor, scrape configuration for log-file-metric exporter, promsecret to access the custom prometheus URL, token.
- The step-by-step guide on how to install storage size calculator on OpenShift is available.
- Also, there is a step-by-step guide on how to contribute to this along with local development and testing procedure.
- There is also a basic troubleshooting guide if you run into some common problems.
Directories
¶
Path | Synopsis |
---|---|
api
|
|
config/v1
Package v1 contains API Schema definitions for the config v1 API group +kubebuilder:object:generate=true +groupName=config.loki.grafana.com
|
Package v1 contains API Schema definitions for the config v1 API group +kubebuilder:object:generate=true +groupName=config.loki.grafana.com |
loki
Module
|
|
apis
|
|
loki
Module
|
|
cmd
|
|
internal
|
Click to show internal directories.
Click to hide internal directories.