Collect (helm voltadmin collect)

Documentation

VoltDB Home » Documentation » VoltDB Kubernetes Administrator's Guide
< previoustable of contentsnext >

Collect (helm voltadmin collect)

Collect — Collects logs, configuration, and error files for all nodes of a VoltDB cluster.

Synopsis

helm voltadmin --release={release-name} collect --outdir=/tmp

global qualifiers:
--chart={chart-name}
--context={context-name}
--help
--namespace={namespace-name}
--verbose

Description

The helm voltadmin collect command collects logs, error files, and configuration information for both the base system and the database. This information can help debug issues with the database operation.

Arguments

The following global arguments must precede the command name, except --outdir which can follow the collect command keyword.

--context={cluster-name}

Specifies the Kubernetes cluster where the database is running.

- -help

Displays a list of available commands and qualifiers. To see help for a specific command and its options, put the --help qualifier after the command name.

--namespace={namespace-name}

Specifies the Kubernetes namespace where the database is running.

--outdir=/tmp

Specifies the destination directory where the collected data is stored. You must specify an output directory and /tmp is recommended because it is the only writeable location on the pod. Required.

--release={release-name}

Specifies the Helm release name of the cluster you want to collect information from. Required.

--verbose

Displays additional information about the specific commands being executed.

Example

The following example collects information from the database cluster associated with the mydb release.

$ helm voltadmin --release=mydb collect --outdir=tmp
< previoustable of contentsnext >