forked from interTwin-eu/interLink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added timeout for create goroutines. Added deployment example. Delete…
…d obsolete README
- Loading branch information
Showing
7 changed files
with
117 additions
and
201 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,127 +1 @@ | ||
| # SLURM DEMO | ||
|
|
||
| ## Deploy interlink+SLURM demo locally | ||
|
|
||
| __N.B.__ in the demo the oauth2 proxy authN/Z is disabled. DO NOT USE THIS IN PRODUCTION unless you know what you are doing. | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Docker | ||
| - Minikube (kubernetes-version 1.24.3) | ||
| - Clone interlink repo | ||
|
|
||
| ```bash | ||
| git clone https://github.com/interTwin-eu/interLink.git | ||
| ``` | ||
|
|
||
| Move to example location: | ||
|
|
||
| ```bash | ||
| cd interLink/examples/interlink-slurm | ||
| ``` | ||
|
|
||
| ### Bootstrap a minikube cluster | ||
|
|
||
| ```bash | ||
| minikube start --kubernetes-version=1.24.3 | ||
| ``` | ||
|
|
||
| ### Configure interLink | ||
|
|
||
| First of all, you need a valid kubeconfig file to be passed to the interLink docker compose. With minikube you will need the following script (check that `PATH_TO_KUBECONFIG` env is pointing to the correct kubeconfig first), otherwise you can simply copy your own there. | ||
|
|
||
| __N.B.__ the kubeconfig file should be a stand-alone one. So the certificate data should be loaded as strings not as path. | ||
|
|
||
| ```bash | ||
| export PATH_TO_KUBECONFIG=$HOME/.kube/config | ||
| export CA_DATA=$(cat $HOME/.minikube/ca.crt | base64 -w0) | ||
| export CERT_DATA=$(cat $HOME/.minikube/profiles/minikube/client.crt | base64 -w0) | ||
| export KEY_DATA=$(cat $HOME/.minikube/profiles/minikube/client.key | base64 -w0) | ||
|
|
||
| mkdir -p interlink/config | ||
|
|
||
| cp $PATH_TO_KUBECONFIG vk/kubeconfig.yaml | ||
| sed 's/certificate-authority:.*/certificate-authority-data: '$CA_DATA'/g' $PATH_TO_KUBECONFIG | sed 's/client-certificate:.*/client-certificate-data: '$CERT_DATA'/g' - | sed 's/client-key:.*/client-key-data: '$KEY_DATA'/g' - > vk/kubeconfig.yaml | ||
|
|
||
| chmod 777 vk/kubeconfig.yaml | ||
| ``` | ||
|
|
||
| Then you need to provide the interLink IP address that should be reachable from the kubernetes pods. In case of this demo setup, that address __is the address of your machine__ | ||
|
|
||
| ```bash | ||
| export INTERLINK_IP_ADDRESS=XXX.XX.X.XXX | ||
|
|
||
| sed -i 's/InterlinkURL:.*/InterlinkURL: "http:\/\/'$INTERLINK_IP_ADDRESS'"/g' interlink/config/InterLinkConfig.yaml | sed -i 's/SidecarURL:.*/SidecarURL: "http:\/\/'$INTERLINK_IP_ADDRESS'"/g' interlink/config/InterLinkConfig.yaml | ||
|
|
||
| sed -i 's/InterlinkURL:.*/InterlinkURL: "http:\/\/'$INTERLINK_IP_ADDRESS'"/g' vk/InterLinkConfig.yaml | sed -i 's/SidecarURL:.*/SidecarURL: "http:\/\/'$INTERLINK_IP_ADDRESS'"/g' vk/InterLinkConfig.yaml | ||
| ``` | ||
|
|
||
| ### Deploy virtualKubelet | ||
|
|
||
| Create the `vk` namespace: | ||
|
|
||
| ```bash | ||
| kubectl create ns vk | ||
| ``` | ||
|
|
||
| Deploy the vk resources on the cluster with: | ||
|
|
||
| ```bash | ||
| kubectl apply -n vk -k vk/ | ||
| ``` | ||
|
|
||
| Check that both the pods and the node are in ready status | ||
|
|
||
| ```bash | ||
| kubectl get pod -n vk | ||
|
|
||
| kubectl get node | ||
| ``` | ||
|
|
||
| ### Deploy interLink via docker compose | ||
|
|
||
| ```bash | ||
| cd interlink | ||
|
|
||
| docker compose up -d | ||
| ``` | ||
|
|
||
| Check logs for both interLink APIs and SLURM sidecar: | ||
|
|
||
| ```bash | ||
| docker logs interlink-interlink-1 | ||
|
|
||
| docker logs interlink-docker-sidecar-1 | ||
| ``` | ||
|
|
||
| ### Deploy a sample application | ||
|
|
||
| ```bash | ||
| kubectl apply -f ../test_pod.yaml | ||
| ``` | ||
|
|
||
| Then observe the application running and eventually succeeding via: | ||
|
|
||
| ```bash | ||
| kubectl get pod -n vk --watch | ||
| ``` | ||
|
|
||
| When finished, interrupt the watch with `Ctrl+C` and retrieve the logs with: | ||
|
|
||
| ```bash | ||
| kubectl logs -n vk test-pod-cfg-cowsay-dciangot | ||
| ``` | ||
|
|
||
| Also you can see with `squeue --me` the jobs appearing on the `interlink-docker-sidecar-1` container with: | ||
|
|
||
| ```bash | ||
| docker exec interlink-docker-sidecar-1 squeue --me | ||
| ``` | ||
|
|
||
| Or, if you need more debug, you can log into the sidecar and look for your POD_UID folder in `.local/interlink/jobs`: | ||
|
|
||
| ```bash | ||
| docker exec -ti interlink-docker-sidecar-1 bash | ||
|
|
||
| ls -altrh .local/interlink/jobs | ||
| ``` | ||
| Check [here](/docs-new/docs/tutorial-users/01-quick-start.md) for a Quick Start tutorial! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: test-deployment-cowsay | ||
| namespace: vk | ||
| spec: | ||
| replicas: 5 | ||
| selector: | ||
| matchLabels: | ||
| app: sleep-ba | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app: sleep-ba | ||
| spec: | ||
| containers: | ||
| - image: docker://ghcr.io/grycap/cowsay | ||
| command: ["/bin/sh"] | ||
| args: ["-c", "\"touch /tmp/test.txt && sleep 60 && echo \\\"hello muu\\\" | /usr/games/cowsay \" " ] | ||
| imagePullPolicy: Always | ||
| name: cowsayo | ||
| nodeSelector: | ||
| kubernetes.io/hostname: test-vk | ||
| tolerations: | ||
| - key: virtual-node.interlink/no-schedule | ||
| operator: Exists | ||
| - key: virtual-kubelet.io/provider | ||
| operator: Exists |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.