Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow setting custom parents via metadata (Alpha) #5082 #20908

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jake-ciolek
Copy link
Contributor

I took a stab at #5082 and took a slightly different approach. Instead of users specifying the parent/child relationship in config, we could allow setting it in the metadata.

This change allows users to define a parent/child relationship for resources where this cannot be inferred from the ownerRef values. The child resource might be a Cluster-scoped CR and the parent might be a namespaced CRD.

The API is straightforward and boils down to setting annotations that define the parent, i.e:

argocd.argoproj.io/ownerApiVersion: custom-api.example.com/v1alpha1
argocd.argoproj.io/ownerKind: Database
argocd.argoproj.io/ownerName: my-claimed-database
argocd.argoproj.io/ownerNamespace: parent-namespace

If a custom parent is defined, we take it over the ownerRef values.

This allows us to display a more ordered resource tree. Some concrete examples include Istio Operator and Crossplane resources (relationship between Claims and Composite Resources).

In the screenshots, you can see that it brings order to the resource tree of Istio Operator and draws the relationship between Crossplane Claim and Crossplane XR.

This is an early implementation and I would appreciate feedback on this approach and pointers on how to make it better. Thanks!

Updates #5082

Screenshot 2024-11-22 at 14 34 18 Screenshot 2024-11-22 at 14 34 31

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

This change allows users to define a parent/child
relationship for resources where this cannot be inferred
from the ownerRef values. The child resource might be a
Cluster-scoped CR and the parent might be a namespaced CRD.

The API is straightforward and boils down to setting
annotations that define the parent, i.e:

argocd.argoproj.io/ownerApiVersion: custom-api.example.com/v1alpha1
argocd.argoproj.io/ownerKind: Database
argocd.argoproj.io/ownerName: my-claimed-database
argocd.argoproj.io/ownerNamespace: parent-namespace

If a custom parent is defined, we take it over the ownerRef values.

This allows us to display a more ordered resource tree.
Some concrete examples include Istio Operator and Crossplane
resources (relationship between Claims and Composite Resources).

Updates argoproj#5082

Signed-off-by: Jakub Ciolek <[email protected]>
@jake-ciolek jake-ciolek requested a review from a team as a code owner November 22, 2024 14:09
Copy link

bunnyshell bot commented Nov 22, 2024

✅ Preview Environment deployed on Bunnyshell

Component Endpoints
argocd https://argocd-tu3s3t.bunnyenv.com/
argocd-ttyd https://argocd-web-cli-tu3s3t.bunnyenv.com/

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔴 /bns:stop to stop the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

@andrii-korotkov-verkada
Copy link
Contributor

Do you have a gitops-engine PR to update the tree construction logic?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants