This repository has been archived by the owner. It is now read-only.
This project has moved to OpenStack.
Clone or download
Felipe Monteiro
Felipe Monteiro [trivial] Remove unused KnownReleasesException
This patchset simply removes the unused KnownReleasesException
from the code as well as its reference in documentation. This
exception was previously removed because it wasn't needed.

Change-Id: Ie98227e14dd493f083a10a211ec2913af6625df3
Latest commit 46bf741 May 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [bug] fixing-chart-diff-check Apr 27, 2017
armada [trivial] Remove unused KnownReleasesException May 16, 2018
charts Chart: Update armada chart Apr 12, 2018
docs/source [trivial] Remove unused KnownReleasesException May 16, 2018
etc/armada Updated Makefile Mar 15, 2018
examples Update HTK Path - OSH Infra May 16, 2018
hapi feat(hapi) updating hapi for new grpcio Mar 10, 2018
swagger Add OpenAPI documentation Apr 2, 2018
tools Update HTK Path - OSH Infra May 16, 2018
.dockerignore style(armada): quality of life and cleanup Feb 12, 2018
.editorconfig style(armada): quality of life and cleanup Feb 12, 2018
.gitignore style(armada): quality of life and cleanup Feb 12, 2018
.gitreview Add gitreview file Aug 11, 2017
CODE_OF_CONDUCT.rst style(armada): quality of life and cleanup Feb 12, 2018
CONTRIBUTING.rst style(armada): quality of life and cleanup Feb 12, 2018
Dockerfile Re-sequence Dockerfile for quicker dev rebuilds Feb 16, 2018
LICENSE Initial commit Feb 8, 2017
Makefile Update HTK Path - OSH Infra May 16, 2018
README.rst feat(readme) Add readthedocs to README Mar 16, 2018
controller.sh style(armada): quality of life and cleanup Feb 12, 2018
entrypoint.sh Updated Makefile Mar 15, 2018
plugin.yaml Bump tiller version to 2.7.2 in armada.handlers.tiller Feb 13, 2018
requirements.txt bug(chartbuilder): uncaught exceptions on bad manifests Mar 29, 2018
setup.cfg style(armada): quality of life and cleanup Feb 12, 2018
setup.py [feat] adding-tox-testing Aug 11, 2017
test-requirements.txt bug(chartbuilder): uncaught exceptions on bad manifests Mar 29, 2018
tox.ini style(pep8): remove E722 exclusion May 9, 2018

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.

Find more documentation for Armada on Read The Docs.

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