9fad5cff0a
This adds a `wait.resources` key to chart documents which allows waiting on a list of k8s type+labels configurations to wait on. Initially supported types are pods, jobs, deployments, daemonsets, and statefulsets. The behavior for controller types is similar to that of `kubectl rollout status`. If `wait.resources` is omitted, it waits on pods and jobs (if any exist) as before. The existing `wait.labels` key still have the same behavior, but if `wait.resources` is also included, the labels are added to each resource wait in that array. Thus they serve to specify base labels that apply to all resources in the release, so as to not have to duplicate them. This may also be useful later for example to use them as labels to wait for when deleting a chart. Controller types additionaly have a `min_ready` field which represents the minimum amount of pods of the controller which must be ready in order for the controller to be considered ready. The value can either be an integer or a percent string e.g. "80%", similar to e.g. `maxUnavailable` in k8s. Default is "100%". This also wraps up moving the rest of the wait code into its own module. Change-Id: If72881af0c74e8f765bbb57ac5ffc8d709cd3c16
Armada
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:
- CLI component (mandatory) which interfaces directly with Tiller.
- 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:
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:latestManual 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:
In addition, Armada's API component has the following integration points:
- Keystone (OpenStack's identity service) provides authentication and support for role-based authorization.