Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/etkecc/agru
ansible-galaxy requirements updater is fast ansible-galaxy replacement
https://github.com/etkecc/agru
ansible cli
Last synced: about 1 month ago
JSON representation
ansible-galaxy requirements updater is fast ansible-galaxy replacement
- Host: GitHub
- URL: https://github.com/etkecc/agru
- Owner: etkecc
- License: agpl-3.0
- Created: 2024-08-11T19:30:23.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T21:02:43.000Z (2 months ago)
- Last Synced: 2024-09-27T15:04:31.994Z (about 2 months ago)
- Topics: ansible, cli
- Language: Go
- Size: 145 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# agru
* [What?](#what)
* [Why?](#why)
* [How?](#how)
* [What's the catch?](#whats-the-catch)
* [only git repos are supported](#only-git-repos-are-supported)
* [only roles are supported](#only-roles-are-supported)
* [only list/update/install/remove operations are supported](#only-listupdateinstallremove-operations-are-supported)
* [Where to get?](#where-to-get)
* [Binaries and distro-specific packages](#binaries-and-distro-specific-packages)
* [Build yourself](#build-yourself)
* [Who uses it?](#who-uses-it)
## What?
**a**nsible-**g**alaxy **r**equirements **u**pdater is fast ansible-galaxy replacement with the following features:
* update requirements.yml file if a newer git tag (role version) is available
* update installed roles only when new version is present in requirements file
* install missing roles
* full backwards-compatibility with `ansible-galaxy`, yes, even the odd trailing space in the galaxy-installed roles' meta/.galaxy_install_info is present
## Why?
We at [etke.cc](https://etke.cc) developing and maintainining a lot of [Ansible roles](https://github.com/orgs/mother-of-all-self-hosting/repositories) and playbooks ([MDAD](https://github.com/spantaleev/matrix-docker-ansible-deploy), [MASH](https://github.com/mother-of-all-self-hosting/mash-playbook), [etke.cc](https://gitlab.com/etke.cc/ansible/)).
And we developed A.G.R.U., because `ansible-galaxy` is slow, **very** slow. And irrational. And it misses some functions.
* You updated some role's version in requirements file? Sorry, `ansible-galaxy install -r requirements.yml -p roles/galaxy/` can't install it, you have to use `--force` or remove the dir manually. A.G.R.U. does that automatically
* You have 100500 roles in your requirements file and you have to manually check each of them if a newer tag is available? A.G.R.U. does that automatically
* Roles installation takes ages with `ansible-galaxy`? A.G.R.U. needs a fraction of that time to install everything
While initially it was for maintainers needs, we made it useful for everyone.
All our playbooks have a nice `just update` command (for maintainers: `just update -u`), which updates the playbook itself and installs all the roles. And it's fast.
## How?
```bash
Usage of agru:
-c cleanup temporary files (default true)
-d string
delete installed role, all other flags are ignored
-i install missing roles (default true)
-l list installed roles
-p string
path to install roles (default "roles/galaxy/")
-r string
ansible-galaxy requirements file (default "requirements.yml")
-u update requirements file if newer versions are available
-v verbose output
```
**list installed roles**
```bash
$ agru -l
```
**install role from the requirements file**
```bash
$ agru
```
**update requirements file if newer versions are available**
```bash
$ agru -u
```
**remove already installed role**
```bash
$ agru -d traefik
```
## What's the catch?
Do you think A.G.R.U. is too good to be true? Well, it's true, but it has limitations:
### only git repos are supported
does **not** work:
```yaml
- src: geerlingguy.docker
version: 6.1.0
```
**does** work:
```yaml
- src: git+https://github.com/geerlingguy/ansible-role-docker
name: geerlingguy.docker
version: 6.1.0
```
### only roles are supported
No collections at this moment, at all.
### only list/update/install/remove operations are supported
Ansible Galaxy API is not used at all, thus no API-related actions are supported
## Where to get?
### Binaries and distro-specific packages
[Releases page](https://github.com/etkecc/agru/releases) and [Arch Linux AUR](https://aur.archlinux.org/packages/agru)
### Build yourself
`just build` or `go build .`
## Who uses it?
- [Matrix Docker Ansible Deploy (MDAD)](https://github.com/spantaleev/matrix-docker-ansible-deploy)
- [Mother of All Self-Hosting (MASH)](https://github.com/mother-of-all-self-hosting/mash-playbook)
- [etke.cc](https://gitlab.com/etke.cc/ansible/)
If you use A.G.R.U. in your project, please let us know by creating an issue or PR with your project link.