[Argo CD]: Add argocd AppProject-ApplicationSet-Application relationships #10920
Conversation
Signed-off-by: innocentrda <[email protected]>
github-actions
bot
added
component/server
area/models
|
|
| "project" | ||
| ] | ||
| ], | ||
| "description": "Application can reference AppProject to specify the project it belongs to." |
There was a problem hiding this comment.
"can" or "does" or "should"?
| "apiVersion": "core.meshery.io/v1alpha1", | ||
| "kind": "Hierarchical", | ||
| "metadata": { | ||
| "description": "A hierarchical inventory relationship in which the configuration of (parent) component is patched with the configuration of other (child) component. Eg: The configuration of the EnvoyFilter (parent) component is patched with the configuration as received from WASMFilter (child) component." |
There was a problem hiding this comment.
I wonder if we have a more readily comprehensible example for the Kubernetes layman as opposed to the somewhat advanced and niche EnvoyFilter example. A quick review of the rest of the existing policies might offer an alternative example such as Pod (child) and Namespace (parent).
There was a problem hiding this comment.
Hierarchical-Parent makes sense for this case if we can relate it to namespaces and pods. Project can be related to namespace.
There was a problem hiding this comment.
Great. Given this, will you please update the sample text with a more readily comprehensible example for users?
|
@innocentrda thanks for presenting this relationship on today's call. 👍 I'm curious as to what any one of the Argo maintainers think of this suggested relationship. |
…ical-Parent Signed-off-by: innocentrda <[email protected]>
There was a problem hiding this comment.
@innocentrda Will you use v1alpha2 version for this relationship definition?
Refer the existing defs for reference.
|
Because there has been a recent change around schema version for these relationships (v1alpha2), so you might consider relocating to correct location. |
server/meshmodel/argo-cd/relationships/hierarchical_inventory.json
Outdated
Show resolved
Hide resolved
server/meshmodel/argo-cd/relationships/hierarchical_inventory.json
Outdated
Show resolved
Hide resolved
| "apiVersion": "core.meshery.io/v1alpha1", | ||
| "kind": "Hierarchical", | ||
| "metadata": { | ||
| "description": "A hierarchical inventory relationship in which the configuration of (parent) component is patched with the configuration of other (child) component. Eg: The configuration of the EnvoyFilter (parent) component is patched with the configuration as received from WASMFilter (child) component." |
There was a problem hiding this comment.
Great. Given this, will you please update the sample text with a more readily comprehensible example for users?
| "apiVersion": "core.meshery.io/v1alpha1", | ||
| "kind": "Hierarchical", | ||
| "metadata": { | ||
| "description": "A parent-child relationship implies the requirement of the parent component before the child component can be created" |
There was a problem hiding this comment.
@innocentrda please take a quick moment to punctuate the first sentence and to include a second sentence using the pod and namespace example that has been suggested. Look to other relationships for text to copy/paste. There might be one of these already written.
There was a problem hiding this comment.
We're missing a relationship-specific description. Will you re-add this so that users of this relationship have a description specific to AppSet and App?
There was a problem hiding this comment.
@leecalcote The description is updated accordingly. Is it much better?
Signed-off-by: innocentrda <[email protected]>
Signed-off-by: innocentrda <[email protected]>
| @@ -0,0 +1,45 @@ | |||
| { | |||
| "apiVersion": "core.meshery.io/v1alpha2", | |||
There was a problem hiding this comment.
Still incorrect, please look at existing relationship def, eg: https://github.com/meshery/meshery/blob/0d2c843bb5c1093b3b1d281130689298859a495a/server/meshmodel/kubearmor/v1.2.1/v1.0.0/relationships/hierarchical_inventory.json
There was a problem hiding this comment.
Thanks for guidance. It is updated.
Signed-off-by: innocentrda <[email protected]>
Signed-off-by: innocentrda <[email protected]>
| "schemaVersion": "core.meshery.io/v1alpha2", | ||
| "version": "v1.0.0", | ||
| "metadata": { | ||
| "description": "A parent-child relationship implies the requirement of the parent component before the child component can be created. For example, a Namespace in Kubernetes can be a parent of Pods within that namespace. Similarly, in Argo CD, an AppProject represents a logical grouping of Applications. Applications and ApplicationSets reference their AppProject by name." |
There was a problem hiding this comment.
Be sure to capitalize consistently, if you would: Namespace.
Yes, the description is ✅
Signed-off-by: innocentrda <[email protected]>
server/meshmodel/argo-cd/relationships/hierarchical_parent.json
Outdated
Show resolved
Hide resolved
Signed-off-by: Mohd Uzair <[email protected]>
Signed-off-by: MUzairS15 <[email protected]>
Signed-off-by: innocentrda <[email protected]>
|
Thanks for your contribution to Meshery! 🎉
|
Notes for Reviewers
This PR fixes #
This PR provides a Argo CD AppProject-ApplicationSet-Application relationships.
In Argo CD, The AppProject CRD is the Kubernetes resource object representing a logical grouping of applications. AppProject should exist before Applications are creatd within it. Similar to namespaces and pods in kubernetes.
ApplicationSet which uses a single manifest file to deploy multiple applications from one or multiple Git repositories to multiple clusters, should also reference AppProject to specify the project where generated Applications belong.
This become a Hierarchical-Parent relationship since AppProject should exist first.
Signed commits