sigs.k8s.io/cluster-api@v1.7.1/errors/kubeadmcontrolplane.go (about)

     1  /*
     2  Copyright 2018 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 errors
    18  
    19  // KubeadmControlPlaneError is a more descriptive kind of error that represents an error condition that
    20  // should be set in the KubeadmControlPlane.Status. The "Reason" field is meant for short,
    21  // enum-style constants meant to be interpreted by control planes. The "Message"
    22  // field is meant to be read by humans.
    23  type KubeadmControlPlaneError struct {
    24  	Reason  KubeadmControlPlaneStatusError
    25  	Message string
    26  }
    27  
    28  // Error satisfies the error interface.
    29  func (e *KubeadmControlPlaneError) Error() string {
    30  	return e.Message
    31  }