An orchestrator for managing a collection of Kubernetes Helm charts.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 9886cb1a5e Merge "CI: Update Airskiff full-site manifest location" 2 days ago
armada Merge "Don't log metrics HTTP data" 2 days ago
charts Implement Prometheus metric integration 1 week ago
doc Support builtin chart dependencies 2 days ago
etc/armada Add viewer rule to armada API 10 months ago
examples Support builtin chart dependencies 2 days ago
hapi Revert "Move to helm 2.14" 2 months ago
images/armada Updating pip reference to pip3 for upgrade 1 week ago
releasenotes feat(reno): add reno 1 year ago
swagger Change various URLs for the OpenDev migration 4 weeks ago
tools CI: Update Airskiff full-site manifest location 3 days ago
.coveragerc fix(coverage): add coverage rc file 1 year ago
.dockerignore Update .dockerignore to trim image 6 months ago
.editorconfig style(armada): quality of life and cleanup 1 year ago
.gitignore Add .stestr and cover to .gitignore 1 year ago
.gitreview OpenDev Migration Patch 4 months ago
.stestr.conf fix(coverage): add coverage rc file 1 year ago
.style.yapf Standardize Armada code with YAPF 3 weeks ago
.zuul.yaml Removing flag added to opensuse gate job to make it non-voting 5 days ago
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 1 year ago
LICENSE Initial commit 2 years ago
Makefile Standardize Armada code with YAPF 3 weeks ago
README.rst Implement Prometheus metric integration 1 week ago
controller.sh Updating Quay Namespace to airshipit 1 year ago
entrypoint.sh Implement Prometheus metric integration 1 week ago
plugin.yaml Bump tiller version to 2.7.2 in armada.handlers.tiller 1 year ago
requirements.txt Implement Prometheus metric integration 1 week ago
setup.cfg Add airship-discuss@lists.airshipit.org 7 months ago
setup.py Adding yapf config, plus formatted code. 1 year ago
test-requirements.txt Standardize Armada code with YAPF 3 weeks ago
tox.ini Standardize Armada code with YAPF 3 weeks ago

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:

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 is one of the supported control document sources for Armada.
  • Prometheus exporter is provided for metric data related to application of charts and collections of charts. See metrics.

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.