Skip to content

Latest commit

 

History

History
125 lines (87 loc) · 4.07 KB

README.md

File metadata and controls

125 lines (87 loc) · 4.07 KB
Raw

agru

What?

ansible-galaxy requirements updater 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 developing and maintainining a lot of Ansible roles and playbooks (MDAD, MASH, etke.cc). 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?

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

$ agru -l

install role from the requirements file

$ agru

update requirements file if newer versions are available

$ agru -u

remove already installed role

$ 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:

- src: geerlingguy.docker
  version: 6.1.0

does work:

- 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 and Arch Linux AUR

Build yourself

just build or go build .

Who uses it?

If you use A.G.R.U. in your project, please let us know by creating an issue or PR with your project link.