Skip to content

Commit c88fd65

Browse files
authored
Docs: Remove (Deprecate) FileDB in docs (#6101)
1 parent 8810ce2 commit c88fd65

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

‎docs/content/en/blog/may-2022-update.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ With the release of Helm [version v3.8.0](https://helm.sh/blog/storing-charts-in
3434

3535
#### The very first touchable FileDB
3636

37+
> **⚠️ DEPRECATED NOTICE:** FileDB has been **discontinued** as of PipeCD v0.53.0 due to maintenance complexity and reliability concerns. PipeCD now exclusively supports **Firestore** and **MySQL** as datastore backends.
38+
3739
It’s been a while since the first time we made a [tweet](https://twitter.com/nghialv2607/status/1480712569535209472) about how PipeCD aims to remove the database as its dependencies to make the installation easier and compact, today we want to make the first achievement on the road to __#nodatabase__ world.\
3840
For now, you can have a quick shot of using the new FileDB “database” of PipeCD with the quickstart example easily on your local machine by changing the `quickstart/control-plane-values.yaml` file contains __config.data__ section to something like below:
3941

@@ -42,7 +44,7 @@ For now, you can have a quick shot of using the new FileDB “database” of Pip
4244
kind: ControlPlane
4345
spec:
4446
datastore:
45-
type: FILEDB
47+
type: FILEDB # ⚠️ DEPRECATED: Use FIRESTORE or MYSQL instead
4648
filestore:
4749
type: MINIO
4850
config:

‎docs/rfcs/0008-simplify-datastore.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
- Start Date: 2021-12-19
22
- Target Version: 0.24.0
3+
- Status: DEPRECATED (Discontinued as of v0.53.0)
34

45
# Summary
56

7+
> **⚠️ DEPRECATED NOTICE:** This RFC describes the FileDB feature which has been **discontinued** as of PipeCD v0.53.0. The implementation was removed due to maintenance complexity and reliability concerns. PipeCD now exclusively supports **Firestore** and **MySQL** as datastore backends.
8+
69
This RFC introduces a way to host your own PipeCD control-plane without datastore. Refer to the PipeCD [control-plane architecture overview](https://pipecd.dev/docs/operator-manual/control-plane/architecture-overview/) for more information about what is PipeCD datastore.
710

811
# Motivation
@@ -58,7 +61,7 @@ Cons:
5861

5962
#### <3> Using version field as data object properties (optimistic locking)
6063

61-
Use a version field in record to ensure that correct version was used before writing.
64+
Use a version field in record to ensure that correct version was used before writing.
6265

6366
Pros:
6467

@@ -97,7 +100,7 @@ To unify with other datastore which be supported as PipeCD datastore (GCP firest
97100

98101
Since we will use filestore as PipeCD database, we should implement filestore with hot & cold storage separated pattern - storage called hot or cold defined based on: How often do the objects be updated? or the update frequency.
99102

100-
Objects such as: deployment, command, event, deployment-chain, etc are only be created once and once they finished their life time (state or status changed to SUCCESS|FAILURE|CANCELLED), they will no more be updated. Those kinds of objects should be stored in `chunk` and mostly will be used to shown as list from deployment list view, for example.
103+
Objects such as: deployment, command, event, deployment-chain, etc are only be created once and once they finished their life time (state or status changed to SUCCESS|FAILURE|CANCELLED), they will no more be updated. Those kinds of objects should be stored in `chunk` and mostly will be used to shown as list from deployment list view, for example.
101104

102105
On the opposite side, objects like piped, project, application, etc have fewer numbers and are updated frequently throughout their lifetime; they should therefore be stored in hot storage.
103106

0 commit comments

Comments
 (0)