Installation¶
Express installation¶
Make sure that at least one of Podman or containerd has been installed. Then just call
Ankaios works with most Linux distributions and has been tested with Ubuntu 22.04, 24.04 and 26.04.
Detailed installation steps, including instructions on setting up container runtimes, choosing an installation method, and installing specific Ankaios versions, are provided below.
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 | 256 MB |
Container runtime¶
Ankaios supports multiple container runtimes. Depending on which runtime is to be used, only certain container runtimes or all supported runtimes can be installed using the following instructions.
Podman¶
For using the Ankaios podman and podman-kube runtimes,
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.
Containerd¶
For using the Ankaios containerd runtime, follow the containerd installation instructions to install the containerd daemon.
Ankaios uses the nerdctl command-line interface (CLI) to manage containers with the containerd runtime. Install a compatible version of the nerdctl CLI for the containerd runtime, or install the full nerdctl package, including dependencies such as containerd, runc, and CNI. Note that if you are not using the version distributed by your package manager, you must check the platform compatibility of containerd. Download and install the nerdctl package from the official nerdctl releases.
Installation methods¶
For setting up Ankaios in a production environment with mutual transport layer security (mTLS), follow the mTLS setup instructions after installing Ankaios.
Install 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:
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 installation path for the binaries is /usr/local/bin.
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 installation path /usr/local/bin and also for systemd
integration. You can disable systemd unit
file generation if required.
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 |
| -t <install-type> | Installation type for systemd integration: server, agent, none or both (default) |
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:
-
Set the desired log levels for each service by assigning valid values to the environment variables
INSTALL_ANK_SERVER_RUST_LOGandINSTALL_ANK_AGENT_RUST_LOG. For the syntax see the documentation forRUST_LOG. -
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 -- -t both -v <version>For the latest version:
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¶
If Ankaios has been installed with the installation script, it can be uninstalled with:
The folder /etc/ankaios will remain.
APT (Debian / Ubuntu)¶
Add the Ankaios signing key and repository:
curl -L "https://keyserver.ubuntu.com/pks/lookup?op=get&search=ankaios-dev@eclipse.org" | gpg --dearmor | sudo tee /usr/share/keyrings/ankaios.gpg > /dev/null
echo "deb [signed-by=/usr/share/keyrings/ankaios.gpg] https://repo.eclipse.org/repository/ankaios-apt/ stable main" | sudo tee /etc/apt/sources.list.d/ankaios.list
Then install the desired package:
The ankaios meta-package installs all components. Individual packages can be installed separately:
| Package | Description |
|---|---|
ankaios |
Meta-package containing ank-server, ank-agent and ank |
ank-server |
Ankaios server |
ank-agent |
Ankaios agent |
ank |
Ankaios CLI |
Note
The ank-server and ank-agent systemd services are started automatically after installation.
The packages are compatible with Ubuntu 22.04+, Debian 12+ and other distributions based on glibc 2.35 or later.
Uninstall¶
To remove individual components, replace ankaios with the specific package name.
Manual download¶
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.