Run yCrash in OpenShift

Deployment Documentation for yCrash Server in OpenShift

This guide provides step-by-step instructions to deploy the yc-server application in an OpenShift environment using the provided YAML files. The deployment consists of creating Secrets, a Deployment, Services, Routes, PersistentVolumeClaims, and ServiceAccounts.

Prerequisites

Ensure you have the following:

• Proper permissions to create resources (Secrets, Deployments, PVCs, etc.)
• Persistent volumes available in the cluster
• Valid license.lic for yc-server
• Project yc-apps should exist or be created before deployment:

oc new-project yc-apps --display-name 'yCrash App'

Step 1: Create a Secret for yCrash License

The ycrash-server-license Secret contains the license.lic file required by the yc-server application.

apiVersion: v1
kind: Secret
metadata:
  name: ycrash-server-license
  namespace: yc-apps
stringData:
  license.lic: |
    Licensor=********************
    Licensee=********************
    UserNo=********************
    IPAddress=********************
    Feature_1=********************
    Feature_2=********************
    Expiration=********************
    Signature=********************

Apply the Secret:

oc apply -f ycrash-server-license.yaml

Step 2: Create PersistentVolumeClaims (PVCs)

Two PVCs are required:

• logs-pvc : Stores log files generated by yc-server
• uploads-pvc : Stores heap dumps, reports, and other uploaded files

PersistentVolumeClaim for Logs

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: logs-pvc
  namespace: yc-apps
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 2Gi

PersistentVolumeClaim for Uploads

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: uploads-pvc
  namespace: yc-apps
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 5Gi

Apply the PVCs:

oc apply -f logs-pvc.yaml
oc apply -f uploads-pvc.yaml

Step 3: Create the ServiceAccount

The yc-server container will use a dedicated ServiceAccount (yc-server-sa) for interacting with the OpenShift API.

apiVersion: v1
kind: ServiceAccount
metadata:
  name: yc-server-sa
  namespace: yc-apps

Apply the ServiceAccount:

oc apply -f yc-server-sa.yaml

Step 4: Create the Deployment for yCrash Server

The yc-server deployment runs two replicas of the server application. The configuration includes resource requests, license mounting, and volume mounts.

Key Configuration Details:

• License File : Mounted from the Secret ycrash-server-license
• Logs Directory : Mounted from logs-pvc
• Uploads Directory : Mounted from uploads-pvc

apiVersion: apps/v1
kind: Deployment
metadata:
  name: yc-apps
  namespace: yc-apps
  labels:
    app: yc-apps
spec:
  replicas: 2
  selector:
    matchLabels:
      app: yc-apps
  template:
    metadata:
      labels:
        app: yc-apps
    spec:
      serviceAccountName: yc-server-sa
      shareProcessNamespace: true
      terminationGracePeriodSeconds: 180
      containers:
      - name: yc-server
        image: ycrash/ycrash:latest
        imagePullPolicy: Always
        args: 
        - "-Xms2g"
        - "-Xmx4g"
        - "-Xss40m"
        - "-verbose:gc"
        - "-Xlog:gc*:file=/opt/workspace/yc/logs/yc-gclog-%p.gc:time,uptime,level,tags"
        - "-XX:+UnlockDiagnosticVMOptions"
        - "-XX:+HeapDumpOnOutOfMemoryError"
        - "-XX:HeapDumpPath=/opt/workspace/yc/logs/ba-heapdump-%p.hprof"
        - "-XX:ErrorFile=/opt/workspace/yc/logs/ba-log-hs_err_pid-%p.log"
        - "-Duser.language=en"
        - "-Duser.country=en_US"
        - "-Djava.awt.headless=true"
        - "-DhprofStrictnessWarning=true"
        - "-DonlyTroubleshootingReport=true"
        - "-Dapp=yc"
        - "-DlogDir=/opt/workspace/yc/logs"
        - "-DuploadDir=/opt/workspace/yc/uploads"
        - "-jar"
        - "webapp-runner.jar"
        - "-AconnectionTimeout=3600000"
        - "--secure-error-report-valve"
        - "--port"
        - "8080"
        - "yc.war"
        ports:
        - containerPort: 8080
        resources:
          requests:
            memory: 2Gi
            cpu: "200m"
          limits:
            memory: 4Gi
            cpu: "500m"
        volumeMounts:
        - name: ycrash-server-license
          mountPath: "/opt/workspace/yc/uploads/license.lic"
          subPath: license.lic
        - name: logs-pvc
          mountPath: "/opt/workspace/yc/logs"
        - name: uploads-pvc
          mountPath: "/opt/workspace/yc/uploads"
        - name: tmp
          mountPath: "/tmp"
      volumes:
      - name: ycrash-server-license
        secret:
          secretName: ycrash-server-license
          items:
          - key: license.lic
            path: license.lic
      - name: logs-pvc
        persistentVolumeClaim:
          claimName: logs-pvc
      - name: uploads-pvc
        persistentVolumeClaim:
          claimName: uploads-pvc
      - name: tmp
        emptyDir: {}

Apply the Deployment:

oc apply -f yc-server-deployment.yaml

Step 5: Create the Service

The yc-server-service exposes the yc-server container within the cluster.

