docs: authorise kargo to argocd-update #2962
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2962 +/- ##
==========================================
- Coverage 50.92% 50.90% -0.02%
==========================================
Files 279 279
Lines 25180 25178 -2
==========================================
- Hits 12823 12818 -5
- Misses 11666 11669 +3
Partials 691 691 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
krancour
reviewed
Nov 19, 2024
| @@ -1156,3 +1156,34 @@ Although the `argocd-update` step is the only promotion step to currently | |||
| utilize this health check framework, we anticipate that future built-in and | |||
| third-party promotion steps will take advantage of it as well. | |||
| ::: | |||
|
|
|||
| ### Authorizing Kargo to Update Argo CD Applications | |||
There was a problem hiding this comment.
Given the importance of this information, I think this should be up higher and I wouldn't give it its own section either. If we put it in a note box at the end of the section that first introduces this step (i.e. line 988), it will be much harder to miss this.
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
krancour
reviewed
Nov 20, 2024
Comment on lines
989
to
1014
| :::note | ||
| For Kargo `Stage`s to modify and manage Argo CD `Application` resources, | ||
| explicit authorization must be granted in the `Application` manifests. | ||
| This is achieved by including the `kargo.akuity.io/authorized-stage` annotation. | ||
|
|
||
| The annotation must be formatted as follows: | ||
|
|
||
| ```yaml | ||
| kargo.akuity.io/authorized-stage: "<project-name>:<stage-name>" | ||
| ``` | ||
|
|
||
| The following example shows how to configure an Argo CD `Application` | ||
| manifest to authorize the `test` `Stage` of the `kargo-demo` `Project`: | ||
|
|
||
| ```yaml | ||
| apiVersion: argoproj.io/v1alpha1 | ||
| kind: Application | ||
| metadata: | ||
| name: kargo-demo-test | ||
| namespace: argocd | ||
| annotations: | ||
| kargo.akuity.io/authorized-stage: kargo-demo:test | ||
| spec: | ||
| # Application specifications go here | ||
| ``` | ||
| ::: |
There was a problem hiding this comment.
Formatting looks off on this entire block.
There was a problem hiding this comment.
I should remove the indentations
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
krancour
reviewed
Nov 20, 2024
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
fykaa
force-pushed
the
docs/update-authorized-stage-annotation
branch
from
93feffe to
c462695
Compare
krancour
approved these changes
Nov 21, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Faeka Ansari <faeka6@gmail.com> (cherry picked from commit 7f92d75)
|
Successfully created backport PR for |
fykaa
added a commit
to fykaa/kargo
that referenced
this pull request
Dec 20, 2024
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #2440
#2921 (comment)