sigs.k8s.io/cluster-api@v1.7.1/internal/contract/infrastructure_machine_template.go (about)

     1  /*
     2  Copyright 2022 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  // InfrastructureMachineTemplateContract encodes information about the Cluster API contract for InfrastructureMachineTemplate objects
    24  // like DockerMachineTemplates, AWSMachineTemplates, etc.
    25  type InfrastructureMachineTemplateContract struct{}
    26  
    27  var infrastructureMachineTemplate *InfrastructureMachineTemplateContract
    28  var onceInfrastructureMachineTemplate sync.Once
    29  
    30  // InfrastructureMachineTemplate provide access to the information about the Cluster API contract for InfrastructureMachineTemplate objects.
    31  func InfrastructureMachineTemplate() *InfrastructureMachineTemplateContract {
    32  	onceInfrastructureMachineTemplate.Do(func() {
    33  		infrastructureMachineTemplate = &InfrastructureMachineTemplateContract{}
    34  	})
    35  	return infrastructureMachineTemplate
    36  }
    37  
    38  // Template provides access to the template.
    39  func (c *InfrastructureMachineTemplateContract) Template() *InfrastructureMachineTemplateTemplate {
    40  	return &InfrastructureMachineTemplateTemplate{}
    41  }
    42  
    43  // InfrastructureMachineTemplateTemplate provides a helper struct for working with the template in an InfrastructureMachineTemplate.
    44  type InfrastructureMachineTemplateTemplate struct{}
    45  
    46  // Metadata provides access to the metadata of a template.
    47  func (c *InfrastructureMachineTemplateTemplate) Metadata() *Metadata {
    48  	return &Metadata{
    49  		path: Path{"spec", "template", "metadata"},
    50  	}
    51  }