Verrazzano Enterprise Container Platform – Diagnostic Tools

Docs: Verrazzano Analysis Tools

Mon, 01 Jan 0001 00:00:00 +0000

Verrazzano provides the vz analyze command-line tool, which assists in troubleshooting issues in your environment. You can use it to analyze a cluster as well as, to analyze a cluster snapshot captured by the vz bug-report tool. For detailed information about vz bug-report, see here.

The vz analyze command-line tool analyzes the cluster or a cluster snapshot, reports the issues found, and prescribes related actions to take. Users, developers, and Continuous Integration (CI) can use this tooling to quickly identify the root cause of encountered problems, determine mitigation actions, and provide a sharable report with other users or tooling.

Set up the CLI tool

To set up the vz command-line tool, follow the steps here.

Analyze clusters

To analyze a Kubernetes cluster:

$ vz analyze

Analyze cluster snapshots

Use the vz bug-report tool to capture a cluster snapshot.

To create a bug report in a TAR file named my-bug-report.tar.gz and extract it to a directory my-cluster-snapshot:
```
$ vz bug-report my-bug-report.tar.gz
  mkdir my-cluster-snapshot
  tar -xvf my-bug-report.tar.gz -C my-cluster-snapshot
```
Use the vz analyze tool to analyze the cluster snapshot.

To perform an analysis of the cluster snapshot under my-cluster-snapshot:
```
$ vz analyze --capture-dir my-cluster-snapshot
```

Use the `vz analyze` tool to analyze multiple snapshots

The vz analyze tool will find and analyze all cluster snapshot directories found under a specified root directory. This lets you create a directory to hold the cluster snapshots of related clusters in subdirectories, which the tool can then analyze.

For example:

my-cluster-snapshots
    CAPTURE_DIR-1
        cluster-snapshot
            ...
    CAPTURE_DIR-2
        cluster-snapshot
            ...

To perform an analysis of the clusters under my-cluster-snapshots:

$ vz analyze --capture-dir my-cluster-snapshots

Usage information

Use the following syntax to run vz commands from your terminal window.

$ vz analyze [flags]

Available options

Command	Definition
`--capture-dir string`	Directory holding the captured data.
`-h, --help`	Help for the `vz analyze` command.
`--report-file string`	Name of the report output file. (Default `stdout`)
`--report-format string`	The format of the report output. Valid report formats are “summary” and “detailed”. (Default “summary”)
`-v, --verbose`	Enable verbose output.

Available flags

These flags apply to all the commands.

Flag	Definition
`--context string`	The name of the kubeconfig file context to use.
`--kubeconfig string`	Path to the kubeconfig file to use.

Docs: Bug Reports

Mon, 01 Jan 0001 00:00:00 +0000

Use the vz bug-report tool to selectively capture cluster information and create an archive (*.tar.gz) file to help diagnose problems. The archive file helps development and support teams analyze issues and provide recommendations.

CLI setup

To set up the vz command-line tool, follow the steps here.

Use the `vz bug-report` tool

To create a bug report in a TAR file named my-bug-report.tar.gz:

$ vz bug-report --report-file my-bug-report.tar.gz

We suggest that you review the contents of the bug report before sharing it with support and development teams.

Usage information

Use the following syntax to run vz commands from your terminal window.

$ vz bug-report [flags]

Available options

Command	Definition
`-h, --help`	Help for the `vz bug-report` command.
`-i, --include-namespaces strings`	A comma-separated list of namespaces, in addition to the ones collected by default (system namespaces), for collecting cluster information. This flag can be specified multiple times, such as `--include-namespaces ns1 --include-namespaces ns...`
`-r, --report-file string`	The report file created by the `vz bug-report` command, as a `*.tar.gz` file. Defaults to `bug-report.tar.gz` in the current directory.
`-l --include-logs`	Include logs from the pods in one or more namespaces; this is specified along with the `--include-namespaces` flag.
`-d --duration duration`	The time period during which the logs are collected in seconds, minutes, and hours.
`-v, --verbose`	Enable verbose output.

Available flags

These flags apply to all the commands.

Flag	Definition
`--context string`	The name of the kubeconfig file context to use.
`--kubeconfig string`	Path to the kubeconfig file to use.

Examples

Create a bug report file, bugreport.tar.gz, by collecting data from the cluster:
```
$ vz bug-report --report-file bugreport.tar.gz
```
When --report-file is not provided, the command creates bug-report.tar.gz in the current directory.
Create a bug report file, bugreport.tar.gz, including the additional namespace ns1 from the cluster:
```
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1
```
The flag --include-namespaces accepts comma-separated values and can be specified multiple times. For example, the following commands create a bug report by including the additional namespaces ns1, ns2, and ns3:
```
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2,ns3
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-namespaces ns3
```
Use the --include-logs flag to collect the logs from the pods in one or more namespaces, by specifying the --include-namespaces flag. For example, the following command creates a bug report by including the logs from the additional namespaces ns1 and ns2:
```
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs
```
The --duration flag collects logs for the specified time period. The default value is zero (0), which collects the complete pod log. You can specify seconds, minutes, and hours. For example, the following commands create bug reports by including the logs from the additional namespaces ns1 and ns2 during the specified periods of time:
```
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 5m
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 2h
$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 300s
```
The values specified for the flag --include-namespaces are case-sensitive.

Docs: Analysis Advice

Mon, 01 Jan 0001 00:00:00 +0000

Verrazzano Enterprise Container Platform – Diagnostic Tools

Docs: Verrazzano Analysis Tools

Set up the CLI tool

Analyze clusters

Analyze cluster snapshots

Use the vz analyze tool to analyze multiple snapshots

Usage information

Available options

Available flags

Docs: Bug Reports

CLI setup

Use the vz bug-report tool

Usage information

Available options

Available flags

Examples

Docs: Analysis Advice

Use the `vz analyze` tool to analyze multiple snapshots

Use the `vz bug-report` tool