62 lines
2.7 KiB
Go
62 lines
2.7 KiB
Go
// +build !ignore_autogenerated
|
|
|
|
/*
|
|
Copyright2019 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
// Code generated by helpgen. DO NOT EDIT.
|
|
|
|
package crd
|
|
|
|
import (
|
|
"sigs.k8s.io/controller-tools/pkg/markers"
|
|
)
|
|
|
|
func (Generator) Help() *markers.DefinitionHelp {
|
|
return &markers.DefinitionHelp{
|
|
Category: "",
|
|
DetailedHelp: markers.DetailedHelp{
|
|
Summary: "generates CustomResourceDefinition objects.",
|
|
Details: "",
|
|
},
|
|
FieldHelp: map[string]markers.DetailedHelp{
|
|
"TrivialVersions": {
|
|
Summary: "indicates that we should produce a single-version CRD. ",
|
|
Details: "Single \"trivial-version\" CRDs are compatible with older (pre 1.13) Kubernetes API servers. The storage version's schema will be used as the CRD's schema. \n Only works with the v1beta1 CRD version.",
|
|
},
|
|
"PreserveUnknownFields": {
|
|
Summary: "indicates whether or not we should turn off pruning. ",
|
|
Details: "Left unspecified, it'll default to true when only a v1beta1 CRD is generated (to preserve compatibility with older versions of this tool), or false otherwise. \n It's required to be false for v1 CRDs.",
|
|
},
|
|
"AllowDangerousTypes": {
|
|
Summary: "allows types which are usually omitted from CRD generation because they are not recommended. ",
|
|
Details: "Currently the following additional types are allowed when this is true: float32 float64 \n Left unspecified, the default is false",
|
|
},
|
|
"MaxDescLen": {
|
|
Summary: "specifies the maximum description length for fields in CRD's OpenAPI schema. ",
|
|
Details: "0 indicates drop the description for all fields completely. n indicates limit the description to at most n characters and truncate the description to closest sentence boundary if it exceeds n characters.",
|
|
},
|
|
"CRDVersions": {
|
|
Summary: "specifies the target API versions of the CRD type itself to generate. Defaults to v1. ",
|
|
Details: "The first version listed will be assumed to be the \"default\" version and will not get a version suffix in the output filename. \n You'll need to use \"v1\" to get support for features like defaulting, along with an API server that supports it (Kubernetes 1.16+).",
|
|
},
|
|
"GenerateEmbeddedObjectMeta": {
|
|
Summary: "specifies if any embedded ObjectMeta in the CRD should be generated",
|
|
Details: "",
|
|
},
|
|
},
|
|
}
|
|
}
|