search

carvel-dev / kapp

kapp is a simple deployment tool focused on the concept of "Kubernetes application" — a set of resources with the same label
https://carvel.dev/kapp
Apache License 2.0
922 stars 110 forks source link

Diff UI explains how to read it #580

Open mamachanko opened 2 years ago

mamachanko commented 2 years ago

Describe the problem/challenge you have

The content of the Diff UI --diff-ui-alpha of kapp 0.52.0 is super helpful, but not intuitive to read.

Describe the solution you'd like

@kumaritanushree explained to me how to read it. I really liked her explanation and now I understand it better. Maybe it could be helpful to add a similar explanation to the Diff UI's page itself.

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible" 👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

rohitagg2020 commented 2 years ago

Thanks @mamachanko for pointing it out. --diff-ui-alpha is an advanced feature. We will see how to enrich the command/documentation to add more context.

mamachanko commented 2 years ago

Actually, now that I am looking at it again, I don't think that the existing explanation that is displayed by the Diff UI is lacking per se. But I say that after I have grokked it.

Changes are sorted in order that they will be applied. They will be applied in parallel within their group. Each change lists other changes that it will wait for before being applied.

praveenrewar commented 2 years ago

Actually, now that I am looking at it again, I don't think that the existing explanation that is displayed by the Diff UI is lacking per se. But I say that after I have grokked it.

💯 I had faced the same issue initially, but once I understood the working of it, the statement "Changes are sorted ..." made complete sense to me.

I think that we can add an example in the docs and add a link to that example along with the explanation on the ui. Even though this is an advanced feature, it definitely helps into getting some insights into how kapp orders changes.

renuy commented 2 years ago
  1. Enhance diff-ui-alpha to explaining the output
  2. Alternatively, add documentation around this feature.
mamachanko commented 2 years ago

Even though this is an advanced feature

I understand that --diff-ui-alpha is considered off the happy path, but when things aren't happy it can safe your life day. Like it did for me last week. I could not explain why the installation of TAP waited forever until I checked the Diff UI. And, indeed, the SecretExport with the registry credentials was upserted after TAP's PackageInstall. I would never have figured that out.