collector

Documentation

Index

• Constants
• func CollectData(cmd *cobra.Command, target string) error
• func LoadConfig(target string) (map[string]*SpecInfo, error)
• func SanitizeString(output string, replaceable map[string]string) string
• func StringToArray(output string, delimiter string) []interface{}
• type Cluster
  • func GetCluster() (*Cluster, error)
  • func NewCluster(clientSet *kubernetes.Clientset, clientConfig clientcmd.ClientConfig, ...) *Cluster
  • func (cluster *Cluster) Platfrom() (Platform, error)
• type Collector
• type Info
• type Node
• type Platform
• type Shell
  • func NewShellCmd() Shell
• type SpecInfo
• type SpecVersion

Constants

const (

	// Version resource version
	Version = "v1"
	// Kind resource kind
	Kind = "NodeInfo"
)

const (
	// WorkerNode worker node type
	WorkerNode = "worker"
	// MasterNode master Node type
	MasterNode = "master"
)

Functions

func CollectData

func CollectData(cmd *cobra.Command, target string) error

CollectData run spec audit command and output it result data

func LoadConfig

func LoadConfig(target string) (map[string]*SpecInfo, error)

LoadConfig load audit commands specification from config file

func SanitizeString

func SanitizeString(output string, replaceable map[string]string) string

SanitizeString snitize string from special characters

func StringToArray

func StringToArray(output string, delimiter string) []interface{}

StringToArray convert string with delimiter to array

Types

type Cluster

type Cluster struct {
	// contains filtered or unexported fields
}

func GetCluster

func GetCluster() (*Cluster, error)

func NewCluster

func NewCluster(clientSet *kubernetes.Clientset, clientConfig clientcmd.ClientConfig, restMApper meta.RESTMapper, dynamicClient dynamic.Interface) *Cluster

func (*Cluster) Platfrom

func (cluster *Cluster) Platfrom() (Platform, error)

type Collector

type Collector struct {
	Key      string `yaml:"key"`
	Title    string `yaml:"title"`
	Audit    string `yaml:"audit"`
	NodeType string `yaml:"nodeType"`
}

Collector details of info to collect

type Info

type Info struct {
	Values interface{} `json:"values"`
}

Info comand output result

type Node

type Node struct {
	APIVersion string            `json:"apiVersion"`
	Kind       string            `json:"kind"`
	Metadata   map[string]string `json:"metadata"`
	Type       string            `json:"type"`
	Info       map[string]*Info  `json:"info"`
}

Node output node data with info results

type Platform

type Platform struct {
	Name    string
	Version string
}

type Shell

type Shell interface {
	Execute(commandArgs string) (string, error)
	FindNodeType() (string, error)
}

Shell command interface to preform shell exec commands

func NewShellCmd

func NewShellCmd() Shell

NewShellCmd instansiate new shell command

type SpecInfo

type SpecInfo struct {
	Version    string      `yaml:"version"`
	Name       string      `yaml:"name"`
	Title      string      `yaml:"title"`
	Collectors []Collector `yaml:"collectors"`
}

SpecInfo spec info with require comand to collect

type SpecVersion

type SpecVersion struct {
	Name    string
	Version string
}