sigs.k8s.io/cluster-api@v1.7.1/controlplane/kubeadm/internal/proxy/proxy.go (about)

     1  /*
     2  Copyright 2020 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  package proxy
    18  
    19  import (
    20  	"time"
    21  
    22  	"k8s.io/client-go/rest"
    23  )
    24  
    25  // Proxy defines the API server port-forwarded proxy.
    26  type Proxy struct {
    27  
    28  	// Kind is the kind of Kubernetes resource
    29  	Kind string
    30  
    31  	// Namespace is the namespace in which the Kubernetes resource exists
    32  	Namespace string
    33  
    34  	// ResourceName is the name of the Kubernetes resource
    35  	ResourceName string
    36  
    37  	// KubeConfig is the config to connect to the API server
    38  	KubeConfig *rest.Config
    39  
    40  	// KeepAlive specifies how often a keep alive message is sent to hold
    41  	// the connection open
    42  	KeepAlive *time.Duration
    43  
    44  	// Port is the port to be forwarded from the relevant resource
    45  	Port int
    46  }