Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit 326066a

Browse files
committed
Update timescale-observability->tobs in README
1 parent 6a1fde6 commit 326066a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ natively supported by Grafana via the PostgreSQL/TimescaleDB datasource.
5050

5151
## Getting started with Helm (recommended)
5252

53-
The quickest way to get started is by using the Helm chart from
54-
[timescale-observability](https://github.com/timescale/timescale-observability),
55-
which provides a broader framework for installing an end-to-end
56-
monitoring stack.
53+
The quickest way to get started is by using
54+
[The Observability Stack for Kubernetes (tobs)](https://github.com/timescale/tobs),
55+
which provides a helm chart and CLI tool for installing an end-to-end
56+
observability stack.
5757

5858
The following command will install Prometheus, TimescaleDB,
5959
Timescale-Prometheus Connector, and Grafana
6060
into your Kubernetes cluster:
6161
```
6262
helm repo add timescale https://charts.timescale.com/
6363
helm repo update
64-
helm install --devel <release_name> timescale/timescale-observability
64+
helm install --devel <release_name> timescale/tobs
6565
```
6666

6767
## Quick tips
@@ -89,14 +89,14 @@ We describe how to use our pre-defined views and functions to work with the prom
8989

9090
A Reference for our SQL API is [available here](docs/sql_api.md).
9191

92-
### Prometheus HTTP API
92+
### Prometheus HTTP API
9393

9494
The Timescale-Prometheus Connector can be used directly as a Prometheus Data Source in Grafana, or other software.
9595

96-
It implements some endpoints of the currently stable (V1)
97-
[Prometheus HTTP API](https://prometheus.io/docs/prometheus/latest/querying/api).
96+
It implements some endpoints of the currently stable (V1)
97+
[Prometheus HTTP API](https://prometheus.io/docs/prometheus/latest/querying/api).
9898
The API is accessible at `http://timescale_prometheus_connector:9201/api/v1` and can be used to execute instant or range
99-
PromQL queries against the data in TimescaleDB, as well as retrieve the metadata for series, label names and label
99+
PromQL queries against the data in TimescaleDB, as well as retrieve the metadata for series, label names and label
100100
values.
101101

102102
A Reference for the implemented endpoints of the Prometheus HTTP API is [available here](docs/prometheus_api.md)
@@ -106,20 +106,20 @@ A Reference for the implemented endpoints of the Prometheus HTTP API is [availab
106106
### Configuring the Helm Chart
107107

108108
To get a fully-documented configuration file for
109-
`timescale-observability`, please run:
109+
`tobs`, please run:
110110

111111
```
112-
helm show values timescale/timescale-observability > my_values.yml
112+
helm show values timescale/tobs > my_values.yml
113113
```
114114

115115
You can then edit `my_values.yml` and deploy the release with the
116116
following command:
117117

118118
```
119-
helm upgrade --install <release_name> --values my_values.yml timescale/timescale-observability
119+
helm upgrade --install <release_name> --values my_values.yml timescale/tobs
120120
```
121121

122-
By default, the `timescale-observability` Helm chart sets up a
122+
By default, the `tobs` Helm chart sets up a
123123
single-instance of TimescaleDB; if you are
124124
interested in a replicated setup for high-availabilty with automated
125125
backups, please see
@@ -130,7 +130,7 @@ backups, please see
130130
A Helm chart for only the Timescale-Prometheus Connector is available in
131131
the [helm-chart directory](helm-chart/README.md) of this repository.
132132

133-
This is used as a dependency from the `timescale-observability` Helm
133+
This is used as a dependency from the `tobs` Helm
134134
chart and can be used as a dependency in your own custom Helm chart.
135135

136136
## Non-Helm deployment
@@ -140,7 +140,7 @@ chart and can be used as a dependency in your own custom Helm chart.
140140
Any non-helm installations also need to make sure the `drop_chunks`
141141
procedure on a regular
142142
basis (e.g. via CRON). We recommend executing it every 30 minutes.
143-
This is necessary to execute data retention policies according to the
143+
This is necessary to execute data retention policies according to the
144144
configured policy. This is set up automatically in helm.
145145

146146
We also recommend running this with a Timescaledb installation that

0 commit comments

Comments
 (0)