arista

Documentation

Overview

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func New(nodeImpl *node.Impl) (node.Node, error)
• type Node
  • func (n *Node) ConfigPush(ctx context.Context, r io.Reader) error
  • func (n *Node) Create(ctx context.Context) error
  • func (n *Node) CreateCRD(ctx context.Context) error
  • func (n *Node) CreateConfig(ctx context.Context) (*corev1.Volume, error)
  • func (n *Node) Delete(ctx context.Context) error
  • func (n *Node) FixInterfaces() error
  • func (n *Node) GenerateSelfSigned(ctx context.Context) error
  • func (n *Node) ResetCfg(ctx context.Context) error
  • func (n *Node) SpawnCLIConn() error
  • func (n *Node) Status(ctx context.Context) (node.Status, error)

Variables

var (
	// ErrIncompatibleCliConn raised when an invalid scrapligo cli transport type is found.
	ErrIncompatibleCliConn = errors.New("incompatible cli connection in use")
)

Functions

func New

func New(nodeImpl *node.Impl) (node.Node, error)

Types

type Node

type Node struct {
	*node.Impl
	// contains filtered or unexported fields
}

func (*Node) ConfigPush

func (n *Node) ConfigPush(ctx context.Context, r io.Reader) error

func (*Node) Create

func (n *Node) Create(ctx context.Context) error

func (*Node) CreateCRD

func (n *Node) CreateCRD(ctx context.Context) error

func (*Node) CreateConfig

func (n *Node) CreateConfig(ctx context.Context) (*corev1.Volume, error)

func (*Node) Delete

func (n *Node) Delete(ctx context.Context) error

func (*Node) FixInterfaces

func (n *Node) FixInterfaces() error

func (*Node) GenerateSelfSigned

func (n *Node) GenerateSelfSigned(ctx context.Context) error

func (*Node) ResetCfg

func (n *Node) ResetCfg(ctx context.Context) error

func (*Node) SpawnCLIConn

func (n *Node) SpawnCLIConn() error

SpawnCLIConn spawns a CLI connection towards a Network OS using `kubectl exec` terminal and ensures CLI is ready to accept inputs. scrapligo options can be provided to this function for a caller to modify scrapligo platform. For example, mock transport can be set via options

func (*Node) Status

func (n *Node) Status(ctx context.Context) (node.Status, error)