util

Documentation

Index

• Constants
• Variables
• func AskBool(msg string, args ...interface{}) (bool, error)
• func Intersect(a []string, b []string) []string
• func RetryPolicyOn404(ctx context.Context, resp *http.Response, err error) (bool, error)
• type ZapWrapper
  • func (z *ZapWrapper) Debug(msg string, args ...interface{})
  • func (z *ZapWrapper) Error(msg string, args ...interface{})
  • func (z *ZapWrapper) Info(msg string, args ...interface{})
  • func (z *ZapWrapper) Warn(msg string, args ...interface{})

Constants

const (

	// number of CPUs
	MinCPUs = 2
	// RAM in GiBs
	MinMem = 12
	// Measure of a GiB in terms of bytes
	GB = 1024 * 1024
	// Disk size in GiBs
	MinDisk = 30
	// Disk size in GiBs
	MinAvailDisk = 15
	// Counter variable max value
	MaxLoopValue = 3
	//Attach Status Loop variable
	MaxRetryValue = 18

	CheckPass       = "PASS"
	CheckFail       = "FAIL"
	Invalid         = "Invalid"
	Valid           = "Valid"
	InvalidPassword = "Sorry, try again."

	PmkVersion = "1.20.11"
	Docker     = "docker"
	Calico     = "calico"
)

const (
	Version         string = "pf9ctl version: v1.29"
	AWSBucketName   string = "pmkft-assets"
	AWSBucketKey    string = "pf9ctl"
	AWSBucketRegion string = "us-west-1"
	BucketPath      string = "https://" + AWSBucketName + ".s3." + AWSBucketRegion + ".amazonaws.com/" + AWSBucketKey + "_setup"
)

These are the constants needed for everything version related

Variables

var (
	// Constants for check failure messages
	PyCliErr                = "Earlier version of pf9ctl already exists. This must be uninstalled."
	ExisitngInstallationErr = "Platform9 packages already exist. These must be uninstalled."
	SudoErr                 = "User running pf9ctl must have privilege (sudo) mode enabled."
	OSPackagesErr           = "Some OS packages needed for the CLI not found"
	CPUErr                  = "At least 2 CPUs are needed on host."
	DiskErr                 = "At least 30 GB of total disk space and 15 GB of free space is needed on host."
	MemErr                  = "At least 12 GB of memory is needed on host."
)

var (
	HomeDir, _ = os.UserHomeDir()
	// PyCliPath is the path of virtual env directory of the Python CLI
	PyCliPath = filepath.Join(HomeDir, "pf9/pf9-venv")
	// PyCliLink is the Symlink of the Python CLI
	PyCliLink      = "/usr/bin/pf9ctl"
	Centos         = "centos"
	Redhat         = "red hat"
	Ubuntu         = "ubuntu"
	Rocky          = "rocky"
	CertsExpireErr = "certificate has expired or is not yet valid"

	//Pf9Dir is the base pf9dir
	Pf9Dir = filepath.Join(HomeDir, "pf9")
	//Pf9LogDir is the base path for creating log dir
	Pf9LogDir = filepath.Join(Pf9Dir, "log")
	// Pf9DBDir is the base dir for storing pf9 db config
	Pf9DBDir = filepath.Join(Pf9Dir, "db")
	// Pf9DBLoc represents location of the config file.
	Pf9DBLoc = filepath.Join(Pf9DBDir, "config.json")
	// Pf9Log represents location of the log.
	Pf9Log = filepath.Join(Pf9LogDir, "pf9ctl.log")
	// WaitPeriod is the sleep period for the cli
	// before it starts with the operations.
	WaitPeriod = time.Duration(60)

	OptDir = "/var/opt/pf9"

	//Location of ovf service file
	OVFLoc           = "/etc/systemd/system/ovf.service"
	VarDir           = "/var/log/pf9"
	EtcDir           = "/etc/pf9"
	DefaultPf9LogLoc = "pf9/log"
	Pf9LogLoc        string
	Pf9DirLoc        = filepath.Join(HomeDir, "/")

	//Auth,Dmesg,dpkg/yum files for Debian/Redhat
	DmesgLog = "/var/log/dmesg"
	MsgDeb   = "/var/log/syslog"
	LockDeb  = "/var/log/dpkg.log"
	MsgRed   = "/var/log/messages"
	LockRed  = "/var/log/yum.log"

	Confidential = []string{"--password", "--user-token"}
)

var (
	//constants to check for cloud-ctl hostagent progress status
	HostAgentProgressBarStages = []*regexp.Regexp{
		regexp.MustCompile(`.*/etc/pf9/certs/hostagent/cert\.pem`),
		regexp.MustCompile(`.*/etc/pf9/certs/hostagent/key\.pem`),
		regexp.MustCompile(`.*/etc/pf9/certs/ca/cert\.pem`),
		regexp.MustCompile(`.*/etc/pf9/hostagent\.conf`),
		regexp.MustCompile(`.*pf9-hostagent-.*\.x86_64\.deb`),
		regexp.MustCompile(`.*pf9-comms-.*\.x86_64\.deb`),
		regexp.MustCompile(`.*download_nocert_routine executed successfully.*`),
	}
	HostAgentprogressPercentage = []int{5, 10, 15, 20, 25, 75, 100}
)

var AutoScalingPermissions []string

var AzureContributorID string

var CheckIfOnboarded bool

var EBSPermissions []string

var EC2Permission []string

var EKSPermissions []string

var Files []string

var GoogleCloudPermissions []string

var HostDown bool

var IAMPermissions []string

var InstallerErrors = make(map[int]string)

var KubeVersion string = ""

KubeVersion allows specifying a role version when running prep-node command

var LogFileNamePath string

var Pf9Packages []string

var PortErr string

var ProcessesList []string // Kubernetes clusters processes list

var RequiredPorts []string

var Route53Permissions []string

var SkipKube bool

SkipKube skips authorizing kube role during prep-node. Not applicable to bootstrap command

var SkipPrepNode bool

var SwapOffDisabled bool // If this is true the swapOff functionality will be disabled.

var VPCPermission []string

Functions

func AskBool

func AskBool(msg string, args ...interface{}) (bool, error)

AskBool function asks for the user input for a boolean input

func Intersect

func Intersect(a []string, b []string) []string

Intersect returns a list of common items between two lists

func RetryPolicyOn404

func RetryPolicyOn404(ctx context.Context, resp *http.Response, err error) (bool, error)

RetryPolicyOn404 is similar to the defaulRetryPolicy but which an additional check for 404 status.

Types

type ZapWrapper

type ZapWrapper struct {
}

Logger interface allows to use other loggers than standard log.Logger.

func (*ZapWrapper) Debug

func (z *ZapWrapper) Debug(msg string, args ...interface{})

func (*ZapWrapper) Error

func (z *ZapWrapper) Error(msg string, args ...interface{})

Implmenting the LeveledLogger for retry http

type LeveledLogger interface {
	Error(msg string, keysAndValues ...interface{})
	Info(msg string, keysAndValues ...interface{})
	Debug(msg string, keysAndValues ...interface{})
	Warn(msg string, keysAndValues ...interface{})
}

func (*ZapWrapper) Info

func (z *ZapWrapper) Info(msg string, args ...interface{})

func (*ZapWrapper) Warn

func (z *ZapWrapper) Warn(msg string, args ...interface{})