From 32c51daf5b156aa44ac95ee47b59ba8e0403a4bc Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Fri, 9 May 2025 15:03:56 +0200 Subject: [PATCH] fix(node): Remove obsolete LiveUSB and Kickstart installation methods Signed-off-by: Steffen Vogel --- docs/liveusb/_category_.json | 4 --- docs/liveusb/build.md | 12 -------- docs/liveusb/index.md | 53 ------------------------------------ docs/liveusb/video.md | 14 ---------- docs/node/index.md | 2 +- docs/node/installation.md | 26 ++++-------------- external/node | 2 +- 7 files changed, 7 insertions(+), 106 deletions(-) delete mode 100644 docs/liveusb/_category_.json delete mode 100644 docs/liveusb/build.md delete mode 100644 docs/liveusb/index.md delete mode 100644 docs/liveusb/video.md diff --git a/docs/liveusb/_category_.json b/docs/liveusb/_category_.json deleted file mode 100644 index 9a412e1..0000000 --- a/docs/liveusb/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "LiveUSB Image", - "position": 105 -} diff --git a/docs/liveusb/build.md b/docs/liveusb/build.md deleted file mode 100644 index 67782f4..0000000 --- a/docs/liveusb/build.md +++ /dev/null @@ -1,12 +0,0 @@ -# Build new LiveUSB images {#liveusb-build} - -Images are build with Fedora's [livemedia-creator](http://lorax.readthedocs.io/en/latest/livemedia-creator.html) and using a custom [Anaconda Kickstart file](https://github.com/VILLASframework/node/blob/master/packaging/live-iso/villas.ks). -A guide for this method can be found here: https://fedoraproject.org/wiki/Livemedia-creator-_How_to_create_and_use_a_Live_CD - -We build the images using the RWTH GitLab continous integration system. Which itself is using a Docker container. -This makes the process as reproducible as possible. - -Every tagged Git commit which is pushed to the GitLab server will trigger the generation of a new ISO. -New ISO images will be pushlished automtically at: http://villas.fein-aachen.org/iso/beta/ - -The Git repository including all the scripts is available here: https://github.com/VILLASframework/node/tree/master/packaging/live-iso diff --git a/docs/liveusb/index.md b/docs/liveusb/index.md deleted file mode 100644 index 21cffbf..0000000 --- a/docs/liveusb/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: Overview ---- - -# LiveUSB Image - -This archive contains a disk image of a Fedora 29 installation which has been tuned for low latency and overall real-time performance. -It facilitates the setup of a VILLASnode instances by partners of the Institute for Automation of Complex Power Systems (ACS), EON Research Center, RWTH Aachen University. - -## What you need - - - An USB drive with at least 8 GB capacity (the content on the drive will be erased, backup before if there are any important files stored!) - - A computer running Windows, Mac OS X or Linux - - A keyboard and display attached to the server - - The live image file `.img.xz` which you can download here: https://villas.fein-aachen.org/iso/ - -## Setup {#liveusb-setup} - -### Step 1: Getting the image onto the USB drive {#liveusb-setup-prepare} - -**Note:** Simply copying the image onto the drive **does not work**! - -1. Plug in your USB drive -2. Download, install and start the [_Fedora Media Writer_](https://getfedora.org/en/workstation/download/) -3. Download the [VILLAS Live ISO file](https://villas.fein-aachen.org/iso/) -4. Select "Custom image" -5. Pick the downloaded ISO file -6. Make sure that the correct USB drive is selected in the popup window -7. Make sure that the "Other" instead of "Raspberry Pi" is selected in the popup window -8. Click on "Write to disk" - -### Step 2: Booting the system from the live USB image {#liveusb-setup-boot} - -1. Shut down the server (and remove the old USB drive running an older version of VILLASnode, if there is any). -2. Plug in the USB drive and start the server. If the server does not boot into the USB drive, you may need to restart and change the boot order by pressing DEL or F12 at the very beginning of the start up. -3. When asked for user credentials, enter the default credentials: - - **User**: root - - **Password:** villas-admin - -### Step 3: Testing functionality {#liveusb-setup-test} - -1. Check the name and information about the running kernel with `uname -a` -2. If available, check the Internet connectivity with `ping www.rwth-aachen.de`. If the request times out, the internet is most likly not reachable. -3. If available, check the public IP address of the server with `curl canihazip.com/s`. -4. Check the network configurations with `ip addr show`. -5. Test installation of VILLASnode with `villas node --help` - -### Step 4: Securing the system (options) {#liveusb-setup-security} - -1. Change the default password: `passwd`. -2. Update the system regulary: `dnf update` -3. Setup a firewall: https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-firewalld-on-centos-7 diff --git a/docs/liveusb/video.md b/docs/liveusb/video.md deleted file mode 100644 index 4ea2a1c..0000000 --- a/docs/liveusb/video.md +++ /dev/null @@ -1,14 +0,0 @@ -# Video - -import AsciinemaPlayer from '@site/src/components/AsciinemaPlayer'; -import 'asciinema-player/dist/bundle/asciinema-player.css'; - -The following video shows the installation of the VILLAS live image on a [VirtualBox](http://www.virtualbox.org) virtual machine. - - - -## Old - - diff --git a/docs/node/index.md b/docs/node/index.md index ae80cb5..ce778f1 100644 --- a/docs/node/index.md +++ b/docs/node/index.md @@ -30,7 +30,7 @@ The project consists of a server daemon and several client modules which are doc - Using the latest C11/C++17 standards - Easily extensible with new interface types, hook functions and payload formats - Released as open source software under the GPLv3 license -- Easily deployable via [ISO installer](../liveusb/index.md), [Docker image](./installation.md#docker) or from [source](./installation.md#source) +- Easily deployable via [Precompiled standalone binaries](./installation.md#standalone), [Docker image](./installation.md#docker) or from [source](./installation.md#source) - Only relies on open source software libraries and the Linux kernel - Follows the Unix philosophy by providing a set of smaller command line tools diff --git a/docs/node/installation.md b/docs/node/installation.md index f32cb5f..c066987 100644 --- a/docs/node/installation.md +++ b/docs/node/installation.md @@ -6,11 +6,11 @@ sidebar_position: 3 VILLASnode can be installed in multiple ways: +- [Precompiled standalone binaries](#standalone) - [Docker image](https://git.rwth-aachen.de/acs/public/villas/node/container_registry) - [Kubernetes (Helm chart)](../installation.md) -- [Bootable Linux live image](../liveusb/index.md) -- Automated [Kickstart installation](#kickstart-installation) for Fedora/RedHat based distributions -- or from source +- [Nix Flake](#nix) +- or [from source](#source) :::caution Requirements Please make sure that your system fulfills the [requirements](requirements.md) before proceeding. @@ -292,7 +292,7 @@ This can be achieved by using the `WITHOUT_GPL` CMake option: cmake -S . -B build -DWITHOUT_GPL=ON ``` -## Single-binary / Standalone Executable +## Single-binary / Standalone Executable {#standalone} We provide single-binary / standalone executable builds of VILLASnode bundle all depdendencies in a [self-extracting ARX archive](https://en.wikipedia.org/wiki/Self-extracting_archive). These standalone binaries allow running VILLASnode irrespectively of the underlying Linux distribution or availability of library dependencies. @@ -333,7 +333,7 @@ To start the main daemon, you can pass a configuration file via a volume mount: docker run --volume /path/to/my/local.conf:/config.conf --privileged registry.git.rwth-aachen.de/acs/public/villas/node node /config.conf ``` -## Nix +## Nix {#nix} VILLASnode is also packaged as a [Nix Flake](https://wiki.nixos.org/wiki/Flakes). [Nix](https://nixos.org) is a cross-platform package manager for Unix-like systems, and a tool to instantiate and manage those systems, invented in 2003 by Eelco Dolstra. @@ -357,22 +357,6 @@ nix run github:VILLASframework/node -- node --help For more details please refer to the details here: https://github.com/VILLASframework/node/blob/master/packaging/nix/README.md -## Kickstart installation - -[Kickstart](https://docs.fedoraproject.org/en-US/fedora/f35/install-guide/advanced/Kickstart_Installations/) is a method for automating the installation of Fedora/Redhat based Linux distributions. -It works by using a Kickstart (`.ks`) file which contains a configuration of all the installation options which the user would usually manually enter using the installation wizard. - -We have prepared such a Kickstart file which installs Fedora with our recommended configuration as well as [installs VILLASnode from source](#source) as described above. - -To use it, you will need to download a [Netinstall image of Fedora Server](https://getfedora.org/de/server/download/) and copy it to a USB stick or opticial disk. -You also need to interrupt the initial boot of the Fedora installer, in the boot manager and append the following Kernel command line: - -```text -inst.ks=https://raw.githubusercontent.com/VILLASframework/node/master/packaging/live-iso/villas.ks -``` - -Further details on how to start the Kickstart installation can be found [in the official Fedora documentation](https://docs.fedoraproject.org/en-US/fedora/f35/install-guide/advanced/Kickstart_Installations/#sect-kickstart-installation-starting). - ## Test installation {#test} Verify everything is working and required node-types are compiled-in: diff --git a/external/node b/external/node index 1acbde5..063f8b3 160000 --- a/external/node +++ b/external/node @@ -1 +1 @@ -Subproject commit 1acbde5d7f9a30c74b265e2244c2fd76e450c076 +Subproject commit 063f8b39c183558398062b12a6a954e7beb11218