FerretDB Complete Doc (#696)

* wip Signed-off-by: sayedppqq <[email protected]> * add some pages and wip Signed-off-by: sayedppqq <[email protected]> * wip * wip Signed-off-by: sayedppqq <[email protected]> * fix link Signed-off-by: sayedppqq <[email protected]> * fix concepts Signed-off-by: sayedppqq <[email protected]> --------- Signed-off-by: sayedppqq <[email protected]> Co-authored-by: Md. Anisur Rahman <[email protected]>
kubedb · Dec 17, 2024 · 42e8787 · 42e8787
1 parent 7786905
commit 42e8787
Show file tree

Hide file tree

Showing 66 changed files with 5,345 additions and 12 deletions.
diff --git a/docs/examples/ferretdb/autoscaling/compute/autoscaler.yaml b/docs/examples/ferretdb/autoscaling/compute/autoscaler.yaml
@@ -0,0 +1,21 @@
+apiVersion: autoscaling.kubedb.com/v1alpha1
+kind: FerretDBAutoscaler
+metadata:
+  name: ferretdb-autoscale-ops
+  namespace: demo
+spec:
+  databaseRef:
+    name: ferretdb-autoscale
+  compute:
+    ferretdb:
+      trigger: "On"
+      podLifeTimeThreshold: 5m
+      resourceDiffPercentage: 20
+      minAllowed:
+        cpu: 400m
+        memory: 400Mi
+      maxAllowed:
+        cpu: 1
+        memory: 1Gi
+      controlledResources: ["cpu", "memory"]
+      containerControlledValues: "RequestsAndLimits"
diff --git a/docs/examples/ferretdb/autoscaling/compute/ferretdb-autoscale.yaml b/docs/examples/ferretdb/autoscaling/compute/ferretdb-autoscale.yaml
@@ -0,0 +1,28 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: ferretdb-autoscale
+  namespace: demo
+spec:
+  version: "1.23.0"
+  replicas: 1
+  backend:
+    externallyManaged: false
+  podTemplate:
+    spec:
+      containers:
+        - name: ferretdb
+          resources:
+            requests:
+              cpu: "200m"
+              memory: "300Mi"
+            limits:
+              cpu: "200m"
+              memory: "300Mi"
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  deletionPolicy: WipeOut
diff --git a/docs/examples/ferretdb/monitoring/builtin-prom-fr.yaml b/docs/examples/ferretdb/monitoring/builtin-prom-fr.yaml
@@ -0,0 +1,19 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: builtin-prom-fr
+  namespace: demo
+spec:
+  version: "1.23.0"
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  backend:
+    externallyManaged: false
+  deletionPolicy: WipeOut
+  replicas: 2
+  monitor:
+    agent: prometheus.io/builtin
diff --git a/docs/examples/ferretdb/monitoring/coreos-prom-fr.yaml b/docs/examples/ferretdb/monitoring/coreos-prom-fr.yaml
@@ -0,0 +1,24 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: coreos-prom-fr
+  namespace: demo
+spec:
+  version: "1.18.0"
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  backend:
+    externallyManaged: false
+  deletionPolicy: WipeOut
+  replicas: 2
+  monitor:
+    agent: prometheus.io/operator
+    prometheus:
+      serviceMonitor:
+        labels:
+          release: prometheus
+        interval: 10s
diff --git a/docs/examples/ferretdb/reconfigure-tls/ferretdb.yaml b/docs/examples/ferretdb/reconfigure-tls/ferretdb.yaml
@@ -0,0 +1,16 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: ferretdb
+  namespace: demo
+spec:
+  version: "1.18.0"
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  backend:
+    externallyManaged: false
+  replicas: 2
diff --git a/docs/examples/ferretdb/reconfigure-tls/frops-add-tls.yaml b/docs/examples/ferretdb/reconfigure-tls/frops-add-tls.yaml
@@ -0,0 +1,16 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: frops-add-tls
+  namespace: demo
+spec:
+  type: ReconfigureTLS
+  databaseRef:
+    name: ferretdb
+  tls:
+    issuerRef:
+      name: ferretdb-ca-issuer
+      kind: Issuer
+      apiGroup: "cert-manager.io"
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/ferretdb/reconfigure-tls/frops-change-issuer.yaml b/docs/examples/ferretdb/reconfigure-tls/frops-change-issuer.yaml
@@ -0,0 +1,14 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: frops-change-issuer
+  namespace: demo
+spec:
+  type: ReconfigureTLS
+  databaseRef:
+    name: ferretdb
+  tls:
+    issuerRef:
+      name: fr-new-issuer
+      kind: Issuer
+      apiGroup: "cert-manager.io"
diff --git a/docs/examples/ferretdb/reconfigure-tls/frops-remove.yaml b/docs/examples/ferretdb/reconfigure-tls/frops-remove.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: frops-remove
+  namespace: demo
+spec:
+  type: ReconfigureTLS
+  databaseRef:
+    name: ferretdb
+  tls:
+    remove: true
diff --git a/docs/examples/ferretdb/reconfigure-tls/frops-rotate.yaml b/docs/examples/ferretdb/reconfigure-tls/frops-rotate.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: frops-rotate
+  namespace: demo
+spec:
+  type: ReconfigureTLS
+  databaseRef:
+    name: ferretdb
+  tls:
+    rotateCertificates: true
diff --git a/docs/examples/ferretdb/reconfigure-tls/issuer.yaml b/docs/examples/ferretdb/reconfigure-tls/issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: ferretdb-ca-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: ferretdb-ca
diff --git a/docs/examples/ferretdb/reconfigure-tls/new-issuer.yaml b/docs/examples/ferretdb/reconfigure-tls/new-issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: fr-new-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: ferretdb-new-ca
diff --git a/docs/examples/ferretdb/restart/ferretdb.yaml b/docs/examples/ferretdb/restart/ferretdb.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: ferretdb
+  namespace: demo
+spec:
+  version: "1.23.0"
+  replicas: 1
+  backend:
+    externallyManaged: false
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  deletionPolicy: WipeOut
diff --git a/docs/examples/ferretdb/restart/ops.yaml b/docs/examples/ferretdb/restart/ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: restart-ferretdb
+  namespace: demo
+spec:
+  type: Restart
+  databaseRef:
+    name: ferretdb
+  timeout: 3m
+  apply: Always
diff --git a/docs/examples/ferretdb/scaling/fr-horizontal.yaml b/docs/examples/ferretdb/scaling/fr-horizontal.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: fr-horizontal
+  namespace: demo
+spec:
+  version: "1.23.0"
+  replicas: 1
+  backend:
+    externallyManaged: false
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  deletionPolicy: WipeOut
diff --git a/docs/examples/ferretdb/scaling/fr-vertical-ops.yaml b/docs/examples/ferretdb/scaling/fr-vertical-ops.yaml
@@ -0,0 +1,20 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: ferretdb-scale-vertical
+  namespace: demo
+spec:
+  type: VerticalScaling
+  databaseRef:
+    name: fr-vertical
+  verticalScaling:
+    node:
+      resources:
+        requests:
+          memory: "2Gi"
+          cpu: "1"
+        limits:
+          memory: "2Gi"
+          cpu: "1"
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/ferretdb/scaling/fr-vertical.yaml b/docs/examples/ferretdb/scaling/fr-vertical.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: fr-vertical
+  namespace: demo
+spec:
+  version: "1.23.0"
+  replicas: 1
+  backend:
+    externallyManaged: false
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  deletionPolicy: WipeOut
diff --git a/docs/examples/ferretdb/scaling/frops-hscale-down-ops.yaml b/docs/examples/ferretdb/scaling/frops-hscale-down-ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: ferretdb-horizontal-scale-down
+  namespace: demo
+spec:
+  type: HorizontalScaling
+  databaseRef:
+    name: fr-horizontal
+  horizontalScaling:
+    node: 2
diff --git a/docs/examples/ferretdb/scaling/frops-hscale-up-ops.yaml b/docs/examples/ferretdb/scaling/frops-hscale-up-ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: ferretdb-horizontal-scale-up
+  namespace: demo
+spec:
+  type: HorizontalScaling
+  databaseRef:
+    name: fr-horizontal
+  horizontalScaling:
+    node: 3
diff --git a/docs/examples/ferretdb/tls/ferretdb-tls.yaml b/docs/examples/ferretdb/tls/ferretdb-tls.yaml
@@ -0,0 +1,25 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: fr-tls
+  namespace: demo
+spec:
+  version: "1.23.0"
+  authSecret:
+    externallyManaged: false
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  backend:
+    externallyManaged: false
+  deletionPolicy: WipeOut
+  replicas: 1
+  sslMode: requireSSL
+  tls:
+    issuerRef:
+      apiGroup: "cert-manager.io"
+      kind: Issuer
+      name: ferretdb-ca-issuer
diff --git a/docs/examples/ferretdb/tls/issuer.yaml b/docs/examples/ferretdb/tls/issuer.yaml
@@ -0,0 +1,8 @@
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: ferretdb-ca-issuer
+  namespace: demo
+spec:
+  ca:
+    secretName: ferretdb-ca
diff --git a/docs/examples/ferretdb/update-version/fr-update.yaml b/docs/examples/ferretdb/update-version/fr-update.yaml
@@ -0,0 +1,17 @@
+apiVersion: kubedb.com/v1alpha2
+kind: FerretDB
+metadata:
+  name: fr-update
+  namespace: demo
+spec:
+  version: "1.18.0"
+  replicas: 1
+  backend:
+    externallyManaged: false
+  storage:
+    accessModes:
+      - ReadWriteOnce
+    resources:
+      requests:
+        storage: 500Mi
+  deletionPolicy: WipeOut
diff --git a/docs/examples/ferretdb/update-version/frops-update.yaml b/docs/examples/ferretdb/update-version/frops-update.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: FerretDBOpsRequest
+metadata:
+  name: ferretdb-version-update
+  namespace: demo
+spec:
+  type: UpdateVersion
+  databaseRef:
+    name: fr-update
+  updateVersion:
+    targetVersion: 1.23.0
diff --git a/docs/guides/ferretdb/autoscaler/_index.md b/docs/guides/ferretdb/autoscaler/_index.md
@@ -0,0 +1,10 @@
+---
+title: Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: fr-auto-scaling
+    name: Autoscaling
+    parent: fr-ferretdb-guides
+    weight: 46
+menu_name: docs_{{ .version }}
+---