github.com/alex123012/deckhouse-controller-tools@v0.0.0-20230510090815-d594daf1af8c/pkg/crd/markers/zz_generated.markerhelp.go (about) 1 //go:build !ignore_autogenerated 2 // +build !ignore_autogenerated 3 4 /* 5 Copyright2019 The Kubernetes Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 */ 19 20 // Code generated by helpgen. DO NOT EDIT. 21 22 package markers 23 24 import ( 25 "sigs.k8s.io/controller-tools/pkg/markers" 26 ) 27 28 func (DeckhouseDocDefault) Help() *markers.DefinitionHelp { 29 return &markers.DefinitionHelp{ 30 Category: "CRD", 31 DetailedHelp: markers.DetailedHelp{ 32 Summary: "configures the additional x-doc-default field for property with default value for deckhouse documentation.", 33 Details: "", 34 }, 35 FieldHelp: map[string]markers.DetailedHelp{ 36 "Value": { 37 Summary: "", 38 Details: "", 39 }, 40 }, 41 } 42 } 43 44 func (DeckhouseDocExample) Help() *markers.DefinitionHelp { 45 return &markers.DefinitionHelp{ 46 Category: "CRD", 47 DetailedHelp: markers.DetailedHelp{ 48 Summary: "DeckhouseDocDefault configures the additional x-doc-example field for property with example usage for deckhouse documentation.", 49 Details: "", 50 }, 51 FieldHelp: map[string]markers.DetailedHelp{ 52 "Value": { 53 Summary: "", 54 Details: "", 55 }, 56 }, 57 } 58 } 59 60 func (Default) Help() *markers.DefinitionHelp { 61 return &markers.DefinitionHelp{ 62 Category: "CRD validation", 63 DetailedHelp: markers.DetailedHelp{ 64 Summary: "sets the default value for this field. ", 65 Details: "A default value will be accepted as any value valid for the field. Formatting for common types include: boolean: `true`, string: `Cluster`, numerical: `1.24`, array: `{1,2}`, object: `{policy: \"delete\"}`). Defaults should be defined in pruned form, and only best-effort validation will be performed. Full validation of a default requires submission of the containing CRD to an apiserver.", 66 }, 67 FieldHelp: map[string]markers.DetailedHelp{ 68 "Value": { 69 Summary: "", 70 Details: "", 71 }, 72 }, 73 } 74 } 75 76 func (DeprecatedVersion) Help() *markers.DefinitionHelp { 77 return &markers.DefinitionHelp{ 78 Category: "CRD", 79 DetailedHelp: markers.DetailedHelp{ 80 Summary: "marks this version as deprecated.", 81 Details: "", 82 }, 83 FieldHelp: map[string]markers.DetailedHelp{ 84 "Warning": { 85 Summary: "message to be shown on the deprecated version", 86 Details: "", 87 }, 88 }, 89 } 90 } 91 92 func (Enum) Help() *markers.DefinitionHelp { 93 return &markers.DefinitionHelp{ 94 Category: "CRD validation", 95 DetailedHelp: markers.DetailedHelp{ 96 Summary: "specifies that this (scalar) field is restricted to the *exact* values specified here.", 97 Details: "", 98 }, 99 FieldHelp: map[string]markers.DetailedHelp{}, 100 } 101 } 102 103 func (Example) Help() *markers.DefinitionHelp { 104 return &markers.DefinitionHelp{ 105 Category: "CRD validation", 106 DetailedHelp: markers.DetailedHelp{ 107 Summary: "sets the example value for this field. ", 108 Details: "An example value will be accepted as any value valid for the field. Formatting for common types include: boolean: `true`, string: `Cluster`, numerical: `1.24`, array: `{1,2}`, object: `{policy: \"delete\"}`). Examples should be defined in pruned form, and only best-effort validation will be performed. Full validation of an example requires submission of the containing CRD to an apiserver.", 109 }, 110 FieldHelp: map[string]markers.DetailedHelp{ 111 "Value": { 112 Summary: "", 113 Details: "", 114 }, 115 }, 116 } 117 } 118 119 func (ExclusiveMaximum) Help() *markers.DefinitionHelp { 120 return &markers.DefinitionHelp{ 121 Category: "CRD validation", 122 DetailedHelp: markers.DetailedHelp{ 123 Summary: "indicates that the maximum is \"up to\" but not including that value.", 124 Details: "", 125 }, 126 FieldHelp: map[string]markers.DetailedHelp{}, 127 } 128 } 129 130 func (ExclusiveMinimum) Help() *markers.DefinitionHelp { 131 return &markers.DefinitionHelp{ 132 Category: "CRD validation", 133 DetailedHelp: markers.DetailedHelp{ 134 Summary: "indicates that the minimum is \"up to\" but not including that value.", 135 Details: "", 136 }, 137 FieldHelp: map[string]markers.DetailedHelp{}, 138 } 139 } 140 141 func (Format) Help() *markers.DefinitionHelp { 142 return &markers.DefinitionHelp{ 143 Category: "CRD validation", 144 DetailedHelp: markers.DetailedHelp{ 145 Summary: "specifies additional \"complex\" formatting for this field. ", 146 Details: "For example, a date-time field would be marked as \"type: string\" and \"format: date-time\".", 147 }, 148 FieldHelp: map[string]markers.DetailedHelp{}, 149 } 150 } 151 152 func (ListMapKey) Help() *markers.DefinitionHelp { 153 return &markers.DefinitionHelp{ 154 Category: "CRD processing", 155 DetailedHelp: markers.DetailedHelp{ 156 Summary: "specifies the keys to map listTypes. ", 157 Details: "It indicates the index of a map list. They can be repeated if multiple keys must be used. It can only be used when ListType is set to map, and the keys should be scalar types.", 158 }, 159 FieldHelp: map[string]markers.DetailedHelp{}, 160 } 161 } 162 163 func (ListType) Help() *markers.DefinitionHelp { 164 return &markers.DefinitionHelp{ 165 Category: "CRD processing", 166 DetailedHelp: markers.DetailedHelp{ 167 Summary: "specifies the type of data-structure that the list represents (map, set, atomic). ", 168 Details: "Possible data-structure types of a list are: \n - \"map\": it needs to have a key field, which will be used to build an associative list. A typical example is a the pod container list, which is indexed by the container name. \n - \"set\": Fields need to be \"scalar\", and there can be only one occurrence of each. \n - \"atomic\": All the fields in the list are treated as a single value, are typically manipulated together by the same actor.", 169 }, 170 FieldHelp: map[string]markers.DetailedHelp{}, 171 } 172 } 173 174 func (MapType) Help() *markers.DefinitionHelp { 175 return &markers.DefinitionHelp{ 176 Category: "CRD processing", 177 DetailedHelp: markers.DetailedHelp{ 178 Summary: "specifies the level of atomicity of the map; i.e. whether each item in the map is independent of the others, or all fields are treated as a single unit. ", 179 Details: "Possible values: \n - \"granular\": items in the map are independent of each other, and can be manipulated by different actors. This is the default behavior. \n - \"atomic\": all fields are treated as one unit. Any changes have to replace the entire map.", 180 }, 181 FieldHelp: map[string]markers.DetailedHelp{}, 182 } 183 } 184 185 func (MaxItems) Help() *markers.DefinitionHelp { 186 return &markers.DefinitionHelp{ 187 Category: "CRD validation", 188 DetailedHelp: markers.DetailedHelp{ 189 Summary: "specifies the maximum length for this list.", 190 Details: "", 191 }, 192 FieldHelp: map[string]markers.DetailedHelp{}, 193 } 194 } 195 196 func (MaxLength) Help() *markers.DefinitionHelp { 197 return &markers.DefinitionHelp{ 198 Category: "CRD validation", 199 DetailedHelp: markers.DetailedHelp{ 200 Summary: "specifies the maximum length for this string.", 201 Details: "", 202 }, 203 FieldHelp: map[string]markers.DetailedHelp{}, 204 } 205 } 206 207 func (MaxProperties) Help() *markers.DefinitionHelp { 208 return &markers.DefinitionHelp{ 209 Category: "CRD validation", 210 DetailedHelp: markers.DetailedHelp{ 211 Summary: "restricts the number of keys in an object", 212 Details: "", 213 }, 214 FieldHelp: map[string]markers.DetailedHelp{}, 215 } 216 } 217 218 func (Maximum) Help() *markers.DefinitionHelp { 219 return &markers.DefinitionHelp{ 220 Category: "CRD validation", 221 DetailedHelp: markers.DetailedHelp{ 222 Summary: "specifies the maximum numeric value that this field can have.", 223 Details: "", 224 }, 225 FieldHelp: map[string]markers.DetailedHelp{}, 226 } 227 } 228 229 func (Metadata) Help() *markers.DefinitionHelp { 230 return &markers.DefinitionHelp{ 231 Category: "CRD", 232 DetailedHelp: markers.DetailedHelp{ 233 Summary: "configures the additional annotations or labels for this CRD. For example adding annotation \"api-approved.kubernetes.io\" for a CRD with Kubernetes groups, or annotation \"cert-manager.io/inject-ca-from-secret\" for a CRD that needs CA injection.", 234 Details: "", 235 }, 236 FieldHelp: map[string]markers.DetailedHelp{ 237 "Annotations": { 238 Summary: "will be added into the annotations of this CRD.", 239 Details: "", 240 }, 241 "Labels": { 242 Summary: "will be added into the labels of this CRD.", 243 Details: "", 244 }, 245 }, 246 } 247 } 248 249 func (MinItems) Help() *markers.DefinitionHelp { 250 return &markers.DefinitionHelp{ 251 Category: "CRD validation", 252 DetailedHelp: markers.DetailedHelp{ 253 Summary: "specifies the minimum length for this list.", 254 Details: "", 255 }, 256 FieldHelp: map[string]markers.DetailedHelp{}, 257 } 258 } 259 260 func (MinLength) Help() *markers.DefinitionHelp { 261 return &markers.DefinitionHelp{ 262 Category: "CRD validation", 263 DetailedHelp: markers.DetailedHelp{ 264 Summary: "specifies the minimum length for this string.", 265 Details: "", 266 }, 267 FieldHelp: map[string]markers.DetailedHelp{}, 268 } 269 } 270 271 func (MinProperties) Help() *markers.DefinitionHelp { 272 return &markers.DefinitionHelp{ 273 Category: "CRD validation", 274 DetailedHelp: markers.DetailedHelp{ 275 Summary: "restricts the number of keys in an object", 276 Details: "", 277 }, 278 FieldHelp: map[string]markers.DetailedHelp{}, 279 } 280 } 281 282 func (Minimum) Help() *markers.DefinitionHelp { 283 return &markers.DefinitionHelp{ 284 Category: "CRD validation", 285 DetailedHelp: markers.DetailedHelp{ 286 Summary: "specifies the minimum numeric value that this field can have. Negative numbers are supported.", 287 Details: "", 288 }, 289 FieldHelp: map[string]markers.DetailedHelp{}, 290 } 291 } 292 293 func (MultipleOf) Help() *markers.DefinitionHelp { 294 return &markers.DefinitionHelp{ 295 Category: "CRD validation", 296 DetailedHelp: markers.DetailedHelp{ 297 Summary: "specifies that this field must have a numeric value that's a multiple of this one.", 298 Details: "", 299 }, 300 FieldHelp: map[string]markers.DetailedHelp{}, 301 } 302 } 303 304 func (Nullable) Help() *markers.DefinitionHelp { 305 return &markers.DefinitionHelp{ 306 Category: "CRD validation", 307 DetailedHelp: markers.DetailedHelp{ 308 Summary: "marks this field as allowing the \"null\" value. ", 309 Details: "This is often not necessary, but may be helpful with custom serialization.", 310 }, 311 FieldHelp: map[string]markers.DetailedHelp{}, 312 } 313 } 314 315 func (OneOf) Help() *markers.DefinitionHelp { 316 return &markers.DefinitionHelp{ 317 Category: "CRD", 318 DetailedHelp: markers.DetailedHelp{ 319 Summary: "configures file name and variable name at package level that will be used to generate oneOf CRD field. for Example, for comment deckhouse:one:of=./cronjob_types.go=OneOfCRD generator will search in package root for file ./cronjob_types.go and declared variable \"OneOfCRD\" in it ", 320 Details: "file: ./cronjob_types.go: \n package api \n import ( metav1 \"k8s.io/apimachinery/pkg/apis/meta/v1\" ) \n const OneOfCRD = ` - required: [layout] properties: layout: enum: [Standard] - required: [layout] properties: layout: enum: [WithoutNAT] masterNodeGroup: properties: instanceClass: type: object properties: disableExternalIP: enum: [false] \n ` \n const \"OneOfCRD\" would be parsed to oneOf field of CRD as it is", 321 }, 322 FieldHelp: map[string]markers.DetailedHelp{}, 323 } 324 } 325 326 func (Pattern) Help() *markers.DefinitionHelp { 327 return &markers.DefinitionHelp{ 328 Category: "CRD validation", 329 DetailedHelp: markers.DetailedHelp{ 330 Summary: "specifies that this string must match the given regular expression.", 331 Details: "", 332 }, 333 FieldHelp: map[string]markers.DetailedHelp{}, 334 } 335 } 336 337 func (PrintColumn) Help() *markers.DefinitionHelp { 338 return &markers.DefinitionHelp{ 339 Category: "CRD", 340 DetailedHelp: markers.DetailedHelp{ 341 Summary: "adds a column to \"kubectl get\" output for this CRD.", 342 Details: "", 343 }, 344 FieldHelp: map[string]markers.DetailedHelp{ 345 "Name": { 346 Summary: "specifies the name of the column.", 347 Details: "", 348 }, 349 "Type": { 350 Summary: "indicates the type of the column. ", 351 Details: "It may be any OpenAPI data type listed at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types.", 352 }, 353 "JSONPath": { 354 Summary: "specifies the jsonpath expression used to extract the value of the column.", 355 Details: "", 356 }, 357 "Description": { 358 Summary: "specifies the help/description for this column.", 359 Details: "", 360 }, 361 "Format": { 362 Summary: "specifies the format of the column. ", 363 Details: "It may be any OpenAPI data format corresponding to the type, listed at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types.", 364 }, 365 "Priority": { 366 Summary: "indicates how important it is that this column be displayed. ", 367 Details: "Lower priority (*higher* numbered) columns will be hidden if the terminal width is too small.", 368 }, 369 }, 370 } 371 } 372 373 func (Resource) Help() *markers.DefinitionHelp { 374 return &markers.DefinitionHelp{ 375 Category: "CRD", 376 DetailedHelp: markers.DetailedHelp{ 377 Summary: "configures naming and scope for a CRD.", 378 Details: "", 379 }, 380 FieldHelp: map[string]markers.DetailedHelp{ 381 "Path": { 382 Summary: "specifies the plural \"resource\" for this CRD. ", 383 Details: "It generally corresponds to a plural, lower-cased version of the Kind. See https://book.kubebuilder.io/cronjob-tutorial/gvks.html.", 384 }, 385 "ShortName": { 386 Summary: "specifies aliases for this CRD. ", 387 Details: "Short names are often used when people have work with your resource over and over again. For instance, \"rs\" for \"replicaset\" or \"crd\" for customresourcedefinition.", 388 }, 389 "Categories": { 390 Summary: "specifies which group aliases this resource is part of. ", 391 Details: "Group aliases are used to work with groups of resources at once. The most common one is \"all\" which covers about a third of the base resources in Kubernetes, and is generally used for \"user-facing\" resources.", 392 }, 393 "Singular": { 394 Summary: "overrides the singular form of your resource. ", 395 Details: "The singular form is otherwise defaulted off the plural (path).", 396 }, 397 "Scope": { 398 Summary: "overrides the scope of the CRD (Cluster vs Namespaced). ", 399 Details: "Scope defaults to \"Namespaced\". Cluster-scoped (\"Cluster\") resources don't exist in namespaces.", 400 }, 401 }, 402 } 403 } 404 405 func (Schemaless) Help() *markers.DefinitionHelp { 406 return &markers.DefinitionHelp{ 407 Category: "CRD validation", 408 DetailedHelp: markers.DetailedHelp{ 409 Summary: "marks a field as being a schemaless object. ", 410 Details: "Schemaless objects are not introspected, so you must provide any type and validation information yourself. One use for this tag is for embedding fields that hold JSONSchema typed objects. Because this field disables all type checking, it is recommended to be used only as a last resort.", 411 }, 412 FieldHelp: map[string]markers.DetailedHelp{}, 413 } 414 } 415 416 func (SkipVersion) Help() *markers.DefinitionHelp { 417 return &markers.DefinitionHelp{ 418 Category: "CRD", 419 DetailedHelp: markers.DetailedHelp{ 420 Summary: "removes the particular version of the CRD from the CRDs spec. ", 421 Details: "This is useful if you need to skip generating and listing version entries for 'internal' resource versions, which typically exist if using the Kubernetes upstream conversion-gen tool.", 422 }, 423 FieldHelp: map[string]markers.DetailedHelp{}, 424 } 425 } 426 427 func (StorageVersion) Help() *markers.DefinitionHelp { 428 return &markers.DefinitionHelp{ 429 Category: "CRD", 430 DetailedHelp: markers.DetailedHelp{ 431 Summary: "marks this version as the \"storage version\" for the CRD for conversion. ", 432 Details: "When conversion is enabled for a CRD (i.e. it's not a trivial-versions/single-version CRD), one version is set as the \"storage version\" to be stored in etcd. Attempting to store any other version will result in conversion to the storage version via a conversion webhook.", 433 }, 434 FieldHelp: map[string]markers.DetailedHelp{}, 435 } 436 } 437 438 func (StructType) Help() *markers.DefinitionHelp { 439 return &markers.DefinitionHelp{ 440 Category: "CRD processing", 441 DetailedHelp: markers.DetailedHelp{ 442 Summary: "specifies the level of atomicity of the struct; i.e. whether each field in the struct is independent of the others, or all fields are treated as a single unit. ", 443 Details: "Possible values: \n - \"granular\": fields in the struct are independent of each other, and can be manipulated by different actors. This is the default behavior. \n - \"atomic\": all fields are treated as one unit. Any changes have to replace the entire struct.", 444 }, 445 FieldHelp: map[string]markers.DetailedHelp{}, 446 } 447 } 448 449 func (SubresourceScale) Help() *markers.DefinitionHelp { 450 return &markers.DefinitionHelp{ 451 Category: "CRD", 452 DetailedHelp: markers.DetailedHelp{ 453 Summary: "enables the \"/scale\" subresource on a CRD.", 454 Details: "", 455 }, 456 FieldHelp: map[string]markers.DetailedHelp{ 457 "SpecPath": { 458 Summary: "specifies the jsonpath to the replicas field for the scale's spec.", 459 Details: "", 460 }, 461 "StatusPath": { 462 Summary: "specifies the jsonpath to the replicas field for the scale's status.", 463 Details: "", 464 }, 465 "SelectorPath": { 466 Summary: "specifies the jsonpath to the pod label selector field for the scale's status. ", 467 Details: "The selector field must be the *string* form (serialized form) of a selector. Setting a pod label selector is necessary for your type to work with the HorizontalPodAutoscaler.", 468 }, 469 }, 470 } 471 } 472 473 func (SubresourceStatus) Help() *markers.DefinitionHelp { 474 return &markers.DefinitionHelp{ 475 Category: "CRD", 476 DetailedHelp: markers.DetailedHelp{ 477 Summary: "enables the \"/status\" subresource on a CRD.", 478 Details: "", 479 }, 480 FieldHelp: map[string]markers.DetailedHelp{}, 481 } 482 } 483 484 func (Type) Help() *markers.DefinitionHelp { 485 return &markers.DefinitionHelp{ 486 Category: "CRD validation", 487 DetailedHelp: markers.DetailedHelp{ 488 Summary: "overrides the type for this field (which defaults to the equivalent of the Go type). ", 489 Details: "This generally must be paired with custom serialization. For example, the metav1.Time field would be marked as \"type: string\" and \"format: date-time\".", 490 }, 491 FieldHelp: map[string]markers.DetailedHelp{}, 492 } 493 } 494 495 func (UniqueItems) Help() *markers.DefinitionHelp { 496 return &markers.DefinitionHelp{ 497 Category: "CRD validation", 498 DetailedHelp: markers.DetailedHelp{ 499 Summary: "specifies that all items in this list must be unique.", 500 Details: "", 501 }, 502 FieldHelp: map[string]markers.DetailedHelp{}, 503 } 504 } 505 506 func (UnservedVersion) Help() *markers.DefinitionHelp { 507 return &markers.DefinitionHelp{ 508 Category: "CRD", 509 DetailedHelp: markers.DetailedHelp{ 510 Summary: "does not serve this version. ", 511 Details: "This is useful if you need to drop support for a version in favor of a newer version.", 512 }, 513 FieldHelp: map[string]markers.DetailedHelp{}, 514 } 515 } 516 517 func (XEmbeddedResource) Help() *markers.DefinitionHelp { 518 return &markers.DefinitionHelp{ 519 Category: "CRD validation", 520 DetailedHelp: markers.DetailedHelp{ 521 Summary: "EmbeddedResource marks a fields as an embedded resource with apiVersion, kind and metadata fields. ", 522 Details: "An embedded resource is a value that has apiVersion, kind and metadata fields. They are validated implicitly according to the semantics of the currently running apiserver. It is not necessary to add any additional schema for these field, yet it is possible. This can be combined with PreserveUnknownFields.", 523 }, 524 FieldHelp: map[string]markers.DetailedHelp{}, 525 } 526 } 527 528 func (XIntOrString) Help() *markers.DefinitionHelp { 529 return &markers.DefinitionHelp{ 530 Category: "CRD validation", 531 DetailedHelp: markers.DetailedHelp{ 532 Summary: "IntOrString marks a fields as an IntOrString. ", 533 Details: "This is required when applying patterns or other validations to an IntOrString field. Knwon information about the type is applied during the collapse phase and as such is not normally available during marker application.", 534 }, 535 FieldHelp: map[string]markers.DetailedHelp{}, 536 } 537 } 538 539 func (XPreserveUnknownFields) Help() *markers.DefinitionHelp { 540 return &markers.DefinitionHelp{ 541 Category: "CRD processing", 542 DetailedHelp: markers.DetailedHelp{ 543 Summary: "PreserveUnknownFields stops the apiserver from pruning fields which are not specified. ", 544 Details: "By default the apiserver drops unknown fields from the request payload during the decoding step. This marker stops the API server from doing so. It affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. \n NB: The kubebuilder:validation:XPreserveUnknownFields variant is deprecated in favor of the kubebuilder:pruning:PreserveUnknownFields variant. They function identically.", 545 }, 546 FieldHelp: map[string]markers.DetailedHelp{}, 547 } 548 } 549 550 func (XValidation) Help() *markers.DefinitionHelp { 551 return &markers.DefinitionHelp{ 552 Category: "CRD validation", 553 DetailedHelp: markers.DetailedHelp{ 554 Summary: "marks a field as requiring a value for which a given expression evaluates to true. ", 555 Details: "This marker may be repeated to specify multiple expressions, all of which must evaluate to true.", 556 }, 557 FieldHelp: map[string]markers.DetailedHelp{ 558 "Rule": { 559 Summary: "", 560 Details: "", 561 }, 562 "Message": { 563 Summary: "", 564 Details: "", 565 }, 566 }, 567 } 568 }