garm/contrib/providers.d/openstack/README.md
Gabriel Adrian Samfira 95db6599ff Make external provider less opinionated about executable
You can now specify the absolute path to a provider executable instead
of specifying a provider directory with a "garm-external-provider" in it.
2022-07-16 18:00:07 +00:00

12 lines
789 B
Markdown

# OpenStack external provider for garm
This is an example external provider, written for OpenStack. It is a simple bash script that implements the external provider interface, in order to supply ```garm``` with compute instances. This is just an example, complete with a sample config file.
Not all functions are implemented, just the bare minimum to get it to work with the current feature set of ```garm```. It is not meant for production, as it needs a lot more error checking, retries, and potentially more flexibility to be of any use in a real environment.
Images that are used with garm require the following properties set on the image:
* os_type (one of: windows, linux)
* os_distro
* os_version
* architecture (one of: x86_64, armv7l, mips64, mips64el, mips, mipsel)