Hello World Example using ArmoniK’s C++ API

Getting started

Prerequisites

Familiarity with Terraform, Kubernetes, and Docker.
CMake installed on WSL2.
ArmoniK prerequisites, including Docker.

Clone the ArmoniK repo on WSL2 if you haven’t already, and follow the local installation guide to install all necessary prerequisites using the provided script:

git clone https://github.com/aneoconsulting/ArmoniK.git

Starting up ArmoniK

Once you’ve cloned the ArmoniK repo and completed the installation steps, start ArmoniK by running:

make deploy

It’s that simple.

Building your application

To develop a C++ application for ArmoniK:

Clone the required repository and copy the cpp folder.
Use the provided Makefile for all necessary commands to build your app.
For autocomplete support, especially on WSL or Linux, run:
```
make setup_dev_env
```
This command builds the ArmoniK.Api shared libraries, copies generated protobuf files, and downloads additional dependencies into the vendor folder. Add these paths to your editor’s include paths to enable autocomplete/intellisense. The command will take some time to download everything but you only need to run it once.

For Visual Studio Code, add or create a c_cpp_properties.json file in your .vscode folder with the following content:

{
    "configurations": [
        {
            "name": "ArmoniK-cpp",
            "includePath": [
                "${workspaceFolder}/**",
                "${workspaceFolder}/armonik_api/include/armonik/worker/",
                "${workspaceFolder}/armonik_api/include/armonik/common/",
                "${workspaceFolder}/armonik_api/include/armonik/client/",
                "${workspaceFolder}/armonik_api/vendor/"
            ],
            "defines": [],
            "compilerPath": "/usr/bin/gcc",
            "cStandard": "c17",
            "cppStandard": "gnu++14",

        }
    ],
    "version": 4
}

Use the following commands to build your worker and client containers:

make build_worker
make build_client

You can modify the image names in the Makefile or pass them as parameters. By default this will build the images armonik-cpp-hello-worker:0.1.0-api and armonik-cpp-hello-client:0.1.0-api

Running your application on ArmoniK

Now, going back to our ArmoniK infrastructure add the C++ worker image, either by:

Replacing the default partition image with the C++ dynamic worker image. This is done by modifying the default partition parameters.tfvars. For example, using the dynamic worker image provided by the ArmoniK Team:

default = {
  # number of replicas for each deployment of compute plane
  replicas = 0
  # ArmoniK polling agent
  polling_agent = {...
  }
  # ArmoniK workers
  worker = [
    {
-     image = "dockerhubaneo/armonik_worker_dll"
+     image = "armonik-cpp-hello-client"
+     tag = "0.1.0-api"
      limits = {...}
      requests = {...}
    }
  ]
  hpa = {...
  }
}

or

Creating a new partition for the C++ worker: You will need to edit the parameters.tfvars file and add the new partition with the right image name and tag:

+hellocpp = {
+  # number of replicas for each deployment of compute plane
+  replicas = 0
+  # ArmoniK polling agent
+  polling_agent = {...
+  }
+  # ArmoniK workers
+  worker = [
+    {
+      image = "armonik-cpp-hello-client"
+      tag = "0.1.0-api"
+      limits = {...}
+      requests = {...}
+    }
+  ]
+  hpa = {...
+  }
+}

Run the deploy command again to update the image.

You can now run your client application to send tasks over to ArmoniK, if you edited the default partition:

docker run --rm armonik-cpp-hello-client:0.1.0-api

If you added a new partition:

docker run --rm -e GrpcClient__Endpoint="http://{armonik-output-ip}:5001" -e PartitionId=hellocpp armonik-cpp-hello-client:0.1.0-api

Replace {armonik-output-ip} with the ip resulting from our make deploy command in the ArmoniK repo.

That’s it! You can now develop and run C++ applications on ArmoniK.

Troubleshooting

My worker hasn’t updated after I redeployed it with the same tag

If your worker hasn’t updated after redeployment with the same tag, use the following command to update the image in your local deployment:

kubectl set image deployment/compute-plane-default -n armonik worker-0=image-name

If the issue persists, try changing the image name temporarily before reverting it to the correct name.

I get an error in Seq that says that my TaskOptions have missing parameters

If you haven’t modified this code, the more likely cause of this error is that you haven’t updated the image name and tag in ArmoniK. Make sure to redeploy after doing so (run make deploy).