sigs.k8s.io/cluster-api@v1.7.1/cmd/clusterctl/client/alias.go (about)

     1  /*
     2  Copyright 2019 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 client
    18  
    19  import (
    20  	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/cluster"
    21  	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
    22  	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/repository"
    23  	yaml "sigs.k8s.io/cluster-api/cmd/clusterctl/client/yamlprocessor"
    24  )
    25  
    26  // Alias creates local aliases for types defined in the low-level libraries.
    27  // By using a local alias, we ensure that users import and use clusterctl's high-level library.
    28  
    29  // Provider defines a provider configuration.
    30  type Provider config.Provider
    31  
    32  // Components wraps a YAML file that defines the provider's components (CRDs, controller, RBAC rules etc.).
    33  type Components repository.Components
    34  
    35  // ComponentsOptions wraps inputs to get provider's components.
    36  type ComponentsOptions repository.ComponentsOptions
    37  
    38  // Template wraps a YAML file that defines the cluster objects (Cluster, Machines etc.).
    39  type Template repository.Template
    40  
    41  // UpgradePlan defines a list of possible upgrade targets for a management cluster.
    42  type UpgradePlan cluster.UpgradePlan
    43  
    44  // CertManagerUpgradePlan defines the upgrade plan if cert-manager needs to be
    45  // upgraded to a different version.
    46  type CertManagerUpgradePlan cluster.CertManagerUpgradePlan
    47  
    48  // Kubeconfig is a type that specifies inputs related to the actual kubeconfig.
    49  type Kubeconfig cluster.Kubeconfig
    50  
    51  // Processor defines the methods necessary for creating a specific yaml
    52  // processor.
    53  type Processor yaml.Processor