An orchestrator for managing a collection of Kubernetes Helm charts.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
armada bugfix: Looking in wrong place for upgrade options Jan 18, 2019
charts Merge "Add viewer rule to armada API" Oct 19, 2018
doc test: Refactor test handler Nov 29, 2018
etc/armada Add viewer rule to armada API Oct 16, 2018
examples Add chart about rabbitmq and remove timeout from example Dec 5, 2018
hapi Move to tiller 2.12.1 Jan 11, 2019
releasenotes feat(reno): add reno Jun 1, 2018
swagger test: Refactor test handler Nov 29, 2018
tools CI: Remove OpenStack-Helm-Infra CI job Jan 17, 2019
.coveragerc fix(coverage): add coverage rc file Jun 8, 2018
.dockerignore style(armada): quality of life and cleanup Feb 12, 2018
.editorconfig style(armada): quality of life and cleanup Feb 12, 2018
.gitignore Add .stestr and cover to .gitignore Jun 13, 2018
.gitreview Update .gitreview for openstack infra May 17, 2018
.stestr.conf fix(coverage): add coverage rc file Jun 8, 2018
.zuul.yaml CI: Remove OpenStack-Helm-Infra CI job Jan 17, 2019
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst May 21, 2018
Dockerfile Making Python version uniform across all airship components. Oct 20, 2018
LICENSE Initial commit Feb 8, 2017
Makefile Create Makefile target to install Helm binary Nov 13, 2018
README.rst trivial: Fix README documentation badge Oct 2, 2018
controller.sh Updating Quay Namespace to airshipit Aug 15, 2018
entrypoint.sh api: Update entrypoint script with proper quotes Oct 10, 2018
plugin.yaml Bump tiller version to 2.7.2 in armada.handlers.tiller Feb 13, 2018
requirements.txt Implement tiller gRPC channel clean up Nov 12, 2018
setup.cfg Making Python version uniform across all airship components. Oct 20, 2018
setup.py Adding yapf config, plus formatted code. Jun 22, 2018
test-requirements.txt Fix for yapf v0.24.0 Sep 11, 2018
tox.ini Fix Flake8 3.6.0 errors Oct 26, 2018

README.rst

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/airshipit/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.