From a809723b1ba07e36d4cca0969925ac371598ba65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Haris=20Osmanagi=C4=87?= Date: Wed, 15 Dec 2021 17:02:41 +0100 Subject: [PATCH 1/4] docs: sharp edges, part 1 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1e05ab27e..c5ec45604 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,19 @@ For more information about the UI refer to the [Readme](ui/README.md) in `/ui`. ![animation](docs/data/animation.gif) +## Sharp edges + +While Conduit is built on strong foundations and experiences from running similar systems, it's not production ready +at the moment. Following features are on the roadmap and yet to be implemented: +1. Clustering support -- currently Conduit is able to run in standalone-mode only. +2. Standard record format -- we plan to have the records implement a single standard for CDC events. +3. Delivery and ordering guarantees -- from the experience we have so far, messages created internally are reliably delivered through +Conduit (from source nodes, over processing nodes to destination nodes). However, we still need good end-to-end, full-scale +tests to actually prove that. +4. Performance guarantees (for the core) -- reasons are identical to reasons for delivery guarantees. +5. Dynamic loading of list of plugins -- currently, the API cannot return the list of all available plugins and the available +configuration parameters. Consequently, the UI has the plugin paths and configuration parameters hard-coded. + ## Documentation To learn more about how to use Conduit visit [docs.conduit.io](https://docs.conduit.io). From 1915b4680f80ba9f663190be0592dcd5843140e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Haris=20Osmanagi=C4=87?= Date: Fri, 17 Dec 2021 16:23:14 +0100 Subject: [PATCH 2/4] reorder, add link to toc --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c5ec45604..cb733b0e6 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Conduit was created and open-sourced by [Meroxa](https://meroxa.io). - [API](#api) - [UI](#ui) - [Documentation](#documentation) +- [Sharp edges](#sharp-edges) - [Contributing](#contributing) ## Installation guide @@ -113,19 +114,6 @@ For more information about the UI refer to the [Readme](ui/README.md) in `/ui`. ![animation](docs/data/animation.gif) -## Sharp edges - -While Conduit is built on strong foundations and experiences from running similar systems, it's not production ready -at the moment. Following features are on the roadmap and yet to be implemented: -1. Clustering support -- currently Conduit is able to run in standalone-mode only. -2. Standard record format -- we plan to have the records implement a single standard for CDC events. -3. Delivery and ordering guarantees -- from the experience we have so far, messages created internally are reliably delivered through -Conduit (from source nodes, over processing nodes to destination nodes). However, we still need good end-to-end, full-scale -tests to actually prove that. -4. Performance guarantees (for the core) -- reasons are identical to reasons for delivery guarantees. -5. Dynamic loading of list of plugins -- currently, the API cannot return the list of all available plugins and the available -configuration parameters. Consequently, the UI has the plugin paths and configuration parameters hard-coded. - ## Documentation To learn more about how to use Conduit visit [docs.conduit.io](https://docs.conduit.io). @@ -138,6 +126,19 @@ If you are interested in internals of Conduit we have prepared some technical do * [Connector Plugins](https://github.com/ConduitIO/conduit/blob/main/docs/plugins.md) contains insights about how Conduit is communicating with connector plugins and how you can build your own connector plugin. +## Sharp edges + +While Conduit is built on strong foundations and experiences from running similar systems, it's not production ready +at the moment. Following features are on the roadmap and yet to be implemented: +1. Clustering support -- currently Conduit is able to run in standalone-mode only. +2. Standard record format -- we plan to have the records implement a single standard for CDC events. +3. Delivery and ordering guarantees -- from the experience we have so far, messages created internally are reliably delivered through + Conduit (from source nodes, over processing nodes to destination nodes). However, we still need good end-to-end, full-scale + tests to actually prove that. +4. Performance guarantees (for the core) -- reasons are identical to reasons for delivery guarantees. +5. Dynamic loading of list of plugins -- currently, the API cannot return the list of all available plugins and the available + configuration parameters. Consequently, the UI has the plugin paths and configuration parameters hard-coded. + ## Contributing For a complete guide to contributing to Conduit, see the From 9ea87c5f7176680609b2180e88ec1029e531dd95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Haris=20Osmanagi=C4=87?= Date: Wed, 22 Dec 2021 18:32:37 +0100 Subject: [PATCH 3/4] rephrase --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb733b0e6..9c9e5bf71 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Conduit was created and open-sourced by [Meroxa](https://meroxa.io). - [API](#api) - [UI](#ui) - [Documentation](#documentation) -- [Sharp edges](#sharp-edges) +- [Future improvements](#future-improvements) - [Contributing](#contributing) ## Installation guide @@ -126,7 +126,7 @@ If you are interested in internals of Conduit we have prepared some technical do * [Connector Plugins](https://github.com/ConduitIO/conduit/blob/main/docs/plugins.md) contains insights about how Conduit is communicating with connector plugins and how you can build your own connector plugin. -## Sharp edges +## Future improvements While Conduit is built on strong foundations and experiences from running similar systems, it's not production ready at the moment. Following features are on the roadmap and yet to be implemented: From e7770c989baefb4c1e5200b76e46fcf0ea0b907f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lovro=20Ma=C5=BEgon?= Date: Mon, 10 Jan 2022 14:49:00 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9c9e5bf71..e73950c38 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Conduit was created and open-sourced by [Meroxa](https://meroxa.io). - [API](#api) - [UI](#ui) - [Documentation](#documentation) -- [Future improvements](#future-improvements) +- [Known limitations](#known-limitations) - [Contributing](#contributing) ## Installation guide @@ -126,17 +126,16 @@ If you are interested in internals of Conduit we have prepared some technical do * [Connector Plugins](https://github.com/ConduitIO/conduit/blob/main/docs/plugins.md) contains insights about how Conduit is communicating with connector plugins and how you can build your own connector plugin. -## Future improvements +## Known limitations While Conduit is built on strong foundations and experiences from running similar systems, it's not production ready at the moment. Following features are on the roadmap and yet to be implemented: -1. Clustering support -- currently Conduit is able to run in standalone-mode only. -2. Standard record format -- we plan to have the records implement a single standard for CDC events. -3. Delivery and ordering guarantees -- from the experience we have so far, messages created internally are reliably delivered through +1. Standard record format - we plan to have the records implement a single standard for CDC events. +2. Delivery and ordering guarantees - from the experience we have so far, messages created internally are reliably delivered through Conduit (from source nodes, over processing nodes to destination nodes). However, we still need good end-to-end, full-scale tests to actually prove that. -4. Performance guarantees (for the core) -- reasons are identical to reasons for delivery guarantees. -5. Dynamic loading of list of plugins -- currently, the API cannot return the list of all available plugins and the available +3. Performance guarantees (for the core) - reasons are identical to reasons for delivery guarantees. +4. Dynamic loading of list of plugins - currently, the API cannot return the list of all available plugins and the available configuration parameters. Consequently, the UI has the plugin paths and configuration parameters hard-coded. ## Contributing