Felipe Monteiro 085d9887e0 Rename docs to doc to align with OpenStack standard
This patchset updates docs to doc to align with OpenStack
standard. Follow-up patchset will be needed to publish
documentation to OpenStack [0].

TODO: Update Armada documentation job to align with [1].

[0] https://docs.openstack.org/doc-contrib-guide/project-guides.html
[1] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I100541611ddfcd5c42f09da631346cb8ef3de5e7
2018-05-17 21:39:01 +00:00

42 lines
1.2 KiB
ReStructuredText

Armada - Test
=============
Commands
--------
.. code:: bash
Usage: armada test [OPTIONS]
This command test deployed charts
The tiller command uses flags to obtain information from tiller services.
The test command will run the release chart tests either via a
manifest or by targeting a release.
To obtain armada deployed releases:
$ armada test --file examples/simple.yaml
To test release:
$ armada test --release blog-1
Options:
--file TEXT armada manifest
--release TEXT helm release
--tiller-host TEXT Tiller Host IP
--tiller-port INTEGER Tiller Host Port
-tn, --tiller-namespace TEXT Tiller Namespace
--target-manifest TEXT The target manifest to run. Required for
specifying which manifest to run when multiple
are available.
--help Show this message and exit.
Synopsis
--------
The test command will perform helm test defined on the release. Test command can
test a single release or a manifest.