pmk

Documentation

Overview

Copyright © 2020 The Platform9 Systems Inc.

Copyright © 2020 The Platform9 Systems Inc.

Copyright © 2020 The Platform9 Systems Inc.

Index

• Constants
• Variables
• func Bootstrap(ctx objects.Config, c client.Client, req qbert.ClusterCreateRequest, ...) error
• func CheckAmazonPovider(awsIamUser, awsID, awsSecret, awsRegion string) bool
• func CheckAvailabilityZonesCount(awsID, awsSecret, awsRegion string) bool
• func CheckAzureProvider(tenantID, appID, subID, secretKey string) bool
• func CheckGoogleProvider(path, projectName, serviceAccountEmail string) bool
• func CheckIfAllowed(results []*iamAws.EvaluationResult) bool
• func CheckIfRoleExists(bindings []*iam.Binding, name string) bool
• func CheckPermissions(arn *string, svc *iamAws.IAM, actions []string) bool
• func CheckRoleAssignment(result assignment.RoleAssignmentListResult, subID string) bool
• func CheckSudo(exec cmdexec.Executor) bool
• func DecommissionNode(cfg *objects.Config, nc objects.NodeConfig, removePf9 bool)
• func DeleteClusterBootstrap(clusterID string, c client.Client, keystoneAuth keystone.KeystoneAuth, ...)
• func DisableUnattendedUpdates(allClients client.Client)
• func EnableUnattendedUpdates(allClients client.Client)
• func GetIp() net.IP
• func IsEnabledUnattendedUpdates(allClients client.Client) bool
• func OpenOSReleaseFile(exec cmdexec.Executor) (string, error)
• func PreReqBootstrap(executor cmdexec.Executor) (bool, bool, error)
• func PrepNode(ctx objects.Config, allClients client.Client, auth keystone.KeystoneAuth) error
• func StartUnattendedUpdates(allClients client.Client)
• func StatusUnattendedUpdates(allClients client.Client) bool
• func StopUnattendedUpdates(allClients client.Client)
• func ValidatePlatform(exec cmdexec.Executor) (string, error)
• type CNIBackend
• type CheckNodeResult
  • func CheckNode(ctx objects.Config, allClients client.Client, auth keystone.KeystoneAuth, ...) (CheckNodeResult, error)
• type CloudProviderType

Constants

const (
	// Response Status Codes
	HostAgentCertless = 200
	HostAgentLegacy   = 404
)

const (
	// ConfigFile is used to store config information
	ConfigFile string = "pf9_config.json"
	// DefaultConfigDir is the default path for config file
	DefaultConfigDir string = "~/"
	// LogFile specifies the filename to which CLI logs o/p and errors
	LogFile string = "pf9ctl.log"

	// AWS cloud provider
	AWS CloudProviderType = "aws"
	// GCP cloud provider
	GCP CloudProviderType = "gcp"
	// BareOS on-prem cloud provider
	BareOS CloudProviderType = "local"
	// Openstack cloud provider
	Openstack CloudProviderType = "openstack"
	// Flannel network plugin for k8s networking
	Flannel CNIBackend = "flannel"
	// Calico network plugin for k8s networking
	Calico CNIBackend = "calico"
	// Weave network plugin for k8s networking
	Weave CNIBackend = "weave"
)

Variables

var HostAgent int

This variable is assigned with StatusCode during hostagent installation

var IsRemoteExecutor bool

var WarningOptionalChecks bool

This flag is set true, to have warning "!" message,

when user passes --skip-checks and optional checks fails.

Functions

func Bootstrap

func Bootstrap(ctx objects.Config, c client.Client, req qbert.ClusterCreateRequest, keystoneAuth keystone.KeystoneAuth, bootConfig objects.NodeConfig) error

Bootstrap simply onboards the local node and attaches it as master to a newly created cluster.

func CheckAmazonPovider

func CheckAmazonPovider(awsIamUser, awsID, awsSecret, awsRegion string) bool

func CheckAvailabilityZonesCount

func CheckAvailabilityZonesCount(awsID, awsSecret, awsRegion string) bool

func CheckAzureProvider

func CheckAzureProvider(tenantID, appID, subID, secretKey string) bool

func CheckGoogleProvider

func CheckGoogleProvider(path, projectName, serviceAccountEmail string) bool

func CheckIfAllowed

func CheckIfAllowed(results []*iamAws.EvaluationResult) bool

func CheckIfRoleExists

func CheckIfRoleExists(bindings []*iam.Binding, name string) bool

func CheckPermissions

func CheckPermissions(arn *string, svc *iamAws.IAM, actions []string) bool

func CheckRoleAssignment

func CheckRoleAssignment(result assignment.RoleAssignmentListResult, subID string) bool

func CheckSudo

func CheckSudo(exec cmdexec.Executor) bool

func DecommissionNode

func DecommissionNode(cfg *objects.Config, nc objects.NodeConfig, removePf9 bool)

func DeleteClusterBootstrap

func DeleteClusterBootstrap(clusterID string, c client.Client, keystoneAuth keystone.KeystoneAuth, token string)

Deleting the cluster if the node is not attached to the cluster

func DisableUnattendedUpdates

func DisableUnattendedUpdates(allClients client.Client)

func EnableUnattendedUpdates

func EnableUnattendedUpdates(allClients client.Client)

func GetIp

func GetIp() net.IP

func IsEnabledUnattendedUpdates

func IsEnabledUnattendedUpdates(allClients client.Client) bool

func OpenOSReleaseFile

func OpenOSReleaseFile(exec cmdexec.Executor) (string, error)

func PreReqBootstrap

func PreReqBootstrap(executor cmdexec.Executor) (bool, bool, error)

Checks Prerequisites for Bootstrap Command

func PrepNode

func PrepNode(ctx objects.Config, allClients client.Client, auth keystone.KeystoneAuth) error

PrepNode sets up prerequisites for k8s stack

func StartUnattendedUpdates

func StartUnattendedUpdates(allClients client.Client)

func StatusUnattendedUpdates

func StatusUnattendedUpdates(allClients client.Client) bool

func StopUnattendedUpdates

func StopUnattendedUpdates(allClients client.Client)

func ValidatePlatform

func ValidatePlatform(exec cmdexec.Executor) (string, error)

Types

type CNIBackend

type CNIBackend string

CNIBackend specifies the networking solution used for the k8s cluster

type CheckNodeResult

type CheckNodeResult string

const (
	PASS             CheckNodeResult = "pass"
	RequiredFail     CheckNodeResult = "requiredFail"
	OptionalFail     CheckNodeResult = "optionalFail"
	CleanInstallFail CheckNodeResult = "cleanInstallFail"
)

func CheckNode

func CheckNode(ctx objects.Config, allClients client.Client, auth keystone.KeystoneAuth, nc objects.NodeConfig) (CheckNodeResult, error)

CheckNode checks the prerequisites for k8s stack

type CloudProviderType

type CloudProviderType string

CloudProviderType specifies the infrastructure where the cluster runs