An orchestrator for managing a collection of Kubernetes Helm charts.
Go to file
Sean Eagan 177b20185a Remove api guide in favor of swagger Docs
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
2018-06-11 12:00:34 -05:00
armada Add command to rollback release to CLI and API 2018-06-06 09:40:31 -05:00
charts Add command to rollback release to CLI and API 2018-06-06 09:40:31 -05:00
doc Remove api guide in favor of swagger Docs 2018-06-11 12:00:34 -05:00
etc/armada Add command to rollback release to CLI and API 2018-06-06 09:40:31 -05:00
examples Update HTK Path - OSH Infra 2018-05-16 05:02:43 +00:00
hapi feat(hapi) updating hapi for new grpcio 2018-03-09 22:33:39 -05:00
releasenotes feat(reno): add reno 2018-06-01 21:58:18 +00:00
swagger Add command to rollback release to CLI and API 2018-06-06 09:40:31 -05:00
tools Merge "Use stestr as the test runner for unit tests" 2018-06-09 18:00:19 +00:00
.coveragerc fix(coverage): add coverage rc file 2018-06-08 06:42:57 +00:00
.dockerignore style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.editorconfig style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.gitignore Add documentation on Armada documents 2018-05-29 22:20:16 -04:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:24:51 +01:00
.stestr.conf fix(coverage): add coverage rc file 2018-06-08 06:42:57 +00:00
.zuul.yaml (zuul) Add docker image publishing 2018-06-07 16:29:52 -05:00
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 2018-05-21 23:58:04 +00:00
controller.sh style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
Dockerfile Re-sequence Dockerfile for quicker dev rebuilds 2018-02-16 12:19:42 -05:00
entrypoint.sh Updated Makefile 2018-03-15 12:40:19 -04:00
LICENSE Initial commit 2017-02-07 16:14:49 -08:00
Makefile Docker: support build behind proxy 2018-06-08 09:27:03 -05:00
plugin.yaml Bump tiller version to 2.7.2 in armada.handlers.tiller 2018-02-13 15:38:00 -05:00
README.rst Remove references to old git repos 2018-05-29 10:15:13 -05:00
requirements.txt bug(chartbuilder): uncaught exceptions on bad manifests 2018-03-29 15:15:00 -04:00
setup.cfg Rename docs to doc to align with OpenStack standard 2018-05-17 21:39:01 +00:00
setup.py [feat] adding-tox-testing 2017-08-11 16:48:57 +00:00
test-requirements.txt Use stestr as the test runner for unit tests 2018-06-08 21:50:03 +00:00
tox.ini fix tox python3 overrides 2018-06-10 15:38:40 +00:00

Armada

Docker Repository on Quay Doc Status

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:

  1. CLI component (mandatory) which interfaces directly with Tiller.
  2. 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:
    • Role-Based Access Control.
    • Limiting projects to specific Tiller functionality by leveraging project-scoping provided by Keystone.

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 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:

  • Tiller manages Armada chart installations.
  • Deckhand supplies storage and management of site designs and secrets.

In addition, Armada's API component has the following integration points:

  • Keystone (OpenStack's identity service) provides authentication and support for role-based authorization.

Further Reading

Airship.