Merge pull request #513 from kubedb/proxysql-docs-final

Signed-off-by: TasdidurRahman [email protected]
kubedb · Dec 12, 2022 · f941dde · f941dde
2 parents f359fa2 + d409d5b
commit f941dde
Show file tree

Hide file tree

Showing 108 changed files with 6,933 additions and 2,748 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -33,7 +33,7 @@ jobs:
 
       - name: Check links
         run: |
-          liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*)$'
+          liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*appscode.com.*|.*docs.search-guard.com.*)$'
 
       - name: Create Kubernetes cluster
         id: kind

diff --git a/docs/guides/elasticsearch/concepts/appbinding/index.md b/docs/guides/elasticsearch/concepts/appbinding/index.md
@@ -26,7 +26,7 @@ KubeDB uses [Stash](https://appscode.com/products/stash/) to perform backup/reco
 
 Like any official Kubernetes resource, an `AppBinding` has `TypeMeta`, `ObjectMeta` and `Spec` sections. However, unlike other Kubernetes resources, it does not have a `Status` section.
 
-An `AppBinding` object created by `KubeDB` for PostgreSQL database is shown below,
+An `AppBinding` object created by `KubeDB` for Elasticsearch database is shown below,
 
 ```yaml
 apiVersion: appcatalog.appscode.com/v1alpha1

diff --git a/docs/guides/proxysql/README.md b/docs/guides/proxysql/README.md
@@ -2,9 +2,9 @@
 title: ProxySQL
 menu:
   docs_{{ .version }}:
-    identifier: prx-readme-proxysql
+    identifier: guides-proxysql-readme
     name: ProxySQL
-    parent: prx-proxysql-guides
+    parent: guides
     weight: 10
 menu_name: docs_{{ .version }}
 section_menu_id: guides
@@ -22,9 +22,10 @@ aliases:
 | Features                             | Availability |
 | ------------------------------------ | :----------: |
 | Load balance MySQL Group Replication |   &#10003;   |
-| Load balance PerconaXtraDB Cluster   |   &#10007;   |
+| Load balance PerconaXtraDB Cluster   |   &#10003;   |
 | Custom Configuration                 |   &#10003;   |
-| Using Custom docker image            |   &#10003;   |
+| Declarative Configuration            |   &#10003;   |
+| Version Update                       |   &#10003;   |
 | Builtin Prometheus Discovery         |   &#10003;   |
 | Using Prometheus operator            |   &#10003;   |
 | ProxySQL server cluster              |   &#10003;   |
@@ -34,13 +35,15 @@ aliases:
 
 ## User Guide
 
-- Overview of ProxySQL [here](/docs/guides/proxysql/overview/overview.md).
-- Configure ProxySQL for Group Replication [here](/docs/guides/proxysql/overview/configure-proxysql.md).
-- Learn to use ProxySQL to Load Balance MySQL Group Replication with KubeDB Operator [here](/docs/guides/proxysql/quickstart/load-balance-mysql-group-replication.md).
-- Monitor your ProxySQL with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/proxysql/monitoring/using-builtin-prometheus.md).
-- Monitor your ProxySQL with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/proxysql/monitoring/using-prometheus-operator.md).
-- Use private Docker registry to deploy ProxySQL with KubeDB [here](/docs/guides/proxysql/private-registry/using-private-registry.md).
-- Use custom config file to configure ProxySQL [here](/docs/guides/proxysql/configuration/using-config-file.md).
-- Detail concepts of ProxySQL CRD [here](/docs/guides/proxysql/concepts/proxysql.md).
-- Detail concepts of ProxySQLVersion CRD [here](/docs/guides/proxysql/concepts/catalog.md).
+- [Overview of KubeDB ProxySQL CRD](/docs/guides/proxysql/concepts/proxysql/index.md) 
+- [Configure KubeDB ProxySQL for MySQL Group Replication](/docs/guides/proxysql/quickstart/mysqlgrp/index.md)
+- [Deploy ProxySQL cluster with KubeDB](/docs/guides/proxysql/clustering/proxysql-cluster/index.md) 
+- [Initialize KubeDB ProxySQL with declarative configuration](/docs/guides/proxysql/concepts/declarative-configuration/index.md) 
+- [Reconfigure KubeDB ProxySQL with ops-request](/docs/guides/proxysql/concepts/opsrequest/index.md)
+- [Deploy TLS/SSL secured KubeDB ProxySQL](/docs/guides/proxysql/tls/configure/index.md)
+- [Reconfigure TLS/SSL for KubeDB ProxySQL](/docs/guides/proxysql/reconfigure-tls/cluster/index.md)
+- [Detail concepts of ProxySQLVersion CRD](/docs/guides/proxysql/concepts/proxysql-version/index.md)
+- [Upgrade KubeDB ProxySQL version with ops-request](/docs/guides/proxysql/upgrading/cluster/index.md)
+- [Scale horizontally and vertically KubeDB ProxySQL with ops-request](/docs/guides/proxysql/scaling/horizontal-scaling/cluster/index.md)
+- [Learn auto-scaling for KubeDB ProxySQL](/docs/guides/proxysql/autoscaler/compute/cluster/index.md)
 - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
diff --git a/docs/guides/proxysql/_index.md b/docs/guides/proxysql/_index.md
@@ -2,7 +2,7 @@
 title: ProxySQL
 menu:
   docs_{{ .version }}:
-    identifier: prx-proxysql-guides
+    identifier: guides-proxysql
     name: ProxySQL
     parent: guides
     weight: 10

diff --git a/docs/guides/proxysql/autoscaler/_index.md b/docs/guides/proxysql/autoscaler/_index.md
@@ -0,0 +1,10 @@
+---
+title: Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: guides-proxysql-autoscaling
+    name: Autoscaling
+    parent: guides-proxysql
+    weight: 46
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/guides/proxysql/autoscaler/compute/_index.md b/docs/guides/proxysql/autoscaler/compute/_index.md
@@ -0,0 +1,10 @@
+---
+title: Compute Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: guides-proxysql-autoscaling-compute
+    name: Compute Autoscaling
+    parent: guides-proxysql-autoscaling
+    weight: 46
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/guides/proxysql/autoscaler/compute/cluster/examples/proxy-as-compute.yaml b/docs/guides/proxysql/autoscaler/compute/cluster/examples/proxy-as-compute.yaml
@@ -0,0 +1,24 @@
+apiVersion: autoscaling.kubedb.com/v1alpha1
+kind: ProxySQLAutoscaler
+metadata:
+  name: proxy-as-compute
+  namespace: demo
+spec:
+  proxyRef:
+    name: proxy-server
+  opsRequestOptions:
+    timeout: 3m
+    apply: IfReady
+  compute:
+    proxysql:
+      trigger: "On"
+      podLifeTimeThreshold: 5m
+      resourceDiffPercentage: 20
+      minAllowed:
+        cpu: 250m
+        memory: 400Mi
+      maxAllowed:
+        cpu: 1
+        memory: 1Gi
+      containerControlledValues: "RequestsAndLimits"
+      controlledResources: ["cpu", "memory"]
diff --git a/docs/guides/proxysql/autoscaler/compute/cluster/examples/sample-mysql.yaml b/docs/guides/proxysql/autoscaler/compute/cluster/examples/sample-mysql.yaml
@@ -0,0 +1,19 @@
+apiVersion: kubedb.com/v1alpha2
+kind: MySQL
+metadata:
+  name: mysql-server
+  namespace: demo
+spec:
+  version: "5.7.36"
+  replicas: 3
+  topology:
+    mode: GroupReplication
+  storageType: Durable
+  storage:
+    storageClassName: "standard"
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 1Gi
+  terminationPolicy: WipeOut
diff --git a/docs/guides/proxysql/autoscaler/compute/cluster/examples/sample-proxysql.yaml b/docs/guides/proxysql/autoscaler/compute/cluster/examples/sample-proxysql.yaml
@@ -0,0 +1,22 @@
+apiVersion: kubedb.com/v1alpha2
+kind: ProxySQL
+metadata:
+  name: proxy-server
+  namespace: demo
+spec:
+  version: "2.3.2-debian"
+  replicas: 3
+  mode: GroupReplication
+  backend:
+    name: mysql-server
+  syncUsers: true
+  terminationPolicy: WipeOut
+  podTemplate:
+    spec:
+      resources:
+        limits:
+          cpu: 200m
+          memory: 300Mi
+        requests:
+          cpu: 200m
+          memory: 300Mi