From 3a045d28a6ed60120ac5607d24a9c7a6bd0f6ab9 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:13:34 +0530 Subject: [PATCH 01/20] Enhance DBaaS documentation --- docs/dbaas/setting-up.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 40d8c70e70..a6d918dd7e 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -8,15 +8,16 @@ For a Kubernetes cluster that doesn't expire you can use our "easy script", you In the sections that follow we'll try to outline the steps to create your own Kubernetes cluster in a few popular ways. -#### Red Hat, CentOS -```sh -yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo -yum -y install docker-ce -usermod -a -G docker centos -systemctl enable docker -systemctl start docker -``` +=== "Red Hat, CentOS" + + ```sh + yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo + yum -y install docker-ce + usermod -a -G docker centos + systemctl enable docker + systemctl start docker + ``` #### Debian, Ubuntu From 70245e4956b8f4544110b9326c4bca40ff22ca7c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:15:21 +0530 Subject: [PATCH 02/20] Update setting-up.md --- docs/dbaas/setting-up.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index a6d918dd7e..749a4d14d8 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -19,27 +19,27 @@ In the sections that follow we'll try to outline the steps to create your own Ku systemctl start docker ``` -#### Debian, Ubuntu +=== "Debian, Ubuntu" -```sh -apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo -systemctl enable docker -systemctl start docker -``` + ```sh + apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo + systemctl enable docker + systemctl start docker + ``` -### minikube +=== "minikube" -Please follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. + Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. -#### Red Hat, CentOS +=== "Red Hat, CentOS" -```sh -yum -y install curl -curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 -chmod +x /usr/local/sbin/minikube -ln -s /usr/local/sbin/minikube /usr/sbin/minikube -alias kubectl='minikube kubectl --' -``` + ```sh + yum -y install curl + curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 + chmod +x /usr/local/sbin/minikube + ln -s /usr/local/sbin/minikube /usr/sbin/minikube + alias kubectl='minikube kubectl --' + ``` ## Start PMM server and activate a DBaaS feature From 029edc96d8bf693e2a13586597b110d362e6534f Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:21:34 +0530 Subject: [PATCH 03/20] Update setting-up.md --- docs/dbaas/setting-up.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 749a4d14d8..8f1d6ed86e 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -41,7 +41,7 @@ In the sections that follow we'll try to outline the steps to create your own Ku alias kubectl='minikube kubectl --' ``` -## Start PMM server and activate a DBaaS feature +## Start PMM server and activate DBaaS feature !!! note alert alert-primary "" - To start a fully-working 3 node XtraDB cluster, consisting of sets of 3x HAProxy, 3x PXC and 6x PMM Client containers, you will need at least 9 vCPU available for minikube. (1x vCPU for HAProxy and PXC and 0.5vCPU for each pmm-client containers). From 99d0b172403c35bd7b273561c8b80d63d384a513 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:22:45 +0530 Subject: [PATCH 04/20] Update setting-up.md --- docs/dbaas/setting-up.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 8f1d6ed86e..b8de7c6b9d 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -8,7 +8,6 @@ For a Kubernetes cluster that doesn't expire you can use our "easy script", you In the sections that follow we'll try to outline the steps to create your own Kubernetes cluster in a few popular ways. - === "Red Hat, CentOS" ```sh From 0defdb5621726a5cc46947014421cde730996e87 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:26:59 +0530 Subject: [PATCH 05/20] Update setting-up.md --- docs/dbaas/setting-up.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index b8de7c6b9d..aa61e3862f 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -9,7 +9,6 @@ In the sections that follow we'll try to outline the steps to create your own Ku === "Red Hat, CentOS" - ```sh yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo yum -y install docker-ce @@ -19,7 +18,6 @@ In the sections that follow we'll try to outline the steps to create your own Ku ``` === "Debian, Ubuntu" - ```sh apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo systemctl enable docker @@ -31,7 +29,6 @@ In the sections that follow we'll try to outline the steps to create your own Ku Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. === "Red Hat, CentOS" - ```sh yum -y install curl curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 From 9bd06b96ba6dfc6cebe337349088e9fbc661564d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:35:10 +0530 Subject: [PATCH 06/20] Update setting-up.md --- docs/dbaas/setting-up.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index aa61e3862f..463b23fe2d 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -9,6 +9,8 @@ In the sections that follow we'll try to outline the steps to create your own Ku === "Red Hat, CentOS" + + ```sh yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo yum -y install docker-ce @@ -18,6 +20,8 @@ In the sections that follow we'll try to outline the steps to create your own Ku ``` === "Debian, Ubuntu" + + ```sh apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo systemctl enable docker From 6aa4b5aa974e17b5ed9be8c4ddbdb59cb6b4e5fa Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:42:24 +0530 Subject: [PATCH 07/20] Update setting-up.md --- docs/dbaas/setting-up.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 463b23fe2d..f16c406a42 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -9,19 +9,17 @@ In the sections that follow we'll try to outline the steps to create your own Ku === "Red Hat, CentOS" - - + ```sh yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo yum -y install docker-ce usermod -a -G docker centos systemctl enable docker systemctl start docker - ``` + ``` === "Debian, Ubuntu" - - + ```sh apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo systemctl enable docker @@ -32,14 +30,19 @@ In the sections that follow we'll try to outline the steps to create your own Ku Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. -=== "Red Hat, CentOS" +=== "minikube" + + Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. + + **Red Hat, CentOS** + ```sh - yum -y install curl - curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 - chmod +x /usr/local/sbin/minikube - ln -s /usr/local/sbin/minikube /usr/sbin/minikube - alias kubectl='minikube kubectl --' - ``` + yum -y install curl + curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 + chmod +x /usr/local/sbin/minikube + ln -s /usr/local/sbin/minikube /usr/sbin/minikube + alias kubectl='minikube kubectl --' + ``` ## Start PMM server and activate DBaaS feature From 9d2abc6a2a7c65a3b5cab5f668bbfe85f26b8280 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:43:09 +0530 Subject: [PATCH 08/20] Update setting-up.md --- docs/dbaas/setting-up.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index f16c406a42..4845e60cb3 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -42,7 +42,8 @@ In the sections that follow we'll try to outline the steps to create your own Ku chmod +x /usr/local/sbin/minikube ln -s /usr/local/sbin/minikube /usr/sbin/minikube alias kubectl='minikube kubectl --' - ``` + ``` + ## Start PMM server and activate DBaaS feature From 2edf9eb79ac59b4092ea225d3e6c98cd364ef55b Mon Sep 17 00:00:00 2001 From: Alina Derkach Date: Wed, 29 Mar 2023 14:27:26 +0300 Subject: [PATCH 09/20] Update setting-up.md --- docs/dbaas/setting-up.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 4845e60cb3..33b912f0c2 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -10,40 +10,38 @@ In the sections that follow we'll try to outline the steps to create your own Ku === "Red Hat, CentOS" - ```sh - yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo - yum -y install docker-ce - usermod -a -G docker centos - systemctl enable docker - systemctl start docker - - ``` + ```sh + yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo + yum -y install docker-ce + usermod -a -G docker centos + systemctl enable docker + systemctl start docker + ``` === "Debian, Ubuntu" - ```sh - apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo - systemctl enable docker - systemctl start docker - ``` + ```sh + apt-add-repository https://download.docker.com/linux/centos/docker-ce.repo + systemctl enable docker + systemctl start docker + ``` === "minikube" - Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. + Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. === "minikube" - Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. + Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. - **Red Hat, CentOS** + **Red Hat, CentOS** - ```sh + ```sh yum -y install curl curl -Lo /usr/local/sbin/minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 chmod +x /usr/local/sbin/minikube ln -s /usr/local/sbin/minikube /usr/sbin/minikube alias kubectl='minikube kubectl --' - ``` - + ``` ## Start PMM server and activate DBaaS feature From fbcb8c2356761c92b24e0c22e0da73e106a28a00 Mon Sep 17 00:00:00 2001 From: Alina Derkach Date: Wed, 29 Mar 2023 14:34:01 +0300 Subject: [PATCH 10/20] Update mkdocs-base.yml --- mkdocs-base.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 21bdad5c5c..859e5eae9c 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -64,7 +64,8 @@ markdown_extensions: pymdownx.details: {} pymdownx.mark: {} pymdownx.smartsymbols: {} - pymdownx.tabbed: {} + pymdownx.tabbed: + {alternate_style: true} pymdownx.tilde: {} pymdownx.superfences: {} pymdownx.highlight: From 5e8b21ba85c77d127a13412c6ef7fb087b24c4b5 Mon Sep 17 00:00:00 2001 From: Alina Derkach Date: Wed, 29 Mar 2023 14:40:39 +0300 Subject: [PATCH 11/20] Update setting-up.md --- docs/dbaas/setting-up.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 33b912f0c2..0ba96c29ee 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -25,10 +25,6 @@ In the sections that follow we'll try to outline the steps to create your own Ku systemctl start docker ``` -=== "minikube" - - Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. - === "minikube" Follow minikube's [documentation to install](https://minikube.sigs.k8s.io/docs/start/) it. From a7140e27e96eb0bc9999f99ffba05dd4702d7b53 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 18:44:01 +0530 Subject: [PATCH 12/20] Update setting-up.md --- docs/dbaas/setting-up.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 4845e60cb3..a9fbbca387 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -1,11 +1,23 @@ # Setting up DBaaS -To use the Database as a Service (DBaaS) solution in PMM there are a few things that need to be setup first including a suitable Kubernetes Cluster. If you've already got a kubernetes cluster you can jump ahead and [enable DBaaS in PMM](../dbaas/get-started.html). +## Prerequisites -If you don't have a Kubernetes cluster available you can use the [free K8s provided by Percona](https://www.percona.com/blog/private-dbaas-with-free-kubernetes-cluster/) for evaluation which will allow you to play around with DBaaS for 3 hours before the cluster expires. -For a Kubernetes cluster that doesn't expire you can use our "easy script", you can find the instructions [here](https://www.percona.com/blog/dbaas-kubernetes-in-under-20-min/). +To use Database-as-a-Service (DBaaS) in PMM following are the prerequisites: -In the sections that follow we'll try to outline the steps to create your own Kubernetes cluster in a few popular ways. +- Set up a suitable Kubernetes Cluster. + + !!! note alert alert-primary "" + If you already have got a kubernetes cluster you can just [enable DBaaS in PMM](../dbaas/get-started.html). + +- If you don't already have a Kubernetes cluster, Percona offers [free K8s](https://www.percona.com/blog/private-dbaas-with-free-kubernetes-cluster/) as an evaluation product, allowing you to test DBaaS for 3 hours before it expires. + +- If you are interested in a PMM DBaaS but want to avoid dealing with Kubernetes, Percona DbaaS Infrastructure Creator might be your solution. It creates the infrastructure in an AWS account. + + It will help you to choose the right types of instances based on the number of vCPU and the amount of memory and create clusters. It can even deploy the clusters and Kubernetes operators for MySQL, PXC, and MongoDB. + +## Create your own Kubernetes Cluster + +In the following sections you can see the steps to create your own Kubernetes cluster in a few popular ways. === "Red Hat, CentOS" From b253289ab746b4337f13bcdb98182032f6a2403c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Wed, 29 Mar 2023 19:02:09 +0530 Subject: [PATCH 13/20] Update setting-up.md --- docs/dbaas/setting-up.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index d492132ef3..6c6582f3f2 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -15,9 +15,9 @@ To use Database-as-a-Service (DBaaS) in PMM following are the prerequisites: It will help you to choose the right types of instances based on the number of vCPU and the amount of memory and create clusters. It can even deploy the clusters and Kubernetes operators for MySQL, PXC, and MongoDB. -## Create your own Kubernetes Cluster +## Install Docker -In the following sections you can see the steps to create your own Kubernetes cluster in a few popular ways. +Following are the ways to install Docker on the various platforms: === "Red Hat, CentOS" From 8c080e5245c115e8662fa85de435c7c6123ee8c7 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 12:23:06 +0530 Subject: [PATCH 14/20] Update setting-up.md --- docs/dbaas/setting-up.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 6c6582f3f2..b1754125f7 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -51,14 +51,19 @@ Following are the ways to install Docker on the various platforms: alias kubectl='minikube kubectl --' ``` -## Start PMM server and activate DBaaS feature +## Start PMM server and activate DBaaS -!!! note alert alert-primary "" - - To start a fully-working 3 node XtraDB cluster, consisting of sets of 3x HAProxy, 3x PXC and 6x PMM Client containers, you will need at least 9 vCPU available for minikube. (1x vCPU for HAProxy and PXC and 0.5vCPU for each pmm-client containers). +These are some key points worth noting: + +!!! note alert alert-primary "Important" + - Minikube requires 9 vCPUs for a fully-functional 3-node XtraDB cluster composed of 3x HAProxy, 3x PXC, and 6x PMM Client containers (1 vCPU each for HAProxy and PXC, and 0.5 vCPU for PMM-client containers). - DBaaS does not depend on PMM Client. - - You can pass the environment variable `--env ENABLE_DBAAS=1` to force the DBaaS feature when starting up pmm-server container. **You can omit the variable and enable the feature later using PMM UI**, please follow the link in step 3. below. - - Add the option `--network minikube` if you run PMM Server and minikube in the same Docker instance. (This will share a single network and the kubeconfig will work.) - - Add the options `--env PMM_DEBUG=1` and/or `--env PMM_TRACE=1` if you need extended debug details + - You can pass the environment variable `--env ENABLE_DBAAS=1` to force the DBaaS feature when starting the pmm-server container. If you omit the variable, you can enable the feature later using PMM UI. Follow the link in step 3. + - Add the parameter `--network minikube` if you are running PMM Server and minikube in the same Docker instance, which will share a network. + - Add the parameters `-env PMM_DEBUG=1`, `-env PMM_TRACE=`1 if you require extended debugging information. + + +The following are the steps to start PMM and activate DBaaS: 1. Start PMM server: From 4d351d620990493602c414b8e13f431729ad732d Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 12:42:11 +0530 Subject: [PATCH 15/20] Update setting-up.md --- docs/dbaas/setting-up.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index b1754125f7..2c9c1e1af5 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -53,7 +53,7 @@ Following are the ways to install Docker on the various platforms: ## Start PMM server and activate DBaaS -These are some key points worth noting: +These are some of the key points worth noting: !!! note alert alert-primary "Important" - Minikube requires 9 vCPUs for a fully-functional 3-node XtraDB cluster composed of 3x HAProxy, 3x PXC, and 6x PMM Client containers (1 vCPU each for HAProxy and PXC, and 0.5 vCPU for PMM-client containers). @@ -71,21 +71,19 @@ The following are the steps to start PMM and activate DBaaS: docker run --detach --publish 80:80 --publish 443:443 --name pmm-server percona/pmm-server:2 ``` -2. Change the default administrator credentials from CLI: +2. Change the default administrator credentials from CLI (optional): - (This step is optional, because the same can be done from the web interface of PMM on first login.) + You can be change the default credentails from the PMM UI on first login. ```sh docker exec -t pmm-server bash -c 'ln -s /srv/grafana /usr/share/grafana/data; chown -R grafana:grafana /usr/share/grafana/data; grafana-cli --homepath /usr/share/grafana admin reset-admin-password ' ``` -!!! caution alert alert-warning "Important" - You must [activate DBaaS](../dbaas/get-started.md#activate-dbaas) using the PMM UI if you omitted `--env ENABLE_DBAAS=1` when starting up the container. +3. [Activate DBaaS](../dbaas/get-started.md#activate-dbaas) using the PMM UI if you omitted the parameter `--env ENABLE_DBAAS=1` when starting up the container. ## Create a Kubernetes cluster -!!! note alert alert-primary "" - The DBaaS feature uses Kubernetes clusters to deploy database clusters. You must first create a Kubernetes cluster and then add it to PMM using `kubeconfig` to get a successful setup. +The DBaaS feature uses Kubernetes clusters to deploy database clusters. To set up PMM successfully, you must first create a Kubernetes cluster and then add it using `kubeconfig`. ### Minikube From ae8ce194777b718703d01817091be1c433a234d1 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 14:46:41 +0530 Subject: [PATCH 16/20] Update setting-up.md --- docs/dbaas/setting-up.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 2c9c1e1af5..b242a8b1f8 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -83,7 +83,7 @@ The following are the steps to start PMM and activate DBaaS: ## Create a Kubernetes cluster -The DBaaS feature uses Kubernetes clusters to deploy database clusters. To set up PMM successfully, you must first create a Kubernetes cluster and then add it using `kubeconfig`. +The DBaaS feature uses Kubernetes clusters to deploy database clusters. To set up PMM successfully, you must first create a Kubernetes cluster and then add it using `Kubeconfig`. ### Minikube @@ -93,14 +93,12 @@ The DBaaS feature uses Kubernetes clusters to deploy database clusters. To set u minikube start --cpus=16 --memory=32G ``` -2. Get your kubeconfig details from `minikube`. (You need these to register your Kubernetes cluster with PMM Server): +2. Obtain a `Kubeconfig` for your minikube cluster and register it in PMM to make it functional. ```sh minikube kubectl -- config view --flatten --minify ``` - - !!! note alert alert-primary "" - You will need to copy this output to your clipboard and continue with [adding a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). +Take this output and copy it to your clipboard. Then, proceed to [add a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). ### Amazon AWS EKS From 60555a0595773076e6f07a7d0ecf8a31d3bb9da4 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 14:57:42 +0530 Subject: [PATCH 17/20] Update setting-up.md --- docs/dbaas/setting-up.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index b242a8b1f8..35d2c22427 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -85,29 +85,35 @@ The following are the steps to start PMM and activate DBaaS: The DBaaS feature uses Kubernetes clusters to deploy database clusters. To set up PMM successfully, you must first create a Kubernetes cluster and then add it using `Kubeconfig`. -### Minikube +You can create a Kubernetes cluster as follows: -1. Configure and start minikube: +=== "**Minikube**" - ```sh - minikube start --cpus=16 --memory=32G - ``` + 1. Configure and start minikube: -2. Obtain a `Kubeconfig` for your minikube cluster and register it in PMM to make it functional. + ```sh + minikube start --cpus=16 --memory=32G + ``` - ```sh - minikube kubectl -- config view --flatten --minify - ``` -Take this output and copy it to your clipboard. Then, proceed to [add a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). + 2. Obtain a `Kubeconfig` for your minikube cluster and register it in PMM to make it functional. -### Amazon AWS EKS + ```sh + minikube kubectl -- config view --flatten --minify + ``` + Take this output and copy it to your clipboard. Then, proceed to [add a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). -1. Create your cluster via [`eksctl`](https://github.com/weaveworks/eksctl#installation) or the Amazon AWS interface. For example: - ```sh - eksctl create cluster --write-kubeconfig --name=your-cluster-name --zones=us-west-2a,us-west-2b --kubeconfig - ``` -2. Copy the resulting kubeconfig and follow these instructions to [register a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). + +=== "**Amazon AWS EKS**" + + 1. Create your cluster via [`eksctl`](https://github.com/weaveworks/eksctl#installation) or the Amazon AWS interface. + + **Example** + + ```sh + eksctl create cluster --write-kubeconfig --name=your-cluster-name --zones=us-west-2a,us-west-2b --kubeconfig + ``` + 2. Copy the resulting kubeconfig and follow these instructions to [register a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). ### Google GKE From a15739b816f1ac8ac4ca13cf53da0ad68df65c1c Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 15:02:28 +0530 Subject: [PATCH 18/20] Update setting-up.md --- docs/dbaas/setting-up.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 35d2c22427..799ccaa0e2 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -91,9 +91,9 @@ You can create a Kubernetes cluster as follows: 1. Configure and start minikube: - ```sh - minikube start --cpus=16 --memory=32G - ``` + ```sh + minikube start --cpus=16 --memory=32G + ``` 2. Obtain a `Kubeconfig` for your minikube cluster and register it in PMM to make it functional. From 57c59a64231c41a145433d0c68320494f4fe6f39 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Thu, 30 Mar 2023 15:02:50 +0530 Subject: [PATCH 19/20] Update setting-up.md --- docs/dbaas/setting-up.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index 799ccaa0e2..be98db45f9 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -108,11 +108,11 @@ You can create a Kubernetes cluster as follows: 1. Create your cluster via [`eksctl`](https://github.com/weaveworks/eksctl#installation) or the Amazon AWS interface. - **Example** + **Example** - ```sh - eksctl create cluster --write-kubeconfig --name=your-cluster-name --zones=us-west-2a,us-west-2b --kubeconfig - ``` + ```sh + eksctl create cluster --write-kubeconfig --name=your-cluster-name --zones=us-west-2a,us-west-2b --kubeconfig + ``` 2. Copy the resulting kubeconfig and follow these instructions to [register a Kubernetes cluster to PMM](../dbaas/get-started.md#add-a-kubernetes-cluster). ### Google GKE From 07fbd77f8818133cdae583f03e55f819c301fd75 Mon Sep 17 00:00:00 2001 From: rasika-chivate <95711051+rasika-chivate@users.noreply.github.com> Date: Tue, 4 Apr 2023 16:42:05 +0530 Subject: [PATCH 20/20] Update setting-up.md --- docs/dbaas/setting-up.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/dbaas/setting-up.md b/docs/dbaas/setting-up.md index be98db45f9..6ce94a6e8d 100644 --- a/docs/dbaas/setting-up.md +++ b/docs/dbaas/setting-up.md @@ -117,6 +117,9 @@ You can create a Kubernetes cluster as follows: ### Google GKE +You can also create Kubernetes cluster with google GKE as follows: + + 1. Create your cluster either with [Google Cloud Console](https://console.cloud.google.com/) or [`gcloud` command line tool](https://cloud.google.com/sdk/gcloud): The command below assumes that your `gcloud` command line tool is properly configured and your user authenticated and authorized to manage GKE Clusters. This example creates a minimal zonal cluster using preemptive node machines, ideal for testing the DBaaS functionality. @@ -185,7 +188,7 @@ You can create a Kubernetes cluster as follows: EOF ``` -3. Extract variables required to generate a kubeconfig: +3. Extract variables required to generate a Kubeconfig: ```sh name=`kubectl get serviceAccounts percona-dbaas-cluster-operator -o json | jq -r '.secrets[].name'` @@ -217,13 +220,11 @@ You can create a Kubernetes cluster as follows: current-context: svcs-acct-context " ``` - 5. Follow the instructions on [How to add a Kubernetes cluster](../dbaas/get-started.md#add-a-kubernetes-cluster) with kubeconfig from the previous step. ## Deleting clusters -!!! note alert alert-primary "" - If a Public Address is set in PMM Settings, for each DB cluster an API Key is created which can be found on the page `/graph/org/apikeys`. You should not delete them (for now, until [issue PMM-8045](https://jira.percona.com/browse/PMM-8045) is fixed) -- once a DB cluster is removed from DBaaS, the related API Key is also removed. +If a Public Address is set in PMM Settings, for each DB cluster an API Key is created which can be found on the page `/graph/org/apikeys`. You should not delete them (for now, until [issue PMM-8045](https://jira.percona.com/browse/PMM-8045) is fixed) -- once a DB cluster is removed from DBaaS, the related API Key is also removed. For example, if you only run `eksctl delete cluster` to delete an Amazon EKS cluster without cleaning up the cluster first, there will be a lot of orphaned resources such as Cloud Formations, Load Balancers, EC2 instances, Network interfaces, etc. The same applies for Google GKE clusters.