Skip to content
Percona Documentation

Percona Everest quick install guide

This section provides instructions for quickly installing and getting started with Percona Everest.

Prerequisites

Before getting started with Percona Everest, do the following:

  1. Install curl.

  2. Set up a Kubernetes cluster.

    Note

    Percona Everest assists with installing all the necessary operators and required packages, but does not deploy a Kubernetes cluster.

    We recommend setting up Percona Everest on the Amazon Elastic Kubernetes Service (EKS) or Google Kubernetes Engine (GKE).

    Create EKS cluster Create GKE cluster

  3. Verify that you have access to the Kubernetes cluster that you want to use with Everest. By default, Everest uses the kubeconfig file available under ~/.kube/config.

    If your file is located elsewhere, use the export command below to set the KUBECONFIG environment variable:

    export KUBECONFIG=~/.kube/config

    To verify access to the Kubernetes cluster, run the following command:

    kubectl get nodes
    Expected output 
    NAME                                    STATUS   ROLES    AGE   VERSION
gke-<name>-default-pool-75d48bfc-bx8g   Ready    <none>   11h   v1.26.7-gke.500
gke-<name>-default-pool-75d48bfc-c2df   Ready    <none>   11h   v1.26.7-gke.500
gke-<name>-default-pool-75d48bfc-zl7k   Ready    <none>   11h   v1.26.7-gke.500

Procedure

You can download the latest version of Everest CLI by visiting the latest release page in this repository.

  1. Download and install Everest CLI.

    curl -sSL -o everestctl-linux-amd64 https://github.com/percona/everest/releases/latest/download/everestctl-linux-amd64
sudo install -m 555 everestctl-linux-amd64 /usr/local/bin/everestctl
rm everestctl-linux-amd64       

    curl -sSL -o everestctl-darwin-arm64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-arm64
sudo install -m 555 everestctl-darwin-arm64 /usr/local/bin/everestctl
rm everestctl-darwin-arm64      

    curl -sSL -o everestctl-darwin-amd64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-amd64
sudo install -m 555 everestctl-darwin-amd64 /usr/local/bin/everestctl
rm everestctl-darwin-amd64

  2. Install Everest and provision the Kubernetes cluster:

    everestctl install

    Enter the specific names for the namespaces you want Everest to manage, separating each name with a comma.

    Important

    • Make sure that you enter at least one namespace.
    • Ensure to copy the authorization token displayed on the terminal in this step. You will need this token to log in to the Percona Everest UI.

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

    • Use the following command to change the Everest service type to LoadBalancer:

      kubectl patch svc/everest -n everest-system -p '{"spec": {"type": "LoadBalancer"}}'

    • Retrieve the external IP address for the Everest service. This is the address where you can then launch Everest at the end of the installation procedure. In this example, the external IP address used is the default 127.0.0.1: 

      kubectl get svc/everest -n everest-system

    Run the following command to use Kubectl port-forwarding for connecting to Everest without exposing the service:

    kubectl port-forward svc/everest 8080:8080 -n everest-system

    Percona Everest will be available at http://127.0.0.1:8080.

Video tutorial

You can also learn about installing Percona Everest via the Quick-Install script by following the video tutorial below:

Next steps

Provision a database

Get expert help

If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.

Community Forum Get a Percona Expert