search

interTwin-eu / interLink

InterLink aims to provide an abstraction for the execution of a Kubernetes pod on any remote resource capable of managing a Container execution lifecycle
https://intertwin-eu.github.io/interLink/
Apache License 2.0
27 stars 12 forks source link

Update Cookbook documentation #298

Open Bianco95 opened 1 week ago

Bianco95 commented 1 week ago

The documentation is very clear and explains in detail the architecture system in its three different versions (edge ​​node, in-cluster, tunneled). However, in some points it can be improved, in particular in the explanation of the installation of the various components and in particular:

Cookbook -> Interlink API Server -> Edge node

At the second point it says “Create the install.sh utility script through the installation utility” with a link to follow. In the new page, there is no trace of the install.sh script, instead there is a script called interlink-remote.sh and reading the guide it would seem to be that. It is necessary to clarify this aspect.

The third point says “Install Oauth2-Proxy and interLink API server services as per Quick start”. Here it is clear how to install the binaries (following the Quick start) but it is not clear that this script is used to install both binaries, so it would be better to specify “Use the script as explained in the Quickstart to install both the OAUTH2 proxy and InterLink binaries”.

Finally, it should be made clear that after installing the binaries you can start them as explained in the Quickstart. This is essential. In the plugin section it is explained how to start the service but not for Interlink.

Deploy Kubernetes components -> Edge node

Inside the configuration of the virtual node it is possible to specify the resources :

virtualNode:
  CPUs: 1000
  MemGiB: 1600
  Pods: 100
  HTTPProxies:
    HTTP: null
    HTTPs: null

It is possible also the specify if the node has some GPU available? In the same configuration file (values.yaml) , why the OAUTH image is specified? This should not be changed from the values.yaml since it is a core component.

Interlink API server -> in-cluster

The button "Testing and Debugging Tips" doesn't point to anything

dciangot commented 1 week ago

Agree, please open a PR with the proposed changes