Improve docs

jupyter/jupyter-application.yaml

@@ -7,7 +7,7 @@ spec:
   project: default
   source:
     repoURL: https://platform.sunet.se/streams/streams-manifests.git
-    targetRevision: streams-manifests-2025-01-28-v03
+    targetRevision: streams-manifests-2025-01-28-v04
     path: jupyter/overlays/test
   destination:
     server: https://kubernetes.default.svc

jupyter/readme.md

@@ -1,17 +1,71 @@
+# Kubernetes Commands for Jupyter Setup
+
+## Namespace Creation
+
+Create a namespace for Jupyter:
+
+```bash
 kubectl create ns jupyter
+```
+
+## Apply Configuration Files
+
+Deploy persistent storage, deployment, services, and secrets:
+
+```bash
 kubectl -n jupyter apply -f jupyter-persistent-volume.yaml
 kubectl -n jupyter apply -f jupyter-deployment.yaml
 kubectl -n jupyter apply -f jupyter-service.yaml
 kubectl -n jupyter apply -f s3-secrets-trino.yaml
+```
 
-kubectl get pvc -n jupyter
+## Persistent Volume Claims (PVC)
-kubectl get pvc -n jupyter
 
+Check the status of PVCs in the Jupyter namespace:
+
+```bash
+kubectl get pvc -n jupyter
+```
+
+## Port Forwarding
+
+```bash
 kubectl -n jupyter port-forward svc/jupyter-notebook-service 8888:8888
+```
 
-kubectl -n jupyter logs jupyter-notebook-676fb4f85b-sb2h8
+## Logs and Debugging
-kubectl -n jupyter describe jupyter-notebook-676fb4f85b-sb2h8
 
+```bash
+kubectl -n jupyter logs <pod-name>
+kubectl -n jupyter describe <pod-name>
+```
+
+> Replace `<pod-name>` with the name of your Jupyter pod (e.g., `jupyter-notebook-676fb4f85b-sb2h8`).
+
+## Node Details
+
+Get detailed information about cluster nodes:
+
+```bash
 kubectl get no -o=wide
+```
 
-!pip install 
+---
+
+## Apply Argo Application
+
+### Deploy Argo Application
+
+Apply the ArgoCD application configuration:
+
+```bash
+kubectl -n argocd apply -f jupyter-application.yaml
+```
+
+### Verify Deployment
+
+Check the ArgoCD deployment details:
+
+```bash
+kubectl get deploy -n argocd -o=yaml
+```