Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update to helm usage by default #413

Merged
merged 2 commits into from
Jun 8, 2022
Merged

docs: Update to helm usage by default #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a35e16e
docs: Update to helm usage by default
onprem Jun 7, 2022
7bf0fbe
docs: Move CLI getting started to cli/README.md
onprem Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ docs:
.PHONY: check-docs
check-docs:
@echo ">> checking formatting and local/remote links"
$(MDOX_BIN) fmt --soft-wraps --check -l --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT)
$(MDOX_BIN) fmt --soft-wraps --check -l --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT)
70 changes: 19 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,52 +22,31 @@ stack into a Kubernetes cluster. Currently this stack includes:

We plan to expand this stack over time and welcome contributions.

Tobs provides a CLI tool to make deployment and operations easier. We also provide
Helm charts that can be used directly or as sub-charts for other projects.
Tobs provides a helm chart to make deployment and operations easier. It can be used directly or as a sub-chart for other projects.

See a demo of tobs in action by clicking the video below:
# Quick start

<p align="center">
<a href="https://www.youtube.com/watch?v=MSvBsXOI1ks"> <img src="https://media.giphy.com/media/e8y7Lq7V5F0K9zQs20/giphy.gif"> </a>
</p>
## Prerequisites

# 🔥 Quick start
Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager.
To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/).

## Installing the CLI tool
*Note*: cert-manager is not required when using tobs with opentelemetry support disabled.

To download and install tobs, run the following in your terminal, then follow the on-screen instructions.
## Installing the helm chart

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

Alternatively, you can download the CLI directly via [our releases page](https://github.com/timescale/tobs/releases/latest)

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.

## Using the tobs CLI tool to deploy the stack into your Kubernetes cluster

After setting up tobs run the following to install the tobs helm charts into your Kubernetes cluster

```bash
tobs install
```

This will deploy all of the tobs components into your cluster and provide instructions as to next steps.

### Tracing support

From `0.7.0` release tobs supports installation of tracing components. To install tracing components use
The following command will install Kube-Prometheus, OpenTelemetry Operator, TimescaleDB, and Promscale
into your Kubernetes cluster:

```
tobs install --tracing
helm repo add timescale https://charts.timescale.com/
helm repo update
helm install --wait <release_name> timescale/tobs
```

For more details on tracing support visit [Promscale tracing docs](https://github.com/timescale/promscale/blob/master/docs/tracing.md).
*Note*: `--wait` flag is necessary for successfull installation as tobs helm chart can create opentelemetry Custom Resources only after opentelemetry-operator is up and running. This flag can be omitted when using tobs without opentelemetry support.

## Using the tobs CLI tool

The CLI tool ([usage guide](https://github.com/timescale/tobs/tree/master/cli#usage-guide)) provides the most seamless experience for interacting with tobs.
For detailed configuration and usage instructions, take a look at the [helm chart's README](/chart/README.md).

# Configuring the stack

Expand All @@ -76,24 +55,13 @@ You can view the self-documenting [default values.yaml](chart/values.yaml) in th
We also have additional documentation about individual configuration settings in our
[Helm chart docs](chart/README.md#configuring-helm-chart).

To modify the settings, first create a values.yaml file:

```bash
tobs helm show-values > values.yaml
```

Then modify the values.yaml file using your favorite editor.
Finally, deploy with the new settings using:

```bash
tobs install -f values.yaml
```
# Alternative deployment methods

# 🛠Alternative deployment methods
## Using the `tobs` CLI tool

## Using the Helm charts without the CLI tool
We also provide a CLI tool to deploy tobs on a Kubernetes cluster. The CLI tool ([usage guide](https://github.com/timescale/tobs/tree/master/cli#usage-guide)) provides detailed instructions on how to use the CLI for managing tobs.

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).
*NOTE*: At this point, the CLI tool is just a thin wrapper around the helm chart, and hence it's set to be removed in future releases.

# Compatibility matrix

Expand All @@ -107,7 +75,7 @@ Users sometimes want to use our Helm charts as sub-charts for other project or i
| 0.8.x | v1.21 to v1.23 |
| 0.7.x | v1.19 to v1.21 |

# ✏️ Contributing
# Contributing

We welcome contributions to tobs, which is
licensed and released under the open-source Apache License, Version 2. The
Expand Down
5 changes: 1 addition & 4 deletions chart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ A Helm chart for deploying Prometheus configured to use TimescaleDB as compresse

# Install

The recommended way to deploy tobs is through the [CLI tool](/cli). However, we also
support helm deployments that do not use the CLI.

## Prerequisites

Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/).
Expand All @@ -36,7 +33,7 @@ Using tobs to install full observability stack with openTelemetry support curren

## Installing the helm chart

The following command will install Kube-Prometheus, TimescaleDB, and Promscale
The following command will install Kube-Prometheus, TimescaleDB, OpenTelemetry Operator, and Promscale
into your Kubernetes cluster:

```
Expand Down
32 changes: 32 additions & 0 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,38 @@ This is a CLI tool for installing and managing the The Observability Stack for K

## Quick Start

### Installing the CLI tool

To download and install tobs, run the following in your terminal, then follow the on-screen instructions.

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

Alternatively, you can download the CLI directly via [our releases page](https://github.com/timescale/tobs/releases/latest)

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.

### Using the tobs CLI tool to deploy the stack into your Kubernetes cluster

After setting up tobs run the following to install the tobs helm charts into your Kubernetes cluster

```bash
tobs install
```

This will deploy all of the tobs components into your cluster and provide instructions as to next steps.

#### Tracing support

From `0.7.0` release tobs supports installation of tracing components. To install tracing components use

```
tobs install --tracing
```

For more details on tracing support visit [Promscale tracing docs](https://github.com/timescale/promscale/blob/master/docs/tracing.md).

### Getting started by viewing your metrics in Grafana

To see your Grafana dashboards after installation run
Expand Down