airship
/
armada
Code Issues Proposed changes
An orchestrator for managing a collection of Kubernetes Helm charts.
188 Commits 5 Branches 0 Tags 7.5 MiB
Python 97.1%
Shell 1.7%
Makefile 1.2%
Go to file
Felipe Monteiro 39b5a876fe Add unit tests for Manifest handler 
Change-Id: Ia7e1c0861cb79b78a65ad95f50729a85a874a892
 		2018-02-05 17:14:12 -05:00
.github [bug] fixing-chart-diff-check 2017-04-27 08:54:09 -05:00
armada Add unit tests for Manifest handler 2018-02-05 17:14:12 -05:00
charts Update RBAC rules for Armada API 2018-01-29 15:17:55 +00:00
docs/source Merge "feat(tiller): adding namespace flag" 2018-01-30 15:34:56 -05:00
etc/armada feat(tiller): adding namespace flag 2018-01-30 17:25:03 +00:00
examples Add unit tests for Manifest handler 2018-02-05 17:14:12 -05:00
hapi feat(armada): adding makefile 2017-11-16 19:47:04 +00:00
tools bug(tox): Support regular expressions via tox -e py35 2018-01-22 23:07:57 +00:00
.dockerignore feat(cli): using-click-framework 2017-11-02 20:59:57 +00:00
.gitignore feat(cli): using-click-framework 2017-11-02 20:59:57 +00:00
.gitreview Add gitreview file 2017-08-11 01:17:05 -05:00
.travis.yml Migrate from pygit2 to GitPython 2017-08-09 21:20:25 +00:00
CODE_OF_CONDUCT.rst feat(armada): adding makefile 2017-11-16 19:47:04 +00:00
CONTRIBUTING.rst docs(links): Fix broken links 2017-11-26 17:04:20 -06:00
Dockerfile feat(yaml): Support document references 2018-01-08 13:39:26 -06:00
LICENSE Initial commit 2017-02-07 16:14:49 -08:00
Makefile feat(armada): adding makefile 2017-11-16 19:47:04 +00:00
OWNERS [Feature] [Docs] owners-list-and-issue-standards 2017-02-15 09:26:24 -06:00
README.rst Docs: Include high-level Armada synposis 2018-01-30 17:38:28 +00:00
controller.sh feat(main): Armada as a plugin 2017-09-28 14:39:23 -04:00
entrypoint.sh feat(cli): using-click-framework 2017-11-02 20:59:57 +00:00
plugin.yaml feat(main): Armada as a plugin 2017-09-28 14:39:23 -04:00
requirements.txt feat(cli): using-click-framework 2017-11-02 20:59:57 +00:00
setup.cfg feat(cli): using-click-framework 2017-11-02 20:59:57 +00: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 tests(git): Unskip git tests and add conditional skip test. 2018-01-22 21:09:26 -05:00

README.rst

Armada

Docker Repository on Quay Build Status 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-loggging ]

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