Skip to content

fix(node): Remove obsolete LiveUSB and Kickstart installation methods #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/liveusb/_category_.json

This file was deleted.

12 changes: 0 additions & 12 deletions docs/liveusb/build.md

This file was deleted.

53 changes: 0 additions & 53 deletions docs/liveusb/index.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/liveusb/video.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
26 changes: 5 additions & 21 deletions docs/node/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion external/node
Submodule node updated 121 files