Skip to main content
Version: 1.15

Install OpenEverest and expose via Ingress controller

This section explains how to install OpenEverest using Helm or everestctl and expose OpenEverest using Ingress.

An Ingress Controller is a Kubernetes component that manages external access to services within a cluster, usually over HTTP and HTTPS. It is responsible for processing Ingress resources, which are rules that define how traffic should be routed to different services within the cluster.

Prerequisites​

  • A kubeconfig file in the ~/.kube/config path. If your file is located elsewhere, use the export command below to set the KUBECONFIG environment variable:

    export KUBECONFIG=~/.kube/config

  • An Ingress controller (e.g., Nginx) installed on your Kubernetes cluster

  • (Optional but recommended for production) A TLS certificate stored in a Kubernetes Secret.

OpenEverest Helm charts are in the openeverest/helm-charts repository on GitHub.

Here are the steps to install OpenEverest and deploy additional database namespaces:

  1. Add the Percona Helm repository:

    helm repo add openeverest https://openeverest.github.io/helm-charts/
    helm repo update

  2. Install OpenEverest with Ingress enabled:

    helm install everest openeverest/openeverest \
      -n everest-system \
      --set ingress.enabled=true \
      --set ingress.ingressClassName="" \
      --set ingress.hosts[0].host=everest.example.com \
      --set ingress.hosts[0].paths[0].path=/ \
      --set  ingress.hosts[0].paths[0].pathType=ImplementationSpecific
    note

    Replace everest.example.com with your own domain.

    What's happening under the hood

    The command does the following:

    1. Deploys the OpenEverest components in the everest-system namespace. Currently, specifying a different namespace for OpenEverest is not supported.

    2. Deploys a new namespace called everest for your databases and the database operators.

      You can override the name of the database namespace by using the dbNamespace.namespaceOverride parameter. If you prefer to deploy just the core components, set dbNamespace.enabled=false

  3. Verify the Ingress resource:

    kubectl get ingress -n everest-system

    Ensure the address provided is valid and correctly routes to the everest service.

    Example: Using a Helm values file
    ingress:
    # -- Enable ingress for Everest server
      enabled: true
    # -- Ingress class name. This is used to specify which ingress controller should handle this ingress.
      ingressClassName: "nginx"
    # -- Additional annotations for the ingress resource.
      annotations: {}
    # -- List of hosts and their paths for the ingress resource.
      hosts:
        - host: everest.example.com
      paths:
          - path: /
          pathType: ImplementationSpecific
    # -- TLS configuration for the ingress resource.
    # -- Each entry in the list specifies a TLS certificate and the hosts it applies to.
      tls: []
    #  - secretName: everest-tls
    #    hosts:
    #      - everest.example.com

    Install OpenEverest using this YAML file:

    helm install everest openeverest/openeverest \
      -n everest-system \
      -f everest-values.yaml
    🔒 Install OpenEverest with TLS enabled

    Install OpenEverest with TLS enabled:

    helm install everest openeverest/openeverest \
    --namespace everest-system \
    --create-namespace
    --set server.tls.enabled=true

    For comprehensive instructions on enabling TLS for OpenEverest, see the section TLS setup with OpenEverest.

  4. Once the installation is complete, retrieve the admin password.

    kubectl get secret everest-accounts -n everest-system -o jsonpath='{.data.users\.yaml}' | base64 --decode  | yq '.admin.passwordHash'

    • The default username for logging into the OpenEverest UI is admin. You can set a different default admin password by using the server.initialAdminPassword parameter during installation.

      Important

      The default admin password is stored in plain text. It is highly recommended that the password be updated using everestctl to ensure that the passwords are hashed. Instructions for installing everestctl can be found in everestctl installation guide.

      To access detailed information on user management, see the manage users in OpenEverest section.

  5. To access the OpenEverest UI/API, open your browser and go to https://everest.example.com.

    note

    Replace everest.example.com with your own domain.

  6. Deploy additional database namespaces:

    Once OpenEverest runs successfully, you can create additional database namespaces using the everest-db-namespace Helm chart.

    If you set dbNamespaces.enabled=false in step 2, you can deploy a database namespace with the following command:

    helm install everest \
    openeverest/everest-db-namespace \
    --create-namespace \
    --namespace <DB namespace>
    note
    • All database operators are installed in your database namespace by default. You can override this by specifying one or more of the following options: [dbNamespace.pxc=false, dbNamespace.pg=false, dbNamespace.psmdb=false].
    • Installation without chart hooks (i.e, the use of --no-hooks) is currently not supported.

Next steps​

Provision a database →