search

carvel-dev / kapp-controller

Continuous delivery and package management for Kubernetes.
https://carvel.dev/kapp-controller
Apache License 2.0
267 stars 102 forks source link

Determine if ytt schema errors are user friendly in context of kapp-controller #312

Open danielhelfand opened 3 years ago

danielhelfand commented 3 years ago

One question that came up in the Carvel community meeting is what ytt schema errors look like when seen via a PackageInstall/App status. We do not currently have any testing in place for ytt schemas with kapp-controller so it might be worthwhile to add error case tests to assess if the UX is consumable for users. It would also be helpful to manually view statuses to assess if the information is easy to follow when errors happen.

More on schemas in docs here: https://carvel.dev/ytt/docs/latest/how-to-write-schema/#docs

One particular issue I was wondering about is what if there are many schema validation errors? Would all of that information be overwhelming to users?

Acceptance Criteria

  1. A brief summary of the UX with any proposed changes that we should consider.
  2. If the changes are small, feel free to implement them as part of this story. If the changes are large, please create an issue so that we can schedule the work.
danielhelfand commented 3 years ago

cc @jorgemoralespou

jorgemoralespou commented 3 years ago

Related #311?

danielhelfand commented 2 years ago

Noting for this issue that we may want to consider investigating other ytt errors as well.

cppforlife commented 2 years ago

cc @pivotaljohn

pivotaljohn commented 2 years ago

I guess it depends on how those error messages are viewed. If kctrl prints such error messages, interpreting escape characters (like \n), might be just great.

Bigger picture, folks in ytt have talked about providing a structured output for error messages as well, separating the content of the messages from their format. But we've had our hands full enough that it hasn't made sense to (yet) invest further into the needs, there.