Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbovo/pixiefairy
a Pixiecore API Companion
https://github.com/mbovo/pixiefairy
api api-rest fastapi pixiecore pxe pxe-boot
Last synced: 17 days ago
JSON representation
a Pixiecore API Companion
- Host: GitHub
- URL: https://github.com/mbovo/pixiefairy
- Owner: mbovo
- Created: 2022-04-10T17:38:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-29T20:05:50.000Z (over 1 year ago)
- Last Synced: 2024-11-15T04:49:17.586Z (about 1 month ago)
- Topics: api, api-rest, fastapi, pixiecore, pxe, pxe-boot
- Language: Python
- Homepage:
- Size: 116 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pixie Fairy - a Pixiecore API companion
[](https://pypi.org/pypi/pixiefairy)
[](https://github.com/mbovo/pixiefairy/actions/workflows/build-image.yml)
`Pixiefairy` is a companion for [pixiecore](https://github.com/danderson/netboot/tree/master/pixiecore) a tool to manage network booting of machines.
`Pixiecore` in [API mode](https://github.com/danderson/netboot/tree/master/pixiecore#pixiecore-in-api-mode) send a request to an external service for each pxe booting event; *pixiefairy* is that service, answering to api calls and serving the configured info, like the kernel, the initrd and the command line to boot.
`Pixiefairy` is higly configurable, you can decide which mac-address and which set of parameters to serve to each client.
## Installation
Pixiefairy requires `python >= 3.9`
It's as easy as
```bash
pip3 install pixiefairy
```
Then you will have available the `pixiefairy` binary
## Usage
Pixiefairy can be started using the `start` command. It requires a config.yaml file with a bunch of defaults in order to know how to serve the requests.
```bash
pixiefairy start -c config.yaml
```
## Configuration
An example configuration can be found into [examples/config.yaml](./examples/config.yaml) like
```yaml
defaults:
boot:
# the kernel to boot into
kernel: "file:///root/vmlinuz-amd64"
initrd: # the list of initrd files to load at boot
- "file:///root/initramfs-amd64.xz"
message: "" # optional, a boot message
cmdline: "" # optional, the command line to boot
net:
dhcp: true # use dhcp or send n ip=.... kernel parameters to configure the network
gateway: "192.168.1.0" # the default gateway to send to the requestor
netmask: "255.255.255.0" # the netmask to send to requestor
dns: "8.8.8.8" # default dns server
ntp: "192.168.1.0" # default ntp server
deny_unknown_clients: false # either boot unknown clients or boot only the mac address listed in mapping below
mapping: # optional
aa:bb:cc:dd:ee:ff: # the matching mac address
net: null # net block, optional, identical to the net block in defaults, override
boot: null # boot block, optional, identical to the boot block in defaults, override
```
## Dev Requirements
In order to partecipate to the development you need the following requirements
- [Taskfile](https://taskfile.dev)
- Python >=3.9
And bootstrap the local dev environment with:
```bash
task setup
```
This will setup locally a python virtualenv with all the dependencies, ready to start coding