---

title: {{or .Metadata.Title "CRD Reference"}}

draft: false

weight: {{or .Metadata.Weight 100 }}

{{- if .Metadata.Description}}

description: {{.Metadata.Description}}

{{- end}}

---

Packages:

{{range .Groups}}

- [{{.Group}}/{{.Version}}](#{{ anchorize (printf "%s/%s" .Group .Version) }})

{{- end -}}{{/* range .Groups */}}

{{- range .Groups }}

{{- $group := . }}

<h1 id="{{ anchorize (printf "%s/%s" .Group .Version) }}">{{.Group}}/{{.Version}}</h1>

Resource Types:

{{range .Kinds}}

- [{{.Name}}](#{{ anchorize .Name }})

{{end}}{{/* range .Kinds */}}

{{range .Kinds}}

{{$kind := .}}

<h2 id="{{ anchorize .Name }}">{{.Name}}</h2>

{{range .Types}}

{{if not .IsTopLevel}}

<h3 id="{{ anchorize .Name }}">

{{.Name}}

{{if .ParentKey}}^{^{<a href="#{{.ParentKey}}">↩ Parent</a>}}{{end}}

</h3>

{{end}}

{{.Description}}

<table>

<thead>

<tr>

<th>Name</th>

<th>Type</th>

<th>Description</th>

<th>Required</th>

</tr>

</thead>

<tbody>

{{- if .IsTopLevel -}}

<tr>

<td><b>apiVersion</b></td>

<td>string</td>

<td>{{$group.Group}}/{{$group.Version}}</td>

<td>true</td>

</tr>

<tr>

<td><b>kind</b></td>

<td>string</td>

<td>{{$kind.Name}}</td>

<td>true</td>

</tr>

<tr>

<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#objectmeta-v1-meta">metadata</a></b></td>

<td>object</td>

<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>

<td>true</td>

</tr>

{{- end -}}

{{- range .Fields -}}

<tr>

<td><b>{{if .TypeKey}}<a href="#{{.TypeKey}}">{{.Name}}</a>{{else}}{{.Name}}{{end}}</b></td>

<td>{{.Type}}</td>

<td>{{.Description}}</td>

<td>{{.Required}}</td>

</tr>

{{- end -}}

</tbody>

</table>

{{- end}}{{/* range .Types */}}

{{- end}}{{/* range .Kinds */}}

{{- end}}{{/* range .Groups */}}