platform

Documentation

Index

• func GetPlatformName(cfg *rest.Config) (string, error)
• type PlatformInfo
  • func GetPlatformInfo(cfg *rest.Config) (PlatformInfo, error)
  • func (info PlatformInfo) IsOpenShift() bool
  • func (info PlatformInfo) String() string
• type PlatformType

Functions

func GetPlatformName

func GetPlatformName(cfg *rest.Config) (string, error)

GetPlatformName is a helper method to return the platform name from GetPlatformInfo results Accepts <nil> or instantiated 'cfg' rest config parameter.

Types

type PlatformInfo

type PlatformInfo struct {
	Name       PlatformType `json:"name"`
	K8SVersion string       `json:"k8sVersion"`
	OS         string       `json:"os"`
}

func GetPlatformInfo

func GetPlatformInfo(cfg *rest.Config) (PlatformInfo, error)

GetPlatformInfo examines the Kubernetes-based environment and determines the running platform, version, & OS. Accepts <nil> or instantiated 'cfg' rest config parameter.

Result: PlatformInfo{ Name: OpenShift, K8SVersion: 1.13+, OS: linux/amd64 }

func (PlatformInfo) IsOpenShift

func (info PlatformInfo) IsOpenShift() bool

func (PlatformInfo) String

func (info PlatformInfo) String() string

type PlatformType

type PlatformType string

const (
	OpenShift  PlatformType = "OpenShift"
	Kubernetes PlatformType = "Kubernetes"
)