Install Percona Everest and expose via Ingress controller¶

This section explains how to install Percona Everest using Helm or everestctl and expose Percona Everest 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.

Install Percona Everest using HelmInstall Percona Everest using everesctl

Percona Helm charts are in the percona/percona-helm-charts repository on GitHub.

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

Add the Percona Helm repository:

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

Install Percona Everest with Ingress enabled:
```
helm --install everest percona/everest \
  -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 Percona Everest components in the everest-system namespace. Currently, specifying a different namespace for Percona Everest 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

Verify the Ingress resource:

kubectl get ingress -n everest-system

Ensure the address provided is valid and correctly routes to the Percona 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 Percona Everest using this YAML file:

helm --install everest percona/everest \
  -n everest-system \
  -f everest-values.yaml

🔒 Install Percona Everest with TLS enabled

Install Percona Everest with TLS enabled:

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

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

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 Everest 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 Percona Everest section.
To access the Everest UI/API, open your browser and go to https://everest.example.com.

Note

Replace everest.example.com with your own domain.
Deploy additional database namespaces:

Once Percona Everest 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 \
percona/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.

Important

Starting from version 1.4.0, everestctl now uses the Helm chart to install Percona Everest. 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 Percona Everest to Kubernetes:

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

Install Percona Everest:

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

Replace everest.example.com with your own domain.

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

Verify Ingress:

kubectl get ingress -n everest-system

Make sure the address provided is valid and that it correctly routes to the Percona Everest service.

Example: Custom YAML configuration 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 to which it applies.
tls: []
        #  - secretName: everest-tls
        #    hosts:
        #      - everest.example.com

Install Percona Everest using this file:

everestctl install --helm.values everest-values.yaml

Once the installation is complete, retrieve the admin password.
```
everestctl accounts initial-admin-password
```
- The default username for logging into the Everest 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.
  
  Important
  
  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 at everestctl installation guide.
  
  To access detailed information on user management, see the manage users in Percona Everest section.
To access the Everest UI/API, open your browser and go to https://everest.example.com.

Note

Replace everest.example.com with your own domain.
If you skip adding the namespaces while installing Percona Everest, you can add them later using the following command.
```
everestctl namespaces add <NAMESPACE>
```

Next steps¶

Provision a database