https://github.com/datto/maasterblaster
A tool designed for rapid deployment of bare metal machines anywhere where Canonical's MaaS has a presence.
https://github.com/datto/maasterblaster
Last synced: 5 months ago
JSON representation
A tool designed for rapid deployment of bare metal machines anywhere where Canonical's MaaS has a presence.
- Host: GitHub
- URL: https://github.com/datto/maasterblaster
- Owner: datto
- License: gpl-3.0
- Created: 2023-07-13T23:57:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-28T12:13:55.000Z (almost 3 years ago)
- Last Synced: 2024-12-30T07:21:07.571Z (over 1 year ago)
- Language: Python
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Who run Bartertown?
## Two Sysadmins Enter, One Sysadmin leaves....
Welcome to MaaSterblaster a tool designed for rapid deployment of
bare metal machines anywhere where Canonical's MaaS has a presence.
Prerequisites:
- Ubuntu Desktop (tested on 18.04 and 20.04)
- https://github.com/dandruczyk/python-libmaas (lightly modified fork of upstream to fix a bug for performance) Follow installation instructions from README within that repo
- python3
- API Key from MAAS
- CSV file describing your machines
### Input CSV
**NOTE: The input CSV must have a header**
`shortname,domain,machine_profile,macs,power,poweruser,powerpass,powerip,netcfg,foreman_hostgroup_id`
Fields:
| Field | Description |
| ----- | ----------- |
| shortname | Short hostname for the host (use1-foobar-1) |
| domain | Domain name (example.lan, example.com, example.net, etc) |
| machine_profile | See below |
| macs | Space separated list of MAC addresses for the host (1 min) |
| power | ipmi until we use hardware with redfish or other OOB mgmt |
| poweruer | IPMI username |
| powerpass | IPMI password |
| powerip | IPMI IP |
| netcfg | See below for this structure |
| foreman_hostgroup_id | The numerical ID of the hostgroup to pre-create this host in |
### Caveats
Maasterblaster uses PXE to boot and image machines, thus each subnet that is
currently MAAS capable has a pool set aside for this purpose, thus the number
of machines per subnet that can be commssioned, deployed or put into rescue
mode at any one time is limited to the size of the DHCP pool allocated to MAAS
within that subnet (see the subnets tab in the GUI). It's recommended to limit
the number of simultaneous commissions/deploys in any one subnet to 10 at a
time.
### Machine Profiles
These refer to a stanza within config.yml which gives maasterblaster guidance
on how to configure disk and network layouts. This yaml file uses anchors
and aliases. Anchors define a chunk of configuration, aliases are used to
refer to it elsewhere, it's a way to reduce repetition.
Anchors are marked with a `&anchorname`
Plain aliases (no overrides) are just `*anchorname`
Aliases that allow overrides are `<<: *anchorname`
see https://yaml.org/spec/1.2/spec.html#id2765878
See the USAGE.md page for details on machine profiles and usage
### Setup
```
cd ~/git ; git clone https://github.com/datto/maasterblaster.git
cd maasterblaster
pipenv shell
pipenv install
```
Setup ~/.config/maasterblaster.conf
```
---
maas-api-key: ""
maas-server: maas.example.com
maas-proto: https
maas-port: 443
rundeck-api-key:
rundeck-clear-puppet-key-jobid:
rundeck-clear-salt-key-jobid:
foreman-user:
foreman-server: puppet.example.com
parallelism: 5
```
You may wish to set the following params in maasterblaster.py to suit your environment:
```
DEFAULT_MAAS_SERVER = "maas.example.com"
DEFAULT_RUNDECK_SERVER = "rundeck.example.com"
DEFAULT_FOREMAN_SERVER = "puppet.example.com"
```
These will just set the defaults so you won't need to put them into a config file (above) or on the command line
If using foreman pairing set the foreman password associated with your account
`read -s -p "Foreman Password: " FOREMAN_PASS ; export FOREMAN_PASS`
To commission and deploy nodes in your CSV file:
`./maasterblaster -d DEBUG -i /path/to/csv -C -D`
# License
Licensed under the GNU General Public License Version 3
Copyright Datto, Inc.
Authored by David Andruczyk