node

Documentation

Overview

Package node provides information about nodes in tenant clusters.

Index

• func IsInvalidConfig(err error) bool
• type Config
• type Request
• type Response
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) ListNodes(ctx context.Context, request Request) (*Response, error)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	Logger        micrologger.Logger
	TenantCluster tenantcluster.Interface
}

Config represents the configuration used to create a new Tenant service.

type Request

type Request struct {
	ClusterID string
	Endpoint  string
}

Request is the configuration for the service action.

type Response

type Response struct {
	Nodes []v1.Node `json:"nodes"`
}

Response holds the data returned from the ListNodes function.

type Service

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

Service holds the dependencies for the Tenant service.

func New

func New(config Config) (*Service, error)

New creates a new configured service object.

func (*Service) ListNodes

func (s *Service) ListNodes(ctx context.Context, request Request) (*Response, error)

ListNodes returns a slice of Nodes in a tenant cluster.