Skip to content

Commit

Permalink
Add Ferretdb quickstart doc (#616)
Browse files Browse the repository at this point in the history
Signed-off-by: sayedppqq <[email protected]>
  • Loading branch information
sayedppqq authored May 8, 2024
1 parent 2423b8a commit 544eccc
Show file tree
Hide file tree
Showing 8 changed files with 724 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/examples/ferretdb/quickstart/ferretdb-external.yaml
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
20 changes: 20 additions & 0 deletions docs/examples/ferretdb/quickstart/ferretdb-internal.yaml
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
1 change: 1 addition & 0 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Guides to show you how to perform tasks with KubeDB:
- [Druid](/docs/guides/kafka/README.md). Shows how to manage Druid using KubeDB.
- [Elasticsearch](/docs/guides/elasticsearch/README.md). Shows how to manage Elasticsearch & OpenSearch using KubeDB.
- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB.
- [FerretDB](/docs/guides/ferretdb/README.md). Shows how to manage FerretDB using KubeDB.
- [MariaDB](/docs/guides/mariadb). Shows how to manage MariaDB using KubeDB.
- [Memcached](/docs/guides/memcached/README.md). Shows how to manage Memcached using KubeDB.
- [Microsoft SQL Server](/docs/guides/mssqlserver/README.md). Shows how to manage Microsoft SQL Server using KubeDB.
Expand Down
54 changes: 54 additions & 0 deletions docs/guides/ferretdb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: FerretDB
menu:
docs_{{ .version }}:
identifier: mg-readme-ferretdb
name: FerretDB
parent: mg-ferretdb-guides
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
url: /docs/{{ .version }}/guides/ferretdb/
aliases:
- /docs/{{ .version }}/guides/ferretdb/README/
---

> New to KubeDB? Please start [here](/docs/README.md).
# 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/images/ferretdb/quick-start.png" >
</p>

## User Guide

- [Quickstart FerretDB](/docs/guides/ferretdb/quickstart/quickstart.md) with KubeDB Operator.
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
10 changes: 10 additions & 0 deletions docs/guides/ferretdb/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: FerretDB
menu:
docs_{{ .version }}:
identifier: fr-ferretdb-guides
name: FerretDB
parent: guides
weight: 10
menu_name: docs_{{ .version }}
---
10 changes: 10 additions & 0 deletions docs/guides/ferretdb/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: FerretDB Quickstart
menu:
docs_{{ .version }}:
identifier: fr-quickstart-ferretdb
name: Quickstart
parent: fr-ferretdb-guides
weight: 15
menu_name: docs_{{ .version }}
---
Loading

0 comments on commit 544eccc

Please sign in to comment.