Skip to content

Commit

Permalink
correlate docs delegate setups details to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigo-roca committed Oct 22, 2024
1 parent 227c818 commit 873d356
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions src/commands/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,7 @@ datadog-ci deployment mark --env prod --service payment-service --revision v1.1.
The `correlate` command connects a GitOps deployment with the CI pipeline of the application repository. Once they are connected, you can see in Datadog's UI which pipeline
triggered a deployment, and which deployments were triggered by a pipeline.

**Important**: This command does not work for every setup. Refer to [when to call the command](#When-to-call-the-command) for more details.

#### When to call the command

In order for the command to work properly, it needs to be called between when the configuration changes are committed and when they are pushed to the configuration repository (where the Kubernetes manifests are). The flow should be similar to the following:

1. Make the changes to the configuration (for example, update a image tag).
2. Run `git commit -m "update kubernetes configuration"`.
3. Run `datadog-ci deployment correlate --provider <cd_provider>` (refer to the command syntax below).
4. Run `git push`.

If you are using [argo cd image updater][3], this command does not work since it relies on making the changes using `git commit`.

Again, these steps need to happen in your CI since the end goal of this command is to correlate the pipeline doing the configuration changes
with the associated deployments.
**Important**: This command does not work for every setup. Refer to the [documentation][3] for more details.

For example:
```bash
Expand All @@ -73,4 +59,4 @@ Additional helpful documentation, links, and articles:

[1]: https://docs.datadoghq.com/continuous_delivery/deployments/ciproviders
[2]: https://docs.datadoghq.com/continuous_delivery/
[3]: https://argocd-image-updater.readthedocs.io/en/stable/
[3]: https://docs.datadoghq.com/continuous_delivery/deployments/argocd#correlate-deployments-with-ci-pipelines

0 comments on commit 873d356

Please sign in to comment.