search

akuity / kargo

Application lifecycle orchestration
https://kargo.akuity.io/
Apache License 2.0
1.77k stars 146 forks source link

docs: authorizing kargo stages to modify argo apps #2921

Open fykaa opened 1 week ago

fykaa commented 1 week ago

closes https://github.com/akuity/kargo/issues/2440

I have made the documentation placement for the kargo.akuity.io/authorized-stage annotation in "Managing User Permissions" section because imo it is a key component in managing permissions between Kargo and Argo CD.

While I also considered options like a dedicated annotation reference guide or including it in key concepts, I believe current placement is most relevant. Please let me know if this location works or if there's an alternative section recommended.

netlify[bot] commented 1 week ago

Deploy Preview for docs-kargo-io ready!

Name Link
Latest commit ce15e5516676298d3cfae0794747befa10974a09
Latest deploy log https://app.netlify.com/sites/docs-kargo-io/deploys/673c1a5d2c31cf000868e455
Deploy Preview https://deploy-preview-2921.docs.kargo.io
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 50.92%. Comparing base (c0d47e0) to head (ce15e55). Report is 14 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2921 +/- ## ========================================== + Coverage 49.92% 50.92% +1.00% ========================================== Files 275 279 +4 Lines 24668 25180 +512 ========================================== + Hits 12315 12823 +508 + Misses 11676 11666 -10 - Partials 677 691 +14 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

krancour commented 1 week ago

I have made the documentation placement for the kargo.akuity.io/authorized-stage annotation in "Managing User Permissions" section because imo it is a key component in managing permissions between Kargo and Argo CD.

I'm not sure I agree with this. It has nothing to do with user permissions.

We probably need to carve out a whole separate page for "Argo CD Integration". It can be very light on content for now with a notice that the page is under construction and the real content can, for now, be limited to what you're adding here.