config

Documentation

Overview

Copyright © 2020-2023 The k3d Author(s)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2020-2023 The k3d Author(s)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• Variables
• func FromViper(config *viper.Viper) (types.Config, error)
• func GetSchemaByVersion(apiVersion string) ([]byte, error)
• func MergeSimple(dest, src conf.SimpleConfig) (*conf.SimpleConfig, error)
• func Migrate(config types.Config, targetVersion string) (types.Config, error)
• func ProcessClusterConfig(clusterConfig conf.ClusterConfig) (*conf.ClusterConfig, error)
• func ProcessSimpleConfig(simpleConfig *conf.SimpleConfig) error
• func SimpleConfigFromViper(cfgViper *viper.Viper) (defaultConfig.SimpleConfig, error)
• func TransformSimpleToClusterConfig(ctx context.Context, runtime runtimes.Runtime, simpleConfig conf.SimpleConfig) (*conf.ClusterConfig, error)
• func ValidateClusterConfig(ctx context.Context, runtime runtimes.Runtime, config conf.ClusterConfig) error
• func ValidateSchema(content interface{}, schemaJSON []byte) error
• func ValidateSchemaFile(filepath string, schema []byte) error
• func ValidateSchemaJSON(contentJSON []byte, schemaJSON []byte) error

Constants

const DefaultConfigApiVersion = defaultConfig.ApiVersion

Variables

var Schemas = map[string]string{
	v1alpha2.ApiVersion:      v1alpha2.JSONSchema,
	v1alpha3.ApiVersion:      v1alpha3.JSONSchema,
	v1alpha4.ApiVersion:      v1alpha4.JSONSchema,
	defaultConfig.ApiVersion: defaultConfig.JSONSchema,
}

Functions

func FromViper

func FromViper(config *viper.Viper) (types.Config, error)

func GetSchemaByVersion

func GetSchemaByVersion(apiVersion string) ([]byte, error)

func MergeSimple

func MergeSimple(dest, src conf.SimpleConfig) (*conf.SimpleConfig, error)

MergeSimple merges two simple configuration files with the values of the destination one having priority

func Migrate

func Migrate(config types.Config, targetVersion string) (types.Config, error)

func ProcessClusterConfig

func ProcessClusterConfig(clusterConfig conf.ClusterConfig) (*conf.ClusterConfig, error)

ProcessClusterConfig applies processing to the config sanitizing it and doing some final modifications

func ProcessSimpleConfig

func ProcessSimpleConfig(simpleConfig *conf.SimpleConfig) error

ProcessSimpleConfig applies processing to the simple config, sanitizing it and doing some modifications

func SimpleConfigFromViper

func SimpleConfigFromViper(cfgViper *viper.Viper) (defaultConfig.SimpleConfig, error)

func TransformSimpleToClusterConfig

func TransformSimpleToClusterConfig(ctx context.Context, runtime runtimes.Runtime, simpleConfig conf.SimpleConfig) (*conf.ClusterConfig, error)

TransformSimpleToClusterConfig transforms a simple configuration to a full-fledged cluster configuration

func ValidateClusterConfig

func ValidateClusterConfig(ctx context.Context, runtime runtimes.Runtime, config conf.ClusterConfig) error

ValidateClusterConfig checks a given cluster config for basic errors

func ValidateSchema

func ValidateSchema(content interface{}, schemaJSON []byte) error

ValidateSchema validates a YAML construct (non-struct representation) against a JSON Schema

func ValidateSchemaFile

func ValidateSchemaFile(filepath string, schema []byte) error

ValidateSchemaFile takes a filepath, reads the file and validates it against a JSON schema

func ValidateSchemaJSON

func ValidateSchemaJSON(contentJSON []byte, schemaJSON []byte) error