Docs: Include high-level Armada synposis
This PS includes Armada's original [0] high-level synposis which
laid out the vision, scope and "mission statement" for Armada.
Due to its helpfulness, it has been reincluded in the README
to give the overarching community a broader understanding
and introduction to Armada.
[0] 501d3d5ca2 (diff-7db4e77bbb908aef69baf34d5ef9d340)
Change-Id: I37065f28a73e2008f9e011c3a32af9772f70c64a
This commit is contained in:
parent
cc322b6f73
commit
f2658260e1
34
README.rst
34
README.rst
|
@ -3,9 +3,37 @@ Armada
|
||||||
|
|
||||||
|Docker Repository on Quay| |Build Status| |Doc Status|
|
|Docker Repository on Quay| |Build Status| |Doc Status|
|
||||||
|
|
||||||
Armada is a tool for managing multiple Helm charts with dependencies by centralizing
|
Armada is a tool for managing multiple Helm charts with dependencies by
|
||||||
all configurations in a single Armada YAML and providing lifecycle
|
centralizing all configurations in a single Armada YAML and providing
|
||||||
hooks for all Helm releases.
|
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:
|
Armada consists of two separate but complementary components:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue