...

Source file src/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1/doc.go

Documentation: k8s.io/kube-aggregator/pkg/apis/apiregistration/v1

     1  /*
     2  Copyright 2016 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // +k8s:deepcopy-gen=package
    18  // +k8s:protobuf-gen=package
    19  // +k8s:conversion-gen=k8s.io/kube-aggregator/pkg/apis/apiregistration
    20  // +k8s:openapi-gen=true
    21  // +groupName=apiregistration.k8s.io
    22  // +k8s:defaulter-gen=TypeMeta
    23  
    24  // Package v1 contains the API Registration API, which is responsible for
    25  // registering an API `Group`/`Version` with another kubernetes like API server.
    26  // The `APIService` holds information about the other API server in
    27  // `APIServiceSpec` type as well as general `TypeMeta` and `ObjectMeta`. The
    28  // `APIServiceSpec` type have the main configuration needed to do the
    29  // aggregation. Any request coming for specified `Group`/`Version` will be
    30  // directed to the service defined by `ServiceReference` (on port 443) after
    31  // validating the target using provided `CABundle` or skipping validation
    32  // if development flag `InsecureSkipTLSVerify` is set. `Priority` is controlling
    33  // the order of this API group in the overall discovery document.
    34  // The return status is a set of conditions for this aggregation. Currently
    35  // there is only one condition named "Available", if true, it means the
    36  // api/server requests will be redirected to specified API server.
    37  package v1 // import "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
    38  

View as plain text