03e9fc290c
This PS revamps the Armada README and installation documentation to increase clarity about how to install and use Armada, and provide additional resource links to aid installation. This PS also fixes a few typos with the current readme. Change-Id: I6fafe8be8a2caf67c5bdecf5d5e682b580332e63 |
||
---|---|---|
.github | ||
armada | ||
charts | ||
docs/source | ||
etc/armada | ||
examples | ||
hapi | ||
tools | ||
.dockerignore | ||
.gitignore | ||
.gitreview | ||
.travis.yml | ||
CODE_OF_CONDUCT.rst | ||
CONTRIBUTING.rst | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
OWNERS | ||
README.rst | ||
controller.sh | ||
entrypoint.sh | ||
plugin.yaml | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
Armada
Armada is a tool for managing multiple Helm charts with dependencies by centralizing all configurations in a single Armada YAML and providing lifecycle hooks for all Helm releases.
Armada consists of two separate but complementary components:
- CLI component (mandatory) which interfaces directly with Tiller.
- API component (optional) which services user requests through a wsgi server (which in turn communicates with the Tiller server) and provides the following additional functionality:
Roadmap
Detailed roadmap can be viewed here.
Issues can be reported on GitHub.
Installation
Quick Start (via Container)
Armada can be most easily installed as a container, which requires Docker to be executed. To install Docker, please reference the following install guide.
Afterward, you can launch the Armada container by executing:
$ sudo docker run -d --net host -p 8000:8000 --name armada \
-v ~/.kube/config:/armada/.kube/config \
-v $(pwd)/examples/:/examples quay.io/attcomdev/armada:latest
Manual Installation
For a comprehensive manual installation guide, please see dev-getting-started
.
Usage
To run Armada, simply supply it with your YAML-based intention for any number of charts:
$ armada apply examples/openstack-helm.yaml [--debug-loggging ]
Which should output something like this:
$ armada apply examples/openstack-helm.yaml 2017-02-10 09:42:36,753
armada INFO Cloning git:
...
For more information on how to install and use Armada, please
reference: guide-use-armada
.
Integration Points
Armada CLI component has the following integration points:
In addition, Armada's API component has the following integration points:
- Keystone (OpenStack's identity service) provides authentication and support for role-based authorization.