node

Documentation

Overview

Package node implements nodes. They do chef-client runs.

Index

• func Count() int64
• func DeleteNodeStatusesByAge(dur time.Duration) (int, error)
• func DoesExist(nodeName string) (bool, util.Gerror)
• func GetList() []string
• func ImportStatus(nodeJSON map[string]interface{}) error
• type ByTime
  • func (b ByTime) Len() int
  • func (b ByTime) Less(i, j int) bool
  • func (b ByTime) Swap(i, j int)
• type Node
  • func AllNodes() []*Node
  • func Get(nodeName string) (*Node, util.Gerror)
  • func GetFromEnv(envName string) ([]*Node, error)
  • func GetMulti(nodeNames []string) ([]*Node, util.Gerror)
  • func GetNodesByStatus(nodeNames []string, status string) ([]*Node, error)
  • func New(name string) (*Node, util.Gerror)
  • func NewFromJSON(jsonNode map[string]interface{}) (*Node, util.Gerror)
  • func UnseenNodes() ([]*Node, error)
  • func (n *Node) AllStatuses() ([]*NodeStatus, error)
  • func (n *Node) Delete() error
  • func (n *Node) DocID() string
  • func (n *Node) Flatten() map[string]interface{}
  • func (n *Node) GetName() string
  • func (n *Node) Index() string
  • func (n *Node) LatestStatus() (*NodeStatus, error)
  • func (n *Node) Save() error
  • func (n *Node) URLType() string
  • func (n *Node) UpdateFromJSON(jsonNode map[string]interface{}) util.Gerror
  • func (n *Node) UpdateStatus(status string) error
• type NodeStatus
  • func AllNodeStatuses() []*NodeStatus
  • func (ns *NodeStatus) ToJSON() map[string]string

Functions

func Count

func Count() int64

Count returns a count of all nodes on this server.

func DeleteNodeStatusesByAge

func DeleteNodeStatusesByAge(dur time.Duration) (int, error)

DeleteNodeStatusesByAge deletes node status older than the given duration. It returns the number of statuses deleted, and an error if any.

func DoesExist

func DoesExist(nodeName string) (bool, util.Gerror)

DoesExist checks if the node in question exists or not

func GetList

func GetList() []string

GetList gets a list of the nodes on this server.

func ImportStatus

func ImportStatus(nodeJSON map[string]interface{}) error

ImportStatus is used by the import function to import node statuses from the exported JSON dump.

Types

type ByTime

type ByTime []*NodeStatus

func (ByTime) Len

func (b ByTime) Len() int

func (ByTime) Less

func (b ByTime) Less(i, j int) bool

func (ByTime) Swap

func (b ByTime) Swap(i, j int)

type Node

type Node struct {
	Name            string                 `json:"name"`
	ChefEnvironment string                 `json:"chef_environment"`
	RunList         []string               `json:"run_list"`
	JSONClass       string                 `json:"json_class"`
	ChefType        string                 `json:"chef_type"`
	Automatic       map[string]interface{} `json:"automatic"`
	Normal          map[string]interface{} `json:"normal"`
	Default         map[string]interface{} `json:"default"`
	Override        map[string]interface{} `json:"override"`
	// contains filtered or unexported fields
}

Node is a basic Chef node, holding the run list and attributes of the node.

func AllNodes

func AllNodes() []*Node

AllNodes returns all the nodes on the server

func Get

func Get(nodeName string) (*Node, util.Gerror)

Get a node.

func GetFromEnv

func GetFromEnv(envName string) ([]*Node, error)

GetFromEnv returns all nodes that belong to the given environment.

func GetMulti

func GetMulti(nodeNames []string) ([]*Node, util.Gerror)

GetMulti gets multiple nodes from a given slice of node names.

func GetNodesByStatus

func GetNodesByStatus(nodeNames []string, status string) ([]*Node, error)

GetNodesByStatus returns the nodes that currently have the given status.

func New

func New(name string) (*Node, util.Gerror)

New makes a new node.

func NewFromJSON

func NewFromJSON(jsonNode map[string]interface{}) (*Node, util.Gerror)

NewFromJSON creates a new node from the uploaded JSON.

func UnseenNodes

func UnseenNodes() ([]*Node, error)

UnseenNodes returns all nodes that have not sent status reports for a while.

func (*Node) AllStatuses

func (n *Node) AllStatuses() ([]*NodeStatus, error)

AllStatuses returns all of the node's status reports to date.

func (*Node) Delete

func (n *Node) Delete() error

Delete the node.

func (*Node) DocID

func (n *Node) DocID() string

DocID returns the node's name.

func (*Node) Flatten

func (n *Node) Flatten() map[string]interface{}

Flatten a node for indexing.

func (*Node) GetName

func (n *Node) GetName() string

GetName returns the node's name.

func (*Node) Index

func (n *Node) Index() string

Index tells the indexer where the node should go.

func (*Node) LatestStatus

func (n *Node) LatestStatus() (*NodeStatus, error)

LatestStatus returns the node's latest status.

func (*Node) Save

func (n *Node) Save() error

Save the node.

func (*Node) URLType

func (n *Node) URLType() string

URLType returns the base element of a node's URL.

func (*Node) UpdateFromJSON

func (n *Node) UpdateFromJSON(jsonNode map[string]interface{}) util.Gerror

UpdateFromJSON updates an existing node with the uploaded JSON.

func (*Node) UpdateStatus

func (n *Node) UpdateStatus(status string) error

UpdateStatus updates a node's current status (up, down, or new).

type NodeStatus

type NodeStatus struct {
	Node      *Node
	Status    string
	UpdatedAt time.Time
}

NodeStatus records a node's status at a particular time.

func AllNodeStatuses

func AllNodeStatuses() []*NodeStatus

AllNodeStatuses returns all node status reports on the server, from all nodes.

func (*NodeStatus) ToJSON

func (ns *NodeStatus) ToJSON() map[string]string

ToJSON formats a node status report for export to JSON.