{"id":13740107,"url":"https://github.com/att-comdev/armada","last_synced_at":"2025-05-08T19:35:44.378Z","repository":{"id":71423523,"uuid":"81268667","full_name":"att-comdev/armada","owner":"att-comdev","description":"This project has moved to OpenStack.","archived":true,"fork":false,"pushed_at":"2018-07-06T04:16:08.000Z","size":1687,"stargazers_count":78,"open_issues_count":32,"forks_count":35,"subscribers_count":36,"default_branch":"master","last_synced_at":"2024-08-04T04:06:07.996Z","etag":null,"topics":["helm","kubernetes","python"],"latest_commit_sha":null,"homepage":"https://www.airshipit.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/att-comdev.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.rst","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-08T00:14:49.000Z","updated_at":"2023-01-28T20:20:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"805302ec-988b-4791-88f8-101a71dab3f6","html_url":"https://github.com/att-comdev/armada","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/att-comdev%2Farmada","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/att-comdev%2Farmada/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/att-comdev%2Farmada/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/att-comdev%2Farmada/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/att-comdev","download_url":"https://codeload.github.com/att-comdev/armada/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224758285,"owners_count":17364976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helm","kubernetes","python"],"created_at":"2024-08-03T04:00:42.730Z","updated_at":"2024-11-15T09:31:04.472Z","avatar_url":"https://github.com/att-comdev.png","language":"Python","funding_links":[],"categories":["Continuous Delivery \u0026 GitOps","Configuration Management"],"sub_categories":[],"readme":"Armada\n======\n\n|Docker Repository on Quay| |Doc Status|\n\nArmada is a tool for managing multiple Helm charts with dependencies by\ncentralizing all configurations in a single Armada YAML and providing\nlife-cycle hooks for all Helm releases.\n\nFind more documentation for Armada on `Read The Docs \u003chttps://armada-helm.readthedocs.io/\u003e`_.\n\nOverview\n--------\n\nThe Armada Python library and command line tool provide a way to\nsynchronize a Helm (Tiller) target with an operator's intended state,\nconsisting of several charts, dependencies, and overrides using a single file\nor directory with a collection of files. This allows operators to define many\ncharts, potentially with different namespaces for those releases, and their\noverrides in a central place. With a single command, deploy and/or upgrade them\nwhere applicable.\n\nArmada also supports fetching Helm chart source and then building charts from\nsource from various local and remote locations, such as Git endpoints, tarballs\nor local directories.\n\nIt will also give the operator some indication of what is about to change by\nassisting with diffs for both values, values overrides, and actual template\nchanges.\n\nIts functionality extends beyond Helm, assisting in interacting with Kubernetes\ndirectly to perform basic pre- and post-steps, such as removing completed or\nfailed jobs, running backup jobs, blocking on chart readiness, or deleting\nresources that do not support upgrades. However, primarily, it is an interface\nto support orchestrating Helm.\n\nComponents\n----------\n\nArmada consists of two separate but complementary components:\n\n#. CLI component (**mandatory**) which interfaces directly with `Tiller`_.\n#. API component (**optional**) which services user requests through a wsgi\n   server (which in turn communicates with the `Tiller`_ server) and provides\n   the following additional functionality:\n\n   * Role-Based Access Control.\n   * Limiting projects to specific `Tiller`_ functionality by leveraging\n     project-scoping provided by `Keystone`_.\n\nRoadmap\n-------\n\nDetailed roadmap can be viewed `here \u003chttps://github.com/att-comdev/armada/milestones\u003e`_.\n\nIssues can be reported `on GitHub \u003chttps://github.com/att-comdev/armada/issues\u003e`_.\n\nInstallation\n------------\n\nQuick Start (via Container)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nArmada can be most easily installed as a container, which requires Docker to be\nexecuted. To install Docker, please reference the following\n`install guide \u003chttps://docs.docker.com/engine/installation/\u003e`_.\n\nAfterward, you can launch the Armada container by executing:\n\n.. code-block:: bash\n\n    $ sudo docker run -d --net host -p 8000:8000 --name armada \\\n        -v ~/.kube/config:/armada/.kube/config \\\n        -v $(pwd)/examples/:/examples quay.io/attcomdev/armada:latest\n\nManual Installation\n^^^^^^^^^^^^^^^^^^^\n\nFor a comprehensive manual installation guide, please\nsee `Manual Install Guide`_.\n\nUsage\n^^^^^\n\nTo run Armada, simply supply it with your YAML-based intention for any\nnumber of charts::\n\n  $ armada apply examples/openstack-helm.yaml [ --debug ]\n\nWhich should output something like this::\n\n  $ armada apply examples/openstack-helm.yaml 2017-02-10 09:42:36,753\n\n    armada INFO Cloning git:\n    ...\n\nFor more information on how to install and use Armada, please reference:\n`Armada Quickstart`_.\n\nIntegration Points\n------------------\n\nArmada CLI component has the following integration points:\n\n  * `Tiller`_ manages Armada chart installations.\n  * `Deckhand`_ supplies storage and management of site designs and secrets.\n\nIn addition, Armada's API component has the following integration points:\n\n  * `Keystone`_ (OpenStack's identity service) provides authentication and\n    support for role-based authorization.\n\nFurther Reading\n---------------\n\n`Undercloud Platform (UCP) \u003chttps://github.com/att-comdev/ucp-integration\u003e`_.\n\n.. _Manual Install Guide: http://armada-helm.readthedocs.io/en/latest/development/getting-started.html#developer-install-guide\n.. _Armada Quickstart: http://armada-helm.readthedocs.io/en/latest/operations/guide-use-armada.html\n.. _kubectl: https://kubernetes.io/docs/user-guide/kubectl/kubectl_config/\n.. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation\n.. _Deckhand: https://github.com/openstack/deckhand\n.. _Keystone: https://github.com/openstack/keystone\n\n.. |Docker Repository on Quay| image:: https://quay.io/repository/attcomdev/armada/status\n   :target: https://quay.io/repository/attcomdev/armada\n.. |Doc Status| image:: https://readthedocs.org/projects/armada-helm/badge/?version=latest\n   :target: http://armada-helm.readthedocs.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatt-comdev%2Farmada","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatt-comdev%2Farmada","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatt-comdev%2Farmada/lists"}