You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-8Lines changed: 40 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,28 @@
1
1
# tobs - The Observability Stack for Kubernetes
2
2
3
-
Tobs deploys an observability stack consisting of Prometheus, TimescaleDB, and Grafana to
4
-
monitor a Kubernetes cluster. It is packaged as a Helm chart that is controlled through a CLI tool.
3
+
Tobs is a tool that aims to make it as easy as possible to install a full observability
4
+
stack into a Kubernetes cluster. Currently this stack includes:
5
+
*[Prometheus](https://github.com/prometheus/prometheus) to collect metrics
6
+
*[Grafana](https://github.com/grafana/grafana) to visualize what's going on
7
+
*[Timescale-Prometheus](https://github.com/timescale/timescale-prometheus) ([design doc][design-doc]) to store metrics for the long-term and allow analysis with both PromQL and SQL.
5
8
6
-
For a detailed description of the architecture, please see [our design doc][design-doc].
9
+
We plan to expand this stack over time and welcome contributions.
7
10
8
-
# Quick start
11
+
Tobs provides a CLI tool to make deployment and operations easier. We also provide
12
+
Helm charts that can be used directly or as sub-charts for other projects.
The [CLI tool](/cli/README.md) provides the most seamless experience for interacting with tobs.
21
+
22
+
Getting started with the CLI tool is a two-step process: First you install the CLI tool locally, then you use the CLI tool to install the tobs stack into your Kubernetes cluster.
23
+
24
+
### Installing the CLI tool
25
+
12
26
To download and install tobs, run the following in your terminal, then follow the on-screen instructions.
Alternatively, you can download the CLI directly via [our releases page](/releases)
19
33
20
-
After setting up tobs run the following to install the tobs helm charts into your kubernetes cluster
34
+
### Using the tobs CLI tool to deploy the stack into your Kubernetes cluster
35
+
36
+
After setting up tobs run the following to install the tobs helm charts into your Kubernetes cluster
21
37
22
38
```bash
23
39
tobs install
24
40
```
25
41
26
-
# Using the Helm charts without the CLI tool
42
+
This will deploy all of the tobs components into your cluster and provide instructions as to next steps.
43
+
44
+
### Getting started by viewing your metrics in Grafana
45
+
To see your Grafana dashboards after installation run
46
+
47
+
```bash
48
+
tobs grafana change-password <new_password>
49
+
tobs grafana port-forward
50
+
```
51
+
Then, point your browser to http://127.0.0.1:8080/ and login with the `admin` username.
52
+
53
+
54
+
More details about the CLI tool can be found [here](/cli/README.md)
55
+
56
+
# 🛠Alternative deployment methods
57
+
58
+
## Using the Helm charts without the CLI tool
27
59
28
-
Instructions on using the Helm charts without the CLI tool can be found [here](/chart/README.md).
60
+
Users sometimes want to use our Helm charts as sub-charts for other project or integrate them into their infrastructure without using our CLI tool. This is a supported use-case and instructions on using the Helm charts can be found [here](/chart/README.md).
29
61
30
-
# Contributing
62
+
# ✏️ Contributing
31
63
32
64
We welcome contributions to tobs, which is
33
65
licensed and released under the open-source Apache License, Version 2. The
Getting started with the CLI tool is a two-step process: First you install the CLI tool locally, then you use the CLI tool to install the tobs stack into your Kubernetes cluster.
10
+
11
+
### Installing the CLI tool
12
+
9
13
To download and install tobs, run the following in your terminal, then follow the on-screen instructions.
0 commit comments