Skip to main content

Automation helper for Fluxnodes

Project description

Arcane Mage - Automated Fluxnode ArcaneOS Installation

Introduction

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.0.tar.gz (413.9 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.0-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for arcane_mage-0.2.0.tar.gz
Algorithm Hash digest
SHA256 53c5d38da602718c8f836a2aebddef1eb3991c19d9e4385f94fe981fc909be48
MD5 6e31ab97695c097624aea397129eb8bb
BLAKE2b-256 694d5c03b09f319c8d4152864aef8074a4bf144a935a1746e8623006d8935082

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arcane_mage-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fbe23356e2e0f91c2178ea97c1cfb8b560cd84d751fb15708aa835c3b2086d9e
MD5 c285613e004219a94e731079d352d99b
BLAKE2b-256 1d9b68e10d9a2e957ce48066c447046be73b890e2474a3cadce295be76b28dc9

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