kubernetes

package

v0.14.0 Latest Latest Go to latest Published: Apr 19, 2016 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

mygithub.libinneed.workers.dev/weaveworks/scope

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Client
- func NewClient(addr string, resyncPeriod time.Duration) (Client, error)
type Pod
- func NewPod(p *api.Pod) Pod
type Reporter
- func NewReporter(client Client) *Reporter
- func (Reporter) Name() string
- func (r *Reporter) Report() (report.Report, error)
type Service
- func NewService(s *api.Service) Service

Constants ¶

View Source

const (
	PodID           = "kubernetes_pod_id"
	PodName         = "kubernetes_pod_name"
	PodCreated      = "kubernetes_pod_created"
	PodContainerIDs = "kubernetes_pod_container_ids"
	PodState        = "kubernetes_pod_state"
	ServiceIDs      = "kubernetes_service_ids"
)

These constants are keys used in node metadata

View Source

const (
	ServiceID      = "kubernetes_service_id"
	ServiceName    = "kubernetes_service_name"
	ServiceCreated = "kubernetes_service_created"
)

These constants are keys used in node metadata

View Source

const (
	Namespace = "kubernetes_namespace"
)

These constants are keys used in node metadata

Variables ¶

View Source

var (
	PodMetadataTemplates = report.MetadataTemplates{
		PodID:      {ID: PodID, Label: "ID", From: report.FromLatest, Priority: 1},
		PodState:   {ID: PodState, Label: "State", From: report.FromLatest, Priority: 2},
		Namespace:  {ID: Namespace, Label: "Namespace", From: report.FromLatest, Priority: 3},
		PodCreated: {ID: PodCreated, Label: "Created", From: report.FromLatest, Priority: 4},
	}

	ServiceMetadataTemplates = report.MetadataTemplates{
		ServiceID:      {ID: ServiceID, Label: "ID", From: report.FromLatest, Priority: 1},
		Namespace:      {ID: Namespace, Label: "Namespace", From: report.FromLatest, Priority: 2},
		ServiceCreated: {ID: ServiceCreated, Label: "Created", From: report.FromLatest, Priority: 3},
	}
)

Exposed for testing

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	Stop()
	WalkPods(f func(Pod) error) error
	WalkServices(f func(Service) error) error
}

Client keeps track of running kubernetes pods and services

func NewClient ¶

func NewClient(addr string, resyncPeriod time.Duration) (Client, error)

NewClient returns a usable Client. Don't forget to Stop it.

type Pod ¶

type Pod interface {
	ID() string
	Name() string
	Namespace() string
	ContainerIDs() []string
	Created() string
	AddServiceID(id string)
	Labels() labels.Labels
	GetNode() report.Node
}

Pod represents a Kubernetes pod

func NewPod ¶

func NewPod(p *api.Pod) Pod

NewPod creates a new Pod

type Reporter ¶

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

Reporter generate Reports containing Container and ContainerImage topologies

func NewReporter ¶

func NewReporter(client Client) *Reporter

NewReporter makes a new Reporter

func (Reporter) Name ¶ added in v0.10.0

func (Reporter) Name() string

Name of this reporter, for metrics gathering

func (*Reporter) Report ¶

func (r *Reporter) Report() (report.Report, error)

Report generates a Report containing Container and ContainerImage topologies

type Service ¶

type Service interface {
	ID() string
	Name() string
	Namespace() string
	GetNode() report.Node
	Selector() labels.Selector
}

Service represents a Kubernetes service

func NewService ¶

func NewService(s *api.Service) Service

NewService creates a new Service

Source Files ¶

client.go
pod.go
reporter.go
service.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL