From 7f92d75029bf65ec705ac8c1babf0db4d25f7486 Mon Sep 17 00:00:00 2001 From: Faeka Ansari Date: Thu, 21 Nov 2024 05:53:17 +0530 Subject: [PATCH] docs: authorise kargo to argocd-update (#2962) Signed-off-by: Faeka Ansari --- docs/docs/35-references/10-promotion-steps.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/docs/35-references/10-promotion-steps.md b/docs/docs/35-references/10-promotion-steps.md index c92adfea3..f0a1f1c1d 100644 --- a/docs/docs/35-references/10-promotion-steps.md +++ b/docs/docs/35-references/10-promotion-steps.md @@ -986,6 +986,34 @@ an Argo CD `Application` to sync after previous steps have updated a remote branch referenced by the `Application`. This step is commonly the last step in a promotion process. +:::note +For an Argo CD `Application` resource to be managed by a Kargo `Stage`, +the `Application` _must_ have an annotation of the following form: + +```yaml +kargo.akuity.io/authorized-stage: ":" +``` + +Such an annotation offers proof that a user who is themselves authorized +to update the `Application` in question has consented to a specific +`Stage` updating the `Application` as well. + +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 +``` +::: + ### `argocd-update` Configuration | Name | Type | Required | Description |