Skip to main content

Automation helper for Fluxnodes

Project description

Arcane Mage - Automated Fluxnode ArcaneOS Installation

Introduction

This is experimental software. There may be rough edges. If you spot something that is not quite right - please open an issue.

Arcane Mage is a suite of tools designed to ease the installation (and configuration) burden of installing a Fluxnode.

The following is available via the GUI, or CLI:

  • Fully automated A to Z Proxmox installs, including Secure Boot key enrollment.
  • Mutlicast config broadcast on LANs - fully automated installs, except Secure Boot Key enrollement.
  • USB stick creation for plug and play automated installs on bare metal

Configuration Options

See the examples directory for sample configurations.

Any option can be easily set via a yaml configuration file, for example, for Proxmox, start on VM creation, rate limits, etc.

It can also reboot direct into systemd-boot for systems that allow easy enrollment of keys (usually bare metal systems)

Installation

Install uv - https://docs.astral.sh/uv/getting-started/installation/

To run once without installing:

uvx --with arcane_mage python -m arcane_mage

Install as a tool:

uv tool install arcane-mage

To use the default config file fluxnodes.yaml in the directory you are in (this will run the GUI):

arcane-mage

Run the following for help:

arcane-mage --help

Hypervisor Setup - Proxmox Automation

MINIMUM PROXMOX VERSION: 8.4.1

In order to use Arcane Mage with Proxmox, the following needs to be set up on your hypervisor:

  • A user for the API
  • An API token (strongly recommended)
  • Nginx reverse proxy (strongly recommended)
  • Storage area for DISK images needs to allow import content type

To set up your Proxmox Instance behind an Nginx reverse proxy, follow these instructions, it doesn't take much effort:

https://pve.proxmox.com/wiki/Web_Interface_Via_Nginx_Proxy

If you don't reverse proxy the api, you can run into connection issues.

If using the default Proxmox settings, you will need to enable the import option under the Datacenter -> Storage endpoint (click edit):

Proxmox Storage Page

To set up your user, go to "Datacenter" on the Proxmox GUI and add a user:

Proxmox User Page

Next, add an api token for your user:

Proxmox Api Token

Finally, give BOTH your user and api token PVEAdmin permissions:

Proxmox Permissions

You're now good to run Arcane Mage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arcane_mage-0.2.2.tar.gz (414.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcane_mage-0.2.2-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

Details for the file arcane_mage-0.2.2.tar.gz.

File metadata

  • Download URL: arcane_mage-0.2.2.tar.gz
  • Upload date:
  • Size: 414.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for arcane_mage-0.2.2.tar.gz
Algorithm Hash digest
SHA256 243e44506582ac88e8cc8b634d50c84b81be1d05324a93882d8636227738ab1a
MD5 6a7aa070ea5557dc79e0f1673e163ecb
BLAKE2b-256 92a7ff2774d4c632e296caf34515b4754860c80846f31bfdc86de6794547e80b

See more details on using hashes here.

File details

Details for the file arcane_mage-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for arcane_mage-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ddc2cd4a1cef1a2239dde6b981f8488e65aa4f5f22e9f7299a8b2ee8e3d50181
MD5 28930a023b6746d82669a6c4f2046232
BLAKE2b-256 d9f1f78510d06c6182e4abae851c2d0cac3155b335ff797a2cfdf210bd02950b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page