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

docs: authorizing kargo stages to modify argo apps #2921

Merged
merged 4 commits into from
Dec 23, 2024

Conversation

fykaa
Copy link
Contributor

@fykaa fykaa commented Nov 13, 2024

closes #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.

@fykaa fykaa self-assigned this Nov 13, 2024
@fykaa fykaa requested review from a team as code owners November 13, 2024 12:03
Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit 7e3d6fd
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-io/deploys/6769d8c24f490a00083382d3
😎 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.

Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.40%. Comparing base (c0d47e0) to head (7e3d6fd).
Report is 114 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2921      +/-   ##
==========================================
+ Coverage   49.92%   51.40%   +1.48%     
==========================================
  Files         275      288      +13     
  Lines       24668    26108    +1440     
==========================================
+ Hits        12315    13421    +1106     
- Misses      11676    11961     +285     
- Partials      677      726      +49     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@krancour
Copy link
Member

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.

Signed-off-by: Faeka Ansari <faeka6@gmail.com>
@fykaa fykaa force-pushed the docs/add-authorized-stage-annotation branch from 4f203d7 to e0a6a70 Compare November 15, 2024 19:43
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@krancour krancour enabled auto-merge December 23, 2024 21:45
@krancour krancour added this pull request to the merge queue Dec 23, 2024
Merged via the queue into akuity:main with commit 011f87a Dec 23, 2024
19 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 23, 2024
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Co-authored-by: Kent Rancourt <kent.rancourt@gmail.com>
(cherry picked from commit 011f87a)
@akuitybot
Copy link

Successfully created backport PR for release-1.1:

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

Successfully merging this pull request may close these issues.

docs: need to document the kargo.akuity.io/authorized-stage annotation
3 participants