177b20185a
This removes the API guide as it was out of date, and the recently added swagger docs are much more accurate and useful. Ideally we should implement hosting of the swagger docs somewhere, but not much benefit in continuing to host an inaccurate api guide in the meantime. Change-Id: I4bee4dda7332e1c8ca1a60aa15c793efb937375f |
||
|---|---|---|
| armada | ||
| charts | ||
| doc | ||
| etc/armada | ||
| examples | ||
| hapi | ||
| releasenotes | ||
| swagger | ||
| tools | ||
| .coveragerc | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .gitreview | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| controller.sh | ||
| Dockerfile | ||
| entrypoint.sh | ||
| LICENSE | ||
| Makefile | ||
| plugin.yaml | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Armada
Armada is a tool for managing multiple Helm charts with dependencies by centralizing all configurations in a single Armada YAML and providing life-cycle hooks for all Helm releases.
Find more documentation for Armada on Read The Docs.
Overview
The Armada Python library and command line tool provide a way to synchronize a Helm (Tiller) target with an operator's intended state, consisting of several charts, dependencies, and overrides using a single file or directory with a collection of files. This allows operators to define many charts, potentially with different namespaces for those releases, and their overrides in a central place. With a single command, deploy and/or upgrade them where applicable.
Armada also supports fetching Helm chart source and then building charts from source from various local and remote locations, such as Git endpoints, tarballs or local directories.
It will also give the operator some indication of what is about to change by assisting with diffs for both values, values overrides, and actual template changes.
Its functionality extends beyond Helm, assisting in interacting with Kubernetes directly to perform basic pre- and post-steps, such as removing completed or failed jobs, running backup jobs, blocking on chart readiness, or deleting resources that do not support upgrades. However, primarily, it is an interface to support orchestrating Helm.
Components
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:
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:latestManual Installation
For a comprehensive manual installation guide, please see Manual Install Guide.
Usage
To run Armada, simply supply it with your YAML-based intention for any number of charts:
$ armada apply examples/openstack-helm.yaml [ --debug ]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: Armada Quickstart.
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.