Argo CD
Lets a pipeline stage deploy by syncing an Argo CD application to the change's commit.
Connect it with: API key. Argo CD's own documentation: https://argo-cd.readthedocs.io/en/stable/user-guide/commands/argocd_account_generate-token/.
What agents can do
Connect Argo CD so the agents working your tasks can reach it. With it connected, they can:
- Sync a stage's Argo CD application to the commit that just landed on the stage's branch.
- Wait until Argo CD reports the application synced at that commit and Healthy, then mark the stage arrived.
- Read the application's external URL as the stage's address.
Before you start
- An Argo CD server reachable over https from the internet.
- An Argo CD account with the apiKey capability and permission to get and sync the stage's application.
- A deploy target set to Argo CD on the stage in Settings > Pipeline, naming the server, the application and this secret.
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with Argo CD
Jaah connects to Argo CD with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- API token: Give an Argo CD account the apiKey capability in argocd-cm and an RBAC role that may get and sync the application, then run argocd account generate-token with that account, or open Settings > Accounts, select the account, then Tokens > Generate New in the Argo CD UI, and copy the token.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the Argo CD card.
- Name the secret and choose who can use it.
- Fill in API token.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to Argo CD with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah checks that each value has the right shape, but does not call Argo CD: the result reads Format checked — Argo CD was not called. The first real check is when an agent uses it.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: token.
Tell the agent in your task description which secret to use, for example “use the Argo CD secret org/argocd”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Argo CD once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Argo CD's side too, revoke or delete the key at Argo CD.
Limitations
- An Argo CD server reachable only on a private network cannot be used: use a script deploy target instead.
- The Test checks the token's shape only; the first deploy is the live check.
- Jaah waits up to 60 minutes for the application to report Healthy at the commit.
- Agents can do only what the connected Argo CD account allows.
Troubleshooting
The deploy fails with Argo CD refused the sync: HTTP 401
The token expired or was revoked. Generate a new one for the account and select Replace on the secret.
The deploy fails with Argo CD refused the sync: HTTP 403
The account's RBAC role may not sync this application. Grant it applications, sync and get on the application's project.
The deploy fails with This address is not public
The Argo CD server resolves to a private address. Expose it over https, or use a script deploy target that runs argocd app sync from the node.
Still stuck? Select Test and read the result: it names the first value that is missing or not in the shape Argo CD uses. It does not call Argo CD, so Argo CD's own errors show only in the agent's session.
FAQ
Does Jaah change the application's settings?
No. It asks Argo CD to sync the application to one commit and reads its status; nothing else is changed.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one Argo CD account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.