Merge remote-tracking branch 'upstream/main' into edithturn-patch-1

percona · Jan 8, 2025 · 44db821 · 44db821
2 parents a535cda + 52aaa25
commit 44db821
Show file tree

Hide file tree

Showing 75 changed files with 1,750 additions and 690 deletions.
diff --git a/docs/administer/manage_namespaces.md b/docs/administer/manage_namespaces.md
@@ -0,0 +1,86 @@
+# Namespaces management
+
+The management of namespaces plays a vital role in efficiently organizing and allocating resources within Percona Everest.
+
+## Add new namespaces
+
+You can run the following command for provisioning a new DB namespace:
+
+```sh
+everestctl namespaces add [NAMESPACE]
+```
+
+The command supports the following flags:
+
+`--operator.mongodb=<bool>`
+
+`--operator.postgresql=<bool>`
+
+`--operator.xtradb-cluster=<bool>`
+
+`--take-ownership` - Allows Percona Everest to manage an existing Kubernetes namespace by adding the necessary labels. Without this flag, Percona Everest will attempt to create the namespace and throw an error if it already exists. Use this flag to take over an existing namespace.
+
+??? example "Example"
+    ```sh
+    everestctl namespaces add development --operator.postgresql=false
+    ✓ Installing namespace 'development'
+    ```
+    In the above command, we did not specify the MongoDB and MySQL operators.       Therefore, by default, Percona Everest assumes these operators are true and will add them.
+
+    ```sh
+    everestctl namespaces add production
+
+    ? Which operators do you want to install? MongoDB    
+    ✓ Installing namespace 'production'
+    ```
+
+!!! note
+    The `everestctl install` command allows you create database namespaces during the initial installation. However, it cannot be rerun to add more database namespaces. To create additional database namespaces after installation, use the namespaces add command.
+
+    - To provision a DB namespace after installation, use the command `everestctl namespaces add`. 
+
+    - You may choose to skip the DB namespace installation in the `everestctl install` command.
+
+## Update namespaces
+
+!!! info "Important"
+    Removing operators with `update` is currently not supported.
+
+You can run the following command to add more operators to an existing DB namespace.
+
+
+```sh
+everestctl namespaces update [NAMESPACE] 
+```
+
+??? example "Example"    
+    ```sh
+    everestctl namespaces update development
+
+    ? Which operators do you want to install? MongoDB
+    ✓ Updating namespace 'development'
+    ```
+
+
+## Delete namespaces
+
+You can run the following command for deleting namespaces:
+
+```sh
+everestctl namespaces remove [NAMESPACE]
+```
+
+- This command deletes only the specified namespace, as long as it is managed by Percona Everest.
+
+- Setting `--keep-namespace` deletes all resources within the namespace (e.g., operators, DatabaseClusters, BackupStorages) while preserving the namespace itself. Use this option to clean up the namespace without removing it.
+
+
+??? example "Example"
+    ```sh
+    everestctl namespaces remove development
+
+    ✓ Deleting database clusters in namespace 'development'
+    ✓ Deleting backup storages in namespace 'development'
+    ✓ Deleting monitoring instances in namespace 'development'
+    ✓ Deleting namespace 'development'
+    ```
diff --git a/docs/administer/rbac.md b/docs/administer/rbac.md
@@ -1,4 +1,5 @@
-# Role Based Access Control
+# Role-based access control (RBAC)
+
 
 !!! warning "Disclaimer"
     RBAC is currently in **Technical Preview**. Early adopters are advised to use this feature only for testing purposes and not in production environments.
