An orchestrator for managing a collection of Kubernetes Helm charts.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Sergiy Markin 812546c875 Update armada image run test
This PS improves armada image run test by enriching it with config
generator. Also this test was removed from make images section of
Makefile. Build images zuul gate has make run_images task to test
the freshly built image now.

Change-Id: I87e089e5d268d248cda1dad1cd417694d166fdfb
3 days ago
.github Add documentation to docs.airshipit.org 3 years ago
armada Armada timeout adjustment 2 weeks ago
charts Attempt to fix Armada self-upgrade race condition 2 years ago
doc Sync requirements with shipyard 1 month ago
etc/armada Armada updates 4 weeks ago
examples Use helm 3 CLI as backend 2 years ago
images/armada Update armada image run test 3 days ago
releasenotes Bump helm version from 3.6.3 to 3.8.2 11 months ago
tools Update armada image run test 3 days ago
.coveragerc fix(coverage): add coverage rc file 5 years ago
.dockerignore Remove unused commands 2 years ago
.editorconfig style(armada): quality of life and cleanup 5 years ago
.gitignore Removing egg-info folder 1 month ago
.gitreview OpenDev Migration Patch 4 years ago
.readthedocs.yaml Update armada image run test 3 days ago
.stestr.conf fix(coverage): add coverage rc file 5 years ago
.style.yapf Standardize Armada code with YAPF 4 years ago
.zuul.yaml Update armada image run test 3 days ago
CONTRIBUTING.rst docs(contributing): update CONTRIBUTING.rst 5 years ago
LICENSE Initial commit 6 years ago
Makefile Update armada image run test 3 days ago
README.rst Remove Tiller 2 years ago
bindep.txt [focal] Python modules sync with Airship project 1 month ago
controller.sh Updating Quay Namespace to airshipit 5 years ago
entrypoint.sh images: Create single metrics dir in entrypoint 4 years ago
plugin.yaml Remove Tiller 2 years ago
requirements-direct.txt Re-add missed paste module 4 weeks ago
requirements-frozen-bionic.txt Restored ubuntu_bionic image build 1 week ago
requirements-frozen.txt Re-add missed paste module 4 weeks ago
requirements.txt [focal] Python modules sync with Airship project 1 month ago
setup.cfg Restored ubuntu_bionic image build 1 week ago
setup.py Bump helm version from 3.6.3 to 3.8.2 11 months ago
test-requirements.txt [focal] Python modules sync with Airship project 1 month ago
tox.ini Restored ubuntu_bionic image build 1 week 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.