Update sql server docs

Signed-off-by: Tamal Saha <[email protected]>
kubedb · Oct 16, 2024 · 06b7414 · 06b7414
1 parent d444fbf
commit 06b7414
Show file tree

Hide file tree

Showing 17 changed files with 2,632 additions and 109 deletions.
diff --git a/Makefile b/Makefile
@@ -10,6 +10,7 @@ docs: hugo-tools
 	rm -rf static/files/cluster-api-provider-aws
 	rm -rf static/files/cluster-api-provider-azure
 	rm -rf static/files/cluster-api-provider-gcp
+	rm -rf static/files/products/appscode/aws-marketplace
 
 .PHONY: docs-skip-assets
 docs-skip-assets: hugo-tools
@@ -24,6 +25,7 @@ assets: hugo-tools
 	rm -rf static/files/cluster-api-provider-aws
 	rm -rf static/files/cluster-api-provider-azure
 	rm -rf static/files/cluster-api-provider-gcp
+	rm -rf static/files/products/appscode/aws-marketplace
 
 .PHONY: gen
 gen:

diff --git a/content/docs/v2024.9.30/examples/mssqlserver/ag-cluster/mssqlserver-ag-cluster.yaml b/content/docs/v2024.9.30/examples/mssqlserver/ag-cluster/mssqlserver-ag-cluster.yaml
@@ -0,0 +1,35 @@
+apiVersion: kubedb.com/v1alpha2
+kind: MSSQLServer
+metadata:
+  name: mssqlserver-ag-cluster
+  namespace: demo
+spec:
+  version: "2022-cu12"
+  replicas: 3
+  topology:
+    mode: AvailabilityGroup
+    availabilityGroup:
+      databases:
+        - agdb1
+        - agdb2
+  internalAuth:
+    endpointCert:
+      issuerRef:
+        apiGroup: cert-manager.io
+        name: mssqlserver-ca-issuer
+        kind: Issuer
+  tls:
+    issuerRef:
+      name: mssqlserver-ca-issuer
+      kind: Issuer
+      apiGroup: "cert-manager.io"
+    clientTLS: false
+  storageType: Durable
+  storage:
+    storageClassName: "standard"
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 1Gi
+  deletionPolicy: WipeOut
diff --git a/content/docs/v2024.9.30/examples/mssqlserver/ag-cluster/mssqlserver-ca-issuer.yaml b/content/docs/v2024.9.30/examples/mssqlserver/ag-cluster/mssqlserver-ca-issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: mssqlserver-ca-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: mssqlserver-ca
diff --git a/content/docs/v2024.9.30/examples/mssqlserver/quickstart/mssqlserver-ca-issuer.yaml b/content/docs/v2024.9.30/examples/mssqlserver/quickstart/mssqlserver-ca-issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: mssqlserver-ca-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: mssqlserver-ca
diff --git a/content/docs/v2024.9.30/examples/mssqlserver/quickstart/mssqlserver-quickstart.yaml b/content/docs/v2024.9.30/examples/mssqlserver/quickstart/mssqlserver-quickstart.yaml
@@ -9,7 +9,7 @@ spec:
   storageType: Durable
   tls:
     issuerRef:
-      name: mssqlserver-issuer
+      name: mssqlserver-ca-issuer
       kind: Issuer
       apiGroup: "cert-manager.io"
     clientTLS: false

diff --git a/content/docs/v2024.9.30/examples/mssqlserver/standalone/mssqlserver-ca-issuer.yaml b/content/docs/v2024.9.30/examples/mssqlserver/standalone/mssqlserver-ca-issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: mssqlserver-ca-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: mssqlserver-ca
diff --git a/content/docs/v2024.9.30/examples/mssqlserver/standalone/mssqlserver-standalone.yaml b/content/docs/v2024.9.30/examples/mssqlserver/standalone/mssqlserver-standalone.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1alpha2
+kind: MSSQLServer
+metadata:
+  name: mssqlserver-standalone
+  namespace: demo
+spec:
+  version: "2022-cu12"
+  replicas: 1
+  storageType: Durable
+  tls:
+    issuerRef:
+      name: mssqlserver-ca-issuer
+      kind: Issuer
+      apiGroup: "cert-manager.io"
+    clientTLS: false
+  storage:
+    storageClassName: "standard"
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 1Gi
+  deletionPolicy: WipeOut
diff --git a/content/docs/v2024.9.30/guides/mssqlserver/README.md b/content/docs/v2024.9.30/guides/mssqlserver/README.md
@@ -28,25 +28,41 @@ info:
 
 # Overview
 
