Skip to content

Commit

Permalink
Merge pull request #8 from joshuacox/v1.9.3
Browse files Browse the repository at this point in the history
Cutting 1.9.3 in prep for 1.9.4
  • Loading branch information
joshuacox authored Mar 15, 2018
2 parents 2c0212e + e946bba commit 58c1d46
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 45 deletions.
50 changes: 5 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@
Build, provision, initialize, add common components, and tear down a cluster PDQ.

[![Build Status](https://travis-ci.org/kubash/kubash.svg?branch=master)](https://travis-ci.org/kubash/kubash)
<<<<<<< HEAD
=======
[![Waffle.io - Columns and their card count](https://badge.waffle.io/kubash/kubash.svg?columns=all)](https://waffle.io/kubash/kubash)

old waffle (still has quite a backlog)
>>>>>>> travis
[![Waffle.io - Columns and their card count](https://badge.waffle.io/joshuacox/kubash.svg?columns=all)](https://waffle.io/joshuacox/kubash)

Dev [![Build Status](https://travis-ci.org/joshuacox/kubash.svg?branch=master)](https://travis-ci.org/joshuacox/kubash)
Expand Down Expand Up @@ -179,55 +176,18 @@ options:

There is an example csv file in this repo which shows how to compose this file

### Debugging
### [Debugging](./docs/debug.md)

First start by adding a few -vvv to the command to bump up the verbosity e.g.
First try `kubash COMMAND --help`

```
kubash -vvvvv init
```

or

```
kubash --verbosity 22 init
```

Alternatively there is an environment variable `VERBOSITY`

```
export VERBOSITY=25
kubash init
```

And you can also add a debug flag:

```
kubash --debug --verbosity 100 init
```
See the [debugging](./docs/debug.md) page for more

try `kubash COMMAND --help`

### Interactive Mode
### [Interactive Mode](./docs/interactive.md)

`kubash` -- alone will invoke an interactive shell (or if you prefer
`kubash interactive`)

```
### Kubash, by Josh Cox
---------------------------------------------------------------------------------------------------------------
Interactive Kubash Shell Enter 'help' for help, or 'quit' to quit
working with the default kubash cluster, or set with 'clustername'
---------------------------------------------------------------------------------------------------------------
K8$
```

At this prompt you can invoke all the kubash commands in a read loop,
this can eliminate alot of typing while interacting with a cluster.
There are a few special commands that you can invoke in the interactive
shell. `name EXAMPLE` will set the name of the cluster that you are
interacting with. `verbosity 10` will set the verbosity to 10. `v` will
increment the verbosity up one.
see the [Interactive Mode](./docs/interactive.md) documentation

### Parallel jobs

Expand Down
28 changes: 28 additions & 0 deletions docs/debug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### Debugging

First start by adding a few -vvv to the command to bump up the verbosity e.g.

```
kubash -vvvvv init
```

or

```
kubash --verbosity 22 init
```

Alternatively there is an environment variable `VERBOSITY`

```
export VERBOSITY=25
kubash init
```

And you can also add a debug flag:

```
kubash --debug --verbosity 100 init
```

try `kubash COMMAND --help`
20 changes: 20 additions & 0 deletions docs/interactive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### Interactive Mode

`kubash` -- alone will invoke an interactive shell (or if you prefer
`kubash interactive`)

```
### Kubash, by Josh Cox
---------------------------------------------------------------------------------------------------------------
Interactive Kubash Shell Enter 'help' for help, or 'quit' to quit
working with the default kubash cluster, or set with 'clustername'
---------------------------------------------------------------------------------------------------------------
K8$
```

At this prompt you can invoke all the kubash commands in a read loop,
this can eliminate alot of typing while interacting with a cluster.
There are a few special commands that you can invoke in the interactive
shell. `name EXAMPLE` will set the name of the cluster that you are
interacting with. `verbosity 10` will set the verbosity to 10. `v` will
increment the verbosity up one.

0 comments on commit 58c1d46

Please sign in to comment.