Skip to content

Commit

Permalink
Add kando output to docs (#4175)
Browse files Browse the repository at this point in the history
  • Loading branch information
pavannd1 authored and Ilya Kislenko committed Oct 19, 2018
1 parent 38f228e commit 993b685
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions docs/tooling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,14 +297,18 @@ object store like AWS S3. We've found it can be cumbersome to pass Profile
configuration to tools like the AWS command line from inside Blueprints.
`kando` is a tool to simplify object store interactions from within blueprints.
It has three commands:
It also provides a way to create desired output from a blueprint phase.
It has the following commands:
* `location push`
* `location pull`
* `location delete`
* `output`
The usage for these commands can be displayed using the `--help` flag:
.. code-block:: bash
Expand Down Expand Up @@ -339,18 +343,29 @@ The usage for these commands can be displayed using the `--help` flag:
.. code-block:: bash
$ kando location delete --help
Delete artifacts from s3-compliant object storage
$ kando location delete --help
Delete artifacts from s3-compliant object storage
Usage:
kando location delete [flags]
Flags:
-h, --help help for delete
Global Flags:
-s, --path string Specify a path suffix (optional)
-p, --profile string Pass a Profile as a JSON string (required)
Usage:
kando location delete [flags]
.. code-block:: bash
Flags:
-h, --help help for delete
$ kando output --help
Create phase output with given key:value
Global Flags:
-s, --path string Specify a path suffix (optional)
-p, --profile string Pass a Profile as a JSON string (required)
Usage:
kando output <key> <value> [flags]
Flags:
-h, --help help for output
The following snippet is an example of using kando from inside a Blueprint.
Expand All @@ -360,6 +375,7 @@ The following snippet is an example of using kando from inside a Blueprint.
kando location delete --profile '{{ .Profile }}' --path '/backup/path'
kando output version 0.13.0
Docker Image
============
Expand Down

0 comments on commit 993b685

Please sign in to comment.