Skip to content

Commit

Permalink
Update docs (#216)
Browse files Browse the repository at this point in the history
Signed-off-by: Tamal Saha <tamal@appscode.com>
  • Loading branch information
tamalsaha committed May 8, 2024
1 parent 07a4e7d commit 547f3b7
Show file tree
Hide file tree
Showing 1,188 changed files with 2,957 additions and 3,701 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
apiVersion: kubedb.com/v1alpha2
kind: FerretDB
metadata:
name: ferretdb-external
namespace: demo
spec:
version: "1.18.0"
authSecret:
externallyManaged: true
name: ha-postgres-auth
sslMode: disabled
storageType: Durable
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 500Mi
backend:
externallyManaged: true
postgres:
service:
name: ha-postgres
namespace: demo
pgPort: 5432
terminationPolicy: WipeOut
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
apiVersion: kubedb.com/v1alpha2
kind: FerretDB
metadata:
name: ferret
namespace: demo
spec:
version: "1.18.0"
authSecret:
externallyManaged: false
sslMode: disabled
storageType: Durable
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 500Mi
backend:
externallyManaged: false
terminationPolicy: WipeOut
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ spec:
databaseRef:
name: mg-replicaset
volumeExpansion:
mode: "Online"
replicaSet: 2Gi
replicaSet: 2Gi
mode: Online
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ spec:
databaseRef:
name: mg-standalone
volumeExpansion:
mode: "Online"
standalone: 2Gi
standalone: 2Gi
mode: Online
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: kubedb.com/v1alpha2
kind: MSSQLServer
metadata:
name: mssqlserver-quickstart
namespace: demo
spec:
version: "2022-cu12"
replicas: 1
storageType: Durable
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
terminationPolicy: Delete
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spec:
name: pgadmin
env:
- name: PGADMIN_DEFAULT_EMAIL
value: "admin"
value: "admin@gmail.com"
- name: PGADMIN_DEFAULT_PASSWORD
value: "admin"
- name: PGADMIN_PORT
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
apiVersion: kubedb.com/v1alpha2
kind: Postgres
metadata:
name: pg-ha-cluster
namespace: demo
spec:
version: "13.13"
replicas: 3
standbyMode: Hot
storageType: Durable
storage:
storageClassName: "linode-block-storage"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 10Gi
terminationPolicy: WipeOut
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
apiVersion: kubedb.com/v1alpha2
kind: Postgres
metadata:
name: pg-standalone
namespace: demo
spec:
version: "13.13"
replicas: 1
standbyMode: Hot
storageType: Durable
storage:
storageClassName: "linode-block-storage"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 10Gi
terminationPolicy: WipeOut
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
apiVersion: ops.kubedb.com/v1alpha1
kind: PostgresOpsRequest
metadata:
name: pgops-vol-exp-ha-cluster
namespace: demo
spec:
apply: IfReady
databaseRef:
name: pg-ha-cluster
type: VolumeExpansion
volumeExpansion:
mode: Online
postgres: 12Gi
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
apiVersion: ops.kubedb.com/v1alpha1
kind: PostgresOpsRequest
metadata:
name: pgops-vol-exp
namespace: demo
spec:
apply: IfReady
databaseRef:
name: pg-standalone
type: VolumeExpansion
volumeExpansion:
mode: Online
postgres: 12Gi
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
apiVersion: kubedb.com/v1alpha2
kind: RabbitMQ
metadata:
name: rm-quickstart
namespace: demo
spec:
version: "3.12.12"
replicas: 3
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: standard
storageType: Durable
terminationPolicy: WipeOut # DoNotTerminate(blocks deletion), Halt( retains pvc,secret), Delete (retains secret)
podTemplate:
spec:
containers:
- name: rabbitmq
resources:
requests:
cpu: "0.5"
memory: "1Gi"
limits:
cpu: "2"
memory: "2Gi"
serviceTemplates:
- alias: primary
spec:
type: LoadBalancer
7 changes: 5 additions & 2 deletions content/docs/v2024.4.27/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,20 @@ info:
Guides to show you how to perform tasks with KubeDB:
- [Druid](/docs/v2024.4.27/guides/kafka/README). Shows how to manage Druid using KubeDB.
- [Elasticsearch](/docs/v2024.4.27/guides/elasticsearch/README). Shows how to manage Elasticsearch & OpenSearch using KubeDB.
- [Kafka](/docs/v2024.4.27/guides/kafka/README). Shows how to manage Kafka using KubeDB.
- [FerretDB](/docs/v2024.4.27/guides/ferretdb/README). Shows how to manage FerretDB using KubeDB.
- [MariaDB](/docs/v2024.4.27/guides/mariadb). Shows how to manage MariaDB using KubeDB.
- [Memcached](/docs/v2024.4.27/guides/memcached/README). Shows how to manage Memcached using KubeDB.
- [Microsoft SQL Server](/docs/v2024.4.27/guides/mssqlserver/README). Shows how to manage Microsoft SQL Server using KubeDB.
- [MongoDB](/docs/v2024.4.27/guides/mongodb/README). Shows how to manage MongoDB using KubeDB.
- [MySQL](/docs/v2024.4.27/guides/mysql/README). Shows how to manage MySQL using KubeDB.
- [Percona XtraDB](/docs/v2024.4.27/guides/percona-xtradb/README). Shows how to manage Percona XtraDB using KubeDB.
- [PgBouncer](/docs/v2024.4.27/guides/pgbouncer/README). Shows how to manage PgBouncer using KubeDB.
- [Pgpool](/docs/v2024.4.27/guides/pgpool/README). Shows how to manage Pgpool using KubeDB.
- [PostgreSQL](/docs/v2024.4.27/guides/postgres/README). Shows how to manage PostgreSQL using KubeDB.
- [ProxySQL](/docs/v2024.4.27/guides/proxysql/README). Shows how to manage ProxySQL using KubeDB.
- [RabbitMQ](/docs/v2024.4.27/guides/rabbitmq/README). Shows how to manage RabbitMQ using KubeDB.
- [Redis](/docs/v2024.4.27/guides/redis/README). Shows how to manage Redis using KubeDB.
- [Kafka](/docs/v2024.4.27/guides/kafka/README). Shows how to manage Kafka using KubeDB.
- [ZooKeeper](/docs/v2024.4.27/guides/zookeeper/README). Shows how to manage ZooKeeper using KubeDB.
- [SingleStore](/docs/v2024.4.27/guides/singlestore/README). Shows how to manage SingleStore using KubeDB.
- [Solr](/docs/v2024.4.27/guides/solr/README). Shows how to manage Solr using KubeDB.
- [ZooKeeper](/docs/v2024.4.27/guides/zookeeper/README). Shows how to manage ZooKeeper using KubeDB.
65 changes: 65 additions & 0 deletions content/docs/v2024.4.27/guides/ferretdb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: FerretDB
menu:
docs_v2024.4.27:
identifier: mg-readme-ferretdb
name: FerretDB
parent: fr-ferretdb-guides
weight: 10
menu_name: docs_v2024.4.27
section_menu_id: guides
url: /docs/v2024.4.27/guides/ferretdb/
aliases:
- /docs/v2024.4.27/guides/ferretdb/README/
info:
autoscaler: v0.30.0
cli: v0.45.0
dashboard: v0.21.0
installer: v2024.4.27
ops-manager: v0.32.0
provisioner: v0.45.0
schema-manager: v0.21.0
ui-server: v0.21.0
version: v2024.4.27
webhook-server: v0.21.0
---

> New to KubeDB? Please start [here](/docs/v2024.4.27/README).
# Overview

FerretDB is an open-source proxy that translates MongoDB wire protocol queries to SQL, with PostgreSQL or SQLite as the database engine. FerretDB was founded to become the true open-source alternative to MongoDB. It uses the same commands, drivers, and tools as MongoDB.

## Supported FerretDB Features

| Features | Availability |
|---------------------------------------|:------------:|
| Internally manageable Backend Engine | &#10003; |
| Externally manageable Backend Engine | &#10003; |
| Authentication & Authorization | &#10003; |
| TLS Support | &#10003; |
| Monitoring using Prometheus | &#10003; |
| Builtin Prometheus Discovery | &#10003; |
| Using Prometheus operator | &#10003; |
| Reconfigurable Health Checker | &#10003; |
| Persistent volume | &#10003; |

## Supported FerretDB Versions

KubeDB supports the following FerretDB Versions.
- `1.18.0`

## Life Cycle of a FerretDB Object

<!---
ref : https://app.diagrams.net/
--->

<p text-align="center">
<img alt="lifecycle" src="/docs/v2024.4.27/images/ferretdb/quick-start.png" >
</p>

## User Guide

- [Quickstart FerretDB](/docs/v2024.4.27/guides/ferretdb/quickstart/quickstart) with KubeDB Operator.
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/v2024.4.27/CONTRIBUTING).
22 changes: 22 additions & 0 deletions content/docs/v2024.4.27/guides/ferretdb/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: FerretDB
menu:
docs_v2024.4.27:
identifier: fr-ferretdb-guides
name: FerretDB
parent: guides
weight: 10
menu_name: docs_v2024.4.27
info:
autoscaler: v0.30.0
cli: v0.45.0
dashboard: v0.21.0
installer: v2024.4.27
ops-manager: v0.32.0
provisioner: v0.45.0
schema-manager: v0.21.0
ui-server: v0.21.0
version: v2024.4.27
webhook-server: v0.21.0
---

22 changes: 22 additions & 0 deletions content/docs/v2024.4.27/guides/ferretdb/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: FerretDB Quickstart
menu:
docs_v2024.4.27:
identifier: fr-quickstart-ferretdb
name: Quickstart
parent: fr-ferretdb-guides
weight: 15
menu_name: docs_v2024.4.27
info:
autoscaler: v0.30.0
cli: v0.45.0
dashboard: v0.21.0
installer: v2024.4.27
ops-manager: v0.32.0
provisioner: v0.45.0
schema-manager: v0.21.0
ui-server: v0.21.0
version: v2024.4.27
webhook-server: v0.21.0
---

Loading

0 comments on commit 547f3b7

Please sign in to comment.