Merge pull request #89093 from robscott/ingressclass-params-docs

Removing ConfigMap as suggestion for IngressClass parameters
This commit is contained in:
Kubernetes Prow Robot 2020-03-13 04:24:39 -07:00 committed by GitHub
commit bce16df824
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 14 deletions

View File

@ -11883,7 +11883,7 @@
}, },
"parameters": { "parameters": {
"$ref": "#/definitions/io.k8s.api.core.v1.TypedLocalObjectReference", "$ref": "#/definitions/io.k8s.api.core.v1.TypedLocalObjectReference",
"description": "Parameters is a link to a resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. Example configuration resources include `core.ConfigMap` or a controller specific Custom Resource." "description": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters."
} }
}, },
"type": "object" "type": "object"

View File

@ -297,10 +297,9 @@ type IngressClassSpec struct {
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
Controller string Controller string
// Parameters is a link to a resource containing additional configuration // Parameters is a link to a custom resource containing additional
// for the controller. This is optional if the controller does not require // configuration for the controller. This is optional if the controller does
// extra parameters. Example configuration resources include // not require extra parameters.
// `core.ConfigMap` or a controller specific Custom Resource.
// +optional // +optional
Parameters *api.TypedLocalObjectReference Parameters *api.TypedLocalObjectReference
} }

View File

@ -148,10 +148,9 @@ message IngressClassSpec {
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
optional string controller = 1; optional string controller = 1;
// Parameters is a link to a resource containing additional configuration // Parameters is a link to a custom resource containing additional
// for the controller. This is optional if the controller does not require // configuration for the controller. This is optional if the controller does
// extra parameters. Example configuration resources include // not require extra parameters.
// `core.ConfigMap` or a controller specific Custom Resource.
// +optional // +optional
optional k8s.io.api.core.v1.TypedLocalObjectReference parameters = 2; optional k8s.io.api.core.v1.TypedLocalObjectReference parameters = 2;
} }

View File

@ -298,10 +298,9 @@ type IngressClassSpec struct {
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"` Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"`
// Parameters is a link to a resource containing additional configuration // Parameters is a link to a custom resource containing additional
// for the controller. This is optional if the controller does not require // configuration for the controller. This is optional if the controller does
// extra parameters. Example configuration resources include // not require extra parameters.
// `core.ConfigMap` or a controller specific Custom Resource.
// +optional // +optional
Parameters *v1.TypedLocalObjectReference `json:"parameters,omitempty" protobuf:"bytes,2,opt,name=parameters"` Parameters *v1.TypedLocalObjectReference `json:"parameters,omitempty" protobuf:"bytes,2,opt,name=parameters"`
} }

View File

@ -92,7 +92,7 @@ func (IngressClassList) SwaggerDoc() map[string]string {
var map_IngressClassSpec = map[string]string{ var map_IngressClassSpec = map[string]string{
"": "IngressClassSpec provides information about the class of an Ingress.", "": "IngressClassSpec provides information about the class of an Ingress.",
"controller": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", "controller": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
"parameters": "Parameters is a link to a resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. Example configuration resources include `core.ConfigMap` or a controller specific Custom Resource.", "parameters": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.",
} }
func (IngressClassSpec) SwaggerDoc() map[string]string { func (IngressClassSpec) SwaggerDoc() map[string]string {