Skip to content

Commit 428fa3a

Browse files
committed
More README edits based on feedback
1 parent cdb3fb7 commit 428fa3a

File tree

2 files changed

+64
-9
lines changed

2 files changed

+64
-9
lines changed

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
# tobs - The Observability Stack for Kubernetes
22

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.
58

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.
710

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.
13+
14+
# 🔥 Quick start
915

1016
__Dependencies__: [Helm](https://helm.sh/docs/intro/install/)
1117

18+
## Using the tobs CLI tool
19+
20+
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+
1226
To download and install tobs, run the following in your terminal, then follow the on-screen instructions.
1327

1428
```bash
@@ -17,17 +31,35 @@ curl --proto '=https' --tlsv1.2 -sSLf https://tsdb.co/install-tobs-sh |sh
1731

1832
Alternatively, you can download the CLI directly via [our releases page](/releases)
1933

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
2137

2238
```bash
2339
tobs install
2440
```
2541

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
2759

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).
2961

30-
# Contributing
62+
# ✏️ Contributing
3163

3264
We welcome contributions to tobs, which is
3365
licensed and released under the open-source Apache License, Version 2. The

cli/README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,36 @@ This is a CLI tool for installing and managing the The Observability Stack for K
66

77
__Dependencies__: [Helm](https://helm.sh/docs/intro/install/)
88

9+
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+
913
To download and install tobs, run the following in your terminal, then follow the on-screen instructions.
1014

1115
```bash
1216
curl --proto '=https' --tlsv1.2 -sSLf https://tsdb.co/install-tobs-sh |sh
1317
```
1418

15-
Alternatively, you can download the CLI directly via [our releases page](/releases).
19+
Alternatively, you can download the CLI directly via [our releases page](/releases)
20+
21+
### Using the tobs CLI tool to deploy the stack into your Kubernetes cluster
22+
23+
After setting up tobs run the following to install the tobs helm charts into your Kubernetes cluster
24+
25+
```bash
26+
tobs install
27+
```
28+
29+
This will deploy all of the tobs components into your cluster and provide instructions as to next steps.
30+
31+
### Getting started by viewing your metrics in Grafana
32+
To see your Grafana dashboards after installation run
33+
34+
```bash
35+
tobs grafana change-password <new_password>
36+
tobs grafana port-forward
37+
```
38+
Then, point your browser to http://127.0.0.1:8080/ and login with the `admin` username.
1639

1740
## Commands
1841

0 commit comments

Comments
 (0)