Hypertool Deployment Guide

Overview

Hypertool is a Python CLI library and Helm package developed within the HYPER-AI project (Task 4.1) to support node registration, discovery, and lifecycle management across the Computing Continuum. It enables resource abstraction and self-advertisement mechanisms, facilitating the interoperability and dynamic integration of heterogeneous nodes into the continuum.

Version: 0.0.1

Installation and Deployment

Prerequisites

Before using hypertool, ensure the following tools are installed and configured:

  • Helm (version 3.x or later): for deploying the Helm chart.

  • Docker: required to build and push the hypertool image.

  • Docker Hub account: used to push and host the hypertool image.

  • Kubernetes cluster with configured kubectl required to deploy and verify hypertool functionality.

Installation Steps

  1. Clone the repository:

    git clone git@gitlab.eclipse.org:eclipse-research-labs/hyper-ai-project/hypertool.git
cd hypertool

  2. Build and deploy the Helm chart:

    make helm-install DOMAIN=yourdomain

    Replace yourdomain with your Docker Hub username

Build and Deployment Notes

  • The Makefile automates building the hypertool Docker image, pushing it to your container registry, and packaging/deploying the Helm chart.

  • The DOMAIN variable is required to specify the registry namespace for your image.

Example Verification

To verify that hypertool has been successfully deployed and is functioning as expected:

kubectl describe node `node-name`

Check that the following annotations are present in the node description (example):

hyperai.eu/node-interface: eth0
hyperai.eu/node-network-type: ethernet

Alternative Installation Method

Alternatively, you can download the pre-packaged Helm chart directly:

  • Download the package from: sharepoint_url

  • Then install it manually:

    helm install hypertool path/to/hypertool-0.1.0.tgz \
    --set image.repository=pcomphypertool/hypertool \
    --set image.tag=0.0.1