Skip to content

Commit

Permalink
update md
Browse files Browse the repository at this point in the history
Signed-off-by: SK Ali Arman <[email protected]>
  • Loading branch information
sheikh-arman committed Dec 20, 2024
1 parent 898dd04 commit cdbe600
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 17 deletions.
51 changes: 39 additions & 12 deletions docs/guides/mariadb/concepts/mariadb-version/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,33 +31,60 @@ apiVersion: catalog.kubedb.com/v1alpha1
kind: MariaDBVersion
metadata:
annotations:
meta.helm.sh/release-name: kubedb-catalog
meta.helm.sh/release-namespace: kube-system
creationTimestamp: "2021-03-09T13:00:51Z"
meta.helm.sh/release-name: kubedb
meta.helm.sh/release-namespace: kubedb
creationTimestamp: "2024-12-19T05:12:32Z"
generation: 1
labels:
app.kubernetes.io/instance: kubedb-catalog
app.kubernetes.io/instance: kubedb
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/name: kubedb-catalog
app.kubernetes.io/version: v0.16.2
helm.sh/chart: kubedb-catalog-v0.16.2
...
app.kubernetes.io/version: v2024.11.18
helm.sh/chart: kubedb-catalog-v2024.11.18
name: 10.5.23
resourceVersion: "1585"
uid: d6b463f0-032a-4832-8b87-4648da0b38a6
spec:
archiver:
addon:
name: mariadb-addon
tasks:
fullBackup:
name: logical-backup
fullBackupRestore:
name: logical-backup-restore
manifestBackup:
name: manifest-backup
manifestRestore:
name: manifest-restore
volumeSnapshot:
name: volume-snapshot
walg:
image: ghcr.io/kubedb/mariadb-archiver:v0.9.0_10.5.23-focal
coordinator:
image: ghcr.io/kubedb/mariadb-coordinator:v0.29.0
db:
image: kubedb/mariadb:10.5.23
image: ghcr.io/appscode-images/mariadb:10.5.23-focal
exporter:
image: kubedb/mysqld-exporter:v0.11.0
image: prom/mysqld-exporter:v0.13.0
initContainer:
image: kubedb/busybox
image: ghcr.io/kubedb/mariadb-init:0.5.2
podSecurityPolicies:
databasePolicyName: maria-db
securityContext:
runAsUser: 999
stash:
addon:
backupTask:
name: mariadb-backup-10.5.23
name: mariadb-backup-10.5.8
restoreTask:
name: mariadb-restore-10.5.23
name: mariadb-restore-10.5.8
ui:
- name: phpmyadmin
version: v2024.4.27
updateConstraints:
allowlist:
- '> 10.5.23, <= 11.5.2'
version: 10.5.23
```
Expand Down
19 changes: 14 additions & 5 deletions docs/guides/mariadb/quickstart/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,19 @@ When you have installed KubeDB, it has created `MariaDBVersion` crd for all supp

```bash
$ kubectl get mariadbversions
NAME VERSION DB_IMAGE DEPRECATED AGE
10.4.32 10.4.32 mariadb:10.4.32 9s
10.5.23 10.5.23 mariadb:10.5.23 9s
10.6.16 10.6.16 mariadb:10.6.16 9s
10.10.7 10.10.7 ghcr.io/appscode-images/mariadb:10.10.7-jammy 27h
10.11.6 10.11.6 ghcr.io/appscode-images/mariadb:10.11.6-jammy 27h
10.4.32 10.4.32 ghcr.io/appscode-images/mariadb:10.4.32-focal 27h
10.5.23 10.5.23 ghcr.io/appscode-images/mariadb:10.5.23-focal 27h
10.6.16 10.6.16 ghcr.io/appscode-images/mariadb:10.6.16-focal 27h
11.0.4 11.0.4 ghcr.io/appscode-images/mariadb:11.0.4-jammy 27h
11.1.3 11.1.3 ghcr.io/appscode-images/mariadb:11.1.3-jammy 27h
11.2.2 11.2.2 ghcr.io/appscode-images/mariadb:11.2.2-jammy 27h
11.3.2 11.3.2 ghcr.io/appscode-images/mariadb:11.3.2-jammy 27h
11.4.3 11.4.3 ghcr.io/appscode-images/mariadb:11.4.3-noble 27h
11.5.2 11.5.2 ghcr.io/appscode-images/mariadb:11.5.2-noble 27h
11.6.2 11.6.2 ghcr.io/appscode-images/mariadb:11.6.2-noble 23m

```

## Create a MariaDB database
Expand Down Expand Up @@ -113,7 +122,7 @@ Here,

- `spec.version` is the name of the MariaDBVersion CRD where the docker images are specified. In this tutorial, a MariaDB `10.5.23` database is going to create.
- `spec.storageType` specifies the type of storage that will be used for MariaDB database. It can be `Durable` or `Ephemeral`. Default value of this field is `Durable`. If `Ephemeral` is used then KubeDB will create MariaDB database using `EmptyDir` volume. In this case, you don't have to specify `spec.storage` field. This is useful for testing purposes.
- `spec.storage` specifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.
- `spec.storage` specifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the PetSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.
- `spec.terminationPolicy` or `spec.deletionPolicy` gives flexibility whether to `nullify`(reject) the delete operation of `MariaDB` crd or which resources KubeDB should keep or delete when you delete `MariaDB` crd. If admission webhook is enabled, It prevents users from deleting the database as long as the `spec.terminationPolicy` is set to `DoNotTerminate`.

> Note: spec.storage section is used to create PVC for database pod. It will create PVC with storage size specified instorage.resources.requests field. Don't specify limits here. PVC does not get resized automatically.
Expand Down

0 comments on commit cdbe600

Please sign in to comment.