config

Documentation

Overview

* * MIT License * * (C) Copyright 2023 Hewlett Packard Enterprise Development LP * * 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. *

* * MIT License * * (C) Copyright 2023 Hewlett Packard Enterprise Development LP * * 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. *

* * MIT License * * (C) Copyright 2023 Hewlett Packard Enterprise Development LP * * 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

• Variables
• func InitConfig(cfg string) (err error)
• func WriteConfig(path string, cfg *Config) error
• type Config
  • func LoadConfig(path string) (c *Config, err error)
• type DeprecatedConfig
• type DeprecatedConfigOptions
• type DeprecatedDomain
• type DeprecatedDomainOpts
• type DeprecatedProviderOpts
• type DeprecatedSession
• type Session

Variables

var ConfigDir, CustomDir, Tl string

Functions

func InitConfig

func InitConfig(cfg string) (err error)

InitConfig creates a default config file if one does not exist

func WriteConfig

func WriteConfig(path string, cfg *Config) error

WriteConfig saves the configuration to a file

Types

type Config

type Config struct {
	Session *Session `yaml:"session"`
}

Config is the top-level config struct that is written/read to/from a file

func LoadConfig

func LoadConfig(path string) (c *Config, err error)

LoadConfig loads the configuration from a file

type DeprecatedConfig

type DeprecatedConfig struct {
	Session *DeprecatedSession `yaml:"session"`
}

DeprecatedConfig is the single-provider Config object and is left here for migration purposes

type DeprecatedConfigOptions

type DeprecatedConfigOptions struct {
	ValidRoles      []string
	ValidSubRoles   []string
	K8sPodsCidr     string
	K8sServicesCidr string
}

DeprecatedConfigOptions is the single-provider ConfigOptions and is now handled within each provider's package

type DeprecatedDomain

type DeprecatedDomain struct {
	// contains filtered or unexported fields
}

DeprecatedDomain is the single-provider Domain object and is left here for migration purposes

type DeprecatedDomainOpts

type DeprecatedDomainOpts struct {
	DatastorePath          string                 `yaml:"datastore_path"`
	LogFilePath            string                 `yaml:"log_file_path"`
	Provider               string                 `yaml:"provider"`
	CsmOptions             DeprecatedProviderOpts `yaml:"csm_options"`
	CustomHardwareTypesDir string                 `yaml:"custom_hardware_types_dir"`
}

DeprecatedDomainOpts is the single-provider Domain object and is left here for migration purposes

type DeprecatedProviderOpts

type DeprecatedProviderOpts struct {
	UseSimulation      bool
	InsecureSkipVerify bool
	APIGatewayToken    string
	BaseUrlSLS         string
	BaseUrlHSM         string
	SecretName         string
	K8sPodsCidr        string
	K8sServicesCidr    string
	KubeConfig         string
	ClientID           string `json:"-" yaml:"-"` // omit credentials from cani.yml
	ClientSecret       string `json:"-" yaml:"-"` // omit credentials from cani.yml
	ProviderHost       string
	TokenUsername      string `json:"-" yaml:"-"` // omit credentials from cani.yml
	TokenPassword      string `json:"-" yaml:"-"` // omit credentials from cani.yml
	CaCertPath         string
	ValidRoles         []string
	ValidSubRoles      []string
}

DeprecatedProviderOpts are the single-provider options and is now handled within each provider's package

type DeprecatedSession

type DeprecatedSession struct {
	DomainOptions *DeprecatedDomainOpts `yaml:"domain_options"`
	Domain        *DeprecatedDomain     `yaml:"domain"`
	Active        bool                  `yaml:"active"`
}

DeprecatedSession is the single-provider Session object and is left here for migration purposes

type Session

type Session struct {
	Domains map[string]*domain.Domain `yaml:"domains"`
}

Session defines the session configuration and domain options