Skip to main content
Version: 2.0.0-dev.4 (preview)

Install OpenEverest using Helm

Developer Preview

This is a developer preview release. Features are incomplete and subject to change. The everestctl installation method is not available for this release.

This section explains how to install OpenEverest using Helm. Helm charts simplify the deployment process by packaging all necessary resources and configurations, making them ideal for automating and managing installations in Kubernetes environments.

Important

If you installed OpenEverest using Helm, make sure to uninstall it exclusively through Helm for a seamless removal.

Install OpenEverest​

Here are the steps to install OpenEverest:

  1. Add the OpenEverest Helm repository:

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

  2. Install OpenEverest:

    helm install everest-core openeverest/openeverest \
      --devel \
      --namespace everest-system \
      --create-namespace

    The --devel flag tells Helm to include pre-release versions, so this installs the latest developer preview available in the repository.

    Pin a specific version

    To install an exact release for reproducibility, add the --version flag, for example --version "2.0.0-dev.3".

  3. Install the MongoDB Provider:

    helm install provider-percona-server-mongodb \
      oci://ghcr.io/openeverest/charts/provider-percona-server-mongodb \
      --namespace everest-system
    Find more providers and plugins in the Plugin Hub

    OpenEverest ships with the Plugin Hub, an in-product catalog for discovering additional providers and plugins. Open it in the OpenEverest UI at /plugins/plugin-hub, or find it in the left-hand menu. Learn more in the Extension Hub docs, browse the online catalog at openeverest.io/extensions ↗, or read the Plugin Hub introduction blog post.

  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.

    • The default admin password is stored in plain text. It is highly recommended to update the password after installation.

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

  5. Access the OpenEverest UI/API using one of the following options for exposing it, as OpenEverest is not exposed with an external IP by default:

    Use the following commands to change the Everest service type to LoadBalancer:

    1. Run the following command:

      helm upgrade everest-core openeverest/openeverest \
      --namespace everest-system \
      --reuse-values \
      --set server.service.type=LoadBalancer

    2. Retrieve the external IP address for the everest service. This is the address where you can then launch OpenEverest at the end of the installation procedure. In this example, the external IP address used is http://34.175.201.246.

      kubectl get svc/everest -n everest-system
      Expected output
      NAME      TYPE           CLUSTER-IP      EXTERNAL-IP     PORT(S)          AGE
      everest   LoadBalancer   10.43.172.194   34.175.201.246       8080:8080/TCP    10s
      When TLS is enabled
      NAME      TYPE           CLUSTER-IP      EXTERNAL-IP     PORT(S)          AGE
      everest   LoadBalancer   10.43.172.194   34.175.201.246       443:8080/TCP    10s

Configure parameters​

You can customize various parameters in the OpenEverest Helm charts for your deployment to meet your specific needs. Refer to the Helm documentation to discover how to configure these parameters.

A few parameters are listed in the following table. For a detailed list of the parameters, see the README.

openeverest/openeverest chart

KeyTypeDefaultDescription
server.initialAdminPasswordstring""Initial password configured for admin user.

If it is not set, a random password is generated. It is recommended to reset the admin password after installation.
server.oidcobject{}OIDC configuration for Everest.

These settings are applied only during installation. To modify the settings after installation, you have to manually update the everest-settings ConfigMap.

Next steps​

Provision a database →