Swarm Node Setup

This guide walks through creating your Swarm node

1. ssh into your Ubuntu VM
2. installing Docker
3. creating a GitLab personal access token
4. logging into the private container registry
5. cloning your individual repository
6. running the startup script

Access your existing Ubuntu VM

With Ubuntu 22.04 LTS or 24.04 LTS as the OS.

• Virtual Machine (VM) Specification
• Once provisioned, connect via SSH:

ssh [<<server>>] [<<identity>>]

Install Docker

For the official and up-to-date Docker installation steps, follow:

• Install using the repository (Docker docs)
• Post installation steps for Linux (Docker docs)

Create GitLab Personal Access Token

Before logging in to the registry, create a personal access token in GitLab:

1. Go to: https://codebase.swarm-learning-hub.org/-/user_settings/personal_access_tokens
2. Click Add new token.
3. Give the token a name and set an expiration date.
4. Select the "read_api" scope (read-only API access).
5. Click Create personal access token.
6. Copy the token immediately and store it securely; it will only be shown once.

Docker Registry Login

in your VM authenticate with the private registry:

docker login registry.swarm-learning-hub.org -u <your-username>
# Enter your token (format: <gplat-xxx>) from the step above as the password interactively

Clone the Repository

Clone the Git repository: (link to the repository via e-mail)

git clone https://codebase.swarm-learning-hub.org/swarms/<SOMEPATH>/<YOUR-REPOSITORY>.git
cd <YOUR-REPOSITORY>

Run the Start Script

Run the start script to launch the application.

sh start-<<your-individual-start-script>>.sh

This will execute any required startup procedures for the swarm-node.