A utility to check the configuration of a running Zenko cluster targeted at sysadmins
Project description
# zenko-check
zenko-check is a command-line utility to check the configuration of a
production Zenko deployment and diagnose problems in it.
## Pre-Requisites
zenko-check requires a [Helm](https://github.com/kubernetes/helm) installation
that is configured to access Tiller running inside Kubernetes.
## Installation
zenko-check can be installed directly from PyPi using Pip:
```
pip install zenko-check
```
A Docker image is also provided for convenience.
```
docker pull zenko/zenko-check:latest
docker run -it zenko/zenko-check help
```
## Syntax
zenko-check commands conform to the following syntax:
```
zenko-check <global option> <subcommand> <-flag or --verbose_option> <optional target>
```
### Global Options
```
--mongo Override the default Mongo connection string (host:port)
-r, --helm-release The Helm release name under which Zenko was installed.
```
### Subcommands
#### checkup
Run all checks and tests (may take a while).
#### k8s
Check Kubernetes-related configuration.
```
-c, --check-services Attempt to connect to defined services and report their status.
```
#### orbit
Check overlay configuration applied via Orbit.
#### backends
Check existence and configuration of backend buckets.
```
-d, --deep Enable deep checking. Check every Zenko bucket for its backing bucket
(same as zenko-check buckets)
```
#### buckets
Check every Zenko bucket for its backend bucket.
zenko-check is a command-line utility to check the configuration of a
production Zenko deployment and diagnose problems in it.
## Pre-Requisites
zenko-check requires a [Helm](https://github.com/kubernetes/helm) installation
that is configured to access Tiller running inside Kubernetes.
## Installation
zenko-check can be installed directly from PyPi using Pip:
```
pip install zenko-check
```
A Docker image is also provided for convenience.
```
docker pull zenko/zenko-check:latest
docker run -it zenko/zenko-check help
```
## Syntax
zenko-check commands conform to the following syntax:
```
zenko-check <global option> <subcommand> <-flag or --verbose_option> <optional target>
```
### Global Options
```
--mongo Override the default Mongo connection string (host:port)
-r, --helm-release The Helm release name under which Zenko was installed.
```
### Subcommands
#### checkup
Run all checks and tests (may take a while).
#### k8s
Check Kubernetes-related configuration.
```
-c, --check-services Attempt to connect to defined services and report their status.
```
#### orbit
Check overlay configuration applied via Orbit.
#### backends
Check existence and configuration of backend buckets.
```
-d, --deep Enable deep checking. Check every Zenko bucket for its backing bucket
(same as zenko-check buckets)
```
#### buckets
Check every Zenko bucket for its backend bucket.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zcheck-0.1.0.tar.gz
(14.7 kB
view hashes)