fix: full review of README for discussion #1230
Conversation
|
|
|
Kudos, SonarCloud Quality Gate passed!
|
| <em>ArmoniK</em> is a high throughput compute grid project using Kubernetes. The project provides a reference | ||
| architecture that can be used to build and adapt a modern high throughput compute solution on-premise or using Cloud | ||
| services, allowing users to submit high volumes of short and long-running tasks and scaling environments dynamically. | ||
| ArmoniK is an open-source high throughput compute grid built on Kubernetes. It provides a scalable and robust framework for running large volumes of compute tasks. |
There was a problem hiding this comment.
I am not sure that insisting on Kubernetes is a good idea. We can present that as an example but for some client using Kubernetes and presenting that as a requirement could be problematic.
|
|
||
| Please, read [documentation](https://aneoconsulting.github.io/ArmoniK/) for more information about ArmoniK. | ||
| ArmoniK allows users to submit high volumes of short and long-running compute tasks, while dynamically scaling the underlying infrastructure to meet demand. It is designed as a reference architecture that can be deployed on-premise or in the cloud. |
There was a problem hiding this comment.
Personnaly I understand this sentence, the last one, as ArmoniK is an infrastructure.
There was a problem hiding this comment.
Yes, we should add a few words about scheduling and resiliency which are our main points that we present everywhere
| Please, read [documentation](https://aneoconsulting.github.io/ArmoniK/) for more information about ArmoniK. | ||
| ArmoniK allows users to submit high volumes of short and long-running compute tasks, while dynamically scaling the underlying infrastructure to meet demand. It is designed as a reference architecture that can be deployed on-premise or in the cloud. | ||
|
|
||
| The project aims to provide a modern, Kubernetes-native solution for high performance computing applications. |
There was a problem hiding this comment.
Same as first remark, too much emphase on Kubernetes
|
|
||
| ## When should I use ArmoniK? | ||
|
|
||
| ArmoniK is designed for workloads that require: |
There was a problem hiding this comment.
(not necessarily all of them at the same time)
| ## Features | ||
|
|
||
| - Horizontally scalable architecture | ||
| - gRPC APIs for task management (11 language clients) |
There was a problem hiding this comment.
| - gRPC APIs for task management (11 language clients) | |
| - gRPC APIs for task management (11 potential language clients, as of today 4 of them are officially supported) | |
| ) |
|
|
||
| ## Acknowledge | ||
| The latest ArmoniK releases are available on [GitHub](https://github.com/aneoconsulting/ArmoniK/releases) and [Docker Hub](https://hub.docker.com/u/dockerhubaneo). |
There was a problem hiding this comment.
| The latest ArmoniK releases are available on [GitHub](https://github.com/aneoconsulting/ArmoniK/releases) and [Docker Hub](https://hub.docker.com/u/dockerhubaneo). | |
| The latest ArmoniK releases are available on [GitHub](https://github.com/aneoconsulting/ArmoniK/releases) and the associated containers on [Docker Hub](https://hub.docker.com/u/dockerhubaneo). |
|
|
||
| Performance benchmarks for ArmoniK are available here: | ||
|
|
||
| [Benchmark results](https://aneoconsulting.github.io/ArmoniK/benchmarking/test-plan/) |
There was a problem hiding this comment.
This is totally obsolete and not maintain. I will not mention it is until it up to date.
|
|
||
| [Organization 1]: https://armonik.fr | ||
| [Organization 2]: https://aneo.fr | ||
| [Blog]: Soon |
There was a problem hiding this comment.
| [Blog]: Soon | |
| [Blog]: https://www.armonik.fr/news |
| [Organization 1]: https://armonik.fr | ||
| [Organization 2]: https://aneo.fr | ||
| [Blog]: Soon | ||
| [YouTube videos]: https://example.com |
There was a problem hiding this comment.
If it does not exist this should be erased
|
|
||
| Please, read [documentation](https://aneoconsulting.github.io/ArmoniK/) for more information about ArmoniK. | ||
| ArmoniK allows users to submit high volumes of short and long-running compute tasks, while dynamically scaling the underlying infrastructure to meet demand. It is designed as a reference architecture that can be deployed on-premise or in the cloud. |
There was a problem hiding this comment.
Yes, we should add a few words about scheduling and resiliency which are our main points that we present everywhere
|
|
||
| Get started with ArmoniK by following the quickstart guide: | ||
|
|
||
| [Quickstart guide](https://armonik.readthedocs.io/en/latest/installation/linux/deployment/) |
There was a problem hiding this comment.
That's a no-go. It does not work !
| 👉 [ArmoniK Versions](https://aneoconsulting.github.io/ArmoniK/armonik#versions) | ||
| 👉 [ArmoniK Installation](https://aneoconsulting.github.io/ArmoniK/installation) | ||
| 👉 [ArmoniK Configuration](https://aneoconsulting.github.io/ArmoniK/guide/how-to/how-to-configure-authentication) | ||
| 👉 [ArmoniK Performance](https://aneoconsulting.github.io/ArmoniK/benchmarking/test-plan) |
There was a problem hiding this comment.
Remove this mention as stated above
| [Organization 1]: https://armonik.fr | ||
| [Organization 2]: https://aneo.fr | ||
| [Blog]: Soon | ||
| [YouTube videos]: https://example.com |
| [Organization 1]: https://armonik.fr | ||
| [Organization 2]: https://aneo.fr | ||
| [Blog]: Soon | ||
| [YouTube videos]: https://example.com |
There was a problem hiding this comment.
| [YouTube videos]: https://example.com |
PR only for discussion around the main customer README