Pixie Fairy - a Pixiecore API companion
Pixiefairy is a companion for pixiecore a tool to manage network booting of machines.
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
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.
pixiefairy start -c config.yaml
Configuration
An example configuration can be found into examples/config.yaml like
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 participate in development you need the following requirements:
And bootstrap the local dev environment with:
just setup
This will setup locally a python virtualenv with all the dependencies, ready to start coding
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pixiefairy-0.2.1.tar.gz.
File metadata
- Download URL: pixiefairy-0.2.1.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c955ea828411ae12d14f76493f461214807baf1903375687e95d762d8e04892
|
|
| MD5 |
9a3ef59ba587ea77c4a60839e3d0bc24
|
|
| BLAKE2b-256 |
2dc2596cf7127aea933086ddf80492e6c2603bd2f8301c03654652cc8ebf0a3e
|
Provenance
The following attestation bundles were made for pixiefairy-0.2.1.tar.gz:
Publisher:
build-image.yaml on mbovo/pixiefairy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pixiefairy-0.2.1.tar.gz -
Subject digest:
3c955ea828411ae12d14f76493f461214807baf1903375687e95d762d8e04892 - Sigstore transparency entry: 2583088751
- Sigstore integration time:
-
Permalink:
mbovo/pixiefairy@b80ed0b056314d61173ef3ebcac02de44310ffb6 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/mbovo
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-image.yaml@b80ed0b056314d61173ef3ebcac02de44310ffb6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pixiefairy-0.2.1-py3-none-any.whl.
File metadata
- Download URL: pixiefairy-0.2.1-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
176520790a53663320528bfb219d3feadc9fd80eaab3893ff77b4d38a225d4fe
|
|
| MD5 |
9ad0ae6b24e1ab0772ede5def8e29978
|
|
| BLAKE2b-256 |
604954eea30c50c1816646a3bf1ea6cf560d07e60c849ec875ce55e98bc80dd2
|
Provenance
The following attestation bundles were made for pixiefairy-0.2.1-py3-none-any.whl:
Publisher:
build-image.yaml on mbovo/pixiefairy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pixiefairy-0.2.1-py3-none-any.whl -
Subject digest:
176520790a53663320528bfb219d3feadc9fd80eaab3893ff77b4d38a225d4fe - Sigstore transparency entry: 2583088754
- Sigstore integration time:
-
Permalink:
mbovo/pixiefairy@b80ed0b056314d61173ef3ebcac02de44310ffb6 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/mbovo
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-image.yaml@b80ed0b056314d61173ef3ebcac02de44310ffb6 -
Trigger Event:
push
-
Statement type:
