Install on OpenShift with Helm

    The Kong Gateway software is governed by the . Kong Gateway (OSS) is licensed under an Apache 2.0 license.

    • A Kubernetes cluster, v1.19 or later
    • v1.19 or later
    • (Enterprise only) A license.json file from Kong
    • Helm 3

    Create namespace

    Create the namespace for Kong Gateway with Kubernetes Ingress Controller. For example:

    Create license secret

    1. Save your license file temporarily with the filename license (no file extension).

    2. Run:

      1. oc create secret generic kong-enterprise-license -n kong --from-file=./license

    1. Update Helm:

      1. helm repo update

    Create secret for RBAC superuser (recommended)

    If you plan to use RBAC, you must create the superuser account at this step in installation. You cannot create it later.

    1. Create the RBAC account.

    2. Create the secret:

      1. oc create secret generic kong-enterprise-superuser-password \
      2. -n kong \
      3. --from-literal=password={your-password}

    Create secret for Session plugin

    1. Create a session config file for Kong Manager:

      1. $ echo '{"cookie_name":"admin_session","cookie_samesite":"off","secret":"<your-password>","cookie_secure":false,"storage":"kong"}' > admin_gui_session_conf

    2. Create a session config file for Kong Dev Portal:

      Or, if you have different subdomains for the portal_api_url and portal_gui_host, set the and cookie_samesite properties as follows:

      1. $ echo '{"cookie_name":"portal_session","cookie_samesite":"off","cookie_domain":"<.your_subdomain.com">,"secret":"<your-password>","cookie_secure":false,"storage":"kong"}' > portal_session_conf

    3. Create the secret:

      For Kong Manager only:

      1. oc create secret generic kong-session-config \
      2. -n kong \
      3. --from-file=admin_gui_session_conf

      For Kong Manager and Dev Portal:

      1. oc create secret generic kong-session-config \
      2. --from-file=admin_gui_session_conf \
      3. --from-file=portal_session_conf

    Create a values.yaml file to provide required values such as password secrets or optional email addresses for notifications. Work from the . The example file includes comments to explain which values you must set. The readme in the charts repository includes an exhaustive list of all possible configuration properties.

    Note that this deployment includes a Postgres sub-chart provided by Bitnami. You might need to delete the PersistentVolume objects for Postgres in your Kubernetes cluster to connect to the database after install.

    Deploy Kong Gateway with Kubernetes Ingress Controller

    1. Run:

      1. helm install my-kong kong/kong -n kong --values ./values.yaml

    2. Check pod status, and make sure the pod is running:

      1. oc get pods -n kong

    Finalize configuration and verify installation

    1. Run:

    2. Copy the IP address from the output, then add the following to the .env section of your values.yaml file:

      1. admin_api_uri: <your-DNS-or-IP>

    3. Clean up:

      1. oc delete jobs -n kong --all

    4. Update with changed values.yaml:

      1. helm upgrade my-kong kong/kong -n kong --values ./values.yaml

    5. After the upgrade finishes, run:

      1. oc get svc -n kong

      The output includes EXTERNAL-IP values for Kong Manager and Dev Portal. For example:

      1. NAME                          TYPE           CLUSTER-IP       EXTERNAL-IP     PORT(S)                            AGE
      2. my-kong-kong-manager          LoadBalancer   10.96.61.116     10.96.61.116    8002:31308/TCP,8445:32420/TCP      24m

    See the for how-to guides, reference guides, and more.