CRD name
template for new CRD reference pages
Copy this template to create a new CRD reference page.
- Replace the variable text in metadata with information for this page
- Delete these instructions from your file
- Populate the page with appropriate content
Synopsis
apiVersion: <library>
kind: <kind>
metadata:
name: <name>
spec:
...
Fields
Fields should be clearly marked as to whether they are required or optional. If they are optional, text should explain the behavior when that field is not populated.
Usage
Examples
Include code snippets that illustrate how this resource is populated. Code examples should use be embedded links to example source code so that they will be updated automatically when changes are made to the example.
Files
- Link to subsection for this resource in the “API Reference”
Differences between versions
See also
- Links to related reference pages
- Links to related User Guides and other documentation
Last modified 2023-11-14: docs: brief info about contributing ref pages (#2446) (910b43ae)