From 8e57e4bdea023726716c5557ab3c6160862c6f54 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 19 Nov 2024 21:04:04 +0530 Subject: [PATCH 01/13] Update rbac.md --- docs/administer/rbac.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/administer/rbac.md b/docs/administer/rbac.md index ac36ecacb..b365b29d0 100644 --- a/docs/administer/rbac.md +++ b/docs/administer/rbac.md @@ -1,4 +1,4 @@ -# 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. From acbb7536acc11358cfb81ddf971b5ae19e7640fe Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 13:23:32 +0530 Subject: [PATCH 02/13] Limitation for 1.3.0 due to psmdb operator --- docs/reference/known_limitations.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index aeda9f9e6..a7ad5e081 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -30,6 +30,19 @@ We are developing a new feature that will allow you to modify these settings dir - Do not create a full backup on an empty database. Instead, perform a full backup after adding some data to the database. +## Databases stuck in initializing state + +If you attempt to delete a MongoDB and MySQL cluster that is stuck in the initializing state due to a lack of resources, the cluster will remain in the deleting state indefinitely. + +**Workaround** + +1. Run the command: + +`kubectl edit psmdb/ -n ` + +2. Delete the finalizer called `delete-pods-in-order` + + ## Upgrading operators - When you upgrade PostgreSQL operators to version 2.4.1, the database transitions to the **Initializing** state as part of the upgrade process. However, this **Initializing** state does not cause any downtime. From dcd2510257688dd03d9fa8eafac37711e6794649 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 13:33:57 +0530 Subject: [PATCH 03/13] Update known_limitations.md --- docs/reference/known_limitations.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index a7ad5e081..6922e2097 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -23,14 +23,16 @@ We are developing a new feature that will allow you to modify these settings dir On the Percona Everest UI, navigate to the **Restores** tab, locate the latest restore object, click `...`, and delete it. Then, attempt to restore it again. -## MongoDB +## Databases + +### MongoDB databases - MongoDB 4.4 will no longer be supported, preventing users from upgrading the PSMDB operator if any database is running version 4.4. - Do not create a full backup on an empty database. Instead, perform a full backup after adding some data to the database. -## Databases stuck in initializing state +### Databases stuck in initializing state If you attempt to delete a MongoDB and MySQL cluster that is stuck in the initializing state due to a lack of resources, the cluster will remain in the deleting state indefinitely. @@ -38,11 +40,10 @@ If you attempt to delete a MongoDB and MySQL cluster that is stuck in the initia 1. Run the command: -`kubectl edit psmdb/ -n ` + `kubectl edit psmdb/ -n ` 2. Delete the finalizer called `delete-pods-in-order` - ## Upgrading operators - When you upgrade PostgreSQL operators to version 2.4.1, the database transitions to the **Initializing** state as part of the upgrade process. However, this **Initializing** state does not cause any downtime. From cbc38a53c8c160fad64350facc4449596eb542c0 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 13:34:30 +0530 Subject: [PATCH 04/13] Update known_limitations.md --- docs/reference/known_limitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index 6922e2097..becd67150 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -34,7 +34,7 @@ We are developing a new feature that will allow you to modify these settings dir ### Databases stuck in initializing state -If you attempt to delete a MongoDB and MySQL cluster that is stuck in the initializing state due to a lack of resources, the cluster will remain in the deleting state indefinitely. +If you attempt to delete a MongoDB and MySQL cluster that is stuck in the **initializing** state due to a lack of resources, the cluster will remain in the deleting state indefinitely. **Workaround** From 48cbfb66cb548e941aa59022d31585a8ce0ec0e5 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 14:34:15 +0530 Subject: [PATCH 05/13] Update known_limitations.md --- docs/reference/known_limitations.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index becd67150..866df0087 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -25,24 +25,20 @@ We are developing a new feature that will allow you to modify these settings dir ## Databases -### MongoDB databases - - MongoDB 4.4 will no longer be supported, preventing users from upgrading the PSMDB operator if any database is running version 4.4. -- Do not create a full backup on an empty database. Instead, perform a full backup after adding some data to the database. - +- Do not perform a full backup of an empty MongoDB database. Instead, ensure that you add some data to the database before creating a full backup. -### Databases stuck in initializing state -If you attempt to delete a MongoDB and MySQL cluster that is stuck in the **initializing** state due to a lack of resources, the cluster will remain in the deleting state indefinitely. +- If you attempt to delete a MongoDB and MySQL cluster stuck in the **initializing** state due to insufficient resources, the cluster will remain in the deleting state indefinitely. -**Workaround** + **Workaround** -1. Run the command: + 1. Run the command: - `kubectl edit psmdb/ -n ` + `kubectl edit psmdb/ -n ` -2. Delete the finalizer called `delete-pods-in-order` + 2. Delete the finalizer called `delete-pods-in-order` ## Upgrading operators From b1b650f8c09269d59470cb44c7faa2c93712c837 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 14:39:37 +0530 Subject: [PATCH 06/13] Update known_limitations.md --- docs/reference/known_limitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index 866df0087..d099b7e2e 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -38,7 +38,7 @@ We are developing a new feature that will allow you to modify these settings dir `kubectl edit psmdb/ -n ` - 2. Delete the finalizer called `delete-pods-in-order` + 2. Delete the finalizer called `delete-pods-in-order`. ## Upgrading operators From 6012d95cea1c901f1fe74fe7d2e433031a4e6386 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 15:08:36 +0530 Subject: [PATCH 07/13] added link to the PSMDB operator bug --- docs/reference/known_limitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index d099b7e2e..a279fa674 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -30,7 +30,7 @@ We are developing a new feature that will allow you to modify these settings dir - Do not perform a full backup of an empty MongoDB database. Instead, ensure that you add some data to the database before creating a full backup. -- If you attempt to delete a MongoDB and MySQL cluster stuck in the **initializing** state due to insufficient resources, the cluster will remain in the deleting state indefinitely. +- If you attempt to delete a MongoDB and MySQL cluster stuck in the **initializing** state due to insufficient resources, the cluster will remain in the deleting state indefinitely. This issue is caused by a [bug](https://perconadev.atlassian.net/browse/K8SPSMDB-1208) in the PSMDB operator. **Workaround** From a3dded30676078d63028e1ec3c44dd9bc28376ff Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 2 Dec 2024 15:17:13 +0530 Subject: [PATCH 08/13] Update known_limitations.md --- docs/reference/known_limitations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/known_limitations.md b/docs/reference/known_limitations.md index a279fa674..9784968d4 100644 --- a/docs/reference/known_limitations.md +++ b/docs/reference/known_limitations.md @@ -30,7 +30,7 @@ We are developing a new feature that will allow you to modify these settings dir - Do not perform a full backup of an empty MongoDB database. Instead, ensure that you add some data to the database before creating a full backup. -- If you attempt to delete a MongoDB and MySQL cluster stuck in the **initializing** state due to insufficient resources, the cluster will remain in the deleting state indefinitely. This issue is caused by a [bug](https://perconadev.atlassian.net/browse/K8SPSMDB-1208) in the PSMDB operator. +- If you attempt to delete a MongoDB and MySQL cluster stuck in the **initializing** state due to insufficient resources, the cluster will remain in the deleting state indefinitely. This issue is caused by a [bug](https://perconadev.atlassian.net/browse/K8SPSMDB-1208){:target="_blank"} in the PSMDB operator. **Workaround** From 84e0bbac027fef187b7d53cedf671fc8f1fba2a5 Mon Sep 17 00:00:00 2001 From: Diogo Recharte Date: Fri, 6 Dec 2024 10:18:20 +0000 Subject: [PATCH 09/13] Update uninstall with all CRDs --- docs/install/uninstallEverest.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/install/uninstallEverest.md b/docs/install/uninstallEverest.md index 9158e723e..28ee15767 100644 --- a/docs/install/uninstallEverest.md +++ b/docs/install/uninstallEverest.md @@ -74,6 +74,8 @@ Below is a list of CRDs for different operators. vmagents.operator.victoriametrics.com vmclusters.operator.victoriametrics.com vmusers.operator.victoriametrics.com + vmscrapeconfigs.operator.victoriametrics.com + vlogs.operator.victoriametrics.com ``` ??? example "Everest operator" @@ -105,8 +107,12 @@ Below is a list of CRDs for different operators. ??? example "PostgreSQL operator (Percona and CrunchyData)" ``` perconapgbackups.pgv2.percona.com - perconapgrestores.pgv2.percona.com perconapgclusters.pgv2.percona.com + perconapgrestores.pgv2.percona.com + perconapgupgrades.pgv2.percona.com + crunchybridgeclusters.postgres-operator.crunchydata.com + pgadmins.postgres-operator.crunchydata.com + pgupgrades.postgres-operator.crunchydata.com postgresclusters.postgres-operator.crunchydata.com ``` @@ -146,6 +152,8 @@ vmalerts.operator.victoriametrics.com vmagents.operator.victoriametrics.com vmclusters.operator.victoriametrics.com vmusers.operator.victoriametrics.com +vmscrapeconfigs.operator.victoriametrics.com +vlogs.operator.victoriametrics.com databaseclusterbackups.everest.percona.com databaseclusters.everest.percona.com databaseengines.everest.percona.com @@ -159,10 +167,14 @@ perconaservermongodbbackups.psmdb.percona.com perconaservermongodbrestores.psmdb.percona.com perconaservermongodbs.psmdb.percona.com perconapgbackups.pgv2.percona.com -perconapgrestores.pgv2.percona.com perconapgclusters.pgv2.percona.com +perconapgrestores.pgv2.percona.com +perconapgupgrades.pgv2.percona.com +crunchybridgeclusters.postgres-operator.crunchydata.com +pgadmins.postgres-operator.crunchydata.com +pgupgrades.postgres-operator.crunchydata.com postgresclusters.postgres-operator.crunchydata.com -EOF +EOF ``` ??? example "Expected output" @@ -189,6 +201,8 @@ EOF customresourcedefinition.apiextensions.k8s.io "vmagents.operator.victoriametrics.com" deleted customresourcedefinition.apiextensions.k8s.io "vmclusters.operator.victoriametrics.com" deleted customresourcedefinition.apiextensions.k8s.io "vmusers.operator.victoriametrics.com" deleted + customresourcedefinition.apiextensions.k8s.io "vmscrapeconfigs.operator.victoriametrics.com" deleted + customresourcedefinition.apiextensions.k8s.io "vlogs.operator.victoriametrics.com" deleted customresourcedefinition.apiextensions.k8s.io "databaseclusterbackups.everest.percona.com" deleted customresourcedefinition.apiextensions.k8s.io "databaseclusters.everest.percona.com" deleted customresourcedefinition.apiextensions.k8s.io "databaseengines.everest.percona.com" deleted @@ -202,8 +216,12 @@ EOF customresourcedefinition.apiextensions.k8s.io "perconaservermongodbrestores.psmdb.percona.com" deleted customresourcedefinition.apiextensions.k8s.io "perconaservermongodbs.psmdb.percona.com" deleted customresourcedefinition.apiextensions.k8s.io "perconapgbackups.pgv2.percona.com" deleted - customresourcedefinition.apiextensions.k8s.io "perconapgrestores.pgv2.percona.com" deleted customresourcedefinition.apiextensions.k8s.io "perconapgclusters.pgv2.percona.com" deleted + customresourcedefinition.apiextensions.k8s.io "perconapgrestores.pgv2.percona.com" deleted + customresourcedefinition.apiextensions.k8s.io "perconapgupgrades.pgv2.percona.com" deleted + customresourcedefinition.apiextensions.k8s.io "crunchybridgeclusters.postgres-operator.crunchydata.com" deleted + customresourcedefinition.apiextensions.k8s.io "pgadmins.postgres-operator.crunchydata.com" deleted + customresourcedefinition.apiextensions.k8s.io "pgupgrades.postgres-operator.crunchydata.com" deleted customresourcedefinition.apiextensions.k8s.io "postgresclusters.postgres-operator.crunchydata.com" deleted ``` From 2646f8515a5149e7c0c83bd9e1e97de3d6dd1895 Mon Sep 17 00:00:00 2001 From: Alina Derkach Date: Fri, 13 Dec 2024 18:36:52 +0100 Subject: [PATCH 10/13] Fix the copy button getting merged in text in the code block Update design.css --- docs/css/design.css | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/css/design.css b/docs/css/design.css index 2d5a37473..1b4a9c04d 100644 --- 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, From a31effad9d84dd800020b01b7ad400db1a69524a Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:40:16 +0530 Subject: [PATCH 11/13] update_create_storage_location --- docs/use/CreateStorage.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/use/CreateStorage.md b/docs/use/CreateStorage.md index d88c9f2c4..c638b4712 100644 --- a/docs/use/CreateStorage.md +++ b/docs/use/CreateStorage.md @@ -13,11 +13,28 @@ Everest supports S3-compatible backup locations, which means you can use [AWS S3 To create a backup storage location: {.power-number} -1. Go to **Settings > Backup storages** and click **Add Backup storage**. -2. In the **Name** field, specify a location name using only lowercase alphanumeric characters or hyphens. -3. Select the **Namepaces** where the backup storage should be available. -4. Enter your credentials, making sure to use regional AWS STS endpoints instead of the global endpoint: `https://s3..amazonaws.com`. - Using an endpoint that is geographically closer to your application reduces latency and provides better response times. +1. Go to **Settings: + + Navigate to **Settings > Backup storages**, then click **Add Backup storage**. + +2. Fill in the Required Fields: + + - **Name**: Enter a name using only lowercase letters, numbers, or hyphens. + - **Description**: (Optional) Add a short description for this backup storage. + - **Namespace**: Select where this backup storage will be available. + - **Type**: Choose S3 Compatible. + - **Bucket Name**: Provide the S3 bucket name where backups will be stored. + - **Region**: Specify the bucket's region (e.g., us-east-1). + - **Endpoint**: Enter the S3-compatible URL (e.g., https://s3.us-east-1.amazonaws.com). + - **Access Key**: Input the access key for your S3 account. + - **Secret Key**: Input the corresponding secret key. + +3. Additional Options: + - **Verify TLS Certificate**: Enable this to validate secure connections. + - **Force Path-Style URL Access**: Use this if your storage provider uses path-style URLs. + +4. Click **Add** to save your configuration. + ## Next steps From 073054e448a84e6f57f27da7a11961b91c7e2692 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:45:30 +0530 Subject: [PATCH 12/13] Update CreateStorage.md --- docs/use/CreateStorage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/use/CreateStorage.md b/docs/use/CreateStorage.md index c638b4712..e60dc3b5b 100644 --- a/docs/use/CreateStorage.md +++ b/docs/use/CreateStorage.md @@ -13,9 +13,9 @@ Everest supports S3-compatible backup locations, which means you can use [AWS S3 To create a backup storage location: {.power-number} -1. Go to **Settings: +1. Go to Backup Storage Settings: - Navigate to **Settings > Backup storages**, then click **Add Backup storage**. + Navigate to **Settings > Backup storages**, then click **Add Backup storage**. 2. Fill in the Required Fields: From 89780218735a5b1a7dce162bf3f3fc9e94a5826f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:49:27 +0530 Subject: [PATCH 13/13] update the section --- docs/use/CreateStorage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/use/CreateStorage.md b/docs/use/CreateStorage.md index e60dc3b5b..79b56b5b0 100644 --- a/docs/use/CreateStorage.md +++ b/docs/use/CreateStorage.md @@ -13,7 +13,7 @@ Everest supports S3-compatible backup locations, which means you can use [AWS S3 To create a backup storage location: {.power-number} -1. Go to Backup Storage Settings: +1. Go to Backup storage settings: Navigate to **Settings > Backup storages**, then click **Add Backup storage**.