tkgconfigpaths

Documentation

Overview

Package tkgconfigpaths provides utilities to get info related to TKG configuration paths.

Index

• Variables
• func GetOverridesDirectory() string
• func GetRegistryCertFile() (string, error)
• func GetRegistryTrustedCACertFileForWindows() (string, error)
• type Client
  • func New(configDir string) Client

Variables

var (
	TKGDefaultImageRepo               string = "projects-stg.registry.vmware.com/tkg"
	TKGDefaultCompatibilityImagePath  string = "framework-zshippable/tkg-compatibility"
	TKGManagementClusterPluginVersion string = "v0.14.0-dev"
)

All the variables are set during build time Note: Please !!DO NOT!!! change the name or remove this variable

Functions

func GetOverridesDirectory

func GetOverridesDirectory() string

GetOverridesDirectory returns path of overrides directory

func GetRegistryCertFile

func GetRegistryCertFile() (string, error)

GetRegistryCertFile returns the registry cert file path

func GetRegistryTrustedCACertFileForWindows

func GetRegistryTrustedCACertFileForWindows() (string, error)

GetRegistryTrustedCACertFileForWindows returns the registry trusted root ca cert filepath for windows

Types

type Client

type Client interface {
	// GetTKGDirectory returns path to tkg config directory "$HOME/.tkg"
	GetTKGDirectory() (string, error)

	// GetTKGProvidersDirectory returns path to tkg config directory "$HOME/.tkg/providers"
	GetTKGProvidersDirectory() (string, error)

	// GetTKGCompatibilityDirectory returns path to tkg compatibility directory "<TKGConfigDirectory>/compatibility"
	GetTKGCompatibilityDirectory() (string, error)

	// GetTKGBoMDirectory returns path to tkg config directory "$HOME/.tkg/bom"
	GetTKGBoMDirectory() (string, error)

	// GetTKGConfigDirectories returns tkg config directories in below order
	// (tkgDir, bomDir, providersDir, error)
	GetTKGConfigDirectories() (string, string, string, error)

	// GetProvidersConfigFilePath returns config file path from providers dir
	// "$HOME/.tkg/providers/config.yaml"
	GetProvidersConfigFilePath() (string, error)

	// GetTKGConfigPath returns tkg configfile path
	GetTKGConfigPath() (string, error)

	// GetDefaultClusterConfigPath returns default cluster config file path
	GetDefaultClusterConfigPath() (string, error)

	// GetTKGCompatibilityConfigPath returns TKG compatibility file path
	GetTKGCompatibilityConfigPath() (string, error)
}

Client implements TKG configuration paths functions

func New

func New(configDir string) Client

New creates new tkg configuration paths client