Skip to content

Installation

Ankaios has been tested with the following Linux distributions. Others might work as well but have not been tested.

  • Ubuntu 24.04 LTS
  • Ubuntu 22.04 LTS
  • Ubuntu 20.04 LTS

System requirements

Ankaios currently requires a Linux OS and is available for x86_64 and arm64 targets.

The minimum system requirements are (tested with EB corbos Linux – built on Ubuntu):

Resource Min
CPU 1 core
RAM 128 MB

Podman needs to be installed as this is used as container runtime (see Podman installation instructions). For using the podman runtime, Podman version 3.4.2 is sufficient but the podman-kube runtime requires at least Podman version 4.3.1.

Note

On Ubuntu 24.04 there is a known problem with Podman stopping containers. The following workaround disables AppArmor for Podman. Run the following steps as root after installation of Podman:

mkdir -p /etc/containers/containers.conf.d
printf '[CONTAINERS]\napparmor_profile=""\n' > /etc/containers/containers.conf.d/disable-apparmor.conf

Installation methods

There are two ways to install Ankaios, depending on your specific needs and focus. If you are new to Ankaios or TLS is not a top priority, we recommend following the setup instructions in Setup with script without enabling mutual transport layer security (mTLS) for communication. On the other hand, if you want to setup Ankaios in a production environment, follow the setup instructions in Setting up Ankaios with mTLS.

Setup with script

The recommended way to install Ankaios is using the installation script. To install the latest release version of Ankaios, please run the following command:

curl -sfL https://github.com/eclipse-ankaios/ankaios/releases/latest/download/install.sh | bash -

Note

Please note that installing the latest version of Ankaios in an automated workflow is discouraged. If you want to install Ankaios during an automated workflow, please install a specific version as described below.

The installation process automatically detects the platform and downloads the appropriate binaries. The default installation path for the binaries is /usr/local/bin but can be changed. The installation also creates systemd unit files and an uninstall script.

Supported platforms: linux/amd64, linux/arm64

Note

The script requires root privileges to install the pre-built binaries into the default installation path /usr/local/bin and also for systemd integration. You can set a custom installation path and disable systemd unit file generation if only non-root privileges are available.

The following table shows the optional arguments that can be passed to the script:

Supported parameters Description
-v <version> e.g. v0.1.0, default: latest version
-i <install-path> File path where Ankaios will be installed, default: /usr/local/bin
-t <install-type> Installation type for systemd integration: server, agent, none or both (default)
-s <server-options> Options which will be passed to the Ankaios server. Default --insecure --startup-config /etc/ankaios/state.yaml
-a <agent-options> Options which will be passed to the Ankaios agent. Default --insecure --name agent_A

To install a specific version run the following command and substitute <version> with a specific version tag e.g. v0.1.0:

curl -sfL https://github.com/eclipse-ankaios/ankaios/releases/download/<version>/install.sh | bash -s -- -v <version>

For available versions see the list of releases.

Set the log level for ank-server and ank-agent services

To configure the log levels for ank-server and ank-agent during the installation process using the provided environment variables, follow these steps:

  1. Set the desired log levels for each service by assigning valid values to the environment variables INSTALL_ANK_SERVER_RUST_LOG and INSTALL_ANK_AGENT_RUST_LOG. For the syntax see the documentation for RUST_LOG.

  2. Run the installation script, making sure to pass these environment variables as arguments if needed:

    For a specific version:

    curl -sfL https://github.com/eclipse-ankaios/ankaios/releases/download/<version>/install.sh | INSTALL_ANK_SERVER_RUST_LOG=debug INSTALL_ANK_AGENT_RUST_LOG=info bash -s -- -i /usr/local/bin -t both -v <version>

    For the latest version:

    curl -sfL https://github.com/eclipse-ankaios/ankaios/releases/download/latest/install.sh | INSTALL_ANK_SERVER_RUST_LOG=debug INSTALL_ANK_AGENT_RUST_LOG=info bash -s -- -i /usr/local/bin -t both

Now, both services will output logs according to the specified log levels. If no explicit value was provided during installation, both services will default to info log level. You can always change the log level by updating the environment variables and reinstalling the services.

Uninstall Ankaios

If Ankaios has been installed with the installation script, it can be uninstalled with:

ank-uninstall.sh

The folder /etc/ankaios will remain.

Manual download of binaries

As an alternative to the installation script, the pre-built binaries can be downloaded manually from the Ankaios repository here. This is useful if the automatic detection of the platform is failing in case of uname system command is not allowed or supported on the target.

Build from source

For building Ankaios from source see Build.