sigs.k8s.io/cluster-api@v1.7.1/api/v1beta1/cluster_phase_types.go (about)

     1  /*
     2  Copyright 2021 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 v1beta1
    18  
    19  // ClusterPhase is a string representation of a Cluster Phase.
    20  //
    21  // This type is a high-level indicator of the status of the Cluster as it is provisioned,
    22  // from the API user’s perspective.
    23  //
    24  // The value should not be interpreted by any software components as a reliable indication
    25  // of the actual state of the Cluster, and controllers should not use the Cluster Phase field
    26  // value when making decisions about what action to take.
    27  //
    28  // Controllers should always look at the actual state of the Cluster’s fields to make those decisions.
    29  type ClusterPhase string
    30  
    31  const (
    32  	// ClusterPhasePending is the first state a Cluster is assigned by
    33  	// Cluster API Cluster controller after being created.
    34  	ClusterPhasePending = ClusterPhase("Pending")
    35  
    36  	// ClusterPhaseProvisioning is the state when the Cluster has a provider infrastructure
    37  	// object associated and can start provisioning.
    38  	ClusterPhaseProvisioning = ClusterPhase("Provisioning")
    39  
    40  	// ClusterPhaseProvisioned is the state when its
    41  	// infrastructure has been created and configured.
    42  	ClusterPhaseProvisioned = ClusterPhase("Provisioned")
    43  
    44  	// ClusterPhaseDeleting is the Cluster state when a delete
    45  	// request has been sent to the API Server,
    46  	// but its infrastructure has not yet been fully deleted.
    47  	ClusterPhaseDeleting = ClusterPhase("Deleting")
    48  
    49  	// ClusterPhaseFailed is the Cluster state when the system
    50  	// might require user intervention.
    51  	ClusterPhaseFailed = ClusterPhase("Failed")
    52  
    53  	// ClusterPhaseUnknown is returned if the Cluster state cannot be determined.
    54  	ClusterPhaseUnknown = ClusterPhase("Unknown")
    55  )