Argo-cd: Store more commit metadata in application revision history
The application revision history contains commit sha which was used during deployment. In addition, to the commit sha it is useful to persist more metadata such as:
- commit author
- tags associated with the commit
The metadata will be visible in Argo CD UI and should help user to understand what was deployed.
alexmt
All 17 comments
Working.
alexec
on 17 Jun 2019
@alexmt I'm adding author and message, but not tags (harder), any reason for tags?
alexec
on 17 Jun 2019
@alexmojo, @narg95 , @code0x58 - thoughts?
alexec
on 17 Jun 2019
Before First Sync
After First Sync
Sync Status
History
alexec
on 17 Jun 2019
So, regarding the solution, we have two options
(a) Store the meta-data when we execute. This impacts the spec, adding fields that would be null for older apps.
(b) Get the data as needed via an API call.
This needs to be considered alongside these questions:
(i) Do you want to see the data in the application panel (as per "After First Sync" above)
(ii) Do you need to see it when you select an item open the application history & rollback panel (see below)? Or do you need to see if for every item?
alexec
on 18 Jun 2019
Finally, what is actually needed/wanted?
x) Author
y) Message
z) Tags
alexec
on 18 Jun 2019
Does it make sense to simply link to the commit in git/github? commit message can be very verbose in some situation and might make the UI harder to display. And since git is already showing all that info, open in a new tab/window might be enough for the use-case.
In our case we have CI doing the commit and the message contains a lot of information about the generation of that commit so a link would have been enough for most of our needs.
this would mean different "links" for each git hosting solution (github, gitlab)...
jpbelanger-mtl
on 18 Jun 2019
We are using a different repo for the helm chart, that contains all the app of the team. So one repo has many helm chart from different code repo. The Deploy process is to change to docker image tag and sync.
It would be nice to have the message in the history (so we can add in the message the commit from the original code repo). And it would be helpful to see it on all the items (and after the first sync), but in this trade-off getting it from the API is better.
OmerKahani
on 18 Jun 2019
This is very useful and will provide much better at-a-glance visibility into deployments and history. I look forward to this feature being released.
okapoor
on 19 Jun 2019
App Page
History Page
Tooltip For More Info
alexec
on 20 Jun 2019
@jpbelanger-mtl I think your idea is neat. How would you deal with private repos?
alexec
on 20 Jun 2019
at the repo CRD definition I would add a addition parameters with replaceable variables:
ie:
revisionLink: https://github.com/argoproj/argo-cd/commit/${revision}
tagLink: https://github.com/argoproj/argo-cd/tree/${tag}
That would probably fit most private repo that accept the revision/tag in the url.
So it would be optional that you define or not. And remove the logic of maintaining all the cloud provider config in argo-cd
jpbelanger-mtl
on 20 Jun 2019
I've realised that this works really well when there's one app in a repo, but when there are multiple apps, then the commit and it's related author and message will most likely relate to another app.
In this scenario, this data becomes deceptive - a human needs to take a look and make a decision.
Another option would be to verify that the commit refers to files within the path.
Hmmm...
alexec
on 21 Jun 2019
That is very true. and unless you start doing some git tree scan to get the latest commit of the folder/file that the argoApp relates to, it will be hard to actually show something that is context based.
But then that's not different from the current commit "hash" shown. It's the commit of the whole repo.
jpbelanger-mtl
on 21 Jun 2019
A bit late to the conversation :)
In my case our deployments are tagged based, so I had the need to check
also the tags associated to that commit.
That is great!
You are making a great job !
On Sat, Jun 22, 2019 at 12:51 AM Alex Collins notifications@github.com
wrote:
Closed #1219 https://github.com/argoproj/argo-cd/issues/1219 via #1762
https://github.com/argoproj/argo-cd/pull/1762.—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/argoproj/argo-cd/issues/1219?email_source=notifications&email_token=ABU573UZEPJMBFONJYMGQ3LP3VLQRA5CNFSM4G3VDEVKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGOSDXU5DQ#event-2431602318,
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABU573TXMHPUQGVSUQ3F3EDP3VLQRANCNFSM4G3VDEVA
.
narg95
on 24 Jun 2019
It's a really useful feature when do rollback! :-} Sometimes, It would be great if argo-rollouts' status(steps?) is displayed in histories.
anarcher
on 25 Jun 2019
@dthomson25 ☝️ rollouts comment.
alexec
on 25 Jun 2019
Related issues
jl431
·
18Comments
storm1kk
·
20Comments
afanrasool
·
26Comments
tschonnie
·
31Comments
alexmt
·
18Comments
Most helpful comment
Does it make sense to simply link to the commit in git/github? commit message can be very verbose in some situation and might make the UI harder to display. And since git is already showing all that info, open in a new tab/window might be enough for the use-case.
In our case we have CI doing the commit and the message contains a lot of information about the generation of that commit so a link would have been enough for most of our needs.
this would mean different "links" for each git hosting solution (github, gitlab)...