Skip to content

Update install_everest_helm_charts.md #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion docs/install/installEverest.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,47 @@ To install and provision Percona Everest to Kubernetes:
To access detailed information about user management, see the [Manage users in Percona Everest](../administer/manage_users.md) section.


4. 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:
4. Access the Everest UI/API using one of the following methods. Everest is deployed with a ClusterIP Service by default.

=== "Ingress"

If your Kubernetes cluster has an Ingress controller installed, we can create an Ingress resource pointing to Everest to expose it on port 80. For example:

1. Prepare the Ingress definition

```sh
tee everest_ingress.yaml <<EOF
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: everest-ingress
namespace: percona-everest
annotations:
kubernetes.io/ingress.allow-http: "true"
spec:
ingressClassName: nginx
rules:
- host: everest.percona.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: everest
port:
number: 8080
EOF
```

2. Create the Ingress

```sh
kubectl create -f everest_ingress.yaml
```

See also [Securing Percona Everest with Ingress and Cert-Manager](https://www.percona.com/blog/securing-percona-everest-with-ingress-and-cert-manager/)

=== "Load Balancer"

1. Use the following command to change the Everest service type to `LoadBalancer`:
Expand Down
44 changes: 42 additions & 2 deletions docs/install/install_everest_helm_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,48 @@ Here are the steps to install Percona Everest and deploy additional database nam

To access detailed information on user management, see the [manage users in Percona Everest](../administer/manage_users.md#update-the-password) section.

4. 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:
4. Access the Everest UI/API using one of the following methods. Everest is deployed with a ClusterIP Service by default.

=== "Ingress"

If your Kubernetes cluster has an Ingress controller installed, you can create an Ingress resource pointing to Everest to expose it on port 80. For example:

1. Prepare the Ingress definition:

```sh
tee everest_ingress.yaml <<EOF
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: everest-ingress
namespace: percona-everest
annotations:
kubernetes.io/ingress.allow-http: "true"
spec:
ingressClassName: nginx
rules:
- host: everest.percona.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: everest
port:
number: 8080
EOF
```

2. Create the Ingress:

```sh
kubectl create -f everest_ingress.yaml
```

See also [Securing Percona Everest with Ingress and Cert-Manager](https://www.percona.com/blog/securing-percona-everest-with-ingress-and-cert-manager/)


=== "Load Balancer"

1. Use the following command to change the Everest service type to `LoadBalancer`:
Expand Down Expand Up @@ -136,7 +176,7 @@ Here are the steps to install Percona Everest and deploy additional database nam
To launch the Percona Everest UI and create your first database cluster, go to your localhost IP address [http://127.0.0.1:8080](http://127.0.0.1:8080).


5. Deploy additional database namespaces:
6. Deploy additional database namespaces:
Comment on lines -139 to +179
Copy link
Contributor

@oksana-grishchenko oksana-grishchenko May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see 1 2 3 4 and then 6, are you sure this is the correct numbering?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is due to the tabs. It should be correct but let's have @rasika-chivate have a look


Once Percona Everest is successfully running, you can create additional database namespaces using the `everest-db-namespace` Helm chart.

Expand Down