@@ -292,8 +293,8 @@ In this section, we will explore some examples that demonstrate how to create po
         p, role:dbadminDatabaseA, namespaces, *, namespaceA
         p, role:dbadminDatabaseA, database-engines, read, namespaceA/*
         p, role:dbadminDatabaseA, database-clusters, *, namespaceA/databaseA
-        p, role:dbadminDatabaseA, database-cluster-backups, *, namespaceA/*
-        p, role:dbadminDatabaseA, database-cluster-restores, *, namespaceA/*
+        p, role:dbadminDatabaseA, database-cluster-backups, *, namespaceA/databaseA
+        p, role:dbadminDatabaseA, database-cluster-restores, *, namespaceA/databaseA
         p, role:dbadminDatabaseA, database-cluster-credentials, *, namespaceA/databaseA
         p, role:dbadminDatabaseA, backup-storages, read, namespaceA/*
         p, role:dbadminDatabaseA, monitoring-instances, read, namespaceA/*

diff --git a/docs/contribute.md b/docs/contribute.md
@@ -2,7 +2,7 @@
 
 Thank you for deciding to contribute and help us improve Percona Everest! We also contribute to other open source projects and communities! Let’s make technology better!
 
-By contributing, you agree to the [Percona Community code of conduct](https://percona.community/contribute/coc/).
+By contributing, you agree to the [Percona Community code of conduct](https://percona.community/contribute/coc/){:target="_blank"}.
 
 We welcome all kinds of contributions so here's how you can get involved:
 
@@ -13,13 +13,13 @@ We welcome all kinds of contributions so here's how you can get involved:
 
 ## Submit a bug report or feature request
 
-If you find a bug in Percona Everest, you can submit a report via the [Percona  Everest Community Forum](https://forums.percona.com). 
+If you find a bug in Percona Everest, you can submit a report via the [Percona  Everest Community Forum](https://forums.percona.com){:target="_blank"}. 
 Start by searching the open topics for a similar report. If you find that someone else has already reported the same issue, you can upvote that report to increase its visibility.
 
 If there is no existing report, submit a report following these steps:
 {.power-number}
 
-1. Sign in to [Percona Everest Forum](https://forums.percona.com). You will need to create an account if you do not have one.
+1. Sign in to [Percona Everest Forum](https://forums.percona.com){:target="_blank"}. You will need to create an account if you do not have one.
 
 2. Create a report that:      
       *  describes the steps to reproduce the issue
@@ -46,8 +46,8 @@ Found a typo or didn't find what you needed? Here's how you can contribute to th
 
     To contribute to the documentation, you should be familiar with the following technologies:
 
-    * [Markdown](https://www.markdownguide.org/getting-started/) markup language. We write the documentation in it.
-    * [git](https://git-scm.com/) and [GitHub](https://guides.github.com/activities/hello-world/)
+    * [Markdown](https://www.markdownguide.org/getting-started/){:target="_blank"} markup language. We write the documentation in it.
+    * [git](https://git-scm.com/){:target="_blank"} and [GitHub](https://guides.github.com/activities/hello-world/){:target="_blank"}
 
     The `.md` files are in the `docs/` directory. 
 

diff --git a/docs/css/design.css b/docs/css/design.css
@@ -262,6 +262,7 @@
     vertical-align: baseline;
     padding: 0 0.2em 0.1em;
     border-radius: 0.15em;
+    white-space: pre-wrap;   /* Ensure long lines wrap */
 }
 .md-typeset .highlight code span,
 .md-typeset code,

