cluster

Documentation

Overview

Code generated for package cluster by go-bindata DO NOT EDIT. (@generated) sources: testdocs/clusteroperator.json testdocs/machines.json testdocs/machinesets.json testdocs/nodes.json

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func GetPromQuery(statisticsType string) (string, error)
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ClusterOperatorsInformation
• type FetchClient
  • func NewFetchClient(log *logrus.Entry, dialer proxy.Dialer, cluster *api.OpenShiftClusterDocument) (FetchClient, error)
• type MachineListInformation
  • func MachinesFromMachineList(machines *machinev1beta1.MachineList) *MachineListInformation
• type MachineResources
• type MachineSetListInformation
• type MachineSetProviderSpecValue
• type MachineSetProviderSpecValueOSDisk
• type MachineSetsInformation
• type MachinesInformation
• type MetricValue
• type Metrics
• type NodeConditions
• type NodeInformation
• type NodeListInformation
  • func NodesFromNodeList(nodes *corev1.NodeList) *NodeListInformation
• type OperatorCondition
• type OperatorInformation
• type OsDiskManagedDisk
• type Taint
• type Volume

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func GetPromQuery

func GetPromQuery(statisticsType string) (string, error)

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ClusterOperatorsInformation

type ClusterOperatorsInformation struct {
	Operators []OperatorInformation `json:"operators"`
}

type FetchClient

type FetchClient interface {
	Nodes(context.Context) (*NodeListInformation, error)
	ClusterOperators(context.Context) (*ClusterOperatorsInformation, error)
	Machines(context.Context) (*MachineListInformation, error)
	MachineSets(context.Context) (*MachineSetListInformation, error)
	Statistics(context.Context, *http.Client, string, time.Duration, time.Time, string) ([]Metrics, error)
}

FetchClient is the interface that the Admin Portal Frontend uses to gather information about clusters. It returns frontend-suitable data structures.

func NewFetchClient

func NewFetchClient(log *logrus.Entry, dialer proxy.Dialer, cluster *api.OpenShiftClusterDocument) (FetchClient, error)

type MachineListInformation

type MachineListInformation struct {
	Machines []MachinesInformation `json:"machines"`
}

func MachinesFromMachineList

func MachinesFromMachineList(machines *machinev1beta1.MachineList) *MachineListInformation

type MachineResources

type MachineResources struct {
	CPU           string
	StorageVolume string
	Memory        string
	Pods          string
}

type MachineSetListInformation

type MachineSetListInformation struct {
	MachineSets []MachineSetsInformation `json:"machines"`
}

type MachineSetProviderSpecValue

type MachineSetProviderSpecValue struct {
	Kind                 string                            `json:"kind"`
	Location             string                            `json:"location"`
	NetworkResourceGroup string                            `json:"networkresourcegroup"`
	OsDisk               MachineSetProviderSpecValueOSDisk `json:"osdisk"`
	PublicIP             bool                              `json:"publicip"`
	PublicLoadBalancer   string                            `json:"publicloadbalancer"`
	Subnet               string                            `json:"subnet"`
	VmSize               string                            `json:"vmsize"`
	Vnet                 string                            `json:"vnet"`
}

type MachineSetProviderSpecValueOSDisk

type MachineSetProviderSpecValueOSDisk struct {
	DiskSizeGB  int               `json:"disksizegb"`
	OsType      string            `json:"ostype"`
	ManagedDisk OsDiskManagedDisk `json:"manageddisk"`
}

type MachineSetsInformation

type MachineSetsInformation struct {
	Name                     string `json:"name"`
	Type                     string `json:"type"`
	CreatedAt                string `json:"createdat"`
	DesiredReplicas          int    `json:"desiredreplicas"`
	Replicas                 int    `json:"replicas"`
	ErrorReason              string `json:"errorreason"`
	ErrorMessage             string `json:"errormessage"`
	PublicLoadBalancerName   string `json:"publicloadbalancername"`
	VMSize                   string `json:"vmsize"`
	OSDiskAccountStorageType string `json:"accountstoragetype"`
	Subnet                   string `json:"subnet"`
	VNet                     string `json:"vnet"`
}

type MachinesInformation

type MachinesInformation struct {
	Name              string `json:"name"`
	CreatedTime       string `json:"createdTime"`
	LastUpdated       string `json:"lastUpdated"`
	ErrorReason       string `json:"errorReason"`
	ErrorMessage      string `json:"errorMessage"`
	LastOperation     string `json:"lastOperation"`
	LastOperationDate string `json:"lastOperationDate"`
	Status            string `json:"status"`
}

type MetricValue

type MetricValue struct {
	Timestamp time.Time `json:"timestamp"`
	Value     float64   `json:"value"`
}

MetricValue contains the actual data of the metrics at certain timestamp, and a slice of this is used in the `Metrics` struct to combine all the metrics in one object.

type Metrics

type Metrics struct {
	Name  string        `json:"metricname"`
	Value []MetricValue `json:"metricvalue"`
}

This is a structure which actually carries, a particular type of metrics

type NodeConditions

type NodeConditions struct {
	Type               string `json:"type"`
	Status             string `json:"status"`
	LastHeartbeatTime  string `json:"lastHeartbeatTime,omitempty"`
	LastTransitionTime string `json:"lastTransitionTime,omitempty"`
	Reason             string `json:"reason,omitempty"`
	Message            string `json:"message,omitempty"`
}

type NodeInformation

type NodeInformation struct {
	Name        string            `json:"name"`
	CreatedTime string            `json:"createdTime"`
	Capacity    MachineResources  `json:"capacity"`
	Volumes     []Volume          `json:"volumes"`
	Allocatable MachineResources  `json:"allocatable"`
	Taints      []Taint           `json:"taints"`
	Conditions  []NodeConditions  `json:"conditions"`
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`
}

type NodeListInformation

type NodeListInformation struct {
	Nodes []NodeInformation `json:"nodes"`
}

func NodesFromNodeList

func NodesFromNodeList(nodes *corev1.NodeList) *NodeListInformation

type OperatorCondition

type OperatorCondition struct {
	Type        configv1.ClusterStatusConditionType `json:"type"`
	LastUpdated string                              `json:"lastUpdated"`
	Status      configv1.ConditionStatus            `json:"status"`
	Reason      string                              `json:"reason"`
	Message     string                              `json:"message"`
}

Type for listing different operator conditions such as "progressing", "degraded" etc

type OperatorInformation

type OperatorInformation struct {
	Name        string                   `json:"name"`
	Available   configv1.ConditionStatus `json:"available"`
	Progressing configv1.ConditionStatus `json:"progressing"`
	Degraded    configv1.ConditionStatus `json:"degraded"`
	Conditions  []OperatorCondition      `json:"conditions"`
}

Type for holding information relating to a specific cluster operator. Certain conditions are listed as properties (Available, Progressing, Degraded) as they are default for all operators

type OsDiskManagedDisk

type OsDiskManagedDisk struct {
	StorageAccountType string `json:"storageaccounttype"`
}

type Taint

type Taint struct {
	Key       string `json:"key"`
	Value     string `json:"value,omitempty"`
	Effect    string `json:"effect"`
	TimeAdded string `json:"timeAdded,omitempty"`
}

type Volume

type Volume struct {
	Name string
	Path string
}