Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shini4i/argo-compare
A comparison tool for displaying the differences between ArgoCD Applications in different Git branches
https://github.com/shini4i/argo-compare
argocd argocd-application diff gitops
Last synced: 3 months ago
JSON representation
A comparison tool for displaying the differences between ArgoCD Applications in different Git branches
- Host: GitHub
- URL: https://github.com/shini4i/argo-compare
- Owner: shini4i
- License: mit
- Created: 2022-09-15T15:44:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T16:00:57.000Z (4 months ago)
- Last Synced: 2024-07-09T20:19:09.194Z (4 months ago)
- Topics: argocd, argocd-application, diff, gitops
- Language: Go
- Homepage:
- Size: 242 KB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-argo - argo-compare
README
# Argo Compare
A comparison tool for displaying the differences between applications in different Git branches
[](https://codecov.io/gh/shini4i/argo-compare)
[](https://goreportcard.com/report/github.com/shini4i/argo-compare)
Example output of `argo-compare` with `diff-so-fancy`
## General information
This tool will show what would be changed in the manifests rendered by helm after changes to the specific Application
are merged into the target branch.
### How to install
The binary can be installed using homebrew:
```bash
brew install shini4i/tap/argo-compare
```
### How to use
The simplest usage scenario is to compare all changed files in the current branch with the target branch:
```bash
argo-compare branch
```
If you want to compare only specific file, you can use the `--file` flag:
```bash
argo-compare branch --file
```
By default, argo-compare will print only changed files content, but if this behavior is not desired, you can use one of the following flags:
```bash
# In addition to the changed files, it will print all added manifests
argo-compare branch --print-added-manifests
# In addition to the changed files, it will print all removed manifests
argo-compare branch --print-removed-manifests
# Print all changed, added and removed manifests
argo-compare branch --full-output
```
To use an external diff tool, you can set `EXTERNAL_DIFF_TOOL` environment variable. Each file diff will be passed in a pipe to the external tool.
```bash
EXTERNAL_DIFF_TOOL=diff-so-fancy argo-compare branch
```
Additionally, you can try this tool using docker container:
```bash
docker run -it --mount type=bind,source="$(pwd)",target=/apps --env EXTERNAL_DIFF_TOOL=diff-so-fancy --workdir /apps ghcr.io/shini4i/argo-compare: branch --full-output
```
#### Password Protected Repositories
Using password protected repositories is a bit more challenging. To make it work, we need to expose JSON as an environment variable.
The JSON should contain the following fields:
```json
{
"url": "https://charts.example.com",
"username": "username",
"password": "password"
}
```
How to properly expose it depends on the specific use case.
A bash example:
```bash
export REPO_CREDS_EXAMPLE={\"url\":\"https://charts.example.com\",\"username\":\"username\",\"password\":\"password\"}
```
Where `EXAMPLE` is an identifier that is not used by the application.
Argo Compare will look for all `REPO_CREDS_*` environment variables and use them if `url` will match the `repoURL` from Application manifest.
## How it works
1) First, this tool will check which files are changed compared to the files in the target branch.
2) It will get the content of the changed Application files from the target branch.
3) It will render manifests using the helm template using source and target branch values.
4) It will get rid of helm related labels as they are not important for the comparison. (It can be skipped by providing `--preserve-helm-labels` flag)
5) As the last step, it will compare rendered manifest from the source and destination branches and print the
difference.
## Current limitations
- Works only with Applications that are using helm repositories and helm values present in the Application yaml.
- Does not support password protected repositories.
## Roadmap
- [ ] Add support for Application using git as a source of helm chart
- [x] Add support for providing credentials for password protected helm repositories
- [ ] Add support for posting diff as a comment to PR (GitHub)/MR(GitLab)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.