Versions:

Use the observability stack (tobs) for Kubernetes

This section covers the main commands you can use with tobs, including how to use it to view metrics in Grafana. For more information about Helm charts, see the tobs Helm charts page.

Before you begin, you should already have installed and set up your Kubernetes cluster and the tobs package. For more information on installing tobs, see the tobs installation page .

Primary tobs commands

This section covers the primary tobs commands.

CommandCommand DescriptionAvailable FlagsFlag description
tobs installAlias for tobs helm install--filename, -fFile to load configuration from
--chart-reference, -cHelm chart reference. Defaults to timescale/tobs
--external-timescaledb-uri, -eExternal database URI. Skips TimescaleDB installation and Promscale connects to the provided database URI.
--enable-prometheus-haOption to enable Prometheus and Promscale HA. Defaults to 3 replicas
--enable-timescaledb-backup, -bEnable TimescaleDB S3 backup
--only-secretsCreate only the TimescaleDB secrets, do no other install tasks
--skip-waitDo not wait for pods to be running. Provides faster tobs installation.
--timescaledb-tls-certProvide your own TLS certificate for TimescaleDB
--timescaledb-tls-keyProvide your own TLS key for TimescaleDB
--versionProvide tobs Helm chart version, if not provided, installs the most recent available tobs Helm chart
--tracingEnable tracing components
tobs uninstallAlias for tobs Helm uninstall--delete-dataDelete persistent volume claims
tobs port-forwardPort forward TimescaleDB, Grafana, and Prometheus to localhost--timescaledb, -tPort for TimescaleDB
--grafana, -gPort for Grafana
--prometheus, -pPort for Prometheus
--promscale, -cPort for Promscale
--promlens, -lPort for Promlens
tobs versionShows the installed version of tobs and the latest Helm chart--deployed-chart, -dShow the deployed Helm chart version with the tobs CLI version

Helm tobs commands

This section covers the tobs commands for managing Helm charts. For more information about Helm charts, see the tobs Helm charts page.

CommandCommand DescriptionAvailable FlagsFlag description
tobs helm show-valuesPrints the YAML configuration of the Helm chart--filename, -fFile to load configuration from
--chart-reference, -cHelm chart reference. Defaults to timescale/tobs

You can use a custom values.yml file with the tobs helm install -f values.yml command.

TimescaleDB tobs commands

This section covers the tobs commands for managing your TimescaleDB database.

CommandCommand DescriptionAvailable FlagsFlag description
tobs timescaledb connectConnects to the Timescale database with the provided user--dbname, -dDatabase name to connect to. Defaults to the name providedd in the Helm release
--master, -mDirectly execute session on master node
tobs timescaledb port-forwardPort forward TimescaleDB to localhost--port, -pPort to listen on

TimescaleDB superuser tobs commands

This section covers the tobs commands for managing your TimescaleDB database that are available to the superuser.

CommandCommand DescriptionAvailable FlagsFlag description
tobs timescaledb superuser get-passwordGets the password of the superuser in the TimescaleDB database
tobs timescaledb superuser change-passwordChanges the password of the superuser in the Timescale database
tobs timescaledb superuser connectConnects to the TimescaleDB database as the superuser--master, -mDirectly execute session on master node

Grafana tobs commands

This section covers the tobs commands for managing Grafana.

CommandCommand DescriptionAvailable FlagsFlag description
tobs grafana port-forwardPort forward the Grafana server to localhost--port, -pPort to listen on
tobs grafana get-passwordGet the Grafana admin password
tobs grafana change-passwordChange the Grafana admin password

Prometheus tobs commands

This section covers the tobs commands for managing Prometheus.

CommandCommand DescriptionAvailable FlagsFlag description
tobs prometheus port-forwardPort forward the Prometheus server to localhost--port, -pPort to listen on

Jaeger tobs commands

This section covers the tobs commands for managing Jaeger. These command are supported only if you enabled tracing when you installed tobs.

CommandCommand DescriptionAvailable FlagsFlag description
tobs jaeger port-forwardPort forward the Jaeger query to localhost--port, -pPort to listen on

Metrics tobs commands

This section covers the tobs commands for managing metrics.

CommandCommand DescriptionAvailable FlagsFlag description
tobs metrics retention getGets the data retention period for the specified metric
tobs metrics retention set-defaultSet the default data retention period to the specified number of days
tobs metrics retention setSet the data retention period for the specified metric to the specified number of days
tobs metrics retention resetReset the data retention period for the specified metric to the default value
tobs metrics chunk-interval getGet the chunk interval for the specified metric
tobs metrics chunk-interval set-defaultSet the default chunk interval for the specified duration
tobs metrics chunk-interval setSet the chunk interval for the specified metric to the specified duration
tobs metrics chunk-interval resetReset the chunk interval for the specified metric to the default value

Volume tobs commands

This section covers the tobs commands for managing TimescaleDB and Prometheus persistent volume claim (PVC) volumes.

To expand PVCs in your Kubernetes cluster, you must have configured the storageClass parameter to be allowVolumeExpansion: true.

CommandCommand DescriptionAvailable FlagsFlag description
tobs volume getDisplays PVC sizes--timescaleDB-storage, -s
--timescaleDB-wal, -w
--prometheus-storage, -p
tobs volume expandExpand the PVC for provided resources to the specified size, given in Ki, Mi or Gi--timescaleDB-storage, -s
--timescaleDB-wal, -w
--prometheus-storage, -p
--restart-pods, -rRestart pods bound to PVC after PVC expansion.

Upgrade tobs commands

This section covers the tobs commands for upgrading your existing tobs installation. You can upgrade tobs to the latest Helm chart, as long as the Helm chart exists in the Timescale Helm repository. You can also upgrade your existing tobs installation to use the latest values.yaml configuration file. Internally, these tools use the Helm upgrade utility.

CommandCommand DescriptionAvailable FlagsFlag description
tobs upgradeUpgrade the tobs deployment to use the newest available Helm chart, and upgrades tobs if a new values.yaml file is provided--filename, -fFile to load configuration from
--chart-reference, -cHelm chart reference. Defaults to timescale/tobs
--reuse-valuesNative Helm upgrade flag to use existing values from release
--reset-valuesNative helm flag to reset values to default Helm chart values
--confirm, -yApprove upgrade action without prompting
--same-chartUpgrade the Helm release with latest values.yaml, but use the same chart
--skip-crdsSkip creating CRDs on upgrade

Global tobs commands

This section covers the global tobs commands that can be used with any other commands listed here.

Available FlagsFlag description
--nameHelm release name
--namespace, -nKubernetes namespace
--configTobs configuration file, defaults to `$HOME/.tobs.yaml

Found an issue on this page?

Report an issue!

Keywords

Related Content