diff --git a/docs/images/Screenshot 2024-10-18 at 3.28.32 PM.png b/docs/images/Screenshot 2024-10-18 at 3.28.32 PM.png
diff --git a/docs/images/database_details.png b/docs/images/database_details.png
diff --git a/docs/images/database_view.png b/docs/images/database_view.png
diff --git a/docs/images/database_view_actions.png b/docs/images/database_view_actions.png
diff --git a/docs/images/display_db_details.png b/docs/images/display_db_details.png
diff --git a/docs/images/edit_resources_toplogy.png b/docs/images/edit_resources_toplogy.png
diff --git a/docs/images/enable_sharding.png b/docs/images/enable_sharding.png
diff --git a/docs/images/everest_adv_config.png b/docs/images/everest_adv_config.png
diff --git a/docs/images/everest_adv_config_edit.png b/docs/images/everest_adv_config_edit.png
diff --git a/docs/images/everest_adv_config_ip_source.png b/docs/images/everest_adv_config_ip_source.png
diff --git a/docs/images/everest_db_provision.png b/docs/images/everest_db_provision.png
diff --git a/docs/images/everest_db_scaling.png b/docs/images/everest_db_scaling.png
diff --git a/docs/images/everest_disable_endpoint.png b/docs/images/everest_disable_endpoint.png
diff --git a/docs/images/everest_multi-namespaces.png b/docs/images/everest_multi-namespaces.png
diff --git a/docs/images/everest_multinamespaces.png b/docs/images/everest_multinamespaces.png
diff --git a/docs/images/everest_scale_horizontally.png b/docs/images/everest_scale_horizontally.png
diff --git a/docs/images/everest_scale_vertically_up.png b/docs/images/everest_scale_vertically_up.png
diff --git a/docs/images/everest_sharded_cluster.png b/docs/images/everest_sharded_cluster.png
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/images/proxies_resources.png b/docs/images/proxies_resources.png
diff --git a/docs/images/remove_db_wizard_edit_resource_widget.png b/docs/images/remove_db_wizard_edit_resource_widget.png
diff --git a/docs/images/remove_edit_db_wizard.png b/docs/images/remove_edit_db_wizard.png
diff --git a/docs/images/resources_page_sharding.png b/docs/images/resources_page_sharding.png
diff --git a/docs/images/resources_pgbouncer.png b/docs/images/resources_pgbouncer.png
diff --git a/docs/images/resources_proxies_page.png b/docs/images/resources_proxies_page.png
diff --git a/docs/images/resources_routers.png b/docs/images/resources_routers.png
diff --git a/docs/images/sharding_routers.png b/docs/images/sharding_routers.png
diff --git a/docs/images/sharding_status.png b/docs/images/sharding_status.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,9 @@
-# Install Everest
+# Install Percona Everest using CLI
+
+!!! warning
+    Google Container Registry (GCR) is scheduled to be deprecated and will officially shut down on March 18, 2025. All versions of Percona Everest prior to 1.4.0 depend on images hosted on GCR, meaning that downloading those images will fail after the shutdown date. We strongly recommend upgrading to Percona Everest version 1.4.0 as soon as possible. If you do not upgrade, Percona Everest will no longer function.
+
+    For more details, refer to the [Container Registry Deprecation documentation](https://cloud.google.com/artifact-registry/docs/transition/prepare-gcr-shutdown){:target="_blank"}.
 
 ## Before you start
 
@@ -8,36 +13,65 @@ 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](https://github.com/percona/percona-helm-charts/tree/main/charts/everest){:target="_blank"} 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}
 
 1. Download the latest release of [everestctl](https://github.com/percona/everest/releases/latest){:target="_blank"} to provision Percona Everest. For detailed installation instructions, see [CLI installation documentation](../install/installEverestCLI).
 
-2. Install Percona Everest using one of the following commands:
+2. You can install Percona Everest using either the wizard or the headless mode.
 
+    !!! note        
+        * If you do not specify a namespace, the `everest` namespace gets provisioned by default.
+        * You can skip provisioning the database namespace during initial installation by using the flag `--skip-db-namespace`.
 
-    ```sh
-    everestctl install
-    ```
+            ```
+            everestctl install --skip-db-namespace
+            ```
+        To explore namespaces management in details, refer to the section on [namespace management](../administer/manage_namespaces.md).
 
-    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.
 
+    - **Install Percona Everest using the wizard**
+        {.power-number}
 
-    Alternatively, you can set multiple namepaces in the headless mode:
+        1. Run the following command.
+            ```sh
+            everestctl install
+            ```
 
-    ```sh
-    everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.xtradb-cluster=true --skip-wizard
-    ```
-    Replace `<namespace-name>` with the desired name for your namespace.
+        2. 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.
 
-    ??? example "Example"
-        ```
-        everestctl install --namespaces dev,prod --operator.mongodb=true --operator.postgresql=true --operator.xtradb-cluster=true --skip-wizard
-        ```
+        3.  If you skip adding the namespaces while installing Percona Everest, you can add them later using the following command.
 
-    To gain a deeper understanding of how to install different operators in various namespaces, refer to the [configure multiple namespaces](../use/multi-namespaces.md#configure-multiple-namespaces) section.
+            ```sh
+            everestctl namespaces add <NAMESPACE>
+            ``` 
+
+    - **Install Percona Everest using the headless mode**
+        {.power-number}
+
+        1. Run the following command. You can set multiple namepaces in the headless mode. Replace `<namespace-name>` with the desired name for your namespace.
+            ```sh
+            everestctl install --namespaces <namespace-name1>,<namespace-name2> --operator.mongodb=true --operator.postgresql=true --operator.xtradb-cluster=true --skip-wizard
+            ```
+
+            ??? example "Example"
+                ```
+                everestctl install --namespaces dev,prod --operator.mongodb=true --operator.postgresql=true --operator.xtradb-cluster=true --skip-wizard
+                ```
+
+        2. If you skip adding the namespaces while installing Percona Everest, you can add them later using the following command.
+
+            ```sh
+            everestctl namespaces add <NAMESPACE>
+            ```
 
 
 3. Update the password for the `admin` user: