Skip to content

Commit 42e8787

Browse files
sayedppqqanisurrahman75
sayedppqq
and
anisurrahman75
authored
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]>
1 parent 7786905 commit 42e8787

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+5345
-12
lines changed

‎docs/examples/ferretdb/autoscaling/compute/autoscaler.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
apiVersion: autoscaling.kubedb.com/v1alpha1
2+
kind: FerretDBAutoscaler
3+
metadata:
4+
name: ferretdb-autoscale-ops
5+
namespace: demo
6+
spec:
7+
databaseRef:
8+
name: ferretdb-autoscale
9+
compute:
10+
ferretdb:
11+
trigger: "On"
12+
podLifeTimeThreshold: 5m
13+
resourceDiffPercentage: 20
14+
minAllowed:
15+
cpu: 400m
16+
memory: 400Mi
17+
maxAllowed:
18+
cpu: 1
19+
memory: 1Gi
20+
controlledResources: ["cpu", "memory"]
21+
containerControlledValues: "RequestsAndLimits"

‎docs/examples/ferretdb/autoscaling/compute/ferretdb-autoscale.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: ferretdb-autoscale
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
replicas: 1
9+
backend:
10+
externallyManaged: false
11+
podTemplate:
12+
spec:
13+
containers:
14+
- name: ferretdb
15+
resources:
16+
requests:
17+
cpu: "200m"
18+
memory: "300Mi"
19+
limits:
20+
cpu: "200m"
21+
memory: "300Mi"
22+
storage:
23+
accessModes:
24+
- ReadWriteOnce
25+
resources:
26+
requests:
27+
storage: 500Mi
28+
deletionPolicy: WipeOut

‎docs/examples/ferretdb/monitoring/builtin-prom-fr.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: builtin-prom-fr
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
storage:
9+
accessModes:
10+
- ReadWriteOnce
11+
resources:
12+
requests:
13+
storage: 500Mi
14+
backend:
15+
externallyManaged: false
16+
deletionPolicy: WipeOut
17+
replicas: 2
18+
monitor:
19+
agent: prometheus.io/builtin

‎docs/examples/ferretdb/monitoring/coreos-prom-fr.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: coreos-prom-fr
5+
namespace: demo
6+
spec:
7+
version: "1.18.0"
8+
storage:
9+
accessModes:
10+
- ReadWriteOnce
11+
resources:
12+
requests:
13+
storage: 500Mi
14+
backend:
15+
externallyManaged: false
16+
deletionPolicy: WipeOut
17+
replicas: 2
18+
monitor:
19+
agent: prometheus.io/operator
20+
prometheus:
21+
serviceMonitor:
22+
labels:
23+
release: prometheus
24+
interval: 10s

‎docs/examples/ferretdb/reconfigure-tls/ferretdb.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: ferretdb
5+
namespace: demo
6+
spec:
7+
version: "1.18.0"
8+
storage:
9+
accessModes:
10+
- ReadWriteOnce
11+
resources:
12+
requests:
13+
storage: 500Mi
14+
backend:
15+
externallyManaged: false
16+
replicas: 2

‎docs/examples/ferretdb/reconfigure-tls/frops-add-tls.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: frops-add-tls
5+
namespace: demo
6+
spec:
7+
type: ReconfigureTLS
8+
databaseRef:
9+
name: ferretdb
10+
tls:
11+
issuerRef:
12+
name: ferretdb-ca-issuer
13+
kind: Issuer
14+
apiGroup: "cert-manager.io"
15+
timeout: 5m
16+
apply: IfReady

‎docs/examples/ferretdb/reconfigure-tls/frops-change-issuer.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: frops-change-issuer
5+
namespace: demo
6+
spec:
7+
type: ReconfigureTLS
8+
databaseRef:
9+
name: ferretdb
10+
tls:
11+
issuerRef:
12+
name: fr-new-issuer
13+
kind: Issuer
14+
apiGroup: "cert-manager.io"

‎docs/examples/ferretdb/reconfigure-tls/frops-remove.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: frops-remove
5+
namespace: demo
6+
spec:
7+
type: ReconfigureTLS
8+
databaseRef:
9+
name: ferretdb
10+
tls:
11+
remove: true

‎docs/examples/ferretdb/reconfigure-tls/frops-rotate.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: frops-rotate
5+
namespace: demo
6+
spec:
7+
type: ReconfigureTLS
8+
databaseRef:
9+
name: ferretdb
10+
tls:
11+
rotateCertificates: true

‎docs/examples/ferretdb/reconfigure-tls/issuer.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: cert-manager.io/v1
2+
kind: Issuer
3+
metadata:
4+
name: ferretdb-ca-issuer
5+
namespace: demo
6+
spec:
7+
ca:
8+
secretName: ferretdb-ca

‎docs/examples/ferretdb/reconfigure-tls/new-issuer.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: cert-manager.io/v1
2+
kind: Issuer
3+
metadata:
4+
name: fr-new-issuer
5+
namespace: demo
6+
spec:
7+
ca:
8+
secretName: ferretdb-new-ca

‎docs/examples/ferretdb/restart/ferretdb.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: ferretdb
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
replicas: 1
9+
backend:
10+
externallyManaged: false
11+
storage:
12+
accessModes:
13+
- ReadWriteOnce
14+
resources:
15+
requests:
16+
storage: 500Mi
17+
deletionPolicy: WipeOut

‎docs/examples/ferretdb/restart/ops.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: restart-ferretdb
5+
namespace: demo
6+
spec:
7+
type: Restart
8+
databaseRef:
9+
name: ferretdb
10+
timeout: 3m
11+
apply: Always

‎docs/examples/ferretdb/scaling/fr-horizontal.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: fr-horizontal
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
replicas: 1
9+
backend:
10+
externallyManaged: false
11+
storage:
12+
accessModes:
13+
- ReadWriteOnce
14+
resources:
15+
requests:
16+
storage: 500Mi
17+
deletionPolicy: WipeOut

‎docs/examples/ferretdb/scaling/fr-vertical-ops.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: ferretdb-scale-vertical
5+
namespace: demo
6+
spec:
7+
type: VerticalScaling
8+
databaseRef:
9+
name: fr-vertical
10+
verticalScaling:
11+
node:
12+
resources:
13+
requests:
14+
memory: "2Gi"
15+
cpu: "1"
16+
limits:
17+
memory: "2Gi"
18+
cpu: "1"
19+
timeout: 5m
20+
apply: IfReady

‎docs/examples/ferretdb/scaling/fr-vertical.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: fr-vertical
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
replicas: 1
9+
backend:
10+
externallyManaged: false
11+
storage:
12+
accessModes:
13+
- ReadWriteOnce
14+
resources:
15+
requests:
16+
storage: 500Mi
17+
deletionPolicy: WipeOut

‎docs/examples/ferretdb/scaling/frops-hscale-down-ops.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: ferretdb-horizontal-scale-down
5+
namespace: demo
6+
spec:
7+
type: HorizontalScaling
8+
databaseRef:
9+
name: fr-horizontal
10+
horizontalScaling:
11+
node: 2

‎docs/examples/ferretdb/scaling/frops-hscale-up-ops.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: ferretdb-horizontal-scale-up
5+
namespace: demo
6+
spec:
7+
type: HorizontalScaling
8+
databaseRef:
9+
name: fr-horizontal
10+
horizontalScaling:
11+
node: 3

‎docs/examples/ferretdb/tls/ferretdb-tls.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: fr-tls
5+
namespace: demo
6+
spec:
7+
version: "1.23.0"
8+
authSecret:
9+
externallyManaged: false
10+
storage:
11+
accessModes:
12+
- ReadWriteOnce
13+
resources:
14+
requests:
15+
storage: 500Mi
16+
backend:
17+
externallyManaged: false
18+
deletionPolicy: WipeOut
19+
replicas: 1
20+
sslMode: requireSSL
21+
tls:
22+
issuerRef:
23+
apiGroup: "cert-manager.io"
24+
kind: Issuer
25+
name: ferretdb-ca-issuer

‎docs/examples/ferretdb/tls/issuer.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: cert-manager.io/v1
2+
kind: Issuer
3+
metadata:
4+
name: ferretdb-ca-issuer
5+
namespace: demo
6+
spec:
7+
ca:
8+
secretName: ferretdb-ca

‎docs/examples/ferretdb/update-version/fr-update.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: FerretDB
3+
metadata:
4+
name: fr-update
5+
namespace: demo
6+
spec:
7+
version: "1.18.0"
8+
replicas: 1
9+
backend:
10+
externallyManaged: false
11+
storage:
12+
accessModes:
13+
- ReadWriteOnce
14+
resources:
15+
requests:
16+
storage: 500Mi
17+
deletionPolicy: WipeOut

‎docs/examples/ferretdb/update-version/frops-update.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: ops.kubedb.com/v1alpha1
2+
kind: FerretDBOpsRequest
3+
metadata:
4+
name: ferretdb-version-update
5+
namespace: demo
6+
spec:
7+
type: UpdateVersion
8+
databaseRef:
9+
name: fr-update
10+
updateVersion:
11+
targetVersion: 1.23.0

‎docs/guides/ferretdb/autoscaler/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Autoscaling
3+
menu:
4+
docs_{{ .version }}:
5+
identifier: fr-auto-scaling
6+
name: Autoscaling
7+
parent: fr-ferretdb-guides
8+
weight: 46
9+
menu_name: docs_{{ .version }}
10+
---

0 commit comments

Comments
 (0)