percona · rasika-chivate · Nov 21, 2024 · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024
diff --git a/docs/release-notes/image-1.png → docs/images/image-1.png b/docs/release-notes/image-1.png → docs/images/image-1.png
diff --git a/docs/release-notes/image.png → docs/images/image.png b/docs/release-notes/image.png → docs/images/image.png
diff --git a/docs/index.md b/docs/index.md
@@ -13,11 +13,10 @@ Percona Everest is the first open-source platform for automated database provisi
 
 Let's start by enabling you to deploy an automated private DBaaS, eliminating vendor lock-in and complex in-house platform development. 
 
-[Percona Everest quickstart guide:material-arrow-right:](quickstart-guide/quick-install.md){.md-button }  [Manage your first cluster :material-arrow-right:](use/db_provision.md){.md-button }
+[Percona Everest quickstart guide:material-arrow-right:](quick-install.md){.md-button }  [Manage your first cluster :material-arrow-right:](use/db_provision.md){.md-button }
 
 
-
-## In this documentation
+Refer to our documentation, and you'll be set up in no time.
 
 <div data-grid markdown><div data-banner markdown>
 

diff --git a/docs/install/SetupPrereqs.md b/docs/install/SetupPrereqs.md
diff --git a/docs/quickstart-guide/eks.md → docs/install/eks.md b/docs/quickstart-guide/eks.md → docs/install/eks.md
diff --git a/docs/quickstart-guide/gke.md → docs/install/gke.md b/docs/quickstart-guide/gke.md → docs/install/gke.md
diff --git a/docs/install/installEverest.md b/docs/install/installEverest.md
@@ -1,4 +1,4 @@
-# Install Everest
+# Install Percona Everest using CLI
 
 ## Before you start
 
@@ -8,7 +8,13 @@ Before running the commands in the **Installation** section, note that Everest w
 export KUBECONFIG=~/.kube/config
 ```
 
-## Installation
+## Install Percona Everest
+
+!!! info "Important"
+    Starting from version 1.4.0, `everestctl` now uses the Helm chart to install Percona Everest. To configure chart parameters during installation through the CLI, 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:
 {.power-number}
@@ -24,8 +30,9 @@ To install and provision Percona Everest to Kubernetes:
 
     Enter the specific names for the namespaces you want Percona Everest to manage, separating each name with a comma. [These](../use/multi-namespaces.md#default-namespaces-in-percona-everest) namespaces are restricted and cannot be used for deploying databases. Make sure that you enter **at least** one namespace.
 
+    **Alternative command**
 
-    Alternatively, you can set multiple namepaces in the headless mode:
+    You can set multiple namepaces in the headless mode:
 
     ```sh
     everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.xtradb-cluster=true --skip-wizard

