sigs.k8s.io/cluster-api@v1.7.1/cmd/clusterctl/api/v1alpha3/annotations.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 v1alpha3
    18  
    19  const (
    20  	// CertManagerVersionAnnotation reports the cert manager version installed by clusterctl.
    21  	CertManagerVersionAnnotation = "cert-manager.clusterctl.cluster.x-k8s.io/version"
    22  
    23  	// SkipCRDNamePreflightCheckAnnotation can be placed on provider CRDs, so that clusterctl doesn't emit a
    24  	// warning if the CRD doesn't comply with Cluster APIs naming scheme.
    25  	// Note: Only CRDs that are referenced by core Cluster API CRDs have to comply with the naming scheme.
    26  	// See the following issue for more information: https://github.com/kubernetes-sigs/cluster-api/issues/5686#issuecomment-1260897278
    27  	SkipCRDNamePreflightCheckAnnotation = "clusterctl.cluster.x-k8s.io/skip-crd-name-preflight-check"
    28  
    29  	// DeleteForMoveAnnotation will be set to objects that are going to be deleted from the
    30  	// source cluster after being moved to the target cluster during the clusterctl move operation.
    31  	//
    32  	// It will help any validation webhook to take decision based on it.
    33  	DeleteForMoveAnnotation = "clusterctl.cluster.x-k8s.io/delete-for-move"
    34  
    35  	// BlockMoveAnnotation prevents the cluster move operation from starting if it is defined on at least one
    36  	// of the objects in scope.
    37  	// Provider controllers are expected to set the annotation on resources that cannot be instantaneously
    38  	// paused and remove the annotation when the resource has been actually paused.
    39  	//
    40  	// e.g. If this annotation is defined with any value on an InfraMachine resource to be moved when
    41  	// `clusterctl move` is invoked, then NO resources for ANY workload cluster will be created on the
    42  	// destination management cluster until the annotation is removed.
    43  	BlockMoveAnnotation = "clusterctl.cluster.x-k8s.io/block-move"
    44  )