Documentation
¶
Overview ¶
Package k8s provides a Kubernetes-based deployment engine for Lux networks. It implements the Engine interface to deploy validator nodes as StatefulSets.
Index ¶
- Constants
- func NewEngine(name string, image string) (engines.Engine, error)
- type Engine
- func (e *Engine) ChainID() ids.ID
- func (e *Engine) Clean(ctx context.Context) error
- func (e *Engine) GetExternalIP(ctx context.Context) (string, error)
- func (e *Engine) Health(ctx context.Context) (*engines.HealthStatus, error)
- func (e *Engine) IsRunning() bool
- func (e *Engine) Metrics() map[string]interface{}
- func (e *Engine) Name() string
- func (e *Engine) NetworkID() uint32
- func (e *Engine) P2PEndpoint() string
- func (e *Engine) ParentChain() *engines.ChainInfo
- func (e *Engine) RPCEndpoint() string
- func (e *Engine) Restart(ctx context.Context) error
- func (e *Engine) Start(ctx context.Context, config *engines.NodeConfig) error
- func (e *Engine) Stop(ctx context.Context) error
- func (e *Engine) Type() engines.EngineType
- func (e *Engine) Uptime() time.Duration
- func (e *Engine) WSEndpoint() string
Constants ¶
View Source
const (
EngineK8s engines.EngineType = "k8s"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
Engine implements the Engine interface for Kubernetes deployments
func (*Engine) GetExternalIP ¶
GetExternalIP returns the external LoadBalancer IP
func (*Engine) P2PEndpoint ¶
P2PEndpoint returns the staking/P2P endpoint
func (*Engine) ParentChain ¶
ParentChain returns nil (Lux is L1)
func (*Engine) RPCEndpoint ¶
RPCEndpoint returns the external RPC endpoint
func (*Engine) WSEndpoint ¶
WSEndpoint returns the external WebSocket endpoint
Source Files
Click to show internal directories.
Click to hide internal directories.