Spring boot tooling support

[kuldeeparora89]

Hi,

We are writing a product on theia which will be based on spring boot. Most of the architecture is similar to coffeee-editor but a end java product would be a spring boot application . We are able to deploy our product successfully on theia.cloud & able to generate spring boot code . But now problem is exposing the spring server http URL to the outside world , as by default only port 3000 is exposed by a running session over a service.
I was able to get around this problem by deploying the custom image of operator that adds custom service port , ingress path & also exposes spring boot port from the deployment.

End results (yamls):

apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    deployment.kubernetes.io/revision: "1"
  creationTimestamp: "2023-01-30T07:02:17Z"
  generation: 1
  name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-deployment-kuldeep-singh
  namespace: theiacloud
  ownerReferences:
  - apiVersion: theia.cloud/v2beta
    kind: Session
    name: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session
    uid: 27b06fc5-e362-45c6-bc5e-8a9ae7dce82b
  resourceVersion: "6758467"
  uid: 8428f8dd-4476-4fb5-98d6-fe8ceaa053ab
spec:
  progressDeadlineSeconds: 600
  replicas: 1
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      app: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session-2
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      annotations:
        kubernetes.io/egress-bandwidth: 30000k
        kubernetes.io/ingress-bandwidth: 30000k
      creationTimestamp: null
      labels:
        app: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session-2
    spec:
      automountServiceAccountToken: false
      containers:
      - args:
        - --config=/etc/oauth2-proxy.cfg
        - --authenticated-emails-file=/emails/authenticated-emails-list
        - --gcp-healthchecks
        - --reverse-proxy
        image: quay.io/oauth2-proxy/oauth2-proxy
        imagePullPolicy: Always
        name: oauth2-proxy
        ports:
        - containerPort: 5000
          name: web
          protocol: TCP
        resources: {}
        terminationMessagePath: /dev/termination-log
        terminationMessagePolicy: File
        volumeMounts:
        - mountPath: /etc/oauth2-proxy.cfg
          name: oauth2-proxy-config
          subPath: oauth2-proxy.cfg
        - mountPath: /templates
          name: oauth2-templates
        - mountPath: /emails
          name: oauth2-emails
      - env:
        - name: THEIA_CLOUD_APP_ID
          value: asdfghjkl
        - name: THEIA_CLOUD_SERVICE_URL
          value: https://service.20.219.43.26.nip.io
        - name: THEIA_CLOUD_SESSION_UID
          value: 27b06fc5-e362-45c6-bc5e-8a9ae7dce82b
        - name: THEIA_CLOUD_SESSION_NAME
          value: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session
        - name: THEIA_CLOUD_SESSION_USER
          value: [email protected]
        - name: THEIA_CLOUD_SESSION_URL
          value: https://ws.20.219.43.26.nip.io/27b06fc5-e362-45c6-bc5e-8a9ae7dce82b/
        image: kuldeepdocker/impaktapps:v6.0
        imagePullPolicy: Always
        name: theia-cloud-demo
        ports:
        - containerPort: 3000
          protocol: TCP
        - containerPort: 8081
          protocol: TCP
        resources:
          limits:
            cpu: "2"
            memory: 1200M
          requests:
            cpu: 100m
            memory: 1G
        securityContext:
          runAsGroup: 101
          runAsUser: 101
        terminationMessagePath: /dev/termination-log
        terminationMessagePolicy: File
        volumeMounts:
        - mountPath: /home/project/persisted
          name: user-data
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext:
        fsGroup: 101
      terminationGracePeriodSeconds: 30
      volumes:
      - configMap:
          defaultMode: 420
          name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-config-kuldeep-singh-act
        name: oauth2-proxy-config
      - configMap:
          defaultMode: 420
          name: oauth2-templates
        name: oauth2-templates
      - configMap:
          defaultMode: 420
          name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-emailconfig-kuldeep-sing
        name: oauth2-emails
      - name: user-data
        persistentVolumeClaim:
          claimName: a4e264ce6-12c5-4325-8f24-973cc3964f0b-pvc-ws-asdfghjkl-theia-c
