docs: Preview features description (#747)

aneoconsulting · Sep 10, 2024 · c469bdb · c469bdb
2 parents 0779cb5 + c7fd38a
commit c469bdb
Showing 1 changed file with 57 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,63 @@ ArmoniK.Core provides services for submitting computational tasks, keeping track
 
 More detailed information on the inner working of ArmoniK.Core is available [here](https://aneoconsulting.github.io/ArmoniK.Core/).
 
+## Development process
+
+This repository follows trunk based development so all features will be integrated into main, in multiple small steps.
+Breaking changes will be limited as much as possible or gated behind feature flags.
+If breaking changes should happen, they will be documented in the releases.
+Therefore, features in development or testing that cannot fit within a branch and need to be integrated into main will be marked as preview so that users know that these features are still in development and subject to changes.
+
+**General availability (GA):** The APIs, plugins and features are thoroughly tested and support is available.
+**Preview:** The APIs, plugins and features that are available on main but still in development. Their API should be stable enough for advanced users who want to test them before GA. Breaking changes should be minimal and will be notified in the release notes. Any feedback or issue encountered with these features are welcome !
+**Beta (Internal preview):** The APIs, plugins and features in active development. They are not stable enough and breaking changes may occur without any notice. Breaking changes will not always be documented. They can be used by the community for testing purposes. Before being  moved to the "Preview" stage, issues might be closed with the minimal messages "Under Active Development".
+**Deprecated:** The deprecated APIs, plugins and features. Features are flagged for future removal. Only production critical bug fixes will be considered.
+**Work in progress (WIP):** The APIs, plugins and features are not fully implemented and may have some missing parts.
+
+| Plugins  | Type           | Description                                   | Status  |
+|----------|----------------|-----------------------------------------------|---------|
+| RabbitMQ | Queue          | RabbitMQ client using AMQP protocol 0.9.2     | GA      |
+| AMQP     | Queue          | AMQP client using AMQP protocol 1.0.0         | GA      |
+| PubSub   | Queue          | Google PubSub client                          | GA      |
+| SQS      | Queue          | AWS SQS client                                | Preview |
+| Redis    | Object Storage | Redis client used to store binary data        | GA      |
+| Local    | Object Storage | File system used to store binary data         | GA      |
+| S3       | Object Storage | AWS S3 client used to store binary data       | GA      |
+| MongoDB  | Database       | MongoDB client to store ArmoniK internal data | GA      |
+
+| APIs                          | Description                                                                         | Status     |
+|-------------------------------|-------------------------------------------------------------------------------------|------------|
+| Agent.CreateTask              | Streamed RPC to submit payloads and tasks from the worker                           | Deprecated |
+| Agent.Get*Data                | RPC to get special Results                                                          | WIP        |
+| Agent.*                       | Service to submit created results, create new results and new tasks from the worker | GA         |
+| Applications.ListApplications | RPC to list applications                                                            | GA         |
+| Authentication.GetCurrentUser | RPC to retrieve the current logged-in user                                          | GA         |
+| Events.GetEvents              | Streamed RPC to subscribe to task and result events during execution                | GA         |
+| HealthChecks.CheckHealth      | RPC to get an overview of the cluster health                                        | GA         |
+| Partitions.ListPartitions     | RPC to list partitions                                                              | GA         |
+| Partitions.GetPartition       | RPC to get partition information                                                    | GA         |
+| Partition metrics exporter    | Metrics exporter to expose partition metrics on shared resources                    | Beta       |
+| Results.WatchResults          | Bi-directionnal RPC to subscribe to events on Results                               | WIP        |
+| Results.*                     | Service to create, download, list and upload results                                | GA         |
+| Sessions.*                    | Service to create, list, cancel, pause, resume, close etc sessions                  | GA         |
+| Submitter.*                   | Deprecated streamed service to create tasks and payloads altogether                 | Deprecated |
+| Tasks.*                       | Service to submit, list and cancel tasks                                            | GA         |
+| Versions.*                    | Service to retrieve versions                                                        | GA         |
+| Worker.*                      | Service implemented by users that consumes the tasks scheduled by ArmoniK           | GA         |
+
+| Docker Image Platform | Status  |
+|-----------------------|---------|
+| linux/amd64           | GA      |
+| linux/arm64           | Preview |
+| windows/amd64         | Beta    |
+
+<!--
+| Feature Flags | Value | Description | Status |
+|---------------|-------|-------------|--------|
+|               |       |             |        |
+|               |       |             |        |
+-->
+
 ## Installation
 
 ArmoniK.Core can be installed only on Linux machines. For Windows users, it is possible to do it on [WSL2](https://learn.microsoft.com/en-us/windows/wsl/about).