argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes

https://argo-cd.readthedocs.io

Apache License 2.0

18.07k stars 5.53k forks source link

Need documentation on Argo CD with ecosystem projects #5827

Open jessesuen opened 3 years ago

jessesuen commented 3 years ago

Summary

We have several ecosystem argoproj-labs projects which integrate well with Argo CD and assume (or were only tested with) specific versions of Argo CD. These include:

Argo CD notifications
Argo CD image updater
ApplicationSet controller

We should improve our documentation to

mention the ecosystem projects as useful add-ons to Argo CD
provide a compatibility matrix to recommended versions
document, or link to installation instructions

jannfis commented 3 years ago

I do like this idea, but I feel that a compatibility matrix would belong more in the domain of the ecosystem's project.

Maybe the matrix should be maintained in each project separately at a given URL, and we link to it from Argo CD docs?

sbose78 commented 3 years ago

I wonder if we should introduce a "certify with the upcoming release of ArgoCD" program ?

Participating projects commit to releasing a tested version of the project with ArgoCD 2.1 for example.
The ecosystem projects ship a release simultaneous to the ArgoCD release - have a lightweight "certification" process.
The ecosystem projects send a PR to the relevant section of the ArgoCD docs specifying the version of the project compatible with the specific version of ArgoCD.

This ensures the following:

Participating ecosystem projects have an incentive to continue to be well-maitained.
Users feel a sense of confidence banking on an ecosystem project.

jay-lee-otsk commented 2 years ago

Hi @jessesuen

I would like to know how this issue is going on. Especially, due to our k8s cluster version upgrade task, I really need a k8s compatibility matrix table.

Regards, Jay Lee

jannfis commented 2 years ago

Hi @jay-lee-otsk,

Especially, due to our k8s cluster version upgrade task, I really need a k8s compatibility matrix table.

If you are requesting information on compatibility between Argo CD and Kubernetes versions, our official stance is as follows:

We do support N-1 minor releases of Argo CD officially (e.g. right now, 2.3.z and 2.2.z)
We aim to support those Kubernetes versions that are currently officially supported by the Kubernetes project (e.g. right now 1.23, 1.22 and 1.21). More information can be found at https://kubernetes.io/releases/

terrytangyuan commented 2 years ago

ICYMI, there's a section for "ecosystem projects" in this list: https://github.com/terrytangyuan/awesome-argo#ecosystem-projects

jay-lee-otsk commented 2 years ago

Hi @jannfis cc @terrytangyuan

Noted with thanks. It was very helpful. I suggest this information be included in README.md shown on the front page. So that everyone could understand this community's official guidance.