In this documentation, we will show how to check the detailed schema of a given capability (i.e. component type or trait).
This may sound challenging because every capability is a "plug-in" in KubeVela (even for the built-in ones), also, it's by design that KubeVela allows platform administrators to modify the capability templates at any time. In this case, do we need to manually write documentation for every newly installed capability? And how can we ensure those documentations for the system is up-to-date?
Actually, as a important part of its "extensibility" design, KubeVela will always automatically generate reference documentation for every workload type or trait registered in your Kubernetes cluster, based on the template in its definition of course. This feature works for any capability: either built-in ones or your own workload types/traits.
Thus, as an end user, the only thing you need to do is:
This command will automatically open the reference documentation for given component type or trait in your default browser.
$ vela show webservice --web as example. The detailed schema documentation for
Web Service component type will show up immediately as below:
Note that there's in the section named
Specification, it even provides you with a full sample for the usage of this workload type with a fake name
Similarly, we can also do
$ vela show autoscale:
With these auto-generated reference documentations, we could easily complete the application description by simple copy-paste, for example:
This reference doc feature also works for terminal-only case. For example:
Note that for all the built-in capabilities, we already published their reference docs below based on the same doc generation mechanism.