helpers

Documentation

Index

• Constants
• func AcceleratedNetworkingSupported(sku string) bool
• func CreatePki(extraFQDNs []string, extraIPs []net.IP, clusterDomain string, ...) (*PkiKeyCertPair, *PkiKeyCertPair, *PkiKeyCertPair, *PkiKeyCertPair, ...)
• func CreateSSH(rg io.Reader, s *i18n.Translator) (privateKey *rsa.PrivateKey, publicKeyString string, err error)
• func CreateSaveSSH(username, outputDirectory string, s *i18n.Translator) (privateKey *rsa.PrivateKey, publicKeyString string, err error)
• func EqualError(a, b error) bool
• func GetAzureLocations() []string
• func GetClassicAllowedSizes() string
• func GetClassicSizeMap() string
• func GetCloudTargetEnv(location string) string
• func GetDCOSMasterAllowedSizes() string
• func GetHomeDir() string
• func GetKubernetesAgentAllowedSizes() string
• func GetMasterAgentAllowedSizes() string
• func GetSizeMap() string
• func IsFalseBoolPointer(b *bool) bool
• func IsTrueBoolPointer(b *bool) bool
• func JSONMarshal(content interface{}, escape bool) ([]byte, error)
• func JSONMarshalIndent(content interface{}, prefix, indent string, escape bool) ([]byte, error)
• func NormalizeAzureRegion(name string) string
• func PointerToBool(b bool) *bool
• func PointerToInt(i int) *int
• func PointerToString(s string) *string
• func ShellQuote(s string) string
• type FileSaver
  • func (f *FileSaver) SaveFile(dir string, file string, data []byte) error
  • func (f *FileSaver) SaveFileString(dir string, file string, data string) error
• type PkiKeyCertPair
  • func CreatePkiKeyCertPair(commonName string) (*PkiKeyCertPair, error)

Constants

const (
	// ValidityDuration specifies the duration an TLS certificate is valid
	ValidityDuration = time.Hour * 24 * 365 * 2
	// PkiKeySize is the size in bytes of the PKI key
	PkiKeySize = 4096
)

const (
	// SSHKeySize is the size (in bytes) of SSH key to create
	SSHKeySize = 4096
)

Functions

func AcceleratedNetworkingSupported

func AcceleratedNetworkingSupported(sku string) bool

AcceleratedNetworkingSupported check if the VmSKU support the Accelerated Networking

func CreatePki

func CreatePki(extraFQDNs []string, extraIPs []net.IP, clusterDomain string, caPair *PkiKeyCertPair, masterCount int) (*PkiKeyCertPair, *PkiKeyCertPair, *PkiKeyCertPair, *PkiKeyCertPair, *PkiKeyCertPair, []*PkiKeyCertPair, error)

CreatePki creates PKI certificates

func CreateSSH

func CreateSSH(rg io.Reader, s *i18n.Translator) (privateKey *rsa.PrivateKey, publicKeyString string, err error)

CreateSSH creates an SSH key pair.

func CreateSaveSSH

func CreateSaveSSH(username, outputDirectory string, s *i18n.Translator) (privateKey *rsa.PrivateKey, publicKeyString string, err error)

CreateSaveSSH generates and stashes an SSH key pair.

func EqualError

func EqualError(a, b error) bool

EqualError is a nil-safe method which reports whether errors a and b are considered equal. They're equal if both are nil, or both are not nil and a.Error() == b.Error().

func GetAzureLocations

func GetAzureLocations() []string

GetAzureLocations provides all azure regions in prod. Related powershell to refresh this list:

Get-AzureRmLocation | Select-Object -Property Location

func GetClassicAllowedSizes

func GetClassicAllowedSizes() string

GetClassicAllowedSizes returns the classic allowed sizes

func GetClassicSizeMap

func GetClassicSizeMap() string

GetClassicSizeMap returns the size / storage map

func GetCloudTargetEnv

func GetCloudTargetEnv(location string) string

GetCloudTargetEnv determines and returns whether the region is a sovereign cloud which have their own data compliance regulations (China/Germany/USGov) or standard

Azure public cloud

func GetDCOSMasterAllowedSizes

func GetDCOSMasterAllowedSizes() string

GetDCOSMasterAllowedSizes returns the master allowed sizes

func GetHomeDir

func GetHomeDir() string

GetHomeDir attempts to get the home dir from env

func GetKubernetesAgentAllowedSizes

func GetKubernetesAgentAllowedSizes() string

GetKubernetesAgentAllowedSizes returns the allowed sizes for Kubernetes agent

func GetMasterAgentAllowedSizes

func GetMasterAgentAllowedSizes() string

GetMasterAgentAllowedSizes returns the agent allowed sizes

func GetSizeMap

func GetSizeMap() string

GetSizeMap returns the size / storage map

func IsFalseBoolPointer

func IsFalseBoolPointer(b *bool) bool

IsFalseBoolPointer is a simple boolean helper function for boolean pointers

func IsTrueBoolPointer

func IsTrueBoolPointer(b *bool) bool

IsTrueBoolPointer is a simple boolean helper function for boolean pointers

func JSONMarshal

func JSONMarshal(content interface{}, escape bool) ([]byte, error)

JSONMarshal marshals JSON w/ optional SetEscapeHTML

func JSONMarshalIndent

func JSONMarshalIndent(content interface{}, prefix, indent string, escape bool) ([]byte, error)

JSONMarshalIndent marshals formatted JSON w/ optional SetEscapeHTML

func NormalizeAzureRegion

func NormalizeAzureRegion(name string) string

NormalizeAzureRegion returns a normalized Azure region with white spaces removed and converted to lower case

func PointerToBool

func PointerToBool(b bool) *bool

PointerToBool returns a pointer to a bool

func PointerToInt

func PointerToInt(i int) *int

PointerToInt returns a pointer to a int

func PointerToString

func PointerToString(s string) *string

PointerToString returns a pointer to a string

func ShellQuote

func ShellQuote(s string) string

ShellQuote returns a string that is enclosed within single quotes. If the string already has single quotes, they will be escaped.

Types

type FileSaver

type FileSaver struct {
	Translator *i18n.Translator
}

FileSaver represents the object that save string or byte data to file

func (*FileSaver) SaveFile

func (f *FileSaver) SaveFile(dir string, file string, data []byte) error

SaveFile saves binary data to file

func (*FileSaver) SaveFileString

func (f *FileSaver) SaveFileString(dir string, file string, data string) error

SaveFileString saves string to file

type PkiKeyCertPair

type PkiKeyCertPair struct {
	CertificatePem string
	PrivateKeyPem  string
}

PkiKeyCertPair represents an PKI public and private cert pair

func CreatePkiKeyCertPair

func CreatePkiKeyCertPair(commonName string) (*PkiKeyCertPair, error)

CreatePkiKeyCertPair generates a pair of PKI certificate and private key