sigs.k8s.io/cluster-api@v1.6.3/internal/contract/infrastructure_cluster_template.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 contract
    18  
    19  import (
    20  	"sync"
    21  )
    22  
    23  // InfrastructureClusterTemplateContract encodes information about the Cluster API contract for InfrastructureClusterTemplate objects
    24  // like DockerClusterTemplates, AWSClusterTemplates, etc.
    25  type InfrastructureClusterTemplateContract struct{}
    26  
    27  var infrastructureClusterTemplate *InfrastructureClusterTemplateContract
    28  var onceInfrastructureClusterTemplate sync.Once
    29  
    30  // InfrastructureClusterTemplate provides access to the information about the Cluster API contract for InfrastructureClusterTemplate objects.
    31  func InfrastructureClusterTemplate() *InfrastructureClusterTemplateContract {
    32  	onceInfrastructureClusterTemplate.Do(func() {
    33  		infrastructureClusterTemplate = &InfrastructureClusterTemplateContract{}
    34  	})
    35  	return infrastructureClusterTemplate
    36  }
    37  
    38  // Template provides access to the template.
    39  func (c *InfrastructureClusterTemplateContract) Template() *InfrastructureClusterTemplateTemplate {
    40  	return &InfrastructureClusterTemplateTemplate{}
    41  }
    42  
    43  // InfrastructureClusterTemplateTemplate provides a helper struct for working with the template in an InfrastructureClusterTemplate..
    44  type InfrastructureClusterTemplateTemplate struct{}
    45  
    46  // Metadata provides access to the metadata of a template.
    47  func (c *InfrastructureClusterTemplateTemplate) Metadata() *Metadata {
    48  	return &Metadata{
    49  		path: Path{"spec", "template", "metadata"},
    50  	}
    51  }