An orchestrator for managing a collection of Kubernetes Helm charts.
Go to file
SPEARS, DUSTIN (ds443n) 7c1865b7db Update helm to v3.14.2
Change-Id: I6952261625d74a7a2205b34b3fe08b02afab6089
2024-03-15 14:04:42 -04:00
.github Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +00:00
armada Airflow stable 2.8.1 2024-02-21 22:24:46 +00:00
charts Use designated image for chart test 2024-03-08 15:21:45 -06:00
doc Airflow stable 2.6.2 2023-08-19 00:37:37 +00:00
etc/armada Airflow stable 2.6.2 2023-08-19 00:37:37 +00:00
examples Use helm 3 CLI as backend 2021-10-04 21:40:26 -05:00
images/armada Kubeadm based Airskiff gate 2024-03-13 15:11:30 +00:00
releasenotes Bump helm version from 3.6.3 to 3.8.2 2022-06-30 22:19:56 -05:00
tools Update helm to v3.14.2 2024-03-15 14:04:42 -04:00
.coveragerc fix(coverage): add coverage rc file 2018-06-08 06:42:57 +00:00
.dockerignore Remove unused commands 2021-09-30 17:22:16 -05:00
.editorconfig style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.gitignore Removing egg-info folder 2023-04-26 22:17:11 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:21 +00:00
.readthedocs.yaml Update armada image run test 2023-05-24 20:14:32 +00:00
.stestr.conf fix(coverage): add coverage rc file 2018-06-08 06:42:57 +00:00
.style.yapf Standardize Armada code with YAPF 2019-07-31 10:16:15 -05:00
.zuul.yaml Update helm to v3.14.2 2024-03-15 14:04:42 -04:00
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 2018-05-21 23:58:04 +00:00
LICENSE Initial commit 2017-02-07 16:14:49 -08:00
Makefile Update helm to v3.14.2 2024-03-15 14:04:42 -04:00
README.rst Remove Tiller 2021-10-05 02:41:32 +00:00
bindep.txt [focal] Python modules sync with Airship project 2023-04-21 23:49:14 +00:00
controller.sh Updating Quay Namespace to airshipit 2018-08-15 09:43:30 -05:00
entrypoint.sh images: Create single metrics dir in entrypoint 2019-10-11 10:11:16 -05:00
plugin.yaml Remove Tiller 2021-10-05 02:41:32 +00:00
requirements-direct.txt Airflow stable 2.8.2 2024-02-26 21:00:58 +00:00
requirements-frozen.txt Airflow stable 2.8.2 2024-02-26 21:00:58 +00:00
requirements.txt [focal] Python modules sync with Airship project 2023-04-21 23:49:14 +00:00
setup.cfg Restored ubuntu_bionic image build 2023-05-19 13:52:30 +00:00
setup.py Bump helm version from 3.6.3 to 3.8.2 2022-06-30 22:19:56 -05:00
test-requirements.txt Deprecating the Ingress Class Annotation 2023-10-05 22:55:39 +00:00
tox.ini Airflow stable 2.8.2 2024-02-26 21:00:58 +00:00

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.