Multicloud use-case based multihost async provisioner for CIs and testing during development
Project description
mrack
Important: most of the described below is not implemented yet
Provisioning library for CI and local multi-host testing supporting multiple provisioning providers e.g. OpenStack, libvirt, containers, Beaker).
But in comparison to multi-cloud libraries, the aim is to be able to describe host from application perspective. E.g.:
network: IPv4
hosts:
- name: master.testdomain.test
role: master
group: ipaserver
os: fedora-31
- name: client.testdomain.test
role: client
group: ipaclient
os: fedora-30
This is then combined with provisioning configuration where each provider has
defined meaning for role, group, os params which e.g. translates to
flavors, images, ...
provider: openstack # default provider
openstack:
images:
fedora-30: Fedora-Cloud-Base-30-compose-latest
fedora-31: Fedora-Cloud-Base-31
flavors:
ipaserver: ci.m1.medium
ipaclient: ci.m1.micro
networks:
IPv4: net_ci_4
IPv6: net_ipv6_only
dual: net_cci_4_6
keypair: ipa_key
beaker:
distros:
fedora-30: FEDORA-30%
fodora-31: FEDORA-31%
So then user can quickly change provisioning location just by changing provider name without needing to redefine the provider/cloud specifics. This is especially useful for a lot of jobs sharing the same app specific provisioner configuration.
provider: beaker
Or each host can use a different provider:
hosts:
- name: master.testdomain.test
role: master
group: ipaserver
os: fedora-31
provider: openstack
network: dual
- name: client.testdomain.test
role: client
group: ipaclient
os: fedora-30
provider: beaker
The output is then Ansible inventory with correct group mapping and information which allows to SSH to the machines.
all:
children:
ipaserver:
hosts:
f30-1.mrack.test: {}
f33-2.mrack.test: {}
hosts:
f30-1.mrack.test:
ansible_host: 10.0.154.21
ansible_python_interpreter: /usr/bin/python3
ansible_ssh_private_key_file: config/id_rsa
ansible_user: fedora
meta_dc_record: DC=mrack,DC=test
meta_domain: mrack.test
meta_fqdn: f30-1.mrack.test
meta_ip: 10.0.154.21
meta_os: fedora-30
meta_provider_id: 7c3c28f9-4674-4f7f-b413-00bc0b00d711
meta_restraint_id: 9
meta_role: master
f33-2.mrack.test:
ansible_host: ec2-13-15-16-1.eu-central-1.compute.amazonaws.com
ansible_python_interpreter: /usr/bin/python3
ansible_ssh_private_key_file: config/id_rsa
ansible_user: fedora
meta_dc_record: DC=mrack,DC=test
meta_domain: mrack.test
meta_fqdn: f33-2.mrack.test
meta_ip: 13.15.16.1
meta_os: fedora-33
meta_provider_id: i-08c0d4a86c4b7f7ef
meta_restraint_id: 1
meta_role: master
Installation
mrack can be installed via pip, from PyPI:
pip install mrack
It is also available for Fedora 32+ via COPR:
sudo dnf copr enable @freeipa/neoave
sudo dnf install mrack
Run mrack
In order to use the mrack utility a mrack.conf (e.g. [mrack.conf] from the repository(repo/blob/master/src/mrack/data/mrack.conf)) is needed.
mrack looks for the config file in following order:
./actual directory~/.mrack/home directory/etc/mrack/system directory
Values from the configuration file could be overriden using mrack utility
options --mrack-config --provisioning-config --db (for more see mrack --help).
Usage: mrack [OPTIONS] COMMAND [ARGS]...
Multihost human friendly provisioner.
Options:
-c, --mrack-config PATH
-p, --provisioning-config PATH
-d, --db PATH
--debug
--help Show this message and exit.
Commands:
destroy Destroy provisioned hosts.
list List host tracked by.
output Create outputs - such as Ansible inventory.
ssh SSH to host.
up Provision hosts.
Provisioning with mrack
To provision system from the metadata.yaml either run:
mrack up
or use up command's option --metadata/-m to orverride path to the metadata file.
mrack up --metadata other-metadata.yaml
To return resources using mrack run:
mrack destroy
or use destroy command's option --metadata/-m to orverride path to the metadata file.
mrack destroy --metadata other-metadata.yaml
mrack as python library
import mrack
# TODO
Contribute
Projects is using black formater and isort to keep consistent formatting, flake8 and pydocstyle to ensure following Python good practices.
Contributions (Pull Requests) are welcome. It is expected that they will pass tox tests and code checkers. Inclusion of the unit tests for the new code is recommended. Because of that we have configured pre-commit hook. Please enable the feature on your local system and use it before sending a patch. It could save us lot of re-pushing to the PR.
Black formatting and isort
Expected formatting can be achived by running:
$ make format
Look into black documentation for possible integration in editors/IDEs.
Testing
Just run tox to execute all tests and linters
$ tox
# or us make
$ make test
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mrack-0.9.0.tar.gz.
File metadata
- Download URL: mrack-0.9.0.tar.gz
- Upload date:
- Size: 62.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fa9b644389e8fc3b5baf74fb3a5164b48f748f4675efb10da165966a68db0dcc |
|
| MD5 | 99c756c88e114e995e56ac27cf2d12ba |
|
| BLAKE2b-256 | b138c2ea4068eb2d9e81cf38322d18dda417792a7d03ed150c24947d07a209ff |
File details
Details for the file mrack-0.9.0-py3-none-any.whl.
File metadata
- Download URL: mrack-0.9.0-py3-none-any.whl
- Upload date:
- Size: 65.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d23cd2dfaeaaca9698471dd52ada2f90fa3efe641720b09ed43a32b386193191 |
|
| MD5 | c843d1ba8d70c83e54a5de033781f5a8 |
|
| BLAKE2b-256 | dac42b0e92212b8c97cdcace3effcef9f319c95b30e21747408417df870cf552 |
