-
Task
-
Resolution: Unresolved
-
Major
-
None
-
None
-
False
-
-
False
-
ToDo
-
-
Sprint 216
We've observed that whiteout files are confusing to early crane users. Often
we get the question "what is a whiteout file and how do I use them?" and
"what is the purpose of a whiteout file"?
Good example of the purpose is for derived resources and explaining that
child resources such as ReplicaSets and Pods of a parent Deployment should
not be applied to a target cluster, but instead we should allow the target
cluster's controllers to recreate these resources.
Additionally, these files are hidden files. A user that is unfamiliar with the
tool naturally runs an `ls` cmd on the transfer command's output, and they
never see them, so it's confusing that they only see a subset of files that
correspond with their raw exported files (while in fact there are many whiteout
files that are hidden). Perhaps it would be better to actually not make these
whiteout files hidden, but instead store them in a dedicated directory such as
"whiteout/" in order to make that more clear.