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.
 
 
 
Phil Sphicas 7c432fdcb4 Update HTK stable commit (Ingress) 1 month ago
.github Add documentation to docs.airshipit.org 1 year ago
armada Fix list_release_ids() 2 months ago
charts Attempt to fix Armada self-upgrade race condition 2 months ago
doc Remove Tiller 2 months ago
etc/armada Remove Tiller 2 months ago
examples Use helm 3 CLI as backend 2 months ago
images/armada Add Helm 3 CLI to images 2 months ago
releasenotes feat(reno): add reno 4 years ago
tools Update HTK stable commit (Ingress) 1 month ago
.coveragerc fix(coverage): add coverage rc file 4 years ago
.dockerignore Remove unused commands 2 months ago
.editorconfig style(armada): quality of life and cleanup 4 years ago
.gitignore Use helm 3 in chart build 2 months ago
.gitreview OpenDev Migration Patch 3 years ago
.readthedocs.yaml Fix: Armada Exceptions docs rendering on RTD 2 years ago
.stestr.conf fix(coverage): add coverage rc file 4 years ago
.style.yapf Standardize Armada code with YAPF 2 years ago
.zuul.yaml Remove Tiller 2 months ago
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 4 years ago
LICENSE Initial commit 5 years ago
Makefile Remove Tiller 2 months ago
README.rst Remove Tiller 2 months ago
controller.sh Updating Quay Namespace to airshipit 3 years ago
entrypoint.sh images: Create single metrics dir in entrypoint 2 years ago
plugin.yaml Remove Tiller 2 months ago
requirements.txt Remove Tiller 2 months ago
setup.cfg Remove Tiller 2 months ago
setup.py setup.py: remove executable bit 2 years ago
test-requirements.txt Gate fix for py36 5 months ago
tox.ini Remove Tiller 2 months ago

README.rst

Armada

Docker Repository on Quay

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 in the Armada documentation.

Overview

The Armada Python library and command line tool provide a way to synchronize a Helm 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 Helm.
  2. API component (optional) which services user requests through a wsgi server (which in turn communicates with the Helm CLI) and provides the following additional functionality:
    • Role-Based Access Control.
    • Limiting projects to specific 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-ubuntu_bionic

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:

  • Helm 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.