diff --git a/docs/install/installEverestCLI.md b/docs/install/installEverestCLI.md
@@ -1,53 +1,81 @@
-# Install Everest CLI
+# Install Percona Everest CLI
+
+!!! info "Important"
+    Installing the Percona Everest CLI is only necessary if you want to use it to install Percona Everest; it is **not** required if you prefer to install Percona Everest with Helm.
 
 You can download the latest version of Everest CLI by visiting the latest release page in [this repository](https://github.com/percona/everest/releases/latest).
 
-## Linux and WSL
 
-To install Everest CLI on Linux or WSL, run the following commands:
+=== "Linux and WSL"
+
+    To install Everest CLI on Linux or WSL, run the following commands:
+    {.power-number}
+
+    1. Download the latest version of Everest CLI.
+
+        ```sh
+        curl -sSL -o everestctl-linux-amd6 https://github.com/percona/everest/releases/latest/download/everestctl-linux-amd64
+        ```
+
+    2. Install the Everest CLI binary to /usr/local/bin/.
+
+        ```sh
+        sudo install -m 555 everestctl-linux-amd64 /usr/local/bin/everestctl
+        ```
+
+    3. Remove the Everest CLI binary to clean up.
+
+        ```sh
+        rm everestctl-linux-amd64
+        ```         
+
+=== "macOS (Apple Silicon)"
+
+    To install Everest CLI on macOS with Apple Silicon, run the following commands:
+    {.power-number}
+
+    1. Download the latest version of Everest CLI for Apple Silicon.
 
-```bash
-# Download the latest version of Everest CLI
-curl -sSL -o everestctl-linux-amd64 https://github.com/percona/everest/releases/latest/download/everestctl-linux-amd64
+        ```sh
+        curl -sSL -o everestctl-darwin-arm64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-arm64
+        ```
 
-# Install the Everest CLI binary to /usr/local/bin/
-sudo install -m 555 everestctl-linux-amd64 /usr/local/bin/everestctl
+    2. Install the Everest CLI binary to /usr/local/bin/.
 
-# Remove the Everest CLI binary to clean up
-rm everestctl-linux-amd64
-```
+        ```sh
+        sudo install -m 555 everestctl-darwin-arm64 /usr/local/bin/everestctl
+        ```
+    3. Remove the Everest CLI binary to clean up
 
-## macOS (Apple Silicon)
+        ```sh
+        rm everestctl-darwin-arm64
+        ```
 
-To install Everest CLI on macOS with Apple Silicon, run the following commands:
+=== "macOS (Intel CPU)"
 
-```bash
-# Download the latest version of Everest CLI for Apple Silicon
-curl -sSL -o everestctl-darwin-arm64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-arm64
+    To install Everest CLI on macOS with an Intel CPU, run the following commands:
+    {.power-number}
 
-# Install the Everest CLI binary to /usr/local/bin/
-sudo install -m 555 everestctl-darwin-arm64 /usr/local/bin/everestctl
 
-# Remove the Everest CLI binary to clean up
-rm everestctl-darwin-arm64
-```
+    1. Download the latest version of Everest CLI for Intel CPUs.
 
-## macOS (Intel CPU)
+        ```sh
+        curl -sSL -o everestctl-darwin-amd64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-amd64
+        ```
 
-To install Everest CLI on macOS with an Intel CPU, run the following commands:
+    2. Install the Everest CLI binary to /usr/local/bin/.
 
-```bash
-# Download the latest version of Everest CLI for Intel CPUs
-curl -sSL -o everestctl-darwin-amd64 https://github.com/percona/everest/releases/latest/download/everestctl-darwin-amd64
+        ```sh
+        sudo install -m 555 everestctl-darwin-amd64 /usr/local/bin/everestctl
+        ```
 
-# Install the Everest CLI binary to /usr/local/bin/
-sudo install -m 555 everestctl-darwin-amd64 /usr/local/bin/everestctl
+    3. Remove the Everest CLI binary to clean up.
 
-# Remove the Everest CLI binary to clean up
-rm everestctl-darwin-amd64
-```
+        ```sh
+        rm everestctl-darwin-amd64
+        ```
 
-### Next steps
+## Next steps
 
 Start by installing Percona Everest: 
 

diff --git a/docs/install/install_everest_helm_charts.md b/docs/install/install_everest_helm_charts.md
@@ -0,0 +1,153 @@
+# Install Percona Everest using Helm
+
+This section explains how to install Percona Everest using [Helm](https://helm.sh/) as an alternative to `everestctl`. Helm charts simplify the deployment process by packaging all necessary resources and configurations, making them ideal for automating and managing installations in Kubernetes environments.
+
+Percona Helm charts can be found in [percona/percona-helm-charts]( https://github.com/percona/percona-helm-charts/tree/main/charts/everest) repository in Github.
+
+## Install Percona Everest and deploy database namespaces
+
+Here are the steps to install Percona Everest and deploy additional database namespaces:
+{.power-number}
+
+1. Add the Percona Helm repository:
+
+    ```sh
+    helm repo add percona https://percona.github.io/percona-helm-charts/
+    ```
+
+2. Install Percona Everest:
+
+    ```sh
+    helm install everest-core percona/everest \
+    --namespace everest-system \
+    --create-namespace
+    ```
+
+    ??? info "What's happening under the hood"
+        The command does the following:
+        {.power-number}
+
+        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`
+
+3. Once the installation is complete, retrieve the `admin` password:
+
+    ```sh
+    kubectl get secret everest-accounts -n everest-system -o jsonpath='{.data.users\.yaml}' | base64 --decode  | yq '.admin.passwordHash'
+    ```
+
+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:
+
+    === "Load Balancer"
+
+        1. Use the following command to change the Everest service type to `LoadBalancer`:
+
+            ```sh
+            kubectl patch svc/everest -n everest-system -p '{"spec": {"type": "LoadBalancer"}}'
+            ```
+
+        2. 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 [http://34.175.201.246](http://34.175.201.246): 
+
+            ```sh 
+            kubectl get svc/everest -n everest-system
+            ```
+
+            ??? example "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
+                ```
+
+
+    === "Node Port"
+        A NodePort is a service that makes a specific port accessible on all nodes within the cluster. It enables external traffic to reach services running within the Kubernetes cluster by assigning a static port to each node's IP address.
+
+        1. Run the following command to change the Everest service type to `NodePort`:
+
+            ```sh
+            kubectl patch svc/everest -n everest-system -p '{"spec": {"type": "NodePort"}}
+            ```
+        2. The following command displays the port assigned by Kubernetes to the everest service, which is `32349` in this case.
+
+            ```sh
+            kubectl get svc/everest -n everest-system
+            NAME      TYPE       CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
+            everest   NodePort   10.43.139.191   <none>        8080:32349/TCP   28m
+            ```
+
+        3. Retrieve the external IP addresses for the kubernetes cluster nodes.
+
+            ```sh
+            kubectl get nodes -o wide
+            NAME                   STATUS   ROLES    AGE   VERSION             
+            INTERNAL-IPEXTERNAL-IP  OS-IMAGE                        KERNEL-VERSION   
+            CONTAINER-RUNTIME
+            gke-everest-test-default-pool-8bbed860-65gx   Ready    <none>   3m35s   
+            v1.30.3-gke.1969001   10.204.15.199   34.175.155.135   Container- 
+            Optimized OS from Google   6.1.100+         containerd://1.7.19
+            gke-everest-test-default-pool-8bbed860-pqzb   Ready    <none>   3m35s   
+            v1.30.3-gke.1969001   10.204.15.200   34.175.120.50    Container- 
+            Optimized OS from Google   6.1.100+         containerd://1.7.19
+            gke-everest-test-default-pool-8bbed860-s0hg   Ready    <none>   3m35s   
+            v1.30.3-gke.1969001   10.204.15.201   34.175.201.246   Container- 
+            Optimized OS from Google   6.1.100+         containerd://1.7.19
+            ```
+
+        4. To launch the Percona Everest UI and create your first database cluster, go to the IP address/port found in steps 2 and 3. In this example, the external IP address used is [http://34.175.155.135:32349](http://34.175.155.135:32349). Nevertheless, you have the option to use any node IP specified in the above steps.
+
+    === "Port Forwarding"
+        Run the following command to use `Kubectl port-forwarding` for connecting to Everest without exposing the service:
+
+        ```sh
+        kubectl port-forward svc/everest 8080:8080 -n everest-system
+        ``` 
+
+        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. 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. It is highly recommended to update the password using `everestctl` to ensure that the passwords are hashed.
+
+5. Deploy additional database namespaces:
+
+    Once Percona Everest is successfully running, you can create additional database namespaces using the `everest-db-namespace` Helm chart. 
+
+    If you set `dbNamespaces.enabled=false` in the previous step, you can deploy a database namespace with the following command:
+
+    ```sh
+    helm install everest \
+    percona/everest-db-namespace \
+    --create-namespace \
+    --namespace everest
+    ```
+
+    !!! 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.
+
+## Configure parameters
+
+You can customize various parameters in the Percona Everest Helm charts for your deployment to meet your specific needs. Refer to the [Helm documentation](https://helm.sh/docs/chart_best_practices/values/){:target="_blank"} 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](https://github.com/percona/percona-helm-charts/blob/main/charts/everest/README.md#configuration){:target="_blank"}.
+
+
+**percona/everest chart**
+
+|**Key**|**Type**|**Default**|**Description**|
+|------|---------|-----------|---------------|
+|`server.initialAdminPassword`|string|""|Initial password configured for admin user.</br></br> If it is not set, a random password is generated. It is recommended to reset the admin password after installation.|
+|`server.oidc`|object|{}|OIDC configuration for Everest.</br></br> These settings are applied only during installation. To modify the settings after installation, you have to manually update the everest-settings `ConfigMap`.|
+
+
+**percona/everest-db-namespace subchart**
+
+|**Key**|**Type**|**Default**|**Description**|
+|-------|--------|-----------|---------------
+|`pxc`|bool|true| Installs the Percona XtraDB Cluster operator if set.|
+|everest-db-namespace|`postgresql`|bool|true| Installs the Percona Postgresql Server operator if set.|
+|`psmdb`|bool|true| Installs the Percona Server MongoDB operator if set.|