airship
/
armada
Code Issues Proposed changes
An orchestrator for managing a collection of Kubernetes Helm charts.
166 Commits 5 Branches 0 Tags 7.5 MiB
Python 97.1%
Shell 1.7%
Makefile 1.2%
Go to file
Felipe Monteiro 03e9fc290c docs(readme): Update Armada README/installation documentation 
This PS revamps the Armada README and installation documentation
to increase clarity about how to install and use Armada, and
provide additional resource links to aid installation.

This PS also fixes a few typos with the current readme.

Change-Id: I6fafe8be8a2caf67c5bdecf5d5e682b580332e63
 		2018-01-22 17:07:29 -05:00
.github [bug] fixing-chart-diff-check 2017-04-27 08:54:09 -05:00
armada Fix: Address typos and error in Armada output 2018-01-19 17:22:24 -06:00
charts Add general env configuration to Armada API 2018-01-22 10:52:40 -06:00
docs/source docs(readme): Update Armada README/installation documentation 2018-01-22 17:07:29 -05:00
etc/armada feat(chart): adding-tiller-service 2017-12-07 20:33:22 +00:00
examples fix(tiller): pre-delete-actions 2017-11-03 20:41:52 +00:00
hapi feat(armada): adding makefile 2017-11-16 19:47:04 +00:00
tools feat(armada): adding makefile 2017-11-16 19:47:04 +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(readme): Update Armada README/installation documentation 2018-01-22 17:07:29 -05: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 feat(yaml): Support document references 2018-01-08 13:39:26 -06: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 lifecycle hooks for all Helm releases.

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