status:
  availableReplicas: 1
  conditions:
  - lastTransitionTime: "2023-01-30T07:02:33Z"
    lastUpdateTime: "2023-01-30T07:02:33Z"
    message: Deployment has minimum availability.
    reason: MinimumReplicasAvailable
    status: "True"
    type: Available
  - lastTransitionTime: "2023-01-30T07:02:17Z"
    lastUpdateTime: "2023-01-30T07:02:33Z"
    message: ReplicaSet "a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-deployment-kuldeep-singh-6764f997f"
      has successfully progressed.
    reason: NewReplicaSetAvailable
    status: "True"
    type: Progressing
  observedGeneration: 1
  readyReplicas: 1
  replicas: 1
  updatedReplicas: 1
  
  
-------------------------------


apiVersion: v1
kind: Service
metadata:
  creationTimestamp: "2023-01-30T07:02:17Z"
  labels:
    app: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session-2
  name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-service-kuldeep-singh-ac
  namespace: theiacloud
  ownerReferences:
  - apiVersion: theia.cloud/v2beta
    kind: Session
    name: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session
    uid: 27b06fc5-e362-45c6-bc5e-8a9ae7dce82b
  resourceVersion: "6758359"
  uid: 09804fc2-2758-4f6d-a1fc-df6bec787436
spec:
  clusterIP: 10.0.246.99
  clusterIPs:
  - 10.0.246.99
  internalTrafficPolicy: Cluster
  ipFamilies:
  - IPv4
  ipFamilyPolicy: SingleStack
  ports:
  - name: http
    port: 3000
    protocol: TCP
    targetPort: web
  - name: appserver
    port: 8081
    protocol: TCP
    targetPort: 8081
  selector:
    app: ws-asdfghjkl-theia-cloud-demo-kuldeep-singh-act21-io-session-2
  sessionAffinity: None
  type: ClusterIP
status:


--------------------------------------



apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    acme.cert-manager.io/http01-ingress-class: nginx
    cert-manager.io/cluster-issuer: letsencrypt-prod
    kubernetes.io/ingress.class: nginx
    meta.helm.sh/release-name: theia-cloud
    meta.helm.sh/release-namespace: theiacloud
    nginx.ingress.kubernetes.io/configuration-snippet: |
      proxy_set_header 'X-Forwarded-Uri' $request_uri;
    nginx.ingress.kubernetes.io/proxy-buffer-size: 8k
    nginx.ingress.kubernetes.io/rewrite-target: /$2
  creationTimestamp: "2023-01-29T16:24:31Z"
  generation: 4
  labels:
    app.kubernetes.io/managed-by: Helm
  name: theia-cloud-demo-ws-ingress
  namespace: theiacloud
  ownerReferences:
  - apiVersion: theia.cloud/v3beta
    kind: AppDefinition
    name: theia-cloud-demo
    uid: 7082ebcf-2b05-4ebf-8a6e-d2fba163eede
  resourceVersion: "6758372"
  uid: 8b67a0af-44f5-4d2b-98bf-e56c78af05dc
spec:
  rules:
  - host: ws.20.219.43.26.nip.io
  - host: ws.20.219.43.26.nip.io
    http:
      paths:
      - backend:
          service:
            name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-service-kuldeep-singh-ac
            port:
              number: 3000
        path: /27b06fc5-e362-45c6-bc5e-8a9ae7dce82b(/|$)(.*)
        pathType: Prefix
      - backend:
          service:
            name: a27b06fc5-e362-45c6-bc5e-8a9ae7dce82b-service-kuldeep-singh-ac
            port:
              number: 8081
        path: /27b06fc5-e362-45c6-bc5e-8a9ae7dce82b/appserver
        pathType: Prefix
  tls:
  - hosts:
    - ws.20.219.43.26.nip.io
    secretName: ws-cert-secret
status:
  loadBalancer:
    ingress:
    - ip: 20.219.43.26

Now the spring boot app URL is exposed as - https://ws.20.219.43.26.nip.io/11be757a-9750-466d-8bc7-065100a15f56/appserver/
& we are able to access it.

Is this the correct way of achieving it or is there any better alternative?

[jfaltermeier]

Hi, customizing the operator for this use cases is the expected way.
The first level would be to just replace the templates, if possible: https://github.com/eclipsesource/theia-cloud/tree/45fe3daa072893aba4204bc769ff8f44517788b9/java/operator/org.eclipse.theia.cloud.operator/src/main/resources
The second intended level is to adjust the code as required.

In future milestones we may introduce smaller services the can be exchanged via dependency injection, e.g. a dedicated service for patching the ingress.

[kuldeeparora89]

Thanks @jfaltermeier ,

Followed a similar approach. It would be cool if such extensions will be supported in the future without changing the core logic.