From 0f766c544bd30f49fed6a090c5826ece740fdafb Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 20 Aug 2024 12:21:08 +0530 Subject: [PATCH 001/100] Trouble shooting section fpr Everest --- docs/reference/troubleshoot.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/reference/troubleshoot.md diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md new file mode 100644 index 000000000..144cbab22 --- /dev/null +++ b/docs/reference/troubleshoot.md @@ -0,0 +1 @@ +An in-depth analysis of troubleshooting strategies for Percona Everest \ No newline at end of file From cdf090f458d05a2bd3751eb5622b41ac50f9d6e0 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 20 Aug 2024 13:17:06 +0530 Subject: [PATCH 002/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 144cbab22..d720ff262 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -1 +1,4 @@ -An in-depth analysis of troubleshooting strategies for Percona Everest \ No newline at end of file +# An in-depth analysis of troubleshooting strategies for Percona Everest + + +This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes]() and [known limitations]() section. \ No newline at end of file From b8574430c265b1c1cc0a3f6180f1e925c787afed Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:25:07 +0530 Subject: [PATCH 003/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index d720ff262..3d07ed555 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -1,4 +1,12 @@ -# An in-depth analysis of troubleshooting strategies for Percona Everest +# Troubleshooting strategies for Percona Everest -This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes]() and [known limitations]() section. \ No newline at end of file +This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. + + + +## Troubleshooting topics + +We have sorted the troubleshooting topics into specific categories, making it simple for you to find the information you need. + +### Installation From 315a28500a1a454364fcbd4b39572e7cd91606b2 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:18:04 +0530 Subject: [PATCH 004/100] installtion topic --- docs/reference/troubleshoot.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 3d07ed555..fc3d91923 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -7,6 +7,14 @@ This section is your go-to resource for tackling common issues and finding solut ## Troubleshooting topics -We have sorted the troubleshooting topics into specific categories, making it simple for you to find the information you need. +We have sorted the troubleshooting topics into specific categories, making it easy for you to find the information you need. ### Installation + +We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the everest-olm namespace. + +The main components are: + +- olm-operator +- catalog-operator +- packageserver. \ No newline at end of file From 03cb752bd5a0fe299de0a9364eb1ea60c0bd1e3d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 8 Nov 2024 14:54:54 +0530 Subject: [PATCH 005/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index fc3d91923..af2d642f7 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -4,6 +4,22 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. +## Troubleshooting checklist + +Here’s a handy checklist to help you identify some potential issues you might experience while using Percona Everest. +{.power-number} + +1. Are you using the recommended Percona Everest and compatible operator versions? +2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? + +3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. +4. Does the problem occur while you deploy a specific database? +5. Does the problem occur when you perform a particular task, like backups, restores etc? +6. Are you using the [authentication](../administer/Idp_integration.md) correctly? +7. Have you allocated enough resources for deploying your databases on Percona Everest? +8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). + + ## Troubleshooting topics From 3cacf6ec93a05d9f9f2abe2e4d5a2131e11ae123 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 8 Nov 2024 15:02:56 +0530 Subject: [PATCH 006/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index af2d642f7..e7f7c3f13 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -6,7 +6,7 @@ This section is your go-to resource for tackling common issues and finding solut ## Troubleshooting checklist -Here’s a handy checklist to help you identify some potential issues you might experience while using Percona Everest. +Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. {.power-number} 1. Are you using the recommended Percona Everest and compatible operator versions? @@ -23,7 +23,8 @@ Here’s a handy checklist to help you identify some potential issues you might ## Troubleshooting topics -We have sorted the troubleshooting topics into specific categories, making it easy for you to find the information you need. +We have organized the topics into distinct categories to assist you in exploring the information more easily. + ### Installation From 4200dddd628eee5fef285413fa4621f597b7cee5 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 12:39:28 +0530 Subject: [PATCH 007/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index e7f7c3f13..f6cf364b8 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -28,10 +28,34 @@ We have organized the topics into distinct categories to assist you in exploring ### Installation -We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the everest-olm namespace. +We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. The main components are: - olm-operator - catalog-operator -- packageserver. \ No newline at end of file +- packageserver + +??? example "What happens under the hood" + + 1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: + + Running the following command, will list all deployments in the everest-olm namespace + + ``` + $ kubectl get deploy -n everest-olm + NAME READY UP-TO-DATE AVAILABLE AGE + olm-operator 1/1 1 1 5m38s + catalog-operator 1/1 1 1 5m37s + packageserver 2/2 2 2 3m2s + ``` + 2. Next, the `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. + + Running the following command will list all `CatalogSources` in the `everest-olm ` namespace: + + ```sh + kubectl get catalogsources -n everest-olm + NAME DISPLAY TYPE PUBLISHER AGE + everest-catalog Everest Catalog grpc Percona 6m5s + ``` + From 01c54b837448e60b21ed8444fa801440469d18b9 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 12:57:32 +0530 Subject: [PATCH 008/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index f6cf364b8..5c4574ec6 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -36,11 +36,10 @@ The main components are: - catalog-operator - packageserver -??? example "What happens under the hood" - 1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: +1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: - Running the following command, will list all deployments in the everest-olm namespace + Execute the following command, all the three deployments should be present in the `everest-olm` namespace ``` $ kubectl get deploy -n everest-olm @@ -49,9 +48,10 @@ The main components are: catalog-operator 1/1 1 1 5m37s packageserver 2/2 2 2 3m2s ``` - 2. Next, the `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. + +2. Next, the `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. - Running the following command will list all `CatalogSources` in the `everest-olm ` namespace: + Execute the following command, `everest-catalog` should be present in the `everest-olm` ` namespace: ```sh kubectl get catalogsources -n everest-olm @@ -59,3 +59,5 @@ The main components are: everest-catalog Everest Catalog grpc Percona 6m5s ``` + + From bcdf442128b41188cbf365e76a4e9e46636ee992 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:14:55 +0530 Subject: [PATCH 009/100] OLM subsription --- docs/reference/troubleshoot.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 5c4574ec6..32f3fa964 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -26,7 +26,7 @@ Here’s a high level checklist to help you identify some potential issues you m We have organized the topics into distinct categories to assist you in exploring the information more easily. -### Installation +### Percona Everest installation We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. @@ -59,5 +59,24 @@ The main components are: everest-catalog Everest Catalog grpc Percona 6m5s ``` +#### OLM subscription + +The process of installing an operator with OLM (Operator Lifecycle Manager) begins with creating a [subscription](https://olm.operatorframework.io/docs/concepts/crds/subscription/). OLM will reconcile this subscription and generate an installation plan. Once the installation plan is approved, OLM will create a Cluster Service Version (CSV), which installs everything necessary for the operator to function properly. + + +In addition to OLM, Everest consists of five different operators: + +- Everest +- VictoriaMetrics +- Percona Operator for MySQL (PXC) +- Percona Operator for MongoDB (PSMDB) +- Percona Operator for PostgreSQL (PG) + + + + + + + From 1c51f233e5d83b458924b79b5f7ba873b8a714c5 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:27:19 +0530 Subject: [PATCH 010/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 32f3fa964..f2f3bb970 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -72,6 +72,28 @@ In addition to OLM, Everest consists of five different operators: - Percona Operator for MongoDB (PSMDB) - Percona Operator for PostgreSQL (PG) +=== "Everest" + The Everest Operator is always installed to the `everest-system` namespace. If the operator is installed properly, you should find a subscription, an install plan and a cluster service version for this operator: + + ??? example "Example" + ```sh + $ kubectl get sub -n everest-system + NAME PACKAGE SOURCE CHANNEL + everest-operator everest-operator everest-catalog stable-v0 + + $ kubectl get ip -n everest-system + NAME CSV APPROVAL APPROVED + install-69g62 everest-operator.v0.10.1 Manual true + + $ kubectl get csv -n everest-system + NAME DISPLAY VERSION REPLACES PHASE + everest-operator.v0.10.1 Everest operator 0.10.1 everest-operator.v0.9.0 Succeeded + + $ kubectl get deploy -n everest-system + NAME READY UP-TO-DATE AVAILABLE AGE + everest-operator-controller-manager 1/1 1 1 12m + percona-everest 1/1 1 1 11m + ``` From f951fa66e2db8eabcbb24633c73febe887999945 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:30:20 +0530 Subject: [PATCH 011/100] add a note --- docs/reference/troubleshoot.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index f2f3bb970..20740cea0 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -94,6 +94,10 @@ In addition to OLM, Everest consists of five different operators: everest-operator-controller-manager 1/1 1 1 12m percona-everest 1/1 1 1 11m ``` + !!! note + + In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. + From e0d0212f10a0be2ae3481c559ce89ae33fea0904 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:34:17 +0530 Subject: [PATCH 012/100] Update mkdocs-base.yml --- mkdocs-base.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index aa3750a9b..af7bb3929 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -198,6 +198,7 @@ nav: - Reference: - Limitations: reference/known_limitations.md - Telemetry on Percona Everest: reference/telemetry.md + - Troubleshooting: reference/troubleshooting.md - Migrate to Percona Everest: reference/migration_guide.md - Copyright and licensing information: reference/copyright.md - Trademark and copyright policy: reference/trademark-policy.md From a06fb6ec46c3ae6debf7b3a53b049536a6a1cf0b Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:36:47 +0530 Subject: [PATCH 013/100] Update mkdocs-base.yml --- mkdocs-base.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index af7bb3929..fb078b3ac 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -198,7 +198,7 @@ nav: - Reference: - Limitations: reference/known_limitations.md - Telemetry on Percona Everest: reference/telemetry.md - - Troubleshooting: reference/troubleshooting.md + - Troubleshooting: reference/troubleshoot.md - Migrate to Percona Everest: reference/migration_guide.md - Copyright and licensing information: reference/copyright.md - Trademark and copyright policy: reference/trademark-policy.md From e45c83bd066761041367b2aa3da974e2b3de6ff4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:42:20 +0530 Subject: [PATCH 014/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 20740cea0..c3e7a0304 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -41,8 +41,8 @@ The main components are: Execute the following command, all the three deployments should be present in the `everest-olm` namespace - ``` - $ kubectl get deploy -n everest-olm + ``` + $ kubectl get deploy -n everest-olm NAME READY UP-TO-DATE AVAILABLE AGE olm-operator 1/1 1 1 5m38s catalog-operator 1/1 1 1 5m37s @@ -96,7 +96,7 @@ In addition to OLM, Everest consists of five different operators: ``` !!! note - In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. + In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. From 6cd0fb3cdaff40c09253671ed57c668939ff9cb4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:44:57 +0530 Subject: [PATCH 015/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index c3e7a0304..4d20c8c92 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -75,25 +75,31 @@ In addition to OLM, Everest consists of five different operators: === "Everest" The Everest Operator is always installed to the `everest-system` namespace. If the operator is installed properly, you should find a subscription, an install plan and a cluster service version for this operator: - ??? example "Example" + ??? example "Examples" ```sh $ kubectl get sub -n everest-system NAME PACKAGE SOURCE CHANNEL everest-operator everest-operator everest-catalog stable-v0 + ``` + ``` $ kubectl get ip -n everest-system NAME CSV APPROVAL APPROVED install-69g62 everest-operator.v0.10.1 Manual true + ``` + ``` $ kubectl get csv -n everest-system NAME DISPLAY VERSION REPLACES PHASE everest-operator.v0.10.1 Everest operator 0.10.1 everest-operator.v0.9.0 Succeeded + ``` $ kubectl get deploy -n everest-system NAME READY UP-TO-DATE AVAILABLE AGE everest-operator-controller-manager 1/1 1 1 12m percona-everest 1/1 1 1 11m ``` + !!! note In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. From 84e8520b1b3201b9b2a3a7bb3983a9034291bf0a Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:50:30 +0530 Subject: [PATCH 016/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 4d20c8c92..af8041a84 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -51,7 +51,7 @@ The main components are: 2. Next, the `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. - Execute the following command, `everest-catalog` should be present in the `everest-olm` ` namespace: + Execute the following command, `everest-catalog` should be present in the `everest-olm` namespace: ```sh kubectl get catalogsources -n everest-olm @@ -94,15 +94,16 @@ In addition to OLM, Everest consists of five different operators: everest-operator.v0.10.1 Everest operator 0.10.1 everest-operator.v0.9.0 Succeeded ``` + ``` $ kubectl get deploy -n everest-system NAME READY UP-TO-DATE AVAILABLE AGE everest-operator-controller-manager 1/1 1 1 12m percona-everest 1/1 1 1 11m ``` - !!! note + !!! note - In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. + In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. From 021c88be06fb34772bd7fdca4aefa7a472b0ed30 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:56:25 +0530 Subject: [PATCH 017/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index af8041a84..8cb72f16c 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -106,6 +106,31 @@ In addition to OLM, Everest consists of five different operators: In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. +=== "VictoriaMetrics" + We use the Victoria Metrics stack along with kube-state-metrics for monitoring. Both can be found in the `everest-monitoring` namespace. + + ??? example "Examples" + ``` + $ kubectl get sub -n everest-monitoring + NAME PACKAGE SOURCE CHANNEL +victoriametrics-operator victoriametrics-operator everest-catalog stable-v0 + ``` + +$ kubectl get ip -n everest-monitoring +NAME CSV APPROVAL APPROVED +install-nw6sf victoriametrics-operator.v0.29.1 Manual true + +$ kubectl get csv -n everest-monitoring +NAME DISPLAY VERSION REPLACES PHASE +victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 victoriametrics-operator.v0.27.2 Succeeded + +$ kubectl get deploy -n everest-monitoring +NAME READY UP-TO-DATE AVAILABLE AGE +vm-operator-vm-operator 1/1 1 1 19m +kube-state-metrics 1/1 1 1 19m + + + From f3df0ed29e21d266f16710efc45148caf793f755 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 14:17:03 +0530 Subject: [PATCH 018/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 8cb72f16c..62e994f78 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -116,20 +116,24 @@ In addition to OLM, Everest consists of five different operators: victoriametrics-operator victoriametrics-operator everest-catalog stable-v0 ``` -$ kubectl get ip -n everest-monitoring -NAME CSV APPROVAL APPROVED -install-nw6sf victoriametrics-operator.v0.29.1 Manual true - -$ kubectl get csv -n everest-monitoring -NAME DISPLAY VERSION REPLACES PHASE -victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 victoriametrics-operator.v0.27.2 Succeeded - -$ kubectl get deploy -n everest-monitoring -NAME READY UP-TO-DATE AVAILABLE AGE -vm-operator-vm-operator 1/1 1 1 19m -kube-state-metrics 1/1 1 1 19m - + ``` + $ kubectl get ip -n everest-monitoring + NAME CSV APPROVAL APPROVED + install-nw6sf victoriametrics-operator.v0.29.1 Manual true + ``` + ``` + $ kubectl get csv -n everest-monitoring + NAME DISPLAY VERSION REPLACES PHASE + victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 victoriametrics-operator.v0.27.2 Succeeded + ``` + + ``` + $ kubectl get deploy -n everest-monitoring + NAME READY UP-TO-DATE AVAILABLE AGE + vm-operator-vm-operator 1/1 1 1 19m + kube-state-metrics 1/1 1 1 19m + ``` From 2c163d9aa9f3825f82489eb3b0cdcdf68228835b Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 14:22:39 +0530 Subject: [PATCH 019/100] formatting fix --- docs/reference/troubleshoot.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 62e994f78..35e6fcf42 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -112,20 +112,25 @@ In addition to OLM, Everest consists of five different operators: ??? example "Examples" ``` $ kubectl get sub -n everest-monitoring - NAME PACKAGE SOURCE CHANNEL -victoriametrics-operator victoriametrics-operator everest-catalog stable-v0 + NAME PACKAGE SOURCE + CHANNEL + victoriametrics-operator victoriametrics-operator everest- + catalog stable-v0 ``` ``` $ kubectl get ip -n everest-monitoring - NAME CSV APPROVAL APPROVED + NAME CSV APPROVAL + APPROVED install-nw6sf victoriametrics-operator.v0.29.1 Manual true ``` ``` $ kubectl get csv -n everest-monitoring - NAME DISPLAY VERSION REPLACES PHASE - victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 victoriametrics-operator.v0.27.2 Succeeded + NAME DISPLAY + VERSION REPLACES PHASE + victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 + victoriametrics-operator.v0.27.2 Succeeded ``` ``` From 2ea730a82aba1bf0376b7c7832cded2a7f714832 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 14:46:42 +0530 Subject: [PATCH 020/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 70 +++++++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 35e6fcf42..bb1d7c31a 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -107,7 +107,53 @@ In addition to OLM, Everest consists of five different operators: === "VictoriaMetrics" - We use the Victoria Metrics stack along with kube-state-metrics for monitoring. Both can be found in the `everest-monitoring` namespace. + In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you want to install all the operators in the `everest` namespace: + + ??? example "Examples" + ``` + $ kubectl get sub -n everest + NAME PACKAGE SOURCE CHANNEL + percona-xtradb-cluster-operator percona-xtradb-cluster-operator everest-catalog stable-v1 + percona-server-mongodb-operator percona-server-mongodb-operator everest-catalog stable-v1 + percona-postgresql-operator percona-postgresql-operator everest-catalog stable-v2 + ``` + + ``` + $ kubectl get ip -n everest + NAME CSV APPROVAL + APPROVED + install-tjwjf percona-xtradb-cluster-operator.v1.14.0 Manual + true + install-8cl7m percona-server-mongodb-operator.v1.15.0 Manual + true + install-8lz2n percona-postgresql-operator.v2.3.1. Manual + true + ``` + + ``` + $ kubectl get csv -n everest + NAME DISPLAY + VERSION REPLACES PHASE + percona-xtradb-cluster-operator.v1.14.0 Percona Operator for MySQL based on Percona XtraDB Cluster + 1.14.0 percona-xtradb-cluster-operator.v1.13.0 Succeeded + percona-server-mongodb-operator.v1.15.0 Percona Distribution for MongoDB Operator + 1.15.0 percona-server-mongodb-operator.v1.14.0 Succeeded + percona-postgresql-operator.v2.3.1 Percona Operator for PostgreSQL + 2.3.1 Succeeded + everest-operator.v0.10.1 Everest operator + 0.10.1 everest-operator.v0.9.0 Succeeded + ``` + + ``` + $ kubectl get deploy -n everest + NAME READY UP-TO-DATE AVAILABLE AGE + percona-xtradb-cluster-operator 1/1 1 1 23m + percona-server-mongodb-operator 1/1 1 1 22m + percona-postgresql-operator 1/1 1 1 21m + ``` + +=== "DB operators" + We use the VictoriaMetrics stack along with [kube-state-metrics](https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/) for monitoring. Both can be found in the `everest-monitoring` namespace. ??? example "Examples" ``` @@ -139,6 +185,28 @@ In addition to OLM, Everest consists of five different operators: vm-operator-vm-operator 1/1 1 1 19m kube-state-metrics 1/1 1 1 19m ``` + The Everest Operator monitors these resources to reconcile the DatabaseEngine Custom Resource Definitions (CRs) for each installed database operator. These DatabaseEngine CRs provide the user interface (UI) with information about the available database engines and their supported versions. If you experience any issues with the list of available database engines or their versions, this is the area to investigate. + + ??? example "Example" + ``` + $ kubectl get dbengine -n everest + NAME TYPE STATUS OPERATOR VERSION + percona-xtradb-cluster-operator pxc installed 1.14.0 + percona-server-mongodb-operator psmdb installed 1.15.0 + percona-postgresql-operator postgresql installed 2.3.1 + + !!! note + The Everest Operator requires an internet connection to reach [check.percona.com](http://check.percona.com/) to get the supported versions for each engine. You can troubleshoot this step by looking at the everest operator logs: + + ``` + kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system + ``` + + + + + + From 37ba5e84d66e558ca3e2a18e8f8131ba776fefdb Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 14:58:39 +0530 Subject: [PATCH 021/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 35 ++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index bb1d7c31a..00fd8f829 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -202,8 +202,43 @@ In addition to OLM, Everest consists of five different operators: kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system ``` +### Database deployment +In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be pxc, psmdb, or pg. + +Example: +This gives a step by step approach to troubleshoot if something goes wrong with your database deployment: +{.power-number} + +1. Run the following command: + +``` +$ kubectl get db -n everest +NAME SIZE READY STATUS HOSTNAME AGE +mysql-7tl 2 2 ready mysql-7tl-haproxy.everest 6m8s + +$ kubectl get pxc -n everest +NAME ENDPOINT STATUS PXC PROXYSQL HAPROXY AGE +mysql-7tl mysql-7tl-haproxy.everest ready 1 1 6m10s +``` + +2. If an issue arises, first investigate these two objects by executing the following commands: + +``` +kubectl describe db/mysql-7tl -n everest +kubectl describe pxc/mysql-7tl -n everest +``` + +3. If relevant information is not found here, then check the Everest Operator logs as well as the PXC Operator logs: + +``` +kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system +kubectl logs pods/percona-xtradb-cluster-operator-77c5ffddf6-fv8vg -n everest +``` +!!! note + + The names of the pods in your deployment may vary. If nothing relevant appears, check the logs for details. From 49567dbbaf775a4450453e91f9542b568f33aebc Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:03:29 +0530 Subject: [PATCH 022/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 00fd8f829..8e529e131 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -187,13 +187,13 @@ In addition to OLM, Everest consists of five different operators: ``` The Everest Operator monitors these resources to reconcile the DatabaseEngine Custom Resource Definitions (CRs) for each installed database operator. These DatabaseEngine CRs provide the user interface (UI) with information about the available database engines and their supported versions. If you experience any issues with the list of available database engines or their versions, this is the area to investigate. - ??? example "Example" - ``` - $ kubectl get dbengine -n everest - NAME TYPE STATUS OPERATOR VERSION - percona-xtradb-cluster-operator pxc installed 1.14.0 - percona-server-mongodb-operator psmdb installed 1.15.0 - percona-postgresql-operator postgresql installed 2.3.1 + ??? example "Example" + ``` + $ kubectl get dbengine -n everest + NAME TYPE STATUS OPERATOR VERSION + percona-xtradb-cluster-operator pxc installed 1.14.0 + percona-server-mongodb-operator psmdb installed 1.15.0 + percona-postgresql-operator postgresql installed 2.3.1 !!! note The Everest Operator requires an internet connection to reach [check.percona.com](http://check.percona.com/) to get the supported versions for each engine. You can troubleshoot this step by looking at the everest operator logs: From 7a67e28c0761a415583686e6ceb1e5d8f2faf10d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:04:15 +0530 Subject: [PATCH 023/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 8e529e131..0a8bb0179 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -212,29 +212,29 @@ This gives a step by step approach to troubleshoot if something goes wrong with 1. Run the following command: -``` -$ kubectl get db -n everest -NAME SIZE READY STATUS HOSTNAME AGE -mysql-7tl 2 2 ready mysql-7tl-haproxy.everest 6m8s + ``` + $ kubectl get db -n everest + NAME SIZE READY STATUS HOSTNAME AGE + mysql-7tl 2 2 ready mysql-7tl-haproxy.everest 6m8s -$ kubectl get pxc -n everest -NAME ENDPOINT STATUS PXC PROXYSQL HAPROXY AGE -mysql-7tl mysql-7tl-haproxy.everest ready 1 1 6m10s -``` + $ kubectl get pxc -n everest + NAME ENDPOINT STATUS PXC PROXYSQL HAPROXY AGE + mysql-7tl mysql-7tl-haproxy.everest ready 1 1 6m10s + ``` 2. If an issue arises, first investigate these two objects by executing the following commands: -``` -kubectl describe db/mysql-7tl -n everest -kubectl describe pxc/mysql-7tl -n everest -``` + ``` + kubectl describe db/mysql-7tl -n everest + kubectl describe pxc/mysql-7tl -n everest + ``` 3. If relevant information is not found here, then check the Everest Operator logs as well as the PXC Operator logs: -``` -kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system -kubectl logs pods/percona-xtradb-cluster-operator-77c5ffddf6-fv8vg -n everest -``` + ``` + kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system + kubectl logs pods/percona-xtradb-cluster-operator-77c5ffddf6-fv8vg -n everest + ``` !!! note From b07110b65bea761226482ed14b43a9cf273b9bae Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:06:18 +0530 Subject: [PATCH 024/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 0a8bb0179..24fb68320 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -4,20 +4,22 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. -## Troubleshooting checklist + ??? info "Troubleshooting checklist" -Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. -{.power-number} + ## Troubleshooting checklist + + Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. + {.power-number} -1. Are you using the recommended Percona Everest and compatible operator versions? -2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? + 1. Are you using the recommended Percona Everest and compatible operator versions? + 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? -3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. -4. Does the problem occur while you deploy a specific database? -5. Does the problem occur when you perform a particular task, like backups, restores etc? -6. Are you using the [authentication](../administer/Idp_integration.md) correctly? -7. Have you allocated enough resources for deploying your databases on Percona Everest? -8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). + 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. + 4. Does the problem occur while you deploy a specific database? + 5. Does the problem occur when you perform a particular task, like backups, restores etc? + 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? + 7. Have you allocated enough resources for deploying your databases on Percona Everest? + 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). From 6ac2aaead60c925781270c184b46d80ca7acca58 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:13:34 +0530 Subject: [PATCH 025/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 24fb68320..402963fe7 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -243,6 +243,30 @@ This gives a step by step approach to troubleshoot if something goes wrong with The names of the pods in your deployment may vary. If nothing relevant appears, check the logs for details. +### Backups and restores + +#### Backups + +Every backup in percona Everest begins with the creation of a `DatabaseClusterBackup (DBB)` `Custom Resource (CR)` that is deployed to a selected namespace. Depending on the chosen engine type, this `DBB` will be converted into the corresponding Custom Resource that can be interpreted by the database operator, such as `pxc-backup`, `psmdb-backup`, or `pg-backup`. + +``` +kubectl describe pxc-backup +kubectl describe psmdb-backup +kubectl describe pg-backup +``` + +#### Restores + +Every Restore operation in Everest begins with a `DatabaseClusterRestore (DBR)` Custom Resource (CR) that is deployed in the specified namespace. Based on the selected engine type, this `DBR` will be transformed into the corresponding Custom Resource that can be processed by the database operator, such as `pxc-restore`, `psmdb-restore`, or `pg-restore`. + +```sh +kubectl describe pxc-restore restoreName +kubectl describe psmdb-restore restoreName +kubectl describe pg-restore restoreName +``` + + + From 22da4115d582101752d07dc0f3b89e561e610252 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:27:23 +0530 Subject: [PATCH 026/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 402963fe7..16beee89d 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -6,20 +6,21 @@ This section is your go-to resource for tackling common issues and finding solut ??? info "Troubleshooting checklist" - ## Troubleshooting checklist + ## Troubleshooting checklist - Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. - {.power-number} + Here’s a high level checklist to help you identify some potential issues you might + encouner while using Percona Everest. + {.power-number} - 1. Are you using the recommended Percona Everest and compatible operator versions? - 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? + 1. Are you using the recommended Percona Everest and compatible operator versions? + 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? - 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. - 4. Does the problem occur while you deploy a specific database? - 5. Does the problem occur when you perform a particular task, like backups, restores etc? - 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? - 7. Have you allocated enough resources for deploying your databases on Percona Everest? - 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). + 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. + 4. Does the problem occur while you deploy a specific database? + 5. Does the problem occur when you perform a particular task, like backups, restores etc? + 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? + 7. Have you allocated enough resources for deploying your databases on Percona Everest? + 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). From 9737cc12a4334767ef414642e07d2e21f7aad0b1 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:32:29 +0530 Subject: [PATCH 027/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 16beee89d..2ef920e03 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -5,9 +5,6 @@ This section is your go-to resource for tackling common issues and finding solut ??? info "Troubleshooting checklist" - - ## Troubleshooting checklist - Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. {.power-number} From b878fc2f6b5a59dd733ca811c72a46bb07f96cfc Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:35:44 +0530 Subject: [PATCH 028/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 2ef920e03..01c5bfefb 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -5,19 +5,20 @@ This section is your go-to resource for tackling common issues and finding solut ??? info "Troubleshooting checklist" + Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. {.power-number} - 1. Are you using the recommended Percona Everest and compatible operator versions? - 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? + 1. Are you using the recommended Percona Everest and compatible operator versions? + 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? - 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. - 4. Does the problem occur while you deploy a specific database? - 5. Does the problem occur when you perform a particular task, like backups, restores etc? - 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? - 7. Have you allocated enough resources for deploying your databases on Percona Everest? - 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). + 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. + 4. Does the problem occur while you deploy a specific database? + 5. Does the problem occur when you perform a particular task, like backups, restores etc? + 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? + 7. Have you allocated enough resources for deploying your databases on Percona Everest? + 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). From 20dcaef263c7a943ba6e444d5cd1b24024a3a54c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:39:40 +0530 Subject: [PATCH 029/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 01c5bfefb..aebc15b93 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -4,11 +4,11 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. - ??? info "Troubleshooting checklist" +??? info "Troubleshooting checklist" - Here’s a high level checklist to help you identify some potential issues you might - encouner while using Percona Everest. - {.power-number} + Here’s a high level checklist to help you identify some potential issues you might + encouner while using Percona Everest. + {.power-number} 1. Are you using the recommended Percona Everest and compatible operator versions? 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? From ebaf2ee156277599488355ad4cedb168c0440244 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:42:46 +0530 Subject: [PATCH 030/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index aebc15b93..ecdd151ac 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -6,6 +6,8 @@ This section is your go-to resource for tackling common issues and finding solut ??? info "Troubleshooting checklist" + ## Checklist + Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. {.power-number} From 9d1794701360c4655db48991f0ba0f8544204081 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:45:54 +0530 Subject: [PATCH 031/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index ecdd151ac..aebc15b93 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -6,8 +6,6 @@ This section is your go-to resource for tackling common issues and finding solut ??? info "Troubleshooting checklist" - ## Checklist - Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. {.power-number} From cec978585b1f80cdd2f62d11db75ab541826c0b2 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:50:51 +0530 Subject: [PATCH 032/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index aebc15b93..45b843582 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -33,9 +33,9 @@ We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework The main components are: -- olm-operator -- catalog-operator -- packageserver + - olm-operator + - catalog-operator + - packageserver 1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: From 16c99d6b5917896d04a6c3d50c7093261b856fd7 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:55:11 +0530 Subject: [PATCH 033/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 45b843582..1b37fe357 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -32,10 +32,11 @@ We have organized the topics into distinct categories to assist you in exploring We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. The main components are: +{.power-number} - - olm-operator - - catalog-operator - - packageserver + - olm-operator + - catalog-operator + - packageserver 1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: From 44f0095383d21c3e1baf01943415ff3e72f5221c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:01:57 +0530 Subject: [PATCH 034/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 1b37fe357..2d00e804a 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -32,14 +32,16 @@ We have organized the topics into distinct categories to assist you in exploring We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. The main components are: + +* olm-operator +* catalog-operator +* packageserver + +When you install Percona Everest, the following components are installed: {.power-number} - - olm-operator - - catalog-operator - - packageserver - -1. When you install Percona Everest, the `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: +1. The `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: Execute the following command, all the three deployments should be present in the `everest-olm` namespace @@ -51,7 +53,7 @@ The main components are: packageserver 2/2 2 2 3m2s ``` -2. Next, the `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. +2. The `everest-catalog` is installed, which serves as the repository for all the operators that Percona Everest supports. Execute the following command, `everest-catalog` should be present in the `everest-olm` namespace: From ed2a00679db29f9d25ed59bb85970bb0db476aee Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:09:21 +0530 Subject: [PATCH 035/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 2d00e804a..65893e93f 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -160,6 +160,8 @@ In addition to OLM, Everest consists of five different operators: We use the VictoriaMetrics stack along with [kube-state-metrics](https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/) for monitoring. Both can be found in the `everest-monitoring` namespace. ??? example "Examples" + + The following example installs all the operators to the `everest` namespace: ``` $ kubectl get sub -n everest-monitoring NAME PACKAGE SOURCE @@ -198,6 +200,7 @@ In addition to OLM, Everest consists of five different operators: percona-xtradb-cluster-operator pxc installed 1.14.0 percona-server-mongodb-operator psmdb installed 1.15.0 percona-postgresql-operator postgresql installed 2.3.1 + ``` !!! note The Everest Operator requires an internet connection to reach [check.percona.com](http://check.percona.com/) to get the supported versions for each engine. You can troubleshoot this step by looking at the everest operator logs: @@ -240,9 +243,9 @@ This gives a step by step approach to troubleshoot if something goes wrong with kubectl logs pods/percona-xtradb-cluster-operator-77c5ffddf6-fv8vg -n everest ``` -!!! note + !!! note - The names of the pods in your deployment may vary. If nothing relevant appears, check the logs for details. + The names of the pods in your deployment may vary. If nothing relevant appears, check the logs for details. ### Backups and restores From 9cde83b6bdc5d7e36b42aeab31a7c4d8dc01cf21 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:10:41 +0530 Subject: [PATCH 036/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 65893e93f..67a29d140 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -4,7 +4,9 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. -??? info "Troubleshooting checklist" +??? info "High-level checklist" + + ## Troubleshooting checklist Here’s a high level checklist to help you identify some potential issues you might encouner while using Percona Everest. From c8328bfc51b6a1c5b1edf7a244ce7fa8c5a81967 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:17:48 +0530 Subject: [PATCH 037/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 67a29d140..54c1972b7 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -213,7 +213,7 @@ In addition to OLM, Everest consists of five different operators: ### Database deployment -In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be pxc, psmdb, or pg. +In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be `pxc`, `psmdb`, or `pg`. Example: This gives a step by step approach to troubleshoot if something goes wrong with your database deployment: From a10f977e2080d8fbca6d6a1f0deac5374ea620e5 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:22:22 +0530 Subject: [PATCH 038/100] added faq topic --- docs/reference/faq.md | 30 ++++++++++++++++++++++++++++++ mkdocs-base.yml | 3 +++ 2 files changed, 33 insertions(+) create mode 100644 docs/reference/faq.md diff --git a/docs/reference/faq.md b/docs/reference/faq.md new file mode 100644 index 000000000..f88be908e --- /dev/null +++ b/docs/reference/faq.md @@ -0,0 +1,30 @@ +# Frequently asked questions + +**What is the DatabaseEngine and what is an example of the "Database Engine Operations". Is that where it manages the database operators and an example would be upgrading the operator? Or is that Everest resources or something?** + +You can refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources +The DatabaseEngine is a resource which holds the PG/PXC/Mongo versions compatible with the current Everest version. You can retrieve and update this information. + +**Everest API: Do we have any logs of the API calls done, so we can validate if an API call was done for a user operation, and if it received any errors (to troubleshoot problems where an operation is done but the respective Everest operator resource is not created for some reason)? If yes, where are they stored?** + +Yes, there are logs in the Everest backend. It runs as a "percona-everest" deployment in the "everest-system" namespace. + +You can get logs from the pods associated with the deployment. + +**Frontend: Do we have any logs for the frontend actions (nginx logs or something similar) to troubleshoot problems between Frontend -> Everest API** + +Such logs would be available in the web browser's console. + +**Regarding the Everest operator part of the image: are there any other resources that are not in the image? For example, is there a resource that receives the API calls and interacts with the individual resources that we should look to troubleshoot/check its logs when issues arise or does the Everest API directly interact with those Everest operator resources, and we should just match the "Percona operator" issue with the responsible Everest resource and go from there?** + +All communication with the Everest resources starts with the API. + +The API updates Everest resources and Everest operator continues to create resources for the respective db operators. Debugging shall start with the API, then the Everest operator and then individual database operators. + +**PMM seems to be missing in this. We see they have MonitorConfig, but does this resource directly interact with each ppm-agent container on database pods as well as deploy new PMM Servers and modify its configuration?** + +When talking to PMM, we create an API key to send data to PMM. + +The API key is used to configure monitoring endpoints for individual database operators and they send data to PMM. + +PMM does not necessarily have a place in the architecture - it's an external service we support. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index fb078b3ac..1292fb91e 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -202,6 +202,9 @@ nav: - Migrate to Percona Everest: reference/migration_guide.md - Copyright and licensing information: reference/copyright.md - Trademark and copyright policy: reference/trademark-policy.md + - Troubleshoot: + - Resolve issues: reference/troubleshoot.md + - FAQ: reference/faq.md - Contribute: contribute.md From 8026f7c6ad1ab298bf7bed79fa196e01a871235c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:43:25 +0530 Subject: [PATCH 039/100] Update mkdocs-base.yml --- mkdocs-base.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 1292fb91e..fb56b6fc4 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -197,14 +197,14 @@ nav: - API: API.md - Reference: - Limitations: reference/known_limitations.md + - Troubleshoot: + - Resolve issues: reference/troubleshoot.md + - FAQ: reference/faq.md - Telemetry on Percona Everest: reference/telemetry.md - - Troubleshooting: reference/troubleshoot.md - Migrate to Percona Everest: reference/migration_guide.md - Copyright and licensing information: reference/copyright.md - Trademark and copyright policy: reference/trademark-policy.md - - Troubleshoot: - - Resolve issues: reference/troubleshoot.md - - FAQ: reference/faq.md + - Contribute: contribute.md From 3ae21b25a1b095374d4ed6198c140e681b22bf48 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 18:30:39 +0530 Subject: [PATCH 040/100] added faq topic --- docs/reference/faq.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index f88be908e..9a7dc67ea 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -1,30 +1,43 @@ # Frequently asked questions -**What is the DatabaseEngine and what is an example of the "Database Engine Operations". Is that where it manages the database operators and an example would be upgrading the operator? Or is that Everest resources or something?** +This section outlines the most frequently asked questions (FAQs) about Percona Everest. -You can refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources -The DatabaseEngine is a resource which holds the PG/PXC/Mongo versions compatible with the current Everest version. You can retrieve and update this information. -**Everest API: Do we have any logs of the API calls done, so we can validate if an API call was done for a user operation, and if it received any errors (to troubleshoot problems where an operation is done but the respective Everest operator resource is not created for some reason)? If yes, where are they stored?** +**Q:** What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? -Yes, there are logs in the Everest backend. It runs as a "percona-everest" deployment in the "everest-system" namespace. -You can get logs from the pods associated with the deployment. +The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. -**Frontend: Do we have any logs for the frontend actions (nginx logs or something similar) to troubleshoot problems between Frontend -> Everest API** +Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. -Such logs would be available in the web browser's console. +**Q: Everest API** -**Regarding the Everest operator part of the image: are there any other resources that are not in the image? For example, is there a resource that receives the API calls and interacts with the individual resources that we should look to troubleshoot/check its logs when issues arise or does the Everest API directly interact with those Everest operator resources, and we should just match the "Percona operator" issue with the responsible Everest resource and go from there?** +- Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. -All communication with the Everest resources starts with the API. + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. -The API updates Everest resources and Everest operator continues to create resources for the respective db operators. Debugging shall start with the API, then the Everest operator and then individual database operators. -**PMM seems to be missing in this. We see they have MonitorConfig, but does this resource directly interact with each ppm-agent container on database pods as well as deploy new PMM Servers and modify its configuration?** +- If we have these logs, where are they stored? -When talking to PMM, we create an API key to send data to PMM. + You can retrieve logs from the pods associated with this deployment. -The API key is used to configure monitoring endpoints for individual database operators and they send data to PMM. -PMM does not necessarily have a place in the architecture - it's an external service we support. \ No newline at end of file +**Q: Frontend**: Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? + +The logs will be accessible in the console of the web browser. + +**Everest operator image**: Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? + + +All communication with Everest resources begins with the API. + +The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. + + +**Q:** PMM appears to be absent in this context. While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? + + +When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. + +!!! note + PMM is an external service we support and does not necessarily fit into our architecture. From 668d57aa82692677c0edfc4d63818911ae87ff3a Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 11 Nov 2024 18:46:08 +0530 Subject: [PATCH 041/100] Update faq.md --- docs/reference/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 9a7dc67ea..0214e6529 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -22,11 +22,11 @@ Refer to our API documentation at https://percona-everest.readme.io/reference/ge You can retrieve logs from the pods associated with this deployment. -**Q: Frontend**: Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? +**Q: Frontend:** Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? The logs will be accessible in the console of the web browser. -**Everest operator image**: Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? +**Q: Everest operator image:** Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? All communication with Everest resources begins with the API. From c2771d28d0d97167950c4698a222b882d1613642 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 18 Nov 2024 19:17:57 +0530 Subject: [PATCH 042/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 54c1972b7..067b0c33b 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -112,7 +112,7 @@ In addition to OLM, Everest consists of five different operators: In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. -=== "VictoriaMetrics" +=== "DB operators" In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you want to install all the operators in the `everest` namespace: ??? example "Examples" @@ -158,7 +158,7 @@ In addition to OLM, Everest consists of five different operators: percona-postgresql-operator 1/1 1 1 21m ``` -=== "DB operators" +=== "VictoriaMetrics" We use the VictoriaMetrics stack along with [kube-state-metrics](https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/) for monitoring. Both can be found in the `everest-monitoring` namespace. ??? example "Examples" From e10b0279103cfaa83e871d2e2a4e78134f61cec5 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 18 Nov 2024 19:18:40 +0530 Subject: [PATCH 043/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 067b0c33b..595fefd3c 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -213,7 +213,7 @@ In addition to OLM, Everest consists of five different operators: ### Database deployment -In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be `pxc`, `psmdb`, or `pg`. +In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be `PXC`, `PSMDB`, or `PG`. Example: This gives a step by step approach to troubleshoot if something goes wrong with your database deployment: From e01e3951bcd7bfd0360a095acd10926a348300bf Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:17:11 +0530 Subject: [PATCH 044/100] Update faq.md --- docs/reference/faq.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 0214e6529..b2c2b6888 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,6 +3,8 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. +???+ DatabaseEngine + **Q:** What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? From 01ad1b988a96c2a3b13c96fcf1984b8f570bc842 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:19:23 +0530 Subject: [PATCH 045/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index b2c2b6888..165486ab9 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -???+ DatabaseEngine +???+ Question **Q:** What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? From 8522f77e89739f910cc506d2f25e9b39cf6a3d2e Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:38:12 +0530 Subject: [PATCH 046/100] Update faq.md --- docs/reference/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 165486ab9..318efae2f 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -8,9 +8,9 @@ This section outlines the most frequently asked questions (FAQs) about Percona E **Q:** What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? -The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. + The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. -Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. + Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. **Q: Everest API** From 13154e2a0570cf3c53a2a90c4ad2502ea3fe3db3 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:42:45 +0530 Subject: [PATCH 047/100] formatting fixes --- docs/reference/faq.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 318efae2f..45fc19be4 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -5,8 +5,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E ???+ Question -**Q:** What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - + What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. From 982e59170e0e69baab51afea8e18af614be18622 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:48:30 +0530 Subject: [PATCH 048/100] Update faq.md --- docs/reference/faq.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 45fc19be4..cb56ff04d 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,9 +7,10 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. + ???+ Question "Answer" + The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. - Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. + Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. **Q: Everest API** From 2326708bc05416a85414bdfa86a9d4e7cc277448 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:52:09 +0530 Subject: [PATCH 049/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index cb56ff04d..7ff58d671 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,7 +7,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - ???+ Question "Answer" + ??? info "Answer" The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. From f0f620e9d1413883570105989f959cb8fa49356e Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:53:10 +0530 Subject: [PATCH 050/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 7ff58d671..b3b6174be 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -???+ Question +???+ Question "DatabaseEngine" What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? From 2f0cb72316b99d3ba93ec87317f8d3fb5fa8916f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 13:55:57 +0530 Subject: [PATCH 051/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index b3b6174be..88bff75db 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,7 +7,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - ??? info "Answer" + ??? info The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. From 7eb4654555a2e655861db78d95fd2d087eab1eef Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:06:26 +0530 Subject: [PATCH 052/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 88bff75db..b3b6174be 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,7 +7,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - ??? info + ??? info "Answer" The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. From 4690af4dfa9334ce7cbf0ee98b2ebb1b2bc0a91d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:12:10 +0530 Subject: [PATCH 053/100] Update faq.md --- docs/reference/faq.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index b3b6174be..eb7ba32e2 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -12,16 +12,18 @@ This section outlines the most frequently asked questions (FAQs) about Percona E Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. -**Q: Everest API** +???+ Question "Everest API" -- Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. + - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + ??? info "Answer" + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. -- If we have these logs, where are they stored? + - If we have these logs, where are they stored? - You can retrieve logs from the pods associated with this deployment. + ??? info "Answer" + You can retrieve logs from the pods associated with this deployment. **Q: Frontend:** Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? From 4052de906d3d0857898ddc95a6b8443193d5c753 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:21:28 +0530 Subject: [PATCH 054/100] Update faq.md --- docs/reference/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index eb7ba32e2..1667d92c0 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -16,8 +16,8 @@ This section outlines the most frequently asked questions (FAQs) about Percona E - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. - ??? info "Answer" - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + ??? info "Answer" + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - If we have these logs, where are they stored? From a5e4d7bb02628261c81804d99a7d3c793ea59861 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:27:16 +0530 Subject: [PATCH 055/100] Update faq.md --- docs/reference/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 1667d92c0..141efd93f 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -???+ Question "DatabaseEngine" +???+ Question "1. DatabaseEngine" What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? @@ -12,7 +12,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. -???+ Question "Everest API" +???+ Question "2. Everest API" - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. From 64e3e06faf4653325c299de315d7880507551504 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:38:16 +0530 Subject: [PATCH 056/100] Update faq.md --- docs/reference/faq.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 141efd93f..b3f803966 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -26,22 +26,31 @@ This section outlines the most frequently asked questions (FAQs) about Percona E You can retrieve logs from the pods associated with this deployment. -**Q: Frontend:** Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? +???+ Question "3. Frontend" -The logs will be accessible in the console of the web browser. + Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? -**Q: Everest operator image:** Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? + ??? info "Answer" + The logs will be accessible in the console of the web browser. + +???+ Question "4. Everest operator image" + + Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? -All communication with Everest resources begins with the API. + ??? info "Answer" + All communication with Everest resources begins with the API. + + The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. -The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. +???+ Question "5. PMM" -**Q:** PMM appears to be absent in this context. While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? + PMM appears to be absent in this context. While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? + ??? info "Answer" -When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. + When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. -!!! note - PMM is an external service we support and does not necessarily fit into our architecture. + !!! note + PMM is an external service we support and does not necessarily fit into our architecture. From fca4597fe89fc5357f09f51aab3297bf30b11745 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:52:43 +0530 Subject: [PATCH 057/100] Update faq.md --- docs/reference/faq.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index b3f803966..3239bfada 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,10 +7,10 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - ??? info "Answer" - The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. + **Answer** + The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. - Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. + Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. ???+ Question "2. Everest API" From 10b7285139698a991ce6a8e00ee9b026219ac88e Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 14:58:41 +0530 Subject: [PATCH 058/100] formatting updates --- docs/reference/faq.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 3239bfada..082d55a11 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -7,50 +7,49 @@ This section outlines the most frequently asked questions (FAQs) about Percona E What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - **Answer** + **Answer:** The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. - Refer to our API documentation at https://percona-everest.readme.io/reference/getkubernetesclusterresources for in-depth information. + Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. ???+ Question "2. Everest API" - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. - ??? info "Answer" - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - If we have these logs, where are they stored? - ??? info "Answer" - You can retrieve logs from the pods associated with this deployment. + **Answer:** + You can retrieve logs from the pods associated with this deployment. ???+ Question "3. Frontend" Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? - ??? info "Answer" - The logs will be accessible in the console of the web browser. + **Answer:** + The logs will be accessible in the console of the web browser. ???+ Question "4. Everest operator image" Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? - ??? info "Answer" - All communication with Everest resources begins with the API. + **Answer:** + All communication with Everest resources begins with the API. - The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. + The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. ???+ Question "5. PMM" PMM appears to be absent in this context. While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? - ??? info "Answer" + **Answer:** + When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. - When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. - - !!! note - PMM is an external service we support and does not necessarily fit into our architecture. + !!! note + PMM is an external service we support and does not necessarily fit into our architecture. From 94bf12b970bed5f20ec77c5f9d7bd4a7577ca3da Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:06:07 +0530 Subject: [PATCH 059/100] Update faq.md --- docs/reference/faq.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 082d55a11..2daab0ee3 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -???+ Question "1. DatabaseEngine" +??? Question "1. DatabaseEngine" What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? @@ -16,14 +16,14 @@ This section outlines the most frequently asked questions (FAQs) about Percona E - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. - **Answer:** - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - If we have these logs, where are they stored? - **Answer:** - You can retrieve logs from the pods associated with this deployment. + **Answer:** + You can retrieve logs from the pods associated with this deployment. ???+ Question "3. Frontend" From 19f019f78f7fe7be33c13e82f874eb326f20ee1d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:13:28 +0530 Subject: [PATCH 060/100] Update faq.md --- docs/reference/faq.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 2daab0ee3..d012ec00f 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -1,20 +1,20 @@ -# Frequently asked questions +# Frequently asked questions (FAQ) This section outlines the most frequently asked questions (FAQs) about Percona Everest. -??? Question "1. DatabaseEngine" +??? Question "What is DatabaseEngine?" - What is a `DatabaseEngine`, and can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? + Can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? **Answer:** The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. -???+ Question "2. Everest API" +???+ Question "Do we have logs of the API calls made?" - - Do we have logs of the API calls made? This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. + - This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. **Answer:** Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. @@ -26,16 +26,14 @@ This section outlines the most frequently asked questions (FAQs) about Percona E You can retrieve logs from the pods associated with this deployment. -???+ Question "3. Frontend" - - Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API? +???+ Question "Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API" **Answer:** The logs will be accessible in the console of the web browser. -???+ Question "4. Everest operator image" +???+ Question "Are there any additional resources that are not included in the image?" - Are there any additional resources that are not included in the image? For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? + For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? **Answer:** @@ -44,9 +42,9 @@ This section outlines the most frequently asked questions (FAQs) about Percona E The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. -???+ Question "5. PMM" +???+ Question "Why PMM appears to be absent in this context?" - PMM appears to be absent in this context. While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? + While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? **Answer:** When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. From e3959132006e7d550d10e952078565a60bbef247 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:19:36 +0530 Subject: [PATCH 061/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index d012ec00f..655660cd3 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -??? Question "What is DatabaseEngine?" +??? Question+ "What is DatabaseEngine?" Can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? From bb0bb2e3b0cfeef63b9e6fd048dbfe43a15b59df Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:27:54 +0530 Subject: [PATCH 062/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 655660cd3..518e0415e 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,7 +3,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -??? Question+ "What is DatabaseEngine?" +???+ Question "What is DatabaseEngine?" Can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? From bbd615f0f452772bb4725604987f2dba51b7e12e Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:43:56 +0530 Subject: [PATCH 063/100] Update faq.md --- docs/reference/faq.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 518e0415e..03ca5a9fa 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -5,8 +5,8 @@ This section outlines the most frequently asked questions (FAQs) about Percona E ???+ Question "What is DatabaseEngine?" - Can you provide an example of **Database Engine Operations**? Does it manage database operators, such as upgrading the operator, or is it related to Percona Everest resources? - + Provide an example of **Database Engine Operations**. Does it manage database operators, such as upgrades, or is it related to Percona Everest resources? + **Answer:** The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. @@ -14,7 +14,10 @@ This section outlines the most frequently asked questions (FAQs) about Percona E ???+ Question "Do we have logs of the API calls made?" - - This would help us validate whether an API call was executed for a user operation and if it encountered any errors. This is important for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn’t been created for some reason. + - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. + + !!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. **Answer:** Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. From becbe7c40dafeb43c0edef050fe83f6a0652f0d4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:49:02 +0530 Subject: [PATCH 064/100] Update faq.md --- docs/reference/faq.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 03ca5a9fa..bd8ffcc06 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -16,11 +16,11 @@ This section outlines the most frequently asked questions (FAQs) about Percona E - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. - !!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. + !!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - **Answer:** - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - If we have these logs, where are they stored? From 178530e7b42195e93bd5ddb3f61dc7a04894a73f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:55:50 +0530 Subject: [PATCH 065/100] Update faq.md --- docs/reference/faq.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index bd8ffcc06..68ca3b101 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -16,11 +16,11 @@ This section outlines the most frequently asked questions (FAQs) about Percona E - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. - !!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. + !!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - **Answer:** - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - If we have these logs, where are they stored? From 46341ad65eabd753d29095a8790a9a6f14bf7232 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:02:41 +0530 Subject: [PATCH 066/100] Update faq.md --- docs/reference/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 68ca3b101..14f4fd6aa 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -16,10 +16,10 @@ This section outlines the most frequently asked questions (FAQs) about Percona E - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. - !!! Note + !!! Note This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - **Answer:** + **Answer:** Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. From 0930174c57b4eace210de3e78d701a4a35b1daf4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:07:49 +0530 Subject: [PATCH 067/100] Update faq.md --- docs/reference/faq.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 14f4fd6aa..a71a97e66 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -29,14 +29,15 @@ This section outlines the most frequently asked questions (FAQs) about Percona E You can retrieve logs from the pods associated with this deployment. -???+ Question "Do we have any logs for frontend actions, like nginx logs, to troubleshoot issues between the frontend and the Percona Everest API" +???+ Question "Do we have any logs for frontend actions, like Nginx logs, to troubleshoot issues between the front end and the Percona Everest API??" **Answer:** The logs will be accessible in the console of the web browser. ???+ Question "Are there any additional resources that are not included in the image?" - For instance, is there a resource that handles the API calls and interacts with individual resources? Should we check its logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? In that case, should we match the "Percona operator" issue with the corresponding Everest resource and address the problem from there? + Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? + **Answer:** From 8b9a0e3576160210716afabb707d0e3e233e7267 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:19:27 +0530 Subject: [PATCH 068/100] Update faq.md --- docs/reference/faq.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index a71a97e66..80d32663e 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -15,13 +15,13 @@ This section outlines the most frequently asked questions (FAQs) about Percona E ???+ Question "Do we have logs of the API calls made?" - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. - - !!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - **Answer:** + **Answer:** Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + !!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. + - If we have these logs, where are they stored? @@ -38,8 +38,6 @@ This section outlines the most frequently asked questions (FAQs) about Percona E Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? - - **Answer:** All communication with Everest resources begins with the API. From 6c196a54b8c509f1fe960d126833647c2018b0a3 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:49:55 +0530 Subject: [PATCH 069/100] added troubleshoot topic to the home page --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7abd2dbf3..dfd0a18d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,11 +37,11 @@ Explore how our security features are designed to ensure the security of your ho
-### :material-account-supervisor: Manage users { .title } +### ::material-frequently-asked-questions: Troubleshooting { .title } -Learn how to manage user accounts in Percona Everest. +Dive into our troubleshooting section, where we will help you overcome challenges. Whether you’re dealing with everyday problems or specific concerns, we have you covered! -[Manage user accounts :material-arrow-right:](administer/manage_users.md){ .md-button .md-button--primary } +[Troubleshoot :material-arrow-right:](reference/troubleshoot.md){ .md-button .md-button--primary }
From d350d9b18a9fd23f00454c20270f701e3d279d78 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:54:00 +0530 Subject: [PATCH 070/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index dfd0a18d9..25beaba08 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,7 @@ Explore how our security features are designed to ensure the security of your ho
-### ::material-frequently-asked-questions: Troubleshooting { .title } +### :material-frequently-asked-questions: Troubleshooting { .title } Dive into our troubleshooting section, where we will help you overcome challenges. Whether you’re dealing with everyday problems or specific concerns, we have you covered! From 5038213c7106004e604ab12c2ec3ae411c083b59 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:19:11 +0530 Subject: [PATCH 071/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 595fefd3c..4786dbfae 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -4,25 +4,6 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. -??? info "High-level checklist" - - ## Troubleshooting checklist - - Here’s a high level checklist to help you identify some potential issues you might - encouner while using Percona Everest. - {.power-number} - - 1. Are you using the recommended Percona Everest and compatible operator versions? - 2. Did you check the known issues section in the [Release Notes](../release-notes/release_notes_index.md) for that particular Percona Everest release? - - 3. Do the logs contain any messages about the problem? See Message logs and Trace logs for more information. - 4. Does the problem occur while you deploy a specific database? - 5. Does the problem occur when you perform a particular task, like backups, restores etc? - 6. Are you using the [authentication](../administer/Idp_integration.md) correctly? - 7. Have you allocated enough resources for deploying your databases on Percona Everest? - 8. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant [Release Notes](../release-notes/release_notes_index.md). - - ## Troubleshooting topics From ecbbbbb59c580ad4f762ae8484e40dbdbb8cad43 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:20:54 +0530 Subject: [PATCH 072/100] Update faq.md --- docs/reference/faq.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 80d32663e..0785c743e 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -3,14 +3,14 @@ This section outlines the most frequently asked questions (FAQs) about Percona Everest. -???+ Question "What is DatabaseEngine?" +## What is DatabaseEngine? - Provide an example of **Database Engine Operations**. Does it manage database operators, such as upgrades, or is it related to Percona Everest resources? +Provide an example of **Database Engine Operations**. Does it manage database operators, such as upgrades, or is it related to Percona Everest resources? - **Answer:** - The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. +**Answer:** +The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. - Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. +Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. ???+ Question "Do we have logs of the API calls made?" From 7174eb2627e960344958caab6882928ac133e045 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:29:01 +0530 Subject: [PATCH 073/100] Update faq.md --- docs/reference/faq.md | 47 +++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 0785c743e..c620c2eca 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -12,44 +12,43 @@ The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versi Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. -???+ Question "Do we have logs of the API calls made?" +### Do we have logs of the API calls made? - - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. +- This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. - **Answer:** - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. - - !!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. +**Answer:** +Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. +!!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - - If we have these logs, where are they stored? +- If we have these logs, where are they stored? - **Answer:** - You can retrieve logs from the pods associated with this deployment. +**Answer:** +You can retrieve logs from the pods associated with this deployment. -???+ Question "Do we have any logs for frontend actions, like Nginx logs, to troubleshoot issues between the front end and the Percona Everest API??" +### Do we have any logs for frontend actions, like Nginx logs, to troubleshoot issues between the front end and the Percona Everest API? - **Answer:** - The logs will be accessible in the console of the web browser. +**Answer:** +The logs will be accessible in the console of the web browser. -???+ Question "Are there any additional resources that are not included in the image?" +### Question "Are there any additional resources that are not included in the image?" - Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? +Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? - **Answer:** - All communication with Everest resources begins with the API. +**Answer:** +All communication with Everest resources begins with the API. - The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. +The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. -???+ Question "Why PMM appears to be absent in this context?" +### Why PMM appears to be absent in this context? - While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? +While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? - **Answer:** - When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. +**Answer:** +When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. - !!! note - PMM is an external service we support and does not necessarily fit into our architecture. +!!! note + PMM is an external service we support and does not necessarily fit into our architecture. From 039c8f9e83f139a5726a98963c9d789f743d0b39 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:33:07 +0530 Subject: [PATCH 074/100] Update faq.md --- docs/reference/faq.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index c620c2eca..c7f9f38c7 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -16,16 +16,16 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get - This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. -**Answer:** -Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. -!!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. + !!! Note + This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. -- If we have these logs, where are they stored? + - If we have these logs, where are they stored? -**Answer:** -You can retrieve logs from the pods associated with this deployment. + **Answer:** + You can retrieve logs from the pods associated with this deployment. ### Do we have any logs for frontend actions, like Nginx logs, to troubleshoot issues between the front end and the Percona Everest API? From a9b36963509672cd86d34baf0da59f18b12c15b9 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:33:45 +0530 Subject: [PATCH 075/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index c7f9f38c7..fd1c63b56 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -33,7 +33,7 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get **Answer:** The logs will be accessible in the console of the web browser. -### Question "Are there any additional resources that are not included in the image?" +### Are there any additional resources that are not included in the image? Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? From c23f07b5754f57da9d0ca3478b058398ab1e1a6f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 13:52:48 +0530 Subject: [PATCH 076/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 4786dbfae..6e65efb14 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -10,7 +10,7 @@ This section is your go-to resource for tackling common issues and finding solut We have organized the topics into distinct categories to assist you in exploring the information more easily. -### Percona Everest installation +### Percona Everest installation overview We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. @@ -20,6 +20,8 @@ The main components are: * catalog-operator * packageserver +#### Percona Everest installation + When you install Percona Everest, the following components are installed: {.power-number} From 880bdc843eff02a62748150fb60080a0fa705dcc Mon Sep 17 00:00:00 2001 From: Rasika Chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:16:50 +0530 Subject: [PATCH 077/100] Update docs/reference/troubleshoot.md Co-authored-by: Diogo Recharte --- docs/reference/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 6e65efb14..aad9145d3 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -28,7 +28,7 @@ When you install Percona Everest, the following components are installed: 1. The `olm-operator`, `catalog-operator`, and `packageserver` gets installed in the `everest-olm` namespace: - Execute the following command, all the three deployments should be present in the `everest-olm` namespace + Execute the following command, all three deployments should be present in the `everest-olm` namespace ``` $ kubectl get deploy -n everest-olm From cace6e2c5d1ec66a2b30d5f2e297f67b598c9c0d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:19:16 +0530 Subject: [PATCH 078/100] removed $ from all the coomands --- docs/index.md | 2 +- docs/reference/troubleshoot.md | 34 +++++++++++++++++----------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/index.md b/docs/index.md index 25beaba08..4a14bf54a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,7 +39,7 @@ Explore how our security features are designed to ensure the security of your ho ### :material-frequently-asked-questions: Troubleshooting { .title } -Dive into our troubleshooting section, where we will help you overcome challenges. Whether you’re dealing with everyday problems or specific concerns, we have you covered! +Dive into our troubleshooting section, which is designed to guide you through any issues you may encounter while using Percona Everest. [Troubleshoot :material-arrow-right:](reference/troubleshoot.md){ .md-button .md-button--primary } diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 6e65efb14..335d4f854 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -10,7 +10,7 @@ This section is your go-to resource for tackling common issues and finding solut We have organized the topics into distinct categories to assist you in exploring the information more easily. -### Percona Everest installation overview +### Percona Everest comprehensive installation overview We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. @@ -31,7 +31,7 @@ When you install Percona Everest, the following components are installed: Execute the following command, all the three deployments should be present in the `everest-olm` namespace ``` - $ kubectl get deploy -n everest-olm + kubectl get deploy -n everest-olm NAME READY UP-TO-DATE AVAILABLE AGE olm-operator 1/1 1 1 5m38s catalog-operator 1/1 1 1 5m37s @@ -66,25 +66,25 @@ In addition to OLM, Everest consists of five different operators: ??? example "Examples" ```sh - $ kubectl get sub -n everest-system + kubectl get sub -n everest-system NAME PACKAGE SOURCE CHANNEL everest-operator everest-operator everest-catalog stable-v0 ``` ``` - $ kubectl get ip -n everest-system + kubectl get ip -n everest-system NAME CSV APPROVAL APPROVED install-69g62 everest-operator.v0.10.1 Manual true ``` ``` - $ kubectl get csv -n everest-system + kubectl get csv -n everest-system NAME DISPLAY VERSION REPLACES PHASE everest-operator.v0.10.1 Everest operator 0.10.1 everest-operator.v0.9.0 Succeeded ``` ``` - $ kubectl get deploy -n everest-system + kubectl get deploy -n everest-system NAME READY UP-TO-DATE AVAILABLE AGE everest-operator-controller-manager 1/1 1 1 12m percona-everest 1/1 1 1 11m @@ -100,7 +100,7 @@ In addition to OLM, Everest consists of five different operators: ??? example "Examples" ``` - $ kubectl get sub -n everest + kubectl get sub -n everest NAME PACKAGE SOURCE CHANNEL percona-xtradb-cluster-operator percona-xtradb-cluster-operator everest-catalog stable-v1 percona-server-mongodb-operator percona-server-mongodb-operator everest-catalog stable-v1 @@ -108,7 +108,7 @@ In addition to OLM, Everest consists of five different operators: ``` ``` - $ kubectl get ip -n everest + kubectl get ip -n everest NAME CSV APPROVAL APPROVED install-tjwjf percona-xtradb-cluster-operator.v1.14.0 Manual @@ -120,7 +120,7 @@ In addition to OLM, Everest consists of five different operators: ``` ``` - $ kubectl get csv -n everest + kubectl get csv -n everest NAME DISPLAY VERSION REPLACES PHASE percona-xtradb-cluster-operator.v1.14.0 Percona Operator for MySQL based on Percona XtraDB Cluster @@ -134,7 +134,7 @@ In addition to OLM, Everest consists of five different operators: ``` ``` - $ kubectl get deploy -n everest + kubectl get deploy -n everest NAME READY UP-TO-DATE AVAILABLE AGE percona-xtradb-cluster-operator 1/1 1 1 23m percona-server-mongodb-operator 1/1 1 1 22m @@ -148,7 +148,7 @@ In addition to OLM, Everest consists of five different operators: The following example installs all the operators to the `everest` namespace: ``` - $ kubectl get sub -n everest-monitoring + kubectl get sub -n everest-monitoring NAME PACKAGE SOURCE CHANNEL victoriametrics-operator victoriametrics-operator everest- @@ -156,14 +156,14 @@ In addition to OLM, Everest consists of five different operators: ``` ``` - $ kubectl get ip -n everest-monitoring + kubectl get ip -n everest-monitoring NAME CSV APPROVAL APPROVED install-nw6sf victoriametrics-operator.v0.29.1 Manual true ``` ``` - $ kubectl get csv -n everest-monitoring + kubectl get csv -n everest-monitoring NAME DISPLAY VERSION REPLACES PHASE victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 @@ -171,7 +171,7 @@ In addition to OLM, Everest consists of five different operators: ``` ``` - $ kubectl get deploy -n everest-monitoring + kubectl get deploy -n everest-monitoring NAME READY UP-TO-DATE AVAILABLE AGE vm-operator-vm-operator 1/1 1 1 19m kube-state-metrics 1/1 1 1 19m @@ -180,7 +180,7 @@ In addition to OLM, Everest consists of five different operators: ??? example "Example" ``` - $ kubectl get dbengine -n everest + kubectl get dbengine -n everest NAME TYPE STATUS OPERATOR VERSION percona-xtradb-cluster-operator pxc installed 1.14.0 percona-server-mongodb-operator psmdb installed 1.15.0 @@ -205,11 +205,11 @@ This gives a step by step approach to troubleshoot if something goes wrong with 1. Run the following command: ``` - $ kubectl get db -n everest + kubectl get db -n everest NAME SIZE READY STATUS HOSTNAME AGE mysql-7tl 2 2 ready mysql-7tl-haproxy.everest 6m8s - $ kubectl get pxc -n everest + kubectl get pxc -n everest NAME ENDPOINT STATUS PXC PROXYSQL HAPROXY AGE mysql-7tl mysql-7tl-haproxy.everest ready 1 1 6m10s ``` From 9de66f9672342edf375176a7aa7a61550c30d2ab Mon Sep 17 00:00:00 2001 From: Rasika Chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:21:12 +0530 Subject: [PATCH 079/100] Update docs/reference/troubleshoot.md Co-authored-by: Diogo Recharte --- docs/reference/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 797a8063a..35695d8c8 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -96,7 +96,7 @@ In addition to OLM, Everest consists of five different operators: === "DB operators" - In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you want to install all the operators in the `everest` namespace: + In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you installed all the operators in the `everest` namespace: ??? example "Examples" ``` From 1dc99093485a965c32cdfd17f960b561a9ad4315 Mon Sep 17 00:00:00 2001 From: Rasika Chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:21:21 +0530 Subject: [PATCH 080/100] Update docs/reference/faq.md Co-authored-by: Diogo Recharte --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index fd1c63b56..8063b3337 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -45,7 +45,7 @@ The API is responsible for updating Everest resources, while the Everest operato ### Why PMM appears to be absent in this context? -While `MonitorConfig` is present, does this resource interact directly with each `ppm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? +While `MonitorConfig` is present, does this resource interact directly with each `pmm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? **Answer:** When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. From 3b6aac3e4ed1f78513bb12531b518122642ed381 Mon Sep 17 00:00:00 2001 From: Rasika Chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:22:20 +0530 Subject: [PATCH 081/100] Update docs/reference/faq.md Co-authored-by: Diogo Recharte --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 8063b3337..eccaa2545 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -28,7 +28,7 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get You can retrieve logs from the pods associated with this deployment. -### Do we have any logs for frontend actions, like Nginx logs, to troubleshoot issues between the front end and the Percona Everest API? +### Do we have any logs for frontend actions, to troubleshoot issues between the front end and the Percona Everest API? **Answer:** The logs will be accessible in the console of the web browser. From d7efb01bb75108afc50ad9ac48fe85815f84912a Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:30:26 +0530 Subject: [PATCH 082/100] Update faq.md --- docs/reference/faq.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index eccaa2545..97a450668 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -33,9 +33,11 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get **Answer:** The logs will be accessible in the console of the web browser. -### Are there any additional resources that are not included in the image? +### Is there a resource that manages the API calls and interacts with the individual resources? -Is there a resource that manages the API calls and interacts with the individual resources? Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? +- Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? + +- If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? **Answer:** All communication with Everest resources begins with the API. @@ -48,6 +50,9 @@ The API is responsible for updating Everest resources, while the Everest operato While `MonitorConfig` is present, does this resource interact directly with each `pmm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? **Answer:** + +Percona Everest doesn't deploy PMM. Instead, we configure PMM agents in each DB deployment to communicate with an existing PMM server. + When communicating with PMM, we generate an API key to facilitate data transmission. This API key allows us to configure monitoring endpoints for individual database operators, enabling them to send data to PMM. !!! note From 93b15c40b7b3ecc35373bcc87b2994adc6248c61 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:32:24 +0530 Subject: [PATCH 083/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 97a450668..8d4e7daeb 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -45,7 +45,7 @@ All communication with Everest resources begins with the API. The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. -### Why PMM appears to be absent in this context? +### Does Percona Everest deploy PMM servers? While `MonitorConfig` is present, does this resource interact directly with each `pmm-agent` container on the database pods, deploy new PMM Servers, and modify their configuration? From b9b610299b789e24d4ee6aac574e92e62e72e5e0 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:50:57 +0530 Subject: [PATCH 084/100] Update faq.md --- docs/reference/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 8d4e7daeb..97904422a 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -8,7 +8,7 @@ This section outlines the most frequently asked questions (FAQs) about Percona E Provide an example of **Database Engine Operations**. Does it manage database operators, such as upgrades, or is it related to Percona Everest resources? **Answer:** -The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Everest version. This information can be retrieved and updated. +The `DatabaseEngine` is a resource that contains compatible PG/PXC/MongoDB versions for the current Percona Everest version. This information can be retrieved and updated. Refer to our [API documentation](https://percona-everest.readme.io/reference/getkubernetesclusterresources) for in-depth information. From e07241fe438d0603ad3c699aecc9f411edbebeba Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 12:33:13 +0530 Subject: [PATCH 085/100] Update troubleshoot.md --- docs/reference/troubleshoot.md | 40 ++-------------------------------- 1 file changed, 2 insertions(+), 38 deletions(-) diff --git a/docs/reference/troubleshoot.md b/docs/reference/troubleshoot.md index 35695d8c8..27549c2aa 100644 --- a/docs/reference/troubleshoot.md +++ b/docs/reference/troubleshoot.md @@ -53,50 +53,14 @@ When you install Percona Everest, the following components are installed: The process of installing an operator with OLM (Operator Lifecycle Manager) begins with creating a [subscription](https://olm.operatorframework.io/docs/concepts/crds/subscription/). OLM will reconcile this subscription and generate an installation plan. Once the installation plan is approved, OLM will create a Cluster Service Version (CSV), which installs everything necessary for the operator to function properly. -In addition to OLM, Everest consists of five different operators: +In addition to OLM, Percona Everest consists of these operators: -- Everest -- VictoriaMetrics - Percona Operator for MySQL (PXC) - Percona Operator for MongoDB (PSMDB) - Percona Operator for PostgreSQL (PG) -=== "Everest" - The Everest Operator is always installed to the `everest-system` namespace. If the operator is installed properly, you should find a subscription, an install plan and a cluster service version for this operator: - ??? example "Examples" - ```sh - kubectl get sub -n everest-system - NAME PACKAGE SOURCE CHANNEL - everest-operator everest-operator everest-catalog stable-v0 - ``` - - ``` - kubectl get ip -n everest-system - NAME CSV APPROVAL APPROVED - install-69g62 everest-operator.v0.10.1 Manual true - ``` - - ``` - kubectl get csv -n everest-system - NAME DISPLAY VERSION REPLACES PHASE - everest-operator.v0.10.1 Everest operator 0.10.1 everest-operator.v0.9.0 Succeeded - ``` - - ``` - kubectl get deploy -n everest-system - NAME READY UP-TO-DATE AVAILABLE AGE - everest-operator-controller-manager 1/1 1 1 12m - percona-everest 1/1 1 1 11m - ``` - - !!! note - - In the last command, besides the Everest operator, you also see the `percona-everest` deployment in the `everest-system `namespace; this is the Percona Everest UI/API deployment. - - -=== "DB operators" - In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you installed all the operators in the `everest` namespace: +In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you installed all the operators in the `everest` namespace: ??? example "Examples" ``` From 195a71ac2e4440e7af11444f54c0ec8eede987e6 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 13:33:45 +0530 Subject: [PATCH 086/100] Update faq.md --- docs/reference/faq.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 97904422a..4f716bf5b 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -14,18 +14,18 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get ### Do we have logs of the API calls made? -- This will help us validate whether an API call was made for a user operation and whether any errors occurred during the process. +- Accessing these logs will enable us to confirm whether an API call was initiated for a specific user operation and to identify any errors that may have occurred during that process. - **Answer:** - Yes, the Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. +**Answer:** +Yes, the Percona Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. !!! Note - This is crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. + Percona Everest logs are crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - - If we have these logs, where are they stored? +- Where are these logs stored? - **Answer:** - You can retrieve logs from the pods associated with this deployment. +**Answer:** +You can retrieve the logs from the pods associated with this deployment. ### Do we have any logs for frontend actions, to troubleshoot issues between the front end and the Percona Everest API? From 908bdf57597263c2b6a5271e2a381d30e9a20175 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:31:52 +0530 Subject: [PATCH 087/100] Update faq.md --- docs/reference/faq.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 4f716bf5b..abe255fc6 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -28,16 +28,18 @@ Yes, the Percona Everest backend has logs. It runs as a `percona-everest` deploy You can retrieve the logs from the pods associated with this deployment. -### Do we have any logs for frontend actions, to troubleshoot issues between the front end and the Percona Everest API? +### Do we have any logs for front end actions to troubleshoot issues between the front end and the Percona Everest API? **Answer:** -The logs will be accessible in the console of the web browser. +You can view these logs in the console of your web browser. -### Is there a resource that manages the API calls and interacts with the individual resources? +### Are there any resources that are not a part of the Percona Everest operator image that we need to troubleshoot? -- Should we check the logs for troubleshooting when issues arise? Alternatively, does the Everest API communicate directly with the Everest operator resources? +- Is there a resource that receives API calls and interacts with individual resources that we should check for troubleshooting and logs when issues arise? -- If so, should we correlate the **Percona operator** issue with the corresponding Everest resource and address the problem from that point? +- Does the Percona Everest API communicate directly with the Percona Everest operator resources? + +- Should we correlate the **Percona operator** issue with the corresponding Percona Everest resource and address the problem from that point? **Answer:** All communication with Everest resources begins with the API. From ab50b679380b2ba130969ffce200465659699136 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:34:51 +0530 Subject: [PATCH 088/100] moved troubleshoot section to an upper level after the use section --- docs/{reference => troubleshoot}/faq.md | 0 docs/{reference => troubleshoot}/troubleshoot.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/{reference => troubleshoot}/faq.md (100%) rename docs/{reference => troubleshoot}/troubleshoot.md (100%) diff --git a/docs/reference/faq.md b/docs/troubleshoot/faq.md similarity index 100% rename from docs/reference/faq.md rename to docs/troubleshoot/faq.md diff --git a/docs/reference/troubleshoot.md b/docs/troubleshoot/troubleshoot.md similarity index 100% rename from docs/reference/troubleshoot.md rename to docs/troubleshoot/troubleshoot.md From 6ec5e0143066c04c68eea1ef502cbf4450bece6f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:35:19 +0530 Subject: [PATCH 089/100] Update mkdocs-base.yml --- mkdocs-base.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index fb56b6fc4..ea05533ba 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -194,12 +194,13 @@ nav: - Monitoring: use/monitor_endpoints.md - Multiple namepaces: use/multi-namespaces.md - API rate limiting: use/API_rate_limit.md + - Troubleshoot: + - Resolve issues: troubleshoot/troubleshoot.md + - FAQ: troubleshoot/faq.md + - API: API.md - Reference: - Limitations: reference/known_limitations.md - - Troubleshoot: - - Resolve issues: reference/troubleshoot.md - - FAQ: reference/faq.md - Telemetry on Percona Everest: reference/telemetry.md - Migrate to Percona Everest: reference/migration_guide.md - Copyright and licensing information: reference/copyright.md From 20dd6875803e08d9714861347373a58676d1e743 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:37:37 +0530 Subject: [PATCH 090/100] Update mkdocs-base.yml --- mkdocs-base.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index ea05533ba..f5c5bf3f0 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -195,7 +195,7 @@ nav: - Multiple namepaces: use/multi-namespaces.md - API rate limiting: use/API_rate_limit.md - Troubleshoot: - - Resolve issues: troubleshoot/troubleshoot.md + - Resolve issues: troubleshoot/troubleshoot.md - FAQ: troubleshoot/faq.md - API: API.md From 8293a7652aaff98ebc56868ac180a18a6edb9dc1 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:42:07 +0530 Subject: [PATCH 091/100] Update mkdocs-base.yml --- mkdocs-base.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index f5c5bf3f0..cf7472846 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -194,6 +194,7 @@ nav: - Monitoring: use/monitor_endpoints.md - Multiple namepaces: use/multi-namespaces.md - API rate limiting: use/API_rate_limit.md + - Troubleshoot: - Resolve issues: troubleshoot/troubleshoot.md - FAQ: troubleshoot/faq.md From 91a7117e1af64aca9d859cf365cdd90524be6293 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:47:54 +0530 Subject: [PATCH 092/100] Update faq.md --- docs/troubleshoot/faq.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/troubleshoot/faq.md b/docs/troubleshoot/faq.md index abe255fc6..8162c2caa 100644 --- a/docs/troubleshoot/faq.md +++ b/docs/troubleshoot/faq.md @@ -16,16 +16,16 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get - Accessing these logs will enable us to confirm whether an API call was initiated for a specific user operation and to identify any errors that may have occurred during that process. -**Answer:** -Yes, the Percona Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. + **Answer:** + Yes, the Percona Everest backend has logs. It runs as a `percona-everest` deployment within the `everest-system `namespace. !!! Note Percona Everest logs are crucial for troubleshooting issues where an operation is completed, but the corresponding Everest operator resource hasn't been created for some reason. - Where are these logs stored? -**Answer:** -You can retrieve the logs from the pods associated with this deployment. + **Answer:** + You can retrieve the logs from the pods associated with this deployment. ### Do we have any logs for front end actions to troubleshoot issues between the front end and the Percona Everest API? @@ -41,10 +41,10 @@ You can view these logs in the console of your web browser. - Should we correlate the **Percona operator** issue with the corresponding Percona Everest resource and address the problem from that point? -**Answer:** -All communication with Everest resources begins with the API. + **Answer:** + All communication with Everest resources begins with the API. -The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. + The API is responsible for updating Everest resources, while the Everest operator continues to create resources for the corresponding database operators. When debugging, start with the API, then proceed to the Everest operator, and finally examine the individual database operators. ### Does Percona Everest deploy PMM servers? From edbb01c2faf69533aa13ff407e8223860fc246a9 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:53:26 +0530 Subject: [PATCH 093/100] Update troubleshoot.md --- docs/troubleshoot/troubleshoot.md | 133 +++++++++--------------------- 1 file changed, 40 insertions(+), 93 deletions(-) diff --git a/docs/troubleshoot/troubleshoot.md b/docs/troubleshoot/troubleshoot.md index 27549c2aa..d98308768 100644 --- a/docs/troubleshoot/troubleshoot.md +++ b/docs/troubleshoot/troubleshoot.md @@ -62,101 +62,48 @@ In addition to OLM, Percona Everest consists of these operators: In this section, we group all the database (DB) operators together because they are managed in the same way. When you run the command `everestctl install`, you must choose which operators to install (PXC, PSMDB, PG) and specify the namespaces for each. The following example assumes that you installed all the operators in the `everest` namespace: - ??? example "Examples" - ``` - kubectl get sub -n everest - NAME PACKAGE SOURCE CHANNEL - percona-xtradb-cluster-operator percona-xtradb-cluster-operator everest-catalog stable-v1 - percona-server-mongodb-operator percona-server-mongodb-operator everest-catalog stable-v1 - percona-postgresql-operator percona-postgresql-operator everest-catalog stable-v2 - ``` - - ``` - kubectl get ip -n everest - NAME CSV APPROVAL - APPROVED - install-tjwjf percona-xtradb-cluster-operator.v1.14.0 Manual - true - install-8cl7m percona-server-mongodb-operator.v1.15.0 Manual - true - install-8lz2n percona-postgresql-operator.v2.3.1. Manual - true - ``` - - ``` - kubectl get csv -n everest - NAME DISPLAY - VERSION REPLACES PHASE - percona-xtradb-cluster-operator.v1.14.0 Percona Operator for MySQL based on Percona XtraDB Cluster - 1.14.0 percona-xtradb-cluster-operator.v1.13.0 Succeeded - percona-server-mongodb-operator.v1.15.0 Percona Distribution for MongoDB Operator - 1.15.0 percona-server-mongodb-operator.v1.14.0 Succeeded - percona-postgresql-operator.v2.3.1 Percona Operator for PostgreSQL - 2.3.1 Succeeded - everest-operator.v0.10.1 Everest operator - 0.10.1 everest-operator.v0.9.0 Succeeded - ``` - - ``` - kubectl get deploy -n everest - NAME READY UP-TO-DATE AVAILABLE AGE - percona-xtradb-cluster-operator 1/1 1 1 23m - percona-server-mongodb-operator 1/1 1 1 22m - percona-postgresql-operator 1/1 1 1 21m - ``` - -=== "VictoriaMetrics" - We use the VictoriaMetrics stack along with [kube-state-metrics](https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/) for monitoring. Both can be found in the `everest-monitoring` namespace. - - ??? example "Examples" - - The following example installs all the operators to the `everest` namespace: - ``` - kubectl get sub -n everest-monitoring - NAME PACKAGE SOURCE - CHANNEL - victoriametrics-operator victoriametrics-operator everest- - catalog stable-v0 - ``` - - ``` - kubectl get ip -n everest-monitoring - NAME CSV APPROVAL - APPROVED - install-nw6sf victoriametrics-operator.v0.29.1 Manual true - ``` - - ``` - kubectl get csv -n everest-monitoring - NAME DISPLAY - VERSION REPLACES PHASE - victoriametrics-operator.v0.29.1 VictoriaMetrics Operator 0.29.1 - victoriametrics-operator.v0.27.2 Succeeded - ``` - - ``` - kubectl get deploy -n everest-monitoring - NAME READY UP-TO-DATE AVAILABLE AGE - vm-operator-vm-operator 1/1 1 1 19m - kube-state-metrics 1/1 1 1 19m - ``` - The Everest Operator monitors these resources to reconcile the DatabaseEngine Custom Resource Definitions (CRs) for each installed database operator. These DatabaseEngine CRs provide the user interface (UI) with information about the available database engines and their supported versions. If you experience any issues with the list of available database engines or their versions, this is the area to investigate. - - ??? example "Example" - ``` - kubectl get dbengine -n everest - NAME TYPE STATUS OPERATOR VERSION - percona-xtradb-cluster-operator pxc installed 1.14.0 - percona-server-mongodb-operator psmdb installed 1.15.0 - percona-postgresql-operator postgresql installed 2.3.1 - ``` +??? example "Examples" + ``` + kubectl get sub -n everest + NAME PACKAGE SOURCE CHANNEL + percona-xtradb-cluster-operator percona-xtradb-cluster-operator everest-catalog stable-v1 + percona-server-mongodb-operator percona-server-mongodb-operator everest-catalog stable-v1 + percona-postgresql-operator percona-postgresql-operator everest-catalog stable-v2 + ``` - !!! note - The Everest Operator requires an internet connection to reach [check.percona.com](http://check.percona.com/) to get the supported versions for each engine. You can troubleshoot this step by looking at the everest operator logs: + ``` + kubectl get ip -n everest + NAME CSV APPROVAL + APPROVED + install-tjwjf percona-xtradb-cluster-operator.v1.14.0 Manual + true + install-8cl7m percona-server-mongodb-operator.v1.15.0 Manual + true + install-8lz2n percona-postgresql-operator.v2.3.1. Manual + true + ``` + + ``` + kubectl get csv -n everest + NAME DISPLAY + VERSION REPLACES PHASE + percona-xtradb-cluster-operator.v1.14.0 Percona Operator for MySQL based on Percona XtraDB Cluster + 1.14.0 percona-xtradb-cluster-operator.v1.13.0 Succeeded + percona-server-mongodb-operator.v1.15.0 Percona Distribution for MongoDB Operator + 1.15.0 percona-server-mongodb-operator.v1.14.0 Succeeded + percona-postgresql-operator.v2.3.1 Percona Operator for PostgreSQL + 2.3.1 Succeeded + everest-operator.v0.10.1 Everest operator + 0.10.1 everest-operator.v0.9.0 Succeeded + ``` - ``` - kubectl logs pods/everest-operator-controller-manager-5b868c4fcc-rt6rp -n everest-system - ``` + ``` + kubectl get deploy -n everest + NAME READY UP-TO-DATE AVAILABLE AGE + percona-xtradb-cluster-operator 1/1 1 1 23m + percona-server-mongodb-operator 1/1 1 1 22m + percona-postgresql-operator 1/1 1 1 21m + ``` ### Database deployment From edf531c09a4fa1c57bb86e650b794e1ffbe39587 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:54:06 +0530 Subject: [PATCH 094/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 4a14bf54a..658f29c74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,7 +41,7 @@ Explore how our security features are designed to ensure the security of your ho Dive into our troubleshooting section, which is designed to guide you through any issues you may encounter while using Percona Everest. -[Troubleshoot :material-arrow-right:](reference/troubleshoot.md){ .md-button .md-button--primary } +[Troubleshoot :material-arrow-right:](troubleshoot/troubleshoot.md){ .md-button .md-button--primary }
From 5ae12c1cf6c88de20adfff86b424f67552db4786 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:04:27 +0530 Subject: [PATCH 095/100] Update faq.md --- docs/troubleshoot/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot/faq.md b/docs/troubleshoot/faq.md index 8162c2caa..4c84e53b1 100644 --- a/docs/troubleshoot/faq.md +++ b/docs/troubleshoot/faq.md @@ -28,7 +28,7 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get You can retrieve the logs from the pods associated with this deployment. -### Do we have any logs for front end actions to troubleshoot issues between the front end and the Percona Everest API? +### Do we have any logs to troubleshoot issues between the front end and the Percona Everest API? **Answer:** You can view these logs in the console of your web browser. From ad668486b6d965bb9cf1fd2c6e9cb12709a13ae7 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:10:22 +0530 Subject: [PATCH 096/100] Update faq.md --- docs/troubleshoot/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot/faq.md b/docs/troubleshoot/faq.md index 4c84e53b1..cc1d2686f 100644 --- a/docs/troubleshoot/faq.md +++ b/docs/troubleshoot/faq.md @@ -33,7 +33,7 @@ Refer to our [API documentation](https://percona-everest.readme.io/reference/get **Answer:** You can view these logs in the console of your web browser. -### Are there any resources that are not a part of the Percona Everest operator image that we need to troubleshoot? +### Do we need to troubleshoot any resources that are not part of the Percona Everest operator image? - Is there a resource that receives API calls and interacts with individual resources that we should check for troubleshooting and logs when issues arise? From 7d6120f6c34190014e38276fd595cb61e5f45441 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:00:27 +0530 Subject: [PATCH 097/100] Update troubleshoot.md --- docs/troubleshoot/troubleshoot.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/troubleshoot/troubleshoot.md b/docs/troubleshoot/troubleshoot.md index d98308768..dbf8cb6c7 100644 --- a/docs/troubleshoot/troubleshoot.md +++ b/docs/troubleshoot/troubleshoot.md @@ -1,16 +1,12 @@ -# Troubleshooting strategies for Percona Everest +# Troubleshooting common issues in Percona Everest This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. -## Troubleshooting topics -We have organized the topics into distinct categories to assist you in exploring the information more easily. - - -### Percona Everest comprehensive installation overview +## Comprehensive installation overview We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. @@ -20,7 +16,7 @@ The main components are: * catalog-operator * packageserver -#### Percona Everest installation +### Percona Everest installation When you install Percona Everest, the following components are installed: {.power-number} @@ -48,7 +44,7 @@ When you install Percona Everest, the following components are installed: everest-catalog Everest Catalog grpc Percona 6m5s ``` -#### OLM subscription +### OLM subscription The process of installing an operator with OLM (Operator Lifecycle Manager) begins with creating a [subscription](https://olm.operatorframework.io/docs/concepts/crds/subscription/). OLM will reconcile this subscription and generate an installation plan. Once the installation plan is approved, OLM will create a Cluster Service Version (CSV), which installs everything necessary for the operator to function properly. @@ -105,7 +101,7 @@ In this section, we group all the database (DB) operators together because they percona-postgresql-operator 1/1 1 1 21m ``` -### Database deployment +## Database deployment In Everest, every database begins with a DatabaseCluster (DBC) Custom Resource (CR) that is deployed to the chosen namespace. Depending on the selected engine type, this DBC will be converted into a corresponding Custom Resource that can be understood by the database operator, whether it be `PXC`, `PSMDB`, or `PG`. @@ -144,9 +140,9 @@ This gives a step by step approach to troubleshoot if something goes wrong with The names of the pods in your deployment may vary. If nothing relevant appears, check the logs for details. -### Backups and restores +## Backups and restores -#### Backups +### Backups Every backup in percona Everest begins with the creation of a `DatabaseClusterBackup (DBB)` `Custom Resource (CR)` that is deployed to a selected namespace. Depending on the chosen engine type, this `DBB` will be converted into the corresponding Custom Resource that can be interpreted by the database operator, such as `pxc-backup`, `psmdb-backup`, or `pg-backup`. @@ -156,7 +152,7 @@ kubectl describe psmdb-backup kubectl describe pg-backup ``` -#### Restores +### Restores Every Restore operation in Everest begins with a `DatabaseClusterRestore (DBR)` Custom Resource (CR) that is deployed in the specified namespace. Based on the selected engine type, this `DBR` will be transformed into the corresponding Custom Resource that can be processed by the database operator, such as `pxc-restore`, `psmdb-restore`, or `pg-restore`. From ef27e89395c83dd6703197ff7c58a28612a582a4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:03:45 +0530 Subject: [PATCH 098/100] Update troubleshoot.md --- docs/troubleshoot/troubleshoot.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/troubleshoot/troubleshoot.md b/docs/troubleshoot/troubleshoot.md index dbf8cb6c7..dcd5aa237 100644 --- a/docs/troubleshoot/troubleshoot.md +++ b/docs/troubleshoot/troubleshoot.md @@ -4,8 +4,6 @@ This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section. - - ## Comprehensive installation overview We leverage the [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/) to manage the operators. OLM is deployed explicitly to the `everest-olm` namespace. From 0229040e918ed63f093d0152db4611db02d7518b Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:05:49 +0530 Subject: [PATCH 099/100] Update mkdocs-base.yml --- mkdocs-base.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index cf7472846..3cd448a97 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -195,8 +195,8 @@ nav: - Multiple namepaces: use/multi-namespaces.md - API rate limiting: use/API_rate_limit.md - - Troubleshoot: - - Resolve issues: troubleshoot/troubleshoot.md + - Resolve issues: + - Troubleshooting: troubleshoot/troubleshoot.md - FAQ: troubleshoot/faq.md - API: API.md From 2e289a4593daddd61ae1f460cc555b2326c357e6 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:06:18 +0530 Subject: [PATCH 100/100] Update troubleshoot.md --- docs/troubleshoot/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot/troubleshoot.md b/docs/troubleshoot/troubleshoot.md index dcd5aa237..45af9cf3d 100644 --- a/docs/troubleshoot/troubleshoot.md +++ b/docs/troubleshoot/troubleshoot.md @@ -1,4 +1,4 @@ -# Troubleshooting common issues in Percona Everest +# Troubleshooting common issues This section is your go-to resource for tackling common issues and finding solutions. For additional troubleshooting tips and known issues, see the Percona Everest [Release Notes](../release-notes/release_notes_index.md) and [known limitations](../reference/known_limitations.md) section.