An orchestrator for managing a collection of Kubernetes Helm charts.
Go to file
Sean Eagan 623c5056d8 Defend against uninitialized fields in k8s objects
Much of these may be unnecessary, but this code was adapted from
go code which handles uninitialized values better via "zero values",
also the k8s python client docs show most of these fields as
"optional".

Hence, initializing leaf values in these model objects to avoid
further surprises.

Change-Id: Ib646b56dfe1ff83f0ecbedaf73fcde8ffa2be0cf
2019-02-08 11:24:57 -06:00
armada Defend against uninitialized fields in k8s objects 2019-02-08 11:24:57 -06:00
charts Merge "Update missed refs to tiller 2.12.1" 2019-02-04 20:28:16 +00:00
doc Add configurability of delete timeout 2019-01-29 16:49:01 -06:00
etc/armada Add viewer rule to armada API 2018-10-16 17:20:25 +00:00
examples Add chart about rabbitmq and remove timeout from example 2018-12-05 19:00:16 +08:00
hapi Move to tiller 2.12.1 2019-01-11 10:52:17 -06:00
releasenotes feat(reno): add reno 2018-06-01 21:58:18 +00:00
swagger test: Refactor test handler 2018-11-29 17:30:57 +00:00
tools Merge "Update missed refs to tiller 2.12.1" 2019-02-04 20:28:16 +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 .stestr and cover to .gitignore 2018-06-13 11:41:59 -05: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 CI: Add chart build gate 2019-01-28 11:35:58 -06:00
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 2018-05-21 23:58:04 +00:00
Dockerfile Switch to ubuntu base image 2019-01-30 14:29:07 -06:00
LICENSE Initial commit 2017-02-07 16:14:49 -08:00
Makefile Use UBUNTU_BASE_IMAGE instead of BASE_IMAGE 2019-02-06 17:04:02 -06:00
README.rst trivial: Fix README documentation badge 2018-10-02 18:35:58 -05:00
controller.sh Updating Quay Namespace to airshipit 2018-08-15 09:43:30 -05:00
entrypoint.sh api: Update entrypoint script with proper quotes 2018-10-10 16:39:26 +00:00
plugin.yaml Bump tiller version to 2.7.2 in armada.handlers.tiller 2018-02-13 15:38:00 -05:00
requirements.txt Move grpc tools to test requirements 2019-01-29 13:12:56 -06:00
setup.cfg Add airship-discuss@lists.airshipit.org 2019-01-20 11:34:57 +00:00
setup.py Adding yapf config, plus formatted code. 2018-06-22 14:56:04 -05:00
test-requirements.txt Move grpc tools to test requirements 2019-01-29 13:12:56 -06:00
tox.ini Fix Flake8 3.6.0 errors 2018-10-26 09:23:42 -04:00

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.