Kustomize documentation from command line

[m_sigismondi]

Hi guys,

does anyone know if there is a way to check the documentation for the Kustomization resource from the command line?

I mean something similar to oc / kubectl explain to check features like configMapGenerator or patchesStrategicMerge.

This would be extremely useful during exams which include Kustomize.

Thank you,

Marco

[Chetan_Tiwary_]

Hello @m_sigismondi ! 

Please see this if it helps : https://kubectl.docs.kubernetes.io/references/kustomize/cmd/help/ 

[m_sigismondi]

Hi @Chetan_Tiwary_ ,

thank you for your suggestion but I'm afraid would not help since is not guaranteed that kustomize command is installed and oc kustomize --help gives a different set of options. 

My concern is about having documentation during EX280 exam.

Marco

[Chetan_Tiwary_]

Hello @m_sigismondi AFAIK - the necessary documentation is provided during exam - however please reach out to exam support if they can provide concrete info to your query :

https://rhtapps.redhat.com/comments 

[atcorduneanu]

From a quick look, it doesn't seem that the official Red Hat OpenShift product documentation has a section on how to write a kustomization.yaml file.

There is documentation about it on kubernetes.io, sometimes the upstream docs are included in exams, is this the case?

[atcorduneanu · Accepted solution]

For whoever may find themselves in the same situation.

Sometimes when necessary you can also find documentation of the upstream project, available offline in an exam environment.
In the case of Kustomize, at the latest version of the do280 course (for openShift 4.14), the OpenShift product documentation does not list any feature of kustomize nor its resource file.
This is also the case (it seems to me) of the official Kubernetes documentation.

The only complete, I would say source of truth, for everything Kustomize, is the documentation of the upstream project kubectl and it seems we don't have an equivalent in  the OpenShift product documentation for oc.

It seems like a defect that need be healed in the product documentation.
I would still expect (it is my opinion, not a fact) to find the upstream documentation for kubectl, available offline in the exam environment.
If this is not the case, this endpoint in the kubectl docs is what I will use to exercise so that the file structure of the Kustomization resource enters my muscular memory.