...

Source file src/github.com/openshift/api/kubecontrolplane/v1/zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/kubecontrolplane/v1

     1  package v1
     2  
     3  // This file contains a collection of methods that can be used from go-restful to
     4  // generate Swagger API documentation for its models. Please read this PR for more
     5  // information on the implementation: https://github.com/emicklei/go-restful/pull/215
     6  //
     7  // TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if
     8  // they are on one line! For multiple line or blocks that you want to ignore use ---.
     9  // Any context after a --- is ignored.
    10  //
    11  // Those methods can be generated by using hack/update-swagger-docs.sh
    12  
    13  // AUTO-GENERATED FUNCTIONS START HERE
    14  var map_AggregatorConfig = map[string]string{
    15  	"":                "AggregatorConfig holds information required to make the aggregator function.",
    16  	"proxyClientInfo": "proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers",
    17  }
    18  
    19  func (AggregatorConfig) SwaggerDoc() map[string]string {
    20  	return map_AggregatorConfig
    21  }
    22  
    23  var map_KubeAPIServerConfig = map[string]string{
    24  	"":                             "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
    25  	"authConfig":                   "authConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
    26  	"aggregatorConfig":             "aggregatorConfig has options for configuring the aggregator component of the API server.",
    27  	"kubeletClientInfo":            "kubeletClientInfo contains information about how to connect to kubelets",
    28  	"servicesSubnet":               "servicesSubnet is the subnet to use for assigning service IPs",
    29  	"servicesNodePortRange":        "servicesNodePortRange is the range to use for assigning service public ports on a host.",
    30  	"consolePublicURL":             "DEPRECATED: consolePublicURL has been deprecated and setting it has no effect.",
    31  	"userAgentMatchingConfig":      "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled.  THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
    32  	"imagePolicyConfig":            "imagePolicyConfig feeds the image policy admission plugin",
    33  	"projectConfig":                "projectConfig feeds an admission plugin",
    34  	"serviceAccountPublicKeyFiles": "serviceAccountPublicKeyFiles is a list of files, each containing a PEM-encoded public RSA key. (If any file contains a private key, the public portion of the key is used) The list of public keys is used to verify presented service account tokens. Each key is tried in order until the list is exhausted or verification succeeds. If no keys are specified, no service account authentication will be available.",
    35  	"oauthConfig":                  "oauthConfig, if present start the /oauth endpoint in this process",
    36  }
    37  
    38  func (KubeAPIServerConfig) SwaggerDoc() map[string]string {
    39  	return map_KubeAPIServerConfig
    40  }
    41  
    42  var map_KubeAPIServerImagePolicyConfig = map[string]string{
    43  	"internalRegistryHostname":  "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. For backward compatibility, users can still use OPENSHIFT_DEFAULT_REGISTRY environment variable but this setting overrides the environment variable.",
    44  	"externalRegistryHostnames": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
    45  }
    46  
    47  func (KubeAPIServerImagePolicyConfig) SwaggerDoc() map[string]string {
    48  	return map_KubeAPIServerImagePolicyConfig
    49  }
    50  
    51  var map_KubeAPIServerProjectConfig = map[string]string{
    52  	"defaultNodeSelector": "defaultNodeSelector holds default project node label selector",
    53  }
    54  
    55  func (KubeAPIServerProjectConfig) SwaggerDoc() map[string]string {
    56  	return map_KubeAPIServerProjectConfig
    57  }
    58  
    59  var map_KubeControllerManagerConfig = map[string]string{
    60  	"":                   "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
    61  	"serviceServingCert": "serviceServingCert provides support for the old alpha service serving cert signer CA bundle",
    62  	"projectConfig":      "projectConfig is an optimization for the daemonset controller",
    63  	"extendedArguments":  "extendedArguments is used to configure the kube-controller-manager",
    64  }
    65  
    66  func (KubeControllerManagerConfig) SwaggerDoc() map[string]string {
    67  	return map_KubeControllerManagerConfig
    68  }
    69  
    70  var map_KubeControllerManagerProjectConfig = map[string]string{
    71  	"defaultNodeSelector": "defaultNodeSelector holds default project node label selector",
    72  }
    73  
    74  func (KubeControllerManagerProjectConfig) SwaggerDoc() map[string]string {
    75  	return map_KubeControllerManagerProjectConfig
    76  }
    77  
    78  var map_KubeletConnectionInfo = map[string]string{
    79  	"":     "KubeletConnectionInfo holds information necessary for connecting to a kubelet",
    80  	"port": "port is the port to connect to kubelets on",
    81  	"ca":   "ca is the CA for verifying TLS connections to kubelets",
    82  }
    83  
    84  func (KubeletConnectionInfo) SwaggerDoc() map[string]string {
    85  	return map_KubeletConnectionInfo
    86  }
    87  
    88  var map_MasterAuthConfig = map[string]string{
    89  	"":                           "MasterAuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
    90  	"requestHeader":              "requestHeader holds options for setting up a front proxy against the API.  It is optional.",
    91  	"webhookTokenAuthenticators": "webhookTokenAuthenticators, if present configures remote token reviewers",
    92  	"oauthMetadataFile":          "oauthMetadataFile is a path to a file containing the discovery endpoint for OAuth 2.0 Authorization Server Metadata for an external OAuth server. See IETF Draft: // https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This option is mutually exclusive with OAuthConfig",
    93  }
    94  
    95  func (MasterAuthConfig) SwaggerDoc() map[string]string {
    96  	return map_MasterAuthConfig
    97  }
    98  
    99  var map_RequestHeaderAuthenticationOptions = map[string]string{
   100  	"":                    "RequestHeaderAuthenticationOptions provides options for setting up a front proxy against the entire API instead of against the /oauth endpoint.",
   101  	"clientCA":            "clientCA is a file with the trusted signer certs.  It is required.",
   102  	"clientCommonNames":   "clientCommonNames is a required list of common names to require a match from.",
   103  	"usernameHeaders":     "usernameHeaders is the list of headers to check for user information.  First hit wins.",
   104  	"groupHeaders":        "groupHeaders is the set of headers to check for group information.  All are unioned.",
   105  	"extraHeaderPrefixes": "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.",
   106  }
   107  
   108  func (RequestHeaderAuthenticationOptions) SwaggerDoc() map[string]string {
   109  	return map_RequestHeaderAuthenticationOptions
   110  }
   111  
   112  var map_ServiceServingCert = map[string]string{
   113  	"":         "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.",
   114  	"certFile": "CertFile is a file containing a PEM-encoded certificate",
   115  }
   116  
   117  func (ServiceServingCert) SwaggerDoc() map[string]string {
   118  	return map_ServiceServingCert
   119  }
   120  
   121  var map_UserAgentDenyRule = map[string]string{
   122  	"":                 "UserAgentDenyRule adds a rejection message that can be used to help a user figure out how to get an approved client",
   123  	"rejectionMessage": "RejectionMessage is the message shown when rejecting a client.  If it is not a set, the default message is used.",
   124  }
   125  
   126  func (UserAgentDenyRule) SwaggerDoc() map[string]string {
   127  	return map_UserAgentDenyRule
   128  }
   129  
   130  var map_UserAgentMatchRule = map[string]string{
   131  	"":          "UserAgentMatchRule describes how to match a given request based on User-Agent and HTTPVerb",
   132  	"regex":     "regex is a regex that is checked against the User-Agent. Known variants of oc clients 1. oc accessing kube resources: oc/v1.2.0 (linux/amd64) kubernetes/bc4550d 2. oc accessing openshift resources: oc/v1.1.3 (linux/amd64) openshift/b348c2f 3. openshift kubectl accessing kube resources:  openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 4. openshift kubectl accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f 5. oadm accessing kube resources: oadm/v1.2.0 (linux/amd64) kubernetes/bc4550d 6. oadm accessing openshift resources: oadm/v1.1.3 (linux/amd64) openshift/b348c2f 7. openshift cli accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f",
   133  	"httpVerbs": "httpVerbs specifies which HTTP verbs should be matched.  An empty list means \"match all verbs\".",
   134  }
   135  
   136  func (UserAgentMatchRule) SwaggerDoc() map[string]string {
   137  	return map_UserAgentMatchRule
   138  }
   139  
   140  var map_UserAgentMatchingConfig = map[string]string{
   141  	"":                        "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled.  THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
   142  	"requiredClients":         "requiredClients if this list is non-empty, then a User-Agent must match one of the UserAgentRegexes to be allowed",
   143  	"deniedClients":           "deniedClients if this list is non-empty, then a User-Agent must not match any of the UserAgentRegexes",
   144  	"defaultRejectionMessage": "defaultRejectionMessage is the message shown when rejecting a client.  If it is not a set, a generic message is given.",
   145  }
   146  
   147  func (UserAgentMatchingConfig) SwaggerDoc() map[string]string {
   148  	return map_UserAgentMatchingConfig
   149  }
   150  
   151  var map_WebhookTokenAuthenticator = map[string]string{
   152  	"":           "WebhookTokenAuthenticators holds the necessary configuation options for external token authenticators",
   153  	"configFile": "configFile is a path to a Kubeconfig file with the webhook configuration",
   154  	"cacheTTL":   "cacheTTL indicates how long an authentication result should be cached. It takes a valid time duration string (e.g. \"5m\"). If empty, you get a default timeout of 2 minutes. If zero (e.g. \"0m\"), caching is disabled",
   155  }
   156  
   157  func (WebhookTokenAuthenticator) SwaggerDoc() map[string]string {
   158  	return map_WebhookTokenAuthenticator
   159  }
   160  
   161  // AUTO-GENERATED FUNCTIONS END HERE
   162  

View as plain text