apiVersion: v1
kind: Service
metadata:
  name: yc-server-service
  labels:
    app: yc-apps
  namespace: yc-apps
spec:
  selector:
    app: yc-apps
  ports:
    - protocol: TCP
      port: 8080
      targetPort: 8080
  type: ClusterIP

Apply the Service:

oc apply -f yc-server-service.yaml

Step 6: Create the Route

The Route exposes the yc-server service outside the OpenShift cluster via the host yc-server-app.local.

apiVersion: route.openshift.io/v1
kind: Route
metadata:
  name: yc-server-route
  namespace: yc-apps
spec:
  host: yc-server-app.local
  to:
    kind: Service
    name: yc-server-service
  port:
    targetPort: 8080
  tls:
    termination: edge
  wildcardPolicy: None

Apply the Route:

oc apply -f yc-server-route.yaml

---

Verification Steps

1. Ensure all resources are created:

oc get all -n yc-apps

2. Add yc-server-app.local to your /etc/hosts file pointing to the ingress IP and access the application:

• Internal : yc-server-service
• External : https://yc-server-app.local (opens new window)

---

Troubleshooting

1. Check logs:

oc logs -f deployment/yc-apps -n yc-apps

2. Verify Routes:

oc get routes -n yc-apps

---

Combined Deployment YAML file

---
# Secret for yc-server license
apiVersion: v1
kind: Secret
metadata:
  name: ycrash-server-license
  namespace: yc-apps
stringData:
  license.lic: |
    apiVersion: v1
kind: Secret
metadata:
  name: ycrash-server-license
  namespace: yc-apps
stringData:
  license.lic: |
    Licensor=********************
    Licensee=********************
    UserNo=********************
    IPAddress=********************
    Feature_1=********************
    Feature_2=********************
    Expiration=********************
    Signature=********************

---
# Deployment for yc-server
apiVersion: apps/v1
kind: Deployment
metadata:
  name: yc-apps
  namespace: yc-apps
  labels:
    app: yc-apps
spec:
  replicas: 2
  selector:
    matchLabels:
      app: yc-apps
  template:
    metadata:
      labels:
        app: yc-apps
    spec:
      terminationGracePeriodSeconds: 180
      containers:
      - name: yc-server
        image: ycrash/ycrash:latest
        imagePullPolicy: Always
        args: 
        - "-Xms2g"
        - "-Xmx4g"
        - "-Xss40m"
        - "-verbose:gc"
        - "-Xlog:gc*:file=/opt/workspace/yc/logs/yc-gclog-%p.gc:time,uptime,level,tags"
        - "-XX:+UnlockDiagnosticVMOptions"
        - "-XX:+HeapDumpOnOutOfMemoryError"
        - "-XX:HeapDumpPath=/opt/workspace/yc/logs/ba-heapdump-%p.hprof"
        - "-XX:ErrorFile=/opt/workspace/yc/logs/ba-log-hs_err_pid-%p.log"
        - "-Duser.language=en"
        - "-Duser.country=en_US"
        - "-Djava.awt.headless=true"
        - "-DhprofStrictnessWarning=true"
        - "-DonlyTroubleshootingReport=true"
        - "-Dapp=yc"
        - "-DlogDir=/opt/workspace/yc/logs"
        - "-DuploadDir=/opt/workspace/yc/uploads"
        - "-jar"
        - "webapp-runner.jar"
        - "-AconnectionTimeout=3600000"
        - "--secure-error-report-valve"
        - "--port"
        - "8080"
        - "yc.war"
        ports:
        - containerPort: 9010
        resources:
          requests:
            memory: 2Gi
            cpu: "200m"
          limits:
            memory: 4Gi
            cpu: "500m"
        volumeMounts:
        - name: ycrash-server-license
          mountPath: "/opt/workspace/yc/uploads/license.lic"
          subPath: license.lic
        - name: logs-pvc
          mountPath: "/opt/workspace/yc/logs"
        - name: uploads-pvc
          mountPath: "/opt/workspace/yc/uploads"
        - name: tmp
          mountPath: "/tmp"
      volumes:
      - name: ycrash-server-license
        secret:
          secretName: ycrash-server-license
          items:
          - key: license.lic
            path: license.lic
      - name: logs-pvc
        persistentVolumeClaim:
          claimName: logs-pvc
      - name: uploads-pvc
        persistentVolumeClaim:
          claimName: uploads-pvc
      - name: tmp
        emptyDir: {}

---
# Service for yc-server
apiVersion: v1
kind: Service
metadata:
  name: yc-server-service
  labels:
    app: yc-apps
  namespace: yc-apps
spec:
  selector:
    app: yc-apps
  ports:
    - protocol: TCP
      port: 8080
      targetPort: 8080
  type: LoadBalancer

---
# Route for yc-server
apiVersion: route.openshift.io/v1
kind: Route
metadata:
  name: yc-server-route
  namespace: yc-apps
spec:
  host: yc-server-app.local
  to:
    kind: Service
    name: yc-server-service
  port:
    targetPort: 8080
  tls:
    termination: edge
  wildcardPolicy: None

---
# PersistentVolumeClaim for Logs
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: logs-pvc
  namespace: yc-apps
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 2Gi

---
# PersistentVolumeClaim for uploads
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: uploads-pvc
  namespace: yc-apps
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 5Gi

---