k8s

Documentation

Index

• func NewNetwork(log logging.Logger, conf network.Config) (network.Network, error)
• type Node
  • func (n *Node) GetAPIClient() api.Client
  • func (n *Node) GetAPIPort() uint16
  • func (n *Node) GetK8sObjSpec() *k8sapi.Avalanchego
  • func (n *Node) GetName() string
  • func (n *Node) GetNodeID() ids.ShortID
  • func (n *Node) GetP2PPort() uint16
  • func (n *Node) GetURL() string
• type ObjectSpec

Functions

func NewNetwork

func NewNetwork(log logging.Logger, conf network.Config) (network.Network, error)

NewNetwork returns a new network whose initial state is specified in the config

Types

type Node

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

Node is a Avalanchego representation on k8s

func (*Node) GetAPIClient

func (n *Node) GetAPIClient() api.Client

See node.Node

func (*Node) GetAPIPort

func (n *Node) GetAPIPort() uint16

func (*Node) GetK8sObjSpec

func (n *Node) GetK8sObjSpec() *k8sapi.Avalanchego

GetK8sObjSpec returns the kubernetes object spec representation of this node

func (*Node) GetName

func (n *Node) GetName() string

See node.Node

func (*Node) GetNodeID

func (n *Node) GetNodeID() ids.ShortID

See node.Node

func (*Node) GetP2PPort

func (n *Node) GetP2PPort() uint16

See node.Node

func (*Node) GetURL

func (n *Node) GetURL() string

See node.Node

type ObjectSpec

type ObjectSpec struct {
	Namespace  string `json:"namespace"`  // The kubernetes Namespace
	Identifier string `json:"identifier"` // Identifies this network in the cluster
	Kind       string `json:"kind"`       // Identifies the object Kind for the operator
	APIVersion string `json:"apiVersion"` // The APIVersion of the kubernetes object
	Image      string `json:"image"`      // The docker image to use
	Tag        string `json:"tag"`        // The docker tag to use
}

ObjectSpec is the K8s-specifc object config. This is the "implementation-specic config" for the K8s-based network runner. See struct Config in network/node/node.go.