Add mysql external database docs

Signed-off-by: Anisur Rahman <[email protected]>

.github/workflows/preview-website.yml

@@ -52,10 +52,11 @@ jobs:
           GITHUB_USER: 1gtm
           GITHUB_TOKEN: ${{ secrets.LGTM_GITHUB_TOKEN }}
           WEBSITE_REPOSITORY: ${{ secrets.WEBSITE_REPOSITORY }}
+          BRANCH_NAME: remove-local-shortcodes
         run: |
           url="https://${GITHUB_USER}:${GITHUB_TOKEN}@${WEBSITE_REPOSITORY}.git"
           cd $RUNNER_WORKSPACE
-          git clone --recurse-submodules $url
+          git clone --branch $BRANCH_NAME --recurse-submodules $url
           cd $(basename $WEBSITE_REPOSITORY)
           git config user.name "${GITHUB_USER}"
           git config user.email "${GITHUB_USER}@appscode.com"

docs/addons/_index.md

@@ -0,0 +1,10 @@
+---
+title: Addons | KubeStash
+menu:
+  docs_{{ .version }}:
+    identifier: kubestash-addons
+    name: Addons
+    weight: 60
+    pre: dropdown
+menu_name: docs_{{ .version }}
+---

docs/addons/mysql/README.md

@@ -0,0 +1,41 @@
+---
+title: MySQL Addon Overview | KubeStash
+description: MySQL Addon Overview | KubeStash
+menu:
+  docs_{{ .version }}:
+    identifier: kubestash-mysql-readme
+    name: Readme
+    parent: kubestash-mysql
+    weight: -1
+product_name: kubestash
+menu_name: docs_{{ .version }}
+section_menu_id: kubestash-addons
+url: /docs/{{ .version }}/addons/mysql/
+aliases:
+  - /docs/{{ .version }}/addons/mysql/README/
+---
+
+# KubeStash MySQL Addon
+
+KubeStash v2024.9.30+ supports extending its functionality through addons. KubeStash MySQL addon enables KubeStash to backup and restore MySQL databases.
+
+This guide will give you an overview of which MySQL versions are supported and how the docs are organized.
+
+## Supported MySQL Versions
+
+KubeStash has the following addon versions for MySQL:
+
+{{< versionlist "mysql">}}
+
+Here, the addon follows `M.M.P` versioning scheme where `M.M.P` (Major.Minor.Patch) represents the respective database version.
+
+## Addon Version Compatibility
+
+Any addon with matching major version with the database version should be able to take backup of that database. For example, MySQL addon with version `8.x.x` should be able take backup of any MySQL of `8.x.x` series. However, this might not be true for some versions. In that case, we will have separate addon for that version.
+
+## Documentation Overview
+
+KubeStash MySQL documentations are organized as below:
+
+- [How does it work?](/docs/addons/mysql/overview/index.md) gives an overview of how backup and restore process for MySQL database works in Stash.
+- [Standalone MySQL Database](/docs/addons/mysql/logical/index.md) shows how to backup and restore an externally managed MySQL database.

docs/addons/mysql/_index.md

@@ -0,0 +1,10 @@
+---
+title: KubeStash MySQL Addon
+menu:
+  docs_{{ .version }}:
+    identifier: kubestash-mysql
+    name: MySQL
+    parent: kubestash-addons
+    weight: 50
+menu_name: docs_{{ .version }}
+---

docs/addons/mysql/logical/examples/appbinding.yaml

@@ -0,0 +1,12 @@
+apiVersion: appcatalog.appscode.com/v1alpha1
+kind: AppBinding
+metadata:
+  name: mysql-appbinding
+  namespace: demo
+spec:
+  clientConfig:
+    url: mysql://kubestash-test-do-user-165729-0.m.db.ondigitalocean.com:25060/defaultdb?ssl-mode=REQUIRED
+  secret:
+    name: mysql-auth-secret
+  type: mysql
+  version: "8.0.21"

docs/addons/mysql/logical/examples/auth-secret.yaml

@@ -0,0 +1,9 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: mysql-auth-secret
+  namespace: demo
+type: Opaque
+stringData:
+  username: doadmin # replace with your auth username
+  password: "" # <replace with your authentication password>

docs/addons/mysql/logical/examples/backupconfiguration.yaml

@@ -0,0 +1,38 @@
+apiVersion: core.kubestash.com/v1alpha1
+kind: BackupConfiguration
+metadata:
+  name: sample-mysql-backup
+  namespace: demo
+spec:
+  target:
+    apiGroup: appcatalog.appscode.com
+    kind: AppBinding
+    name: mysql-appbinding
+    namespace: demo
+  backends:
+    - name: gcs-backend
+      storageRef:
+        namespace: demo
+        name: gcs-storage
+      retentionPolicy:
+        name: demo-retention
+        namespace: demo
+  sessions:
+    - name: frequent-backup
+      scheduler:
+        schedule: "*/5 * * * *"
+        jobTemplate:
+          backoffLimit: 1
+      repositories:
+        - name: gcs-mysql-repo
+          backend: gcs-backend
+          directory: /mysql
+          encryptionSecret:
+            name: encrypt-secret
+            namespace: demo
+      addon:
+        name: mysql-addon
+        tasks:
+          - name: logical-backup
+            params:
+              databases: playground

docs/addons/mysql/logical/examples/backupstorage.yaml

@@ -0,0 +1,17 @@
+apiVersion: storage.kubestash.com/v1alpha1
+kind: BackupStorage
+metadata:
+  name: gcs-storage
+  namespace: demo
+spec:
+  storage:
+    provider: gcs
+    gcs:
+      bucket: kubestash-qa
+      prefix: demo
+      secretName: gcs-secret
+  usagePolicy:
+    allowedNamespaces:
+      from: All
+  default: true
+  deletionPolicy: Delete

docs/addons/mysql/logical/examples/restoresession.yaml

@@ -0,0 +1,21 @@
+apiVersion: core.kubestash.com/v1alpha1
+kind: RestoreSession
+metadata:
+  name: restore-sample-mysql
+  namespace: demo
+spec:
+  target:
+    apiGroup: appcatalog.appscode.com
+    kind: AppBinding
+    name: mysql-appbinding
+    namespace: demo
+  dataSource:
+    repository: gcs-mysql-repo
+    snapshot: latest
+    encryptionSecret:
+      name: encrypt-secret
+      namespace: demo
+  addon:
+    name: mysql-addon
+    tasks:
+      - name: logical-backup-restore

docs/addons/mysql/logical/examples/retentionpolicy.yaml

@@ -0,0 +1,15 @@
+apiVersion: storage.kubestash.com/v1alpha1
+kind: RetentionPolicy
+metadata:
+  name: demo-retention
+  namespace: demo
+spec:
+  default: true
+  failedSnapshots:
+    last: 2
+  maxRetentionPeriod: 2mo
+  successfulSnapshots:
+    last: 5
+  usagePolicy:
+    allowedNamespaces:
+      from: All