Skip to content

Commit 88d107f

Browse files
committed
docs: Simplify main README following OpenStack style
1 parent 3374c98 commit 88d107f

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
1-
# Kubernetes Observability & Operations Platform
1+
# Kubernetes Observability Platform
22

3-
This repository provisions a comprehensive, production-grade observability and operations platform on **Google Kubernetes Engine (GKE)**. It integrates distinct, modular components to handle **deployment**, **monitoring**, **logging**, **tracing**, and **certificate management**.
3+
Comprehensive observability and operations infrastructure for Kubernetes, integrating monitoring, logging, tracing, and automated certificate management.
44

5-
## Core Components
5+
## Components
66

7-
* **Observability (LGTM Stack)**:
8-
* **Loki**: Distributed logging.
9-
* **Grafana**: Visualization and dashboards.
10-
* **Tempo**: Distributed tracing.
11-
* **Mimir**: Scalable metrics (Prometheus storage).
12-
* **GitOps (ArgoCD)**:
13-
* **ArgoCD**: Continuous delivery and declarative GitOps workflows.
14-
* **Infrastructure Essentials**:
15-
* **Cert-Manager**: Automated TLS certificate issuance (Let's Encrypt).
16-
* **Ingress Controller**: NGINX Ingress for external traffic management.
7+
**Observability Stack**
8+
- Loki - Log aggregation
9+
- Grafana - Metrics visualization
10+
- Tempo - Distributed tracing
11+
- Mimir - Long-term metrics storage
1712

18-
## Project Structure
13+
**Operations**
14+
- ArgoCD - GitOps continuous delivery
15+
- Cert-Manager - Automated TLS certificates
16+
- NGINX Ingress - Traffic routing
1917

20-
This project is built with **Terraform** and **Helm**, designed for modularity. You can deploy the entire stack or individual components as needed.
18+
## Getting Started
2119

22-
> **Architecture Note**: This repository contains multiple deployable stacks (LGTM, ArgoCD) that share core infrastructure (Cert-Manager, Ingress). To prevent conflicts, ensure only **one** stack manages these shared resources, or use `terraform import` to adopt them into the correct state. See the [Shared Infrastructure Guide](docs/kubernetes-observability.md#modular-components--shared-infrastructure) for details.
20+
Each component includes detailed deployment guides:
2321

24-
* **[`lgtm-stack/`](lgtm-stack/README.md)**: The core internal monitoring platform.
25-
* **[`argocd/`](argocd/README.md)**: The GitOps delivery engine.
26-
* **[`cert-manager/`](cert-manager/README.md)**: Certificate management infrastructure.
27-
* **[`ingress-controller/`](ingress-controller/README.md)**: Ingress routing infrastructure.
22+
- [LGTM Stack](lgtm-stack/README.md) - Complete observability platform
23+
- [ArgoCD](argocd/README.md) - GitOps delivery
24+
- [Cert-Manager](cert-manager/README.md) - Certificate management
25+
- [Ingress Controller](ingress-controller/README.md) - Traffic routing
2826

2927
## Documentation
3028

31-
* **[Kubernetes Observability Guide](docs/kubernetes-observability.md)**: Deployment and architecture of the LGTM stack.
32-
* **[Cert-Manager Deployment](docs/cert-manager-terraform-deployment.md)**: Terraform guide for Cert-Manager.
33-
* **[Ingress Controller Deployment](docs/ingress-controller-terraform-deployment.md)**: Terraform guide for NGINX Ingress.
34-
* **[ArgoCD Documentation](argocd/README.md)**: Setup and configuration for GitOps.
35-
29+
Full deployment guides and references are available in the [`docs/`](docs/) directory.

0 commit comments

Comments
 (0)