config

Documentation

Index

• Constants
• Variables
• type Config
  • func ConfigFromEnv() (cfg Config, ok bool)
  • func ReadConfig(config io.Reader) (Config, error)
• type VirtualCenterConfig

Constants

const (
	DefaultRoundTripperCount uint   = 3
	DefaultAPIBinding        string = ":43001"
	DefaultK8sServiceAccount string = "cloud-controller-manager"
	DefaultVCenterPort       string = "443"
	DefaultSecretDirectory   string = "/etc/cloud/secrets"
)

const (
	MissingUsernameErrMsg  = "Username is missing"
	MissingPasswordErrMsg  = "Password is missing"
	InvalidVCenterIPErrMsg = "vsphere.conf does not have the VirtualCenter IP address specified"
)

Error Messages

Variables

var (
	ErrUsernameMissing  = errors.New(MissingUsernameErrMsg)
	ErrPasswordMissing  = errors.New(MissingPasswordErrMsg)
	ErrInvalidVCenterIP = errors.New(InvalidVCenterIPErrMsg)
)

Error constants

Types

type Config

type Config struct {
	Global struct {
		// vCenter username.
		User string `gcfg:"user"`
		// vCenter password in clear text.
		Password string `gcfg:"password"`
		// Deprecated. Use VirtualCenter to specify multiple vCenter Servers.
		// vCenter IP.
		VCenterIP string `gcfg:"server"`
		// vCenter port.
		VCenterPort string `gcfg:"port"`
		// True if vCenter uses self-signed cert.
		InsecureFlag bool `gcfg:"insecure-flag"`
		// Datacenter in which VMs are located.
		Datacenters string `gcfg:"datacenters"`
		// Soap round tripper count (retries = RoundTripper - 1)
		RoundTripperCount uint `gcfg:"soap-roundtrip-count"`
		// Specifies the path to a CA certificate in PEM format. Optional; if not
		// configured, the system's CA certificates will be used.
		CAFile string `gcfg:"ca-file"`
		// Thumbprint of the VCenter's certificate thumbprint
		Thumbprint string `gcfg:"thumbprint"`
		// Name of the secret were vCenter credentials are present.
		SecretName string `gcfg:"secret-name"`
		// Secret Namespace where secret will be present that has vCenter credentials.
		SecretNamespace string `gcfg:"secret-namespace"`
		// The kubernetes service account used to launch the cloud controller manager.
		// Default: cloud-controller-manager
		ServiceAccount string `gcfg:"service-account"`
		// Secret directory in the event that:
		// 1) we don't want to use the k8s API to listen for changes to secrets
		// 2) we are not in a k8s env, namely DC/OS, since CSI is CO agnostic
		// Default: /etc/cloud/credentials
		SecretsDirectory string `gcfg:"secrets-directory"`
		// Disable the vSphere CCM API
		// Default: true
		APIDisable bool `gcfg:"api-disable"`
		// Configurable vSphere CCM API port
		// Default: 43001
		APIBinding string `gcfg:"api-binding"`
	}
	VirtualCenter map[string]*VirtualCenterConfig
}

Config is used to read and store information from the cloud configuration file

func ConfigFromEnv

func ConfigFromEnv() (cfg Config, ok bool)

ConfigFromEnv allows setting configuration via environment variables.

func ReadConfig

func ReadConfig(config io.Reader) (Config, error)

ReadConfig parses vSphere cloud config file and stores it into VSphereConfig.

type VirtualCenterConfig

type VirtualCenterConfig struct {
	// vCenter username.
	User string `gcfg:"user"`
	// vCenter password in clear text.
	Password string `gcfg:"password"`
	// vCenter port.
	VCenterPort string `gcfg:"port"`
	// True if vCenter uses self-signed cert.
	InsecureFlag bool `gcfg:"insecure-flag"`
	// Datacenter in which VMs are located.
	Datacenters string `gcfg:"datacenters"`
	// Soap round tripper count (retries = RoundTripper - 1)
	RoundTripperCount uint `gcfg:"soap-roundtrip-count"`
	// Specifies the path to a CA certificate in PEM format. Optional; if not
	// configured, the system's CA certificates will be used.
	CAFile string `gcfg:"ca-file"`
	// Thumbprint of the VCenter's certificate thumbprint
	Thumbprint string `gcfg:"thumbprint"`
}

Structure that represents Virtual Center configuration