Skip to content

Commit 29deae7

Browse files
committed
docs: standardize filenames to kebab-case and add LGTM stack README
1 parent b109235 commit 29deae7

File tree

9 files changed

+24
-4
lines changed

9 files changed

+24
-4
lines changed
File renamed without changes.
File renamed without changes.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Manual LGTM Stack Deployment
1+
# manual LGTM Stack Deployment
22

3-
This guide explains how to manually deploy the observability stack (Loki, Grafana, Tempo, Mimir) using the Docker Compose configuration found in `lgtm-stack/Manual`.
3+
This guide explains how to manually deploy the observability stack (Loki, Grafana, Tempo, Mimir) using the Docker Compose configuration found in `lgtm-stack/manual`.
44

55
## 1. Deployment Constraints
66

7-
The configuration in `lgtm-stack/Manual/docker-compose.yaml` expects an external Docker network named `netbird_netbird` to exist. This is typically created by the NetBird management stack.
7+
The configuration in `lgtm-stack/manual/docker-compose.yaml` expects an external Docker network named `netbird_netbird` to exist. This is typically created by the NetBird management stack.
88

99
If you do not have NetBird running, you must create this network manually to avoid errors:
1010

@@ -17,7 +17,7 @@ docker network create netbird_netbird
1717
1. Navigate to the manual configuration directory:
1818

1919
```bash
20-
cd ../lgtm-stack/Manual
20+
cd ../lgtm-stack/manual
2121
```
2222

2323
2. Start the services in detached mode:
File renamed without changes.

lgtm-stack/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# LGTM Stack Deployment
2+
3+
The **LGTM** stack is a comprehensive open-source observability platform powered by Grafana Labs. It provides unmatched correlation between metrics, logs, and traces, allowing complete visibility into your applications and infrastructure.
4+
5+
## Components
6+
7+
- **L**oki: Like Prometheus, but for logs. It is a horizontally-scalable, highly-available, multi-tenant log aggregation system.
8+
- **G**rafana: The open observability platform for visualization and analytics.
9+
- **T**empo: A high-volume, minimal dependency distributed tracing backend.
10+
- **M**imir: Scalable long-term storage for Prometheus metrics.
11+
12+
## Deployment Guides
13+
14+
This repository provides two guides to help you deploy the stack:
15+
16+
### 1. Automated Deployment
17+
For a fully automated deployment using this stack, please follow the [Kubernetes Observability Guide](../docs/kubernetes-observability.md).
18+
19+
### 2. Manual Deployment
20+
If you prefer to configure and deploy components manually, or need to understand the individual steps, please refer to the [Manual LGTM Deployment Guide](../docs/manual-lgtm-deployment.md).

0 commit comments

Comments
 (0)