github.com/christarazi/controller-tools@v0.3.1-0.20210907042920-aa94049173f8/pkg/crd/markers/zz_generated.markerhelp.go (about)

     1  // +build !ignore_autogenerated
     2  
     3  /*
     4  Copyright2019 The Kubernetes Authors.
     5  
     6  Licensed under the Apache License, Version 2.0 (the "License");
     7  you may not use this file except in compliance with the License.
     8  You may obtain a copy of the License at
     9  
    10      http://www.apache.org/licenses/LICENSE-2.0
    11  
    12  Unless required by applicable law or agreed to in writing, software
    13  distributed under the License is distributed on an "AS IS" BASIS,
    14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    15  See the License for the specific language governing permissions and
    16  limitations under the License.
    17  */
    18  
    19  // Code generated by helpgen. DO NOT EDIT.
    20  
    21  package markers
    22  
    23  import (
    24  	"sigs.k8s.io/controller-tools/pkg/markers"
    25  )
    26  
    27  func (Default) Help() *markers.DefinitionHelp {
    28  	return &markers.DefinitionHelp{
    29  		Category: "CRD validation",
    30  		DetailedHelp: markers.DetailedHelp{
    31  			Summary: "sets the default value for this field. ",
    32  			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.",
    33  		},
    34  		FieldHelp: map[string]markers.DetailedHelp{
    35  			"Value": markers.DetailedHelp{
    36  				Summary: "",
    37  				Details: "",
    38  			},
    39  		},
    40  	}
    41  }
    42  
    43  func (Enum) Help() *markers.DefinitionHelp {
    44  	return &markers.DefinitionHelp{
    45  		Category: "CRD validation",
    46  		DetailedHelp: markers.DetailedHelp{
    47  			Summary: "specifies that this (scalar) field is restricted to the *exact* values specified here.",
    48  			Details: "",
    49  		},
    50  		FieldHelp: map[string]markers.DetailedHelp{},
    51  	}
    52  }
    53  
    54  func (ExclusiveMaximum) Help() *markers.DefinitionHelp {
    55  	return &markers.DefinitionHelp{
    56  		Category: "CRD validation",
    57  		DetailedHelp: markers.DetailedHelp{
    58  			Summary: "indicates that the maximum is \"up to\" but not including that value.",
    59  			Details: "",
    60  		},
    61  		FieldHelp: map[string]markers.DetailedHelp{},
    62  	}
    63  }
    64  
    65  func (ExclusiveMinimum) Help() *markers.DefinitionHelp {
    66  	return &markers.DefinitionHelp{
    67  		Category: "CRD validation",
    68  		DetailedHelp: markers.DetailedHelp{
    69  			Summary: "indicates that the minimum is \"up to\" but not including that value.",
    70  			Details: "",
    71  		},
    72  		FieldHelp: map[string]markers.DetailedHelp{},
    73  	}
    74  }
    75  
    76  func (Format) Help() *markers.DefinitionHelp {
    77  	return &markers.DefinitionHelp{
    78  		Category: "CRD validation",
    79  		DetailedHelp: markers.DetailedHelp{
    80  			Summary: "specifies additional \"complex\" formatting for this field. ",
    81  			Details: "For example, a date-time field would be marked as \"type: string\" and \"format: date-time\".",
    82  		},
    83  		FieldHelp: map[string]markers.DetailedHelp{},
    84  	}
    85  }
    86  
    87  func (ListMapKey) Help() *markers.DefinitionHelp {
    88  	return &markers.DefinitionHelp{
    89  		Category: "CRD processing",
    90  		DetailedHelp: markers.DetailedHelp{
    91  			Summary: "specifies the keys to map listTypes. ",
    92  			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.",
    93  		},
    94  		FieldHelp: map[string]markers.DetailedHelp{},
    95  	}
    96  }
    97  
    98  func (ListType) Help() *markers.DefinitionHelp {
    99  	return &markers.DefinitionHelp{
   100  		Category: "CRD processing",
   101  		DetailedHelp: markers.DetailedHelp{
   102  			Summary: "specifies the type of data-structure that the list represents (map, set, atomic). ",
   103  			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.",
   104  		},
   105  		FieldHelp: map[string]markers.DetailedHelp{},
   106  	}
   107  }
   108  
   109  func (MapType) Help() *markers.DefinitionHelp {
   110  	return &markers.DefinitionHelp{
   111  		Category: "CRD processing",
   112  		DetailedHelp: markers.DetailedHelp{
   113  			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. ",
   114  			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.",
   115  		},
   116  		FieldHelp: map[string]markers.DetailedHelp{},
   117  	}
   118  }
   119  
   120  func (MaxItems) Help() *markers.DefinitionHelp {
   121  	return &markers.DefinitionHelp{
   122  		Category: "CRD validation",
   123  		DetailedHelp: markers.DetailedHelp{
   124  			Summary: "specifies the maximum length for this list.",
   125  			Details: "",
   126  		},
   127  		FieldHelp: map[string]markers.DetailedHelp{},
   128  	}
   129  }
   130  
   131  func (MaxLength) Help() *markers.DefinitionHelp {
   132  	return &markers.DefinitionHelp{
   133  		Category: "CRD validation",
   134  		DetailedHelp: markers.DetailedHelp{
   135  			Summary: "specifies the maximum length for this string.",
   136  			Details: "",
   137  		},
   138  		FieldHelp: map[string]markers.DetailedHelp{},
   139  	}
   140  }
   141  
   142  func (Maximum) Help() *markers.DefinitionHelp {
   143  	return &markers.DefinitionHelp{
   144  		Category: "CRD validation",
   145  		DetailedHelp: markers.DetailedHelp{
   146  			Summary: "specifies the maximum numeric value that this field can have.",
   147  			Details: "",
   148  		},
   149  		FieldHelp: map[string]markers.DetailedHelp{},
   150  	}
   151  }
   152  
   153  func (MinItems) Help() *markers.DefinitionHelp {
   154  	return &markers.DefinitionHelp{
   155  		Category: "CRD validation",
   156  		DetailedHelp: markers.DetailedHelp{
   157  			Summary: "specifies the minimun length for this list.",
   158  			Details: "",
   159  		},
   160  		FieldHelp: map[string]markers.DetailedHelp{},
   161  	}
   162  }
   163  
   164  func (MinLength) Help() *markers.DefinitionHelp {
   165  	return &markers.DefinitionHelp{
   166  		Category: "CRD validation",
   167  		DetailedHelp: markers.DetailedHelp{
   168  			Summary: "specifies the minimum length for this string.",
   169  			Details: "",
   170  		},
   171  		FieldHelp: map[string]markers.DetailedHelp{},
   172  	}
   173  }
   174  
   175  func (Minimum) Help() *markers.DefinitionHelp {
   176  	return &markers.DefinitionHelp{
   177  		Category: "CRD validation",
   178  		DetailedHelp: markers.DetailedHelp{
   179  			Summary: "specifies the minimum numeric value that this field can have.",
   180  			Details: "",
   181  		},
   182  		FieldHelp: map[string]markers.DetailedHelp{},
   183  	}
   184  }
   185  
   186  func (MultipleOf) Help() *markers.DefinitionHelp {
   187  	return &markers.DefinitionHelp{
   188  		Category: "CRD validation",
   189  		DetailedHelp: markers.DetailedHelp{
   190  			Summary: "specifies that this field must have a numeric value that's a multiple of this one.",
   191  			Details: "",
   192  		},
   193  		FieldHelp: map[string]markers.DetailedHelp{},
   194  	}
   195  }
   196  
   197  func (Nullable) Help() *markers.DefinitionHelp {
   198  	return &markers.DefinitionHelp{
   199  		Category: "CRD validation",
   200  		DetailedHelp: markers.DetailedHelp{
   201  			Summary: "marks this field as allowing the \"null\" value. ",
   202  			Details: "This is often not necessary, but may be helpful with custom serialization.",
   203  		},
   204  		FieldHelp: map[string]markers.DetailedHelp{},
   205  	}
   206  }
   207  
   208  func (Pattern) Help() *markers.DefinitionHelp {
   209  	return &markers.DefinitionHelp{
   210  		Category: "CRD validation",
   211  		DetailedHelp: markers.DetailedHelp{
   212  			Summary: "specifies that this string must match the given regular expression.",
   213  			Details: "",
   214  		},
   215  		FieldHelp: map[string]markers.DetailedHelp{},
   216  	}
   217  }
   218  
   219  func (PrintColumn) Help() *markers.DefinitionHelp {
   220  	return &markers.DefinitionHelp{
   221  		Category: "CRD",
   222  		DetailedHelp: markers.DetailedHelp{
   223  			Summary: "adds a column to \"kubectl get\" output for this CRD.",
   224  			Details: "",
   225  		},
   226  		FieldHelp: map[string]markers.DetailedHelp{
   227  			"Name": markers.DetailedHelp{
   228  				Summary: "specifies the name of the column.",
   229  				Details: "",
   230  			},
   231  			"Type": markers.DetailedHelp{
   232  				Summary: "indicates the type of the column. ",
   233  				Details: "It may be any OpenAPI data type listed at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types.",
   234  			},
   235  			"JSONPath": markers.DetailedHelp{
   236  				Summary: "specifies the jsonpath expression used to extract the value of the column.",
   237  				Details: "",
   238  			},
   239  			"Description": markers.DetailedHelp{
   240  				Summary: "specifies the help/description for this column.",
   241  				Details: "",
   242  			},
   243  			"Format": markers.DetailedHelp{
   244  				Summary: "specifies the format of the column. ",
   245  				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.",
   246  			},
   247  			"Priority": markers.DetailedHelp{
   248  				Summary: "indicates how important it is that this column be displayed. ",
   249  				Details: "Lower priority (*higher* numbered) columns will be hidden if the terminal width is too small.",
   250  			},
   251  		},
   252  	}
   253  }
   254  
   255  func (Resource) Help() *markers.DefinitionHelp {
   256  	return &markers.DefinitionHelp{
   257  		Category: "CRD",
   258  		DetailedHelp: markers.DetailedHelp{
   259  			Summary: "configures naming and scope for a CRD.",
   260  			Details: "",
   261  		},
   262  		FieldHelp: map[string]markers.DetailedHelp{
   263  			"Path": markers.DetailedHelp{
   264  				Summary: "specifies the plural \"resource\" for this CRD. ",
   265  				Details: "It generally corresponds to a plural, lower-cased version of the Kind. See https://book.kubebuilder.io/cronjob-tutorial/gvks.html.",
   266  			},
   267  			"ShortName": markers.DetailedHelp{
   268  				Summary: "specifies aliases for this CRD. ",
   269  				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.",
   270  			},
   271  			"Categories": markers.DetailedHelp{
   272  				Summary: "specifies which group aliases this resource is part of. ",
   273  				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.",
   274  			},
   275  			"Singular": markers.DetailedHelp{
   276  				Summary: "overrides the singular form of your resource. ",
   277  				Details: "The singular form is otherwise defaulted off the plural (path).",
   278  			},
   279  			"Scope": markers.DetailedHelp{
   280  				Summary: "overrides the scope of the CRD (Cluster vs Namespaced). ",
   281  				Details: "Scope defaults to \"Namespaced\".  Cluster-scoped (\"Cluster\") resources don't exist in namespaces.",
   282  			},
   283  		},
   284  	}
   285  }
   286  
   287  func (SkipVersion) Help() *markers.DefinitionHelp {
   288  	return &markers.DefinitionHelp{
   289  		Category: "CRD",
   290  		DetailedHelp: markers.DetailedHelp{
   291  			Summary: "removes the particular version of the CRD from the CRDs spec. ",
   292  			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.",
   293  		},
   294  		FieldHelp: map[string]markers.DetailedHelp{},
   295  	}
   296  }
   297  
   298  func (StorageVersion) Help() *markers.DefinitionHelp {
   299  	return &markers.DefinitionHelp{
   300  		Category: "CRD",
   301  		DetailedHelp: markers.DetailedHelp{
   302  			Summary: "marks this version as the \"storage version\" for the CRD for conversion. ",
   303  			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.",
   304  		},
   305  		FieldHelp: map[string]markers.DetailedHelp{},
   306  	}
   307  }
   308  
   309  func (StructType) Help() *markers.DefinitionHelp {
   310  	return &markers.DefinitionHelp{
   311  		Category: "CRD processing",
   312  		DetailedHelp: markers.DetailedHelp{
   313  			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. ",
   314  			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.",
   315  		},
   316  		FieldHelp: map[string]markers.DetailedHelp{},
   317  	}
   318  }
   319  
   320  func (SubresourceScale) Help() *markers.DefinitionHelp {
   321  	return &markers.DefinitionHelp{
   322  		Category: "CRD",
   323  		DetailedHelp: markers.DetailedHelp{
   324  			Summary: "enables the \"/scale\" subresource on a CRD.",
   325  			Details: "",
   326  		},
   327  		FieldHelp: map[string]markers.DetailedHelp{
   328  			"SpecPath": markers.DetailedHelp{
   329  				Summary: "specifies the jsonpath to the replicas field for the scale's spec.",
   330  				Details: "",
   331  			},
   332  			"StatusPath": markers.DetailedHelp{
   333  				Summary: "specifies the jsonpath to the replicas field for the scale's status.",
   334  				Details: "",
   335  			},
   336  			"SelectorPath": markers.DetailedHelp{
   337  				Summary: "specifies the jsonpath to the pod label selector field for the scale's status. ",
   338  				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.",
   339  			},
   340  		},
   341  	}
   342  }
   343  
   344  func (SubresourceStatus) Help() *markers.DefinitionHelp {
   345  	return &markers.DefinitionHelp{
   346  		Category: "CRD",
   347  		DetailedHelp: markers.DetailedHelp{
   348  			Summary: "enables the \"/status\" subresource on a CRD.",
   349  			Details: "",
   350  		},
   351  		FieldHelp: map[string]markers.DetailedHelp{},
   352  	}
   353  }
   354  
   355  func (Type) Help() *markers.DefinitionHelp {
   356  	return &markers.DefinitionHelp{
   357  		Category: "CRD validation",
   358  		DetailedHelp: markers.DetailedHelp{
   359  			Summary: "overrides the type for this field (which defaults to the equivalent of the Go type). ",
   360  			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\".",
   361  		},
   362  		FieldHelp: map[string]markers.DetailedHelp{},
   363  	}
   364  }
   365  
   366  func (UniqueItems) Help() *markers.DefinitionHelp {
   367  	return &markers.DefinitionHelp{
   368  		Category: "CRD validation",
   369  		DetailedHelp: markers.DetailedHelp{
   370  			Summary: "specifies that all items in this list must be unique.",
   371  			Details: "",
   372  		},
   373  		FieldHelp: map[string]markers.DetailedHelp{},
   374  	}
   375  }
   376  
   377  func (UnservedVersion) Help() *markers.DefinitionHelp {
   378  	return &markers.DefinitionHelp{
   379  		Category: "CRD",
   380  		DetailedHelp: markers.DetailedHelp{
   381  			Summary: "does not serve this version. ",
   382  			Details: "This is useful if you need to drop support for a version in favor of a newer version.",
   383  		},
   384  		FieldHelp: map[string]markers.DetailedHelp{},
   385  	}
   386  }
   387  
   388  func (TopLevelDesc) Help() *markers.DefinitionHelp {
   389  	return &markers.DefinitionHelp{
   390  		Category: "CRD",
   391  		DetailedHelp: markers.DetailedHelp{
   392  			Summary: "specifies that a top-level description field will be added to the validation schema.",
   393  			Details: "This is useful for CRDs that want a top-level description field to describe the resource.",
   394  		},
   395  		FieldHelp: map[string]markers.DetailedHelp{},
   396  	}
   397  }
   398  
   399  func (XEmbeddedResource) Help() *markers.DefinitionHelp {
   400  	return &markers.DefinitionHelp{
   401  		Category: "CRD validation",
   402  		DetailedHelp: markers.DetailedHelp{
   403  			Summary: "EmbeddedResource marks a fields as an embedded resource with apiVersion, kind and metadata fields. ",
   404  			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.",
   405  		},
   406  		FieldHelp: map[string]markers.DetailedHelp{},
   407  	}
   408  }
   409  
   410  func (XPreserveUnknownFields) Help() *markers.DefinitionHelp {
   411  	return &markers.DefinitionHelp{
   412  		Category: "CRD processing",
   413  		DetailedHelp: markers.DetailedHelp{
   414  			Summary: "PreserveUnknownFields stops the apiserver from pruning fields which are not specified. ",
   415  			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.",
   416  		},
   417  		FieldHelp: map[string]markers.DetailedHelp{},
   418  	}
   419  }