airship
/
armada
Code Issues Proposed changes
An orchestrator for managing a collection of Kubernetes Helm charts.
215 Commits 5 Branches 0 Tags 7.5 MiB
Python 97.1%
Shell 1.7%
Makefile 1.2%
Go to file
Dae Seong Kim d59fbbbfe4 Fix to use policy.yaml 
default policy file in oslo.policy library is policy.json
NOT policy.yaml. So we need to set policy_file up in armada.conf
to use policy.yaml

Change-Id: Iad371feb2aebe712cbaa60975fec883a3f0a61ae
 		2018-02-27 01:21:36 -05:00
.github [bug] fixing-chart-diff-check 2017-04-27 08:54:09 -05:00
armada Add test for GET '/api/v1.0/test/{release}' endpoint 2018-02-25 17:57:57 -05:00
charts Fix to use policy.yaml 2018-02-27 01:21:36 -05:00
docs/source Add validation logic to Test endpoints 2018-02-25 17:57:04 -05:00
etc/armada style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
examples Improved document validation 2018-02-23 11:11:09 -05:00
hapi feat(armada): adding makefile 2017-11-16 19:47:04 +00:00
tools style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.dockerignore style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.editorconfig style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.gitignore style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
.gitreview Add gitreview file 2017-08-11 01:17:05 -05:00
CODE_OF_CONDUCT.rst style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
CONTRIBUTING.rst style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
Dockerfile Re-sequence Dockerfile for quicker dev rebuilds 2018-02-16 12:19:42 -05:00
LICENSE Initial commit 2017-02-07 16:14:49 -08:00
Makefile Update Makefile 2018-02-25 16:03:35 -05:00
README.rst style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
controller.sh style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
entrypoint.sh Add validation logic to Test endpoints 2018-02-25 17:57:04 -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 Improved document validation 2018-02-23 11:11:09 -05:00
setup.cfg style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00
setup.py [feat] adding-tox-testing 2017-08-11 16:48:57 +00:00
test-requirements.txt feat(armada): generic-exception 2017-11-29 21:42:56 +00:00
tox.ini style(armada): quality of life and cleanup 2018-02-12 10:27:11 -05:00

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.

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.

Roadmap

Detailed roadmap can be viewed here.

Issues can be reported on GitHub.

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/attcomdev/armada:latest

Manual Installation

For a comprehensive manual installation guide, please see dev-getting-started.

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: guide-use-armada.

Integration Points

Armada CLI component has the following integration points:

  • Tiller manages Armada chart installations.
  • Deckhand supplies storage and management of site designs and secrets.

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

Undercloud Platform (UCP).