Skip to main content
Version: 1.15

Install OpenEverest using everestctl

ACTION REQUIRED: OpenEverest and Bitnami Container Catalog changes

Bitnami is restructuring its container catalog on September 29, 2025. To avoid potential failures in OpenEverest operations, follow the steps outlined in this post.

Before you start​

Before running the commands in the Installation section, note that OpenEverest will search for the 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
Important

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

Install OpenEverest​

Important

Starting from version 1.4.0, everestctl now uses the Helm chart to install OpenEverest. To configure chart parameters during installation through everestctl, you can:

  • Use the --helm.set flag to specify individual parameter values.
  • Provide a values file with the --helm.values flag for bulk configuration.

To install and provision OpenEverest to Kubernetes:

  1. Download the latest release of everestctl to provision OpenEverest. For detailed installation instructions, see everestctl installation documentation.

  2. You can install OpenEverest using either the wizard or the headless mode.

    note

    • If you do not specify a namespace, the everest namespace gets provisioned by default.

    • You can skip provisioning the database namespace during initial installation by using the flag --skip-db-namespace.

      everestctl install --skip-db-namespace

      To explore namespaces management in details, refer to the section on namespace management.

    • Install OpenEverest using the wizard

      1. Run the following command.

        everestctl install

      2. Enter the specific names for the namespaces you want OpenEverest to manage, separating each name with a comma. These namespaces are restricted and cannot be used for deploying databases.

      3. If you skip adding the namespaces while installing OpenEverest, you can add them later using the following command.

        everestctl namespaces add <NAMESPACE>

    • Install OpenEverest using the headless mode

      1. Run the following command. You can set multiple namepaces in the headless mode. Replace <namespace-name> with the desired name for your namespace.

        everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.mysql=true --skip-wizard
        note

        The flag --operator.xtradb-cluster has been deprecated and will be removed in the subsequent releases. While it will continue to function for now, users will receive a warning message asking them to use --operator.mysql instead.

        Example
        everestctl install --namespaces dev,prod --operator.mongodb=true --operator.postgresql=true --operator.mysql=true --skip-wizard

        Optional installation flags

        | Flags | Description |Helm flag | |------------------|--------------------------------------------------------------------------------------------------|----------------------------------| | PMM deployment | Deploy Percona Monitoring and Management (PMM) as a sub-chart. PMM will be automatically deployed within the everest-system namespace. | --helm.set pmm.enabled=true | | TLS enabled | Enable TLS encryption for secure communication between OpenEverest components.| --helm.set server.tls.enabled=true |

        Examples

        Install with PMM enabled

        everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.mysql=true --helm.set pmm.enabled=true --skip-wizard

        Install OpenEverest with TLS enabled:

        everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.mysql=true --helm.set server.tls.enabled=true --skip-wizard

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

      2. If you skip adding the namespaces while installing OpenEverest, you can add them later using the following command.

        everestctl namespaces add <NAMESPACE>

  3. Update the password for the admin user:

    everestctl accounts set-password --username admin
    Important

    You can retrieve the automatically generated password by running the everestctl accounts initial-admin-password command. However, this password isn't stored securely.

    To access detailed information about user management, see the Manage users in OpenEverest section.

  4. 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:

    1. Use the following command to change the Everest service type to LoadBalancer:

      helm upgrade everest 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

Next steps​

Provision a database →