An orchestrator for managing a collection of Kubernetes Helm charts.
Go to file
Iago Estrela ddbdd7256c Tolerate 404 Response for non existing resource
Armada raises an exception for the 404 response from the Kubernetes
API if the resource was not found. However, some resources, like
jobs, are "volatile" they may disappear after some minutes. The
armada may send a DELETE request to the Kubernetes API after the job
finished its lifecycle. In this situation the job will not be found
in the cluster and the armada will break some application reapply due
to this behavior. Therefore, a possible solution may be check, at
least for the job resource type, whether the response returned from
the Kubernetes API is 404, if it is then just log the API response
error reason and continue trying to delete the remaining jobs in the
list, otherwise we raise the exception.

Partial-Bug: 1948850

Signed-off-by: Iago Estrela <IagoFilipe.EstrelaBarros@windriver.com>
Change-Id: I12ee8cef869e4443920d7f2e1899556e8940a977
2021-10-26 18:04:57 -03:00
.github Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +00:00
armada Tolerate 404 Response for non existing resource 2021-10-26 18:04:57 -03:00
charts Add "labels" to Armada deployment 2021-06-03 15:11:26 +00:00
doc Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +00:00
etc/armada Add viewer rule to armada API 2018-10-16 17:20:25 +00:00
examples Support builtin chart dependencies 2019-08-22 08:13:03 -05:00
hapi Move Tiller version to 2.16.9 2020-09-17 10:48:44 -05:00
images/armada Fix gates (helm install, xenial image) 2021-02-28 06:35:16 +00:00
manifests Airship 2 support features 2020-03-25 13:56:32 -05:00
releasenotes feat(reno): add reno 2018-06-01 21:58:18 +00:00
swagger api: Remove dry-run parameter 2019-09-05 16:29:04 +00:00
tools Gate fixes 2021-09-30 17:21:33 -05:00
.coveragerc fix(coverage): add coverage rc file 2018-06-08 06:42:57 +00:00
.dockerignore Update .dockerignore to trim image 2019-01-30 15:36:40 -06:00
.editorconfig style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.gitignore Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:21 +00:00
.readthedocs.yaml Fix: Armada Exceptions docs rendering on RTD 2019-08-27 22:57:52 +02: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 Gate fixes for Armada 2021-06-02 14:45:14 -07: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 Fix: Armada Exceptions docs rendering on RTD 2019-08-27 22:57:52 +02:00
README.rst Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +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 Bump tiller version to 2.7.2 in armada.handlers.tiller 2018-02-13 15:38:00 -05:00
requirements.txt Gate fixes 2021-09-30 17:21:33 -05:00
setup.cfg Add documentation to docs.airshipit.org 2020-08-03 10:33:13 +00:00
setup.py setup.py: remove executable bit 2019-09-30 11:26:52 -07:00
test-requirements.txt Gate fix for py36 2021-06-22 16:01:05 +00:00
tox.ini Standardize Armada code with YAPF 2019-07-31 10:16:15 -05: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 (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-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:

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