-Microsoft SQL Server, one of the most popular relational database management systems (RDBMS) in the world. KubeDB support for Provisioning SQL Server Availability Group and Standalone SQL Server instance. Utilize SQL Server’s high availability features by deploying instances in availability group mode. KubeDB leverages the Raft Consensus Algorithm for cluster coordination, enabling automatic leader election and failover decisions. Quorum support ensures the reliability and fault tolerance of your SQL Server deployments. You can also deploy SQL Server instances in standalone mode for simple, single-node configurations. KubeDB users can now seamlessly provision and manage SQL Server instances directly within their Kubernetes clusters.
+Microsoft SQL Server is one of the most popular relational database management systems (RDBMS) in the world. KubeDB support provisioning for SQL Server Availability Group and Standalone SQL Server instances. Utilize SQL Server’s high availability features by deploying instances in availability group mode. KubeDB leverages the Raft Consensus Algorithm for cluster coordination, enabling automatic leader election and fail over decisions. Quorum support ensures the reliability and fault tolerance of your SQL Server deployments. You can also deploy SQL Server instances in standalone mode for simple, single-node configurations. KubeDB users can now seamlessly provision and manage SQL Server instances directly within their Kubernetes clusters.
 
 ## Supported Microsoft SQL Server Features
 
-| Features                                                                   | Availability |
-|----------------------------------------------------------------------------|:------------:|
-| Standalone and Availability Group                                          |   &#10003;   |
-| Authentication & Authorization                                             |   &#10003;   |
-| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) |   &#10003;   |
-| Initializing from Snapshot ( [KubeStash](https://kubestash.com/))          |   &#10003;   |
-| Externally manageable Auth Secret                                          |   &#10003;   |
-| Reconfigurable Health Checker                                              |   &#10003;   |
-| Persistent volume                                                          |   &#10003;   | 
+| Features                                                            | Availability |
+|---------------------------------------------------------------------|:------------:|
+| Standalone and Availability Group Cluster (HA configuration)        |   &#10003;   |
+| Synchronous Replication                                             |   &#10003;   |
+| Automatic Failover                                                  |   &#10003;   |
+| Custom Configuration                                                |   &#10003;   |
+| Authentication & Authorization                                      |   &#10003;   |
+| Externally manageable Auth Secret                                   |   &#10003;   |
+| Instant and Scheduled Backup  ([KubeStash](https://kubestash.com/)) |   &#10003;   |
+| Continuous Archiving using `wal-g`                                  |   &#10003;   |
+| Initialization from WAL archive                                     |   &#10003;   |
+| Initializing from Snapshot ([KubeStash](https://kubestash.com/))    |   &#10003;   |
+| Reconfigurable Health Checker                                       |   &#10003;   |
+| Persistent volume                                                   |   &#10003;   | 
+| Builtin Prometheus Discovery                                        |   &#10003;   |
+| Using Prometheus operator                                           |   &#10003;   |
+| Automated Version Update                                            |   &#10003;   |
+| Automated Vertical Scaling, Volume Expansion                        |   &#10003;   |
+| Automated Horizontal Scaling                                        |   &#10003;   |
+| Autoscaler for Compute and Storage Resources                        |   &#10003;   |
+| Reconfiguration                                                     |   &#10003;   |
+| TLS                                                                 |   &#10003;   |
+| Grafana Dashboards                                                  |   &#10003;   |
+| Autoscaling (vertically)                                            |   &#10003;   |
 
 
 ## Supported Microsoft SQL Server Versions
 
 KubeDB supports the following Microsoft SQL Server Version.
 - `2022-CU12-ubuntu-22.04`
+- `2022-CU14-ubuntu-22.04`
 
 ## Life Cycle of a Microsoft SQL Server Object
 
@@ -60,5 +76,8 @@ ref : https://cacoo.com/diagrams/4PxSEzhFdNJRIbIb/0281B
 
 ## User Guide
 
-- [Quickstart MSSQLServer](/docs/v2024.9.30/guides/mssqlserver/quickstart/quickstart) with KubeDB Operator.
+- [Quickstart Microsoft SQL Server](/docs/v2024.9.30/guides/mssqlserver/quickstart/quickstart) with KubeDB Operator.
+- Detail concepts of [MSSQLServer object](/docs/v2024.9.30/guides/mssqlserver/concepts/mssqlserver).
+- [SQL Server Availability Group Clustering](/docs/v2024.9.30/guides/mssqlserver/clustering/ag_cluster) supported by KubeDB.
+- How to [Backup & Restore](/docs/v2024.9.30/guides/mssqlserver/backup/overview/) SQL Server using [KubeStash](https://kubestash.com/).
 - Want to hack on KubeDB? Check our [contribution guidelines](/docs/v2024.9.30/CONTRIBUTING).
diff --git a/content/docs/v2024.9.30/guides/mssqlserver/clustering/_index.md b/content/docs/v2024.9.30/guides/mssqlserver/clustering/_index.md
@@ -0,0 +1,22 @@
+---
+title: MSSQLServer Clustering
+menu:
+  docs_v2024.9.30:
+    identifier: ms-clustering
+    name: Clustering
+    parent: guides-mssqlserver
+    weight: 25
+menu_name: docs_v2024.9.30
+info:
+  autoscaler: v0.33.0
+  cli: v0.48.0
+  dashboard: v0.24.0
+  installer: v2024.9.30
+  ops-manager: v0.35.0
+  provisioner: v0.48.0
+  schema-manager: v0.24.0
+  ui-server: v0.24.0
+  version: v2024.9.30
+  webhook-server: v0.24.0
+---
+