Skip to content
Merged
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
6 changes: 3 additions & 3 deletions docs/install/installEverest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export KUBECONFIG=~/.kube/config
## Install OpenEverest

!!! info "Important"
Starting from version 1.4.0, `everestctl` now uses the [Helm chart](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} to install OpenEverest. To configure chart parameters during installation through `everestctl`, you can:
Starting from version 1.4.0, `everestctl` now uses the [Helm chart](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} 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.
Expand Down Expand Up @@ -124,7 +124,7 @@ To install and provision OpenEverest to Kubernetes:
1. Use the following command to change the Everest service type to `LoadBalancer`:

```sh
helm upgrade everest-system percona/everest \
helm upgrade everest openeverest/openeverest \
--namespace everest-system \
--reuse-values \
--set server.service.type=LoadBalancer
Expand Down Expand Up @@ -156,7 +156,7 @@ To install and provision OpenEverest to Kubernetes:


```sh
helm upgrade everest-system percona/everest \
helm upgrade everest openeverest/openeverest \
--namespace everest-system \
--reuse-values \
--set server.service.type=NodePort
Expand Down
14 changes: 7 additions & 7 deletions docs/install/install_everest_and_expose_via_ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,22 @@ An Ingress Controller is a Kubernetes component that manages external access to

=== "Install OpenEverest using Helm"

Percona Helm charts are in the [percona/percona-helm-charts]( https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} repository on GitHub.
OpenEverest Helm charts are in the [openeverest/helm-charts](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} repository on GitHub.

Here are the steps to install OpenEverest 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/
helm repo add openeverest https://openeverest.github.io/helm-charts/
helm repo update
```

2. Install OpenEverest with **Ingress enabled**:

```sh
helm install everest percona/everest \
helm install everest openeverest/openeverest \
-n everest-system \
--set ingress.enabled=true \
--set ingress.ingressClassName="" \
Expand Down Expand Up @@ -93,7 +93,7 @@ An Ingress Controller is a Kubernetes component that manages external access to
Install OpenEverest using this `YAML` file:

```sh
helm install everest percona/everest \
helm install everest openeverest/openeverest \
-n everest-system \
-f everest-values.yaml
```
Expand All @@ -103,7 +103,7 @@ An Ingress Controller is a Kubernetes component that manages external access to
Install OpenEverest with TLS enabled:

```sh
helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace
--set server.tls.enabled=true
Expand Down Expand Up @@ -139,7 +139,7 @@ An Ingress Controller is a Kubernetes component that manages external access to

```sh
helm install everest \
percona/everest-db-namespace \
openeverest/everest-db-namespace \
--create-namespace \
--namespace <DB namespace>
```
Expand All @@ -151,7 +151,7 @@ An Ingress Controller is a Kubernetes component that manages external access to
=== "Install OpenEverest using everesctl"

!!! info "Important"
Starting from version 1.4.0, `everestctl` now uses the [Helm chart](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} to install OpenEverest. To configure chart parameters during installation through `everestctl`, you can:
Starting from version 1.4.0, `everestctl` now uses the [Helm chart](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} 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.
Expand Down
22 changes: 11 additions & 11 deletions docs/install/install_everest_helm_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section explains how to install OpenEverest using [Helm](https://helm.sh/){:target="_blank"} 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.

OpenEverest Helm charts can be found in [percona/percona-helm-charts]( https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} repository in Github.
OpenEverest Helm charts can be found in [openeverest/helm-charts](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} repository in Github.

!!! info "Important"
If you installed OpenEverest using Helm, make sure to uninstall it exclusively through Helm for a seamless removal.
Expand All @@ -16,14 +16,14 @@ Here are the steps to install OpenEverest and deploy additional database namespa
1. Add the OpenEverest Helm repository:

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

2. Install OpenEverest:

```sh
helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace
```
Expand Down Expand Up @@ -51,14 +51,14 @@ Here are the steps to install OpenEverest and deploy additional database namespa


```sh
helm install everest-core percona/everest --namespace=everest-system --create-namespace --set pmm.enabled=true
helm install everest-core openeverest/openeverest --namespace=everest-system --create-namespace --set pmm.enabled=true
```


Install OpenEverest with TLS enabled:


helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace
--set server.tls.enabled=true
Expand Down Expand Up @@ -89,7 +89,7 @@ Here are the steps to install OpenEverest and deploy additional database namespa
1. Run the following command:

```sh
helm upgrade everest-core percona/everest \
helm upgrade everest-core openeverest/openeverest \
--namespace everest-system \
--reuse-values \
--set server.service.type=LoadBalancer
Expand Down Expand Up @@ -123,7 +123,7 @@ Here are the steps to install OpenEverest and deploy additional database namespa
1. Run the following command to change the Everest service type to `NodePort`:

```sh
helm upgrade everest-core percona/everest \
helm upgrade everest-core openeverest/openeverest \
--namespace everest-system \
--reuse-values \
--set server.service.type=NodePort
Expand Down Expand Up @@ -192,7 +192,7 @@ Here are the steps to install OpenEverest and deploy additional database namespa

```sh
helm install everest \
percona/everest-db-namespace \
openeverest/everest-db-namespace \
--create-namespace \
--namespace <DB namespace>
```
Expand All @@ -205,18 +205,18 @@ Here are the steps to install OpenEverest and deploy additional database namespa

You can customize various parameters in the OpenEverest 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"}.
A few parameters are listed in the following table. For a detailed list of the parameters, see the [README](https://github.com/openeverest/helm-charts/blob/main/charts/everest/README.md#configuration){:target="_blank"}.


**percona/everest chart**
**openeverest/openeverest 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**
**openeverest/everest-db-namespace subchart**

|**Key**|**Type**|**Default**|**Description**|
|-------|--------|-----------|---------------
Expand Down
8 changes: 4 additions & 4 deletions docs/install/install_everest_openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here are the steps to install OpenEverest with OpenShift compatibility enabled:
1. Run the following command:

```sh
helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace \
--set compatibility.openshift=true \
Expand Down Expand Up @@ -53,7 +53,7 @@ Here are the steps to install OpenEverest with OpenShift compatibility enabled:

```sh
helm install everest \
percona/everest-db-namespace \
openeverest/everest-db-namespace \
--create-namespace \
--namespace everest \
--set compatibility.openshift=true
Expand All @@ -77,10 +77,10 @@ Here are the steps to install OpenEverest with OpenShift compatibility enabled:

=== "Load Balancer"

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

```
helm install percona-everest percona/everest \
helm install everest openeverest/openeverest \
--set service.type=LoadBalancer
```

Expand Down
14 changes: 7 additions & 7 deletions docs/quick-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Helm simplifies the installation of OpenEverest. With this guide, you'll be up and running with OpenEverest in no time. However, we also have a comprehensive [installation guide](install/install_everest_helm_charts.md) that covers all possibilities.

OpenEverest Helm charts can be found in [percona/percona-helm-charts](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} repository in Github.
OpenEverest Helm charts can be found in [openeverest/helm-charts](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} repository in Github.

!!! info "Alternative installation method"
If you prefer an alternative method, you can [install OpenEverest using everestctl](install/installEverest.md).
Expand Down Expand Up @@ -58,15 +58,15 @@ To install OpenEverest using Helm follow these steps:
1. Add the OpenEverest Helm repository.

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

2. Install OpenEverest.


```sh
helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace
```
Expand All @@ -89,7 +89,7 @@ To install OpenEverest using Helm follow these steps:
1. Install OpenEverest:

```sh
helm install everest percona/everest \
helm install everest openeverest/openeverest \
-n everest-system \
--set ingress.enabled=true \
--set ingress.ingressClassName="" \
Expand Down Expand Up @@ -134,7 +134,7 @@ To install OpenEverest using Helm follow these steps:
Install OpenEverest using this file:

```sh
helm install everest percona/everest \
helm install everest openeverest/openeverest \
-n everest-system \
-f everest-values.yaml
```
Expand All @@ -144,7 +144,7 @@ To install OpenEverest using Helm follow these steps:
Install OpenEverest with TLS enabled:

```sh
helm install everest-core percona/everest \
helm install everest openeverest/openeverest \
--namespace everest-system \
--create-namespace
--set server.tls.enabled=true
Expand Down Expand Up @@ -183,7 +183,7 @@ Once you have successfully installed OpenEverest, proceed with the following ste
1. Use the following command to change the Everest service type to `LoadBalancer`:

```sh
helm install percona-everest percona/everest \
helm install everest openeverest/openeverest \
--set service.type=LoadBalancer
```

Expand Down
6 changes: 3 additions & 3 deletions docs/security/tls_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Here are the steps to set up the OpenEverest server using cert-manager:
2. Install OpenEverest using the above values:

```sh
helm install everest-core percona/everest --create-namespace \
helm install everest-core openeverest/openeverest --create-namespace \
-n everest-system \
-f values.yaml
```
Expand All @@ -65,7 +65,7 @@ Here are the steps to set up the OpenEverest server using cert-manager:


```sh
helm install everest-core percona/everest --create-namespace \
helm install everest-core openeverest/openeverest --create-namespace \
-n everest-system \
--set server.tls.enabled=true
```
Expand Down Expand Up @@ -94,7 +94,7 @@ Here are the steps to set up the OpenEverest server using cert-manager:
3. Install OpenEverest using the above values:

```sh
helm install everest-core percona/everest --create-namespace \
helm install everest-core openeverest/openeverest --create-namespace \
-n everest-system \
-f values.yaml
```
Expand Down
8 changes: 4 additions & 4 deletions docs/troubleshoot/bitnami_container_catalog_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ You must **manually update your Helm charts** to use the new image. If you are o
2. Upgrade the main OpenEverest chart (for example, the `everest-system` release) with its corresponding release name, namespace, and version:

```sh
helm upgrade everest-system percona/everest \
helm upgrade everest-system openeverest/openeverest \
--reuse-values \
--namespace everest-system \
--version 1.8.1
Expand All @@ -94,7 +94,7 @@ You must **manually update your Helm charts** to use the new image. If you are o
Execute the helm upgrade command for each `everest-db-namespace `chart identified in **step 1**.

```sh
helm upgrade a1 percona/everest-db-namespace \
helm upgrade a1 openeverest/everest-db-namespace \
--reuse-values \
--namespace a1 \
--version 1.8.1
Expand All @@ -108,7 +108,7 @@ You must **manually update your Helm charts** to use the new image. If you are o
```

```sh
helm upgrade everest percona/everest-db-namespace \
helm upgrade everest openeverest/everest-db-namespace \
--reuse-values \
--namespace everest \
--version 1.8.1
Expand Down Expand Up @@ -201,7 +201,7 @@ Follow these steps to fix the problem:
Use the release name, namespace, and **APP VERSION** from the previous steps to upgrade the chart.

```sh
helm upgrade everest percona/everest-db-namespace \
helm upgrade everest openeverest/everest-db-namespace \
--reuse-values \
--namespace everest \
--version 1.8.1
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshoot/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ OpenEverest doesn't deploy PMM (Percona Monitoring and Management). However, you

We configure PMM agents in each DB deployment to communicate with an existing PMM server.

The following table shows the [configurable parameters](https://github.com/percona/percona-helm-charts/tree/main/charts/everest#configuration){:target="_blank"} of OpenEverest chart and their default values.
The following table shows the [configurable parameters](https://github.com/openeverest/helm-charts/tree/main/charts/everest#configuration){:target="_blank"} of OpenEverest chart and their default values.

### Monitoring configuration highlights:

Expand Down
10 changes: 5 additions & 5 deletions docs/troubleshoot/installation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ This page provides an overview of how OpenEverest is installed, the components i

Starting with OpenEverest v1.4.0, the [everestctl](../install/installEverest.md) is a wrapper around two helm charts:

- [everest-core](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"}
- [everest-core](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"}

- [everest-db-namespace](https://github.com/percona/percona-helm-charts/tree/main/charts/everest/charts/everest-db-namespace){:target="_blank"}.
- [everest-db-namespace](https://github.com/openeverest/helm-charts/tree/main/charts/everest/charts/everest-db-namespace){:target="_blank"}.

The installation flow is as follows:
{.power-number}
Expand Down Expand Up @@ -72,9 +72,9 @@ everestctl namespaces update [NAMESPACE]
everestctl namespaces remove [NAMESPACE]
```

For detailed information on managing namespaces, see the [Namespaces management](https://github.com/percona/percona-helm-charts/tree/main/charts/everest#4-deploy-additional-database-namespaces){:target="_blank"} section.
For detailed information on managing namespaces, see the [Namespaces management](https://github.com/openeverest/helm-charts/tree/main/charts/everest#4-deploy-additional-database-namespaces){:target="_blank"} section.

The [helm installation method](../install/install_everest_helm_charts.md) provides an identical flow to the one described above, with similar configuration options. Refer to the [helm chart documentation](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} for a complete list of available [configuration options](https://github.com/percona/percona-helm-charts/tree/main/charts/everest#configuration){:target="_blank"}.
The [helm installation method](../install/install_everest_helm_charts.md) provides an identical flow to the one described above, with similar configuration options. Refer to the [helm chart documentation](https://github.com/openeverest/helm-charts/tree/main/charts/everest){:target="_blank"} for a complete list of available [configuration options](https://github.com/openeverest/helm-charts/tree/main/charts/everest#configuration){:target="_blank"}.

## Server and operator workflow

Expand All @@ -100,7 +100,7 @@ Here's the database creation workflow in OpenEverest:
Here’s the workflow for the database engine in OpenEverest:
{.power-number}

1. You can install the `everest-db-namespace` chart either as part of the initial installation or as a [separate step](https://github.com/percona/percona-helm-charts/tree/main/charts/everest#4-deploy-additional-database-namespaces).
1. You can install the `everest-db-namespace` chart either as part of the initial installation or as a [separate step](https://github.com/openeverest/helm-charts/tree/main/charts/everest#4-deploy-additional-database-namespaces).
2. OLM subscriptions are created for the operators chosen while installing the Helm chart.
3. OLM **reconciles the Subscriptions** and creates an **InstallPlan**.
4. The Helm chart creates a Kubernetes job called `everest-operators-installer` that waits for the `InstallPlan` to be created and approves it.
Expand Down
Loading