sigs.k8s.io/cluster-api@v1.7.1/cmd/clusterctl/client/yamlprocessor/processor.go (about)

     1  /*
     2  Copyright 2020 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 yamlprocessor implements YAML processing.
    18  package yamlprocessor
    19  
    20  // Processor defines the methods necessary for creating a specific yaml
    21  // processor.
    22  type Processor interface {
    23  	// GetTemplateName returns the file name of the template that needs to be
    24  	// retrieved from the source.
    25  	GetTemplateName(version, flavor string) string
    26  
    27  	// GetClusterClassTemplateName returns the file name of the cluster class
    28  	// template that needs to be retrieved from the source.
    29  	GetClusterClassTemplateName(version, name string) string
    30  
    31  	// GetVariables parses the template blob of bytes and provides a
    32  	// list of variables that the template uses.
    33  	GetVariables([]byte) ([]string, error)
    34  
    35  	// GetVariableMap parses the template blob of bytes and provides a
    36  	// map of variables that the template uses with their default values.
    37  	GetVariableMap([]byte) (map[string]*string, error)
    38  
    39  	// Process processes the template blob of bytes and will return the final
    40  	// yaml with values retrieved from the values getter
    41  	Process([]byte, func(string) (string, error)) ([]byte, error)
    42  }