helpers

Documentation

Overview

Package helpers provides general purpose utility methods that are used throughout aks-engine codebase.

Index

• Constants
• Variables
• func AcceleratedNetworkingSupported(sku string) bool
• func CreatePki(pkiParams PkiParams) (*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 EnsureString(val, defaultVal string) string
• func EqualError(a, b error) bool
• func GetAzureLocations() []string
• func GetCloudTargetEnv(location string) string
• func GetEnglishOrderedQuotedListWithOxfordCommas(l []string) string
• func GetHomeDir() string
• func GetKubernetesAllowedVMSKUs() string
• func GetLogAnalyticsWorkspaceDomain(cloudOrDependenciesLocation string) string
• func GetSizeMap() string
• func GetTargetEnv(location, customCloudName string) 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 PublicKeyAuth(sshPrivateKeyPath string) (ssh.AuthMethod, error)
• func SSHClient(jumpboxHost, jumpboxPort, hostname string, ...) (*ssh.Client, error)
• func SSHClientConfig(user string, auth ssh.AuthMethod) *ssh.ClientConfig
• 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(params PkiKeyCertPairParams) (*PkiKeyCertPair, error)
• type PkiKeyCertPairParams
• type PkiParams
• type VMSku

Constants

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

	// DefaultPkiKeySize is the default size in bytes of the PKI key
	DefaultPkiKeySize = 4096
)

const (
	// ValidityDuration specifies the duration an TLS certificate is valid
	ValidityDuration = time.Hour * 24 * 365 * 30
)

Variables

var VMSkus = []VMSku{}/* 462 elements not displayed */

Functions

func AcceleratedNetworkingSupported

func AcceleratedNetworkingSupported(sku string) bool

AcceleratedNetworkingSupported checks if the VM SKU supports Accelerated Networking.

func CreatePki

func CreatePki(pkiParams PkiParams) (*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 EnsureString

func EnsureString(val, defaultVal string) string

EnsureString returns an string for the default value. If val is not empty, return val If val is empty, return defaultVal

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 available Azure cloud locations.

Code generated for package helpers by aks-engine DO NOT EDIT. (@generated)

To generate this code, run the command:

aks-engine get-locations --output=code

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 GetEnglishOrderedQuotedListWithOxfordCommas

func GetEnglishOrderedQuotedListWithOxfordCommas(l []string) string

GetEnglishOrderedQuotedListWithOxfordCommas returns a string that you can use in an English statement to report a list of things With each thing in quotes, e.g. "thing 1", "thing 2", and "thing 3" Oxford Comma not optional!

func GetHomeDir

func GetHomeDir() string

GetHomeDir attempts to get the home dir from env

func GetKubernetesAllowedVMSKUs

func GetKubernetesAllowedVMSKUs() string

GetKubernetesAllowedVMSKUs returns the allowed sizes for Kubernetes agent

func GetLogAnalyticsWorkspaceDomain

func GetLogAnalyticsWorkspaceDomain(cloudOrDependenciesLocation string) string

get domain of azure log analytics workspace based on the cloud or azure stack dependenciesLocation

func GetSizeMap

func GetSizeMap() string

GetSizeMap returns the size / storage map

func GetTargetEnv

func GetTargetEnv(location, customCloudName string) string

GetTargetEnv 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 CustomCloudName is name of environment if customCloudProfile is provided, it will be empty string if customCloudProfile is empty. Because customCloudProfile is empty for deployment for AzurePublicCloud, AzureChinaCloud,AzureGermanCloud,AzureUSGovernmentCloud, The customCloudName value will be empty string for those clouds This value is also used in azure.json file, which is used by Kubernetes to read various endpoints specific to cloud

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 PublicKeyAuth

func PublicKeyAuth(sshPrivateKeyPath string) (ssh.AuthMethod, error)

func SSHClient

func SSHClient(jumpboxHost, jumpboxPort, hostname string, jumpboxConfig, nodeConfig *ssh.ClientConfig) (*ssh.Client, error)

func SSHClientConfig

func SSHClientConfig(user string, auth ssh.AuthMethod) *ssh.ClientConfig

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(params PkiKeyCertPairParams) (*PkiKeyCertPair, error)

CreatePkiKeyCertPair generates a pair of PKI certificate and private key

type PkiKeyCertPairParams

type PkiKeyCertPairParams struct {
	CommonName string
	PkiKeySize int
}

PkiKeyCertPairParams is the params when we create the pki key cert pair.

type PkiParams

type PkiParams struct {
	ExtraFQDNs    []string
	ExtraIPs      []net.IP
	ClusterDomain string
	CaPair        *PkiKeyCertPair
	MasterCount   int
	PkiKeySize    int
}

PkiParams is used when we create Pki

type VMSku

type VMSku struct {
	Name                  string
	AcceleratedNetworking bool
}