openshift-example.md 10 KB
Kubernetes
There are different ways you might run OpenHands on Kubernetes or OpenShift. This guide goes through one possible way:
- Create a PV "as a cluster admin" to map workspace_base data and docker directory to the pod through the worker node
- Create a PVC to be able to mount those PVs to the pod
- Create a pod which contains two containers; the OpenHands and Sandbox containers
Detailed Steps for the Example Above
Note: Make sure you are logged in to the cluster first with the proper account for each step. PV creation requires cluster administrator!
Make sure you have read/write permissions on the hostPath used below (i.e. /tmp/workspace)
- Create the PV: Sample yaml file below can be used by a cluster admin to create the PV.
workspace-pv.yaml
apiVersion: v1 kind: PersistentVolume metadata: name: workspace-pv spec: capacity: storage: 2Gi accessModes: - ReadWriteOnce persistentVolumeReclaimPolicy: Retain hostPath: path: /tmp/workspace# apply yaml file $ oc create -f workspace-pv.yaml persistentvolume/workspace-pv created # review: $ oc get pv NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE workspace-pv 2Gi RWO Retain Available 7m23s
docker-pv.yaml
apiVersion: v1 kind: PersistentVolume metadata: name: docker-pv spec: capacity: storage: 2Gi accessModes: - ReadWriteOnce persistentVolumeReclaimPolicy: Retain hostPath: path: /var/run/docker.sock# apply yaml file $ oc create -f docker-pv.yaml persistentvolume/docker-pv created # review: oc get pv NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE docker-pv 2Gi RWO Retain Available 6m55s workspace-pv 2Gi RWO Retain Available 7m23s
- Create the PVC: Sample PVC yaml file below:
workspace-pvc.yaml
apiVersion: v1 kind: PersistentVolumeClaim metadata: name: workspace-pvc spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi# create the pvc $ oc create -f workspace-pvc.yaml persistentvolumeclaim/workspace-pvc created # review $ oc get pvc NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE workspace-pvc Pending hcloud-volumes 4s $ oc get events LAST SEEN TYPE REASON OBJECT MESSAGE 8s Normal WaitForFirstConsumer persistentvolumeclaim/workspace-pvc waiting for first consumer to be created before bindingdocker-pvc.yaml
apiVersion: v1 kind: PersistentVolumeClaim metadata: name: docker-pvc spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi# create pvc $ oc create -f docker-pvc.yaml persistentvolumeclaim/docker-pvc created # review $ oc get pvc NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE docker-pvc Pending hcloud-volumes 4s workspace-pvc Pending hcloud-volumes 2m53s $ oc get events LAST SEEN TYPE REASON OBJECT MESSAGE 10s Normal WaitForFirstConsumer persistentvolumeclaim/docker-pvc waiting for first consumer to be created before binding 10s Normal WaitForFirstConsumer persistentvolumeclaim/workspace-pvc waiting for first consumer to be created before binding
- Create the pod yaml file: Sample pod yaml file below:
pod.yaml
apiVersion: v1 kind: Pod metadata: name: openhands-app-2024 labels: app: openhands-app-2024 spec: containers: - name: openhands-app-2024 image: ghcr.io/all-hands-ai/openhands:main env: - name: SANDBOX_USER_ID value: "1000" - name: WORKSPACE_MOUNT_PATH value: "/opt/workspace_base" volumeMounts: - name: workspace-volume mountPath: /opt/workspace_base - name: docker-sock mountPath: /var/run/docker.sock ports: - containerPort: 3000 - name: openhands-sandbox-2024 image: ghcr.io/all-hands-ai/sandbox:main ports: - containerPort: 51963 command: ["/usr/sbin/sshd", "-D", "-p 51963", "-o", "PermitRootLogin=yes"] volumes: - name: workspace-volume persistentVolumeClaim: claimName: workspace-pvc - name: docker-sock persistentVolumeClaim: claimName: docker-pvc# create the pod $ oc create -f pod.yaml W0716 11:22:07.776271 107626 warnings.go:70] would violate PodSecurity "restricted:v1.24": allowPrivilegeEscalation != false (containers "openhands-app-2024", "openhands-sandbox-2024" must set securityContext.allowPrivilegeEscalation=false), unrestricted capabilities (containers "openhands-app-2024", "openhands-sandbox-2024" must set securityContext.capabilities.drop=["ALL"]), runAsNonRoot != true (pod or containers "openhands-app-2024", "openhands-sandbox-2024" must set securityContext.runAsNonRoot=true), seccompProfile (pod or containers "openhands-app-2024", "openhands-sandbox-2024" must set securityContext.seccompProfile.type to "RuntimeDefault" or "Localhost") pod/openhands-app-2024 created # Above warning can be ignored for now as we will not modify SCC restrictions. # review $ oc get pods NAME READY STATUS RESTARTS AGE openhands-app-2024 0/2 Pending 0 5s $ oc get pods NAME READY STATUS RESTARTS AGE openhands-app-2024 0/2 ContainerCreating 0 15s $ oc get events LAST SEEN TYPE REASON OBJECT MESSAGE 38s Normal WaitForFirstConsumer persistentvolumeclaim/docker-pvc waiting for first consumer to be created before binding 23s Normal ExternalProvisioning persistentvolumeclaim/docker-pvc waiting for a volume to be created, either by external provisioner "csi.hetzner.cloud" or manually created by system administrator 27s Normal Provisioning persistentvolumeclaim/docker-pvc External provisioner is provisioning volume for claim "openhands/docker-pvc" 17s Normal ProvisioningSucceeded persistentvolumeclaim/docker-pvc Successfully provisioned volume pvc-2b1d223a-1c8f-4990-8e3d-68061a9ae252 16s Normal Scheduled pod/openhands-app-2024 Successfully assigned All-Hands-AI/OpenHands-app-2024 to worker1.hub.internal.blakane.com 9s Normal SuccessfulAttachVolume pod/openhands-app-2024 AttachVolume.Attach succeeded for volume "pvc-2b1d223a-1c8f-4990-8e3d-68061a9ae252" 9s Normal SuccessfulAttachVolume pod/openhands-app-2024 AttachVolume.Attach succeeded for volume "pvc-31f15b25-faad-4665-a25f-201a530379af" 6s Normal AddedInterface pod/openhands-app-2024 Add eth0 [10.128.2.48/23] from openshift-sdn 6s Normal Pulled pod/openhands-app-2024 Container image "ghcr.io/all-hands-ai/openhands:main" already present on machine 6s Normal Created pod/openhands-app-2024 Created container openhands-app-2024 6s Normal Started pod/openhands-app-2024 Started container openhands-app-2024 6s Normal Pulled pod/openhands-app-2024 Container image "ghcr.io/all-hands-ai/sandbox:main" already present on machine 5s Normal Created pod/openhands-app-2024 Created container openhands-sandbox-2024 5s Normal Started pod/openhands-app-2024 Started container openhands-sandbox-2024 83s Normal WaitForFirstConsumer persistentvolumeclaim/workspace-pvc waiting for first consumer to be created before binding 27s Normal Provisioning persistentvolumeclaim/workspace-pvc External provisioner is provisioning volume for claim "openhands/workspace-pvc" 17s Normal ProvisioningSucceeded persistentvolumeclaim/workspace-pvc Successfully provisioned volume pvc-31f15b25-faad-4665-a25f-201a530379af $ oc get pods NAME READY STATUS RESTARTS AGE openhands-app-2024 2/2 Running 0 23s $ oc get pvc NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE docker-pvc Bound pvc-2b1d223a-1c8f-4990-8e3d-68061a9ae252 10Gi RWO hcloud-volumes 10m workspace-pvc Bound pvc-31f15b25-faad-4665-a25f-201a530379af 10Gi RWO hcloud-volumes 13m
Create a NodePort service. Sample service creation command below:
# create the service of type NodePort $ oc create svc nodeport openhands-app-2024 --tcp=3000:3000 service/openhands-app-2024 created # review $ oc get svc NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE openhands-app-2024 NodePort 172.30.225.42 <none> 3000:30495/TCP 4s $ oc describe svc openhands-app-2024 Name: openhands-app-2024 Namespace: openhands Labels: app=openhands-app-2024 Annotations: <none> Selector: app=openhands-app-2024 Type: NodePort IP Family Policy: SingleStack IP Families: IPv4 IP: 172.30.225.42 IPs: 172.30.225.42 Port: 3000-3000 3000/TCP TargetPort: 3000/TCP NodePort: 3000-3000 30495/TCP Endpoints: 10.128.2.48:3000 Session Affinity: None External Traffic Policy: Cluster Events: <none>Connect to OpenHands UI, configure the Agent, then test: