Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Cookbook documentation #298

Open
Bianco95 opened this issue Oct 2, 2024 · 1 comment
Open

Update Cookbook documentation #298

Bianco95 opened this issue Oct 2, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Bianco95
Copy link
Collaborator

Bianco95 commented Oct 2, 2024

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

@Bianco95 Bianco95 added the documentation Improvements or additions to documentation label Oct 2, 2024
@dciangot dciangot added this to the 0.3.x milestone Oct 2, 2024
@dciangot
Copy link
Collaborator

dciangot commented Oct 2, 2024

Agree, please open a PR with the proposed changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants