API Gateway

Caution

Before upgrading to API Gateway 2.1.0, you must first uninstall all Obcerv apps. Due to a breaking change in a core library (Spring Boot), you need to upgrade all Obcerv apps at the same time. Make sure that you reinstall the latest mutually compatible versions of Obcerv apps. See the Obcerv Compatibility Matrix.

The API gateway provides a publicly accessible REST API to interact with the Obcerv platform.

Some apps require access to the API gateway to provide functionality.

Install Copied

  1. Create a chart config file, named api.yaml containing content similar to:

    ingress:
      annotations:
        kubernetes.io/ingress.class: "nginx"
        nginx.org/mergeable-ingress-type: "minion"
    

    Your ingress controller may require custom annotations on the ingress (this example is for ingress-nginx).

  2. Install the chart:

    helm install -f api.yaml obcerv-app-api-gateway itrs/obcerv-app-api-gateway --version 2.1.0 -n <namespace> --wait
    

    Uninstall Copied

helm uninstall obcerv-app-api-gateway -n itrs

Upgrade Copied

To upgrade the app, first uninstall and then install it again using the new version.

["Obcerv"] ["Obcerv > API Gateway"] ["User Guide"]

Was this topic helpful?