Skip to main content
Version: 2.14

Accessing Ververica Platform

There are multiple ways to access Ververica Platform, depending on your environment.

Port Forwarding​

Kubernetes' built-in Port Fowarding capabilities can be used for quick setup, testing purposes, and for production environments where Ingress is not available or not allowed.

In the example below, assuming you have deployed Ververica Platform using Helm with release name ververica-platform into Kubernetes namespace vvp-system, you can use this command to forward the Ververica Platform REST API and Web User Interface locally on port 8080:

kubectl -n vvp-system port-forward service/api-gateway 8080:8080

You can open the Web user interface using the address http://localhost:8080.

Kubernetes Ingress​

For production environments where Kubernetes Ingress is available, Ververica Platform can be accessed without using Port Forwarding. This is recommended for environments where users of Ververica Platform do not need to have access to the underlaying Kubernetes cluster infrastructure.

** From here this has to be checked. We need to verify the correct Service name that is created ** The Helm chart creates a Service called <release-name>-ververica-platform, which can be accessed directly or referenced from an Ingress.

Examples​

  1. A LoadBalancer Service that exposes Ververica Platform using the release name and Kubernetes namespace above:
apiVersion: v1
kind: Service
metadata:
  name: my-service
  namespace: my-namespace
spec:
  type: LoadBalancer
  ports:
  - name: appmanager
    port: 80
    targetPort: 8080
  selector:
    app: vvp-ververica-platform
    component: appmanager
  1. An Nginx Ingress configured to serve Ververica Platform from an internal domain:
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: nginx
  name: my-ingress
  namespace: my-namespace
spec:
  rules:
  - host: ververica-platform.internal
    http:
      paths:
      - backend:
          serviceName: vvp-ververica-platform
          servicePort: 80
        path: /

If you set a context path i.e. a subpath instead of /, then remember to modify the path appropriately in the Ingress configuration. It must match the context path.

Accessing VVP UI from a Subpath​

You might want to make the Ververica Platform UI accessible from a subpath rather than the root path. To do so, set the context path using Spring Boot configurations.

  1. Using topLevelConfig in your YAML configuration:
topLevelConfig:
  server:
    servlet:
      contextPath: /vvp
  1. Using an environment variable:
env:
  - name: SERVER_SERVLET_CONTEXT_PATH
    value: /vvp

After setting the context path, when you deploy Ververica Platform the UI is accessed from the specified subpath.

The subpath has the format http://localhost:port-number/<context-path>/app. For example:

http://localhost:8080/vvp/app