k8stopo

Documentation

Overview

Package k8stopo implements topo.Server with the Kubernetes API as the backend.

We expect the following behavior from the kubernetes client library:

• TODO

We follow these conventions within this package:

• TODO

Index

• func VersionFromInt(version int64) topo.Version
• type Factory
  • func (f Factory) Create(cell, serverAddr, root string) (topo.Conn, error)
  • func (f Factory) HasGlobalReadOnlyCell(serverAddr, root string) bool
• type KubernetesVersion
  • func (v KubernetesVersion) String() string
• type NodeReference
  • func (n *NodeReference) ToData() vtv1beta1.VitessTopoNodeData
• type Server
  • func NewServer(_, root string) (*Server, error)
  • func (s *Server) Close()
  • func (s *Server) Create(ctx context.Context, filePath string, contents []byte) (topo.Version, error)
  • func (s *Server) Delete(ctx context.Context, filePath string, version topo.Version) error
  • func (s *Server) Get(ctx context.Context, filePath string) ([]byte, topo.Version, error)
  • func (s *Server) List(ctx context.Context, filePathPrefix string) ([]topo.KVInfo, error)
  • func (s *Server) ListDir(ctx context.Context, dirPath string, full bool) ([]topo.DirEntry, error)
  • func (s *Server) Lock(ctx context.Context, dirPath, contents string) (topo.LockDescriptor, error)
  • func (s *Server) NewLeaderParticipation(name, id string) (topo.LeaderParticipation, error)
  • func (s *Server) Update(ctx context.Context, filePath string, contents []byte, version topo.Version) (topo.Version, error)
  • func (s *Server) Watch(ctx context.Context, filePath string) (*topo.WatchData, <-chan *topo.WatchData, error)
  • func (s *Server) WatchRecursive(_ context.Context, path string) ([]*topo.WatchDataRecursive, <-chan *topo.WatchDataRecursive, error)

Functions

func VersionFromInt

func VersionFromInt(version int64) topo.Version

VersionFromInt is used by old-style functions to create a proper Version: if version is -1, returns nil. Otherwise returns the KubernetesVersion object.

Types

type Factory

type Factory struct{}

Factory is the Kubernetes topo.Factory implementation.

func (Factory) Create

func (f Factory) Create(cell, serverAddr, root string) (topo.Conn, error)

Create is part of the topo.Factory interface.

func (Factory) HasGlobalReadOnlyCell

func (f Factory) HasGlobalReadOnlyCell(serverAddr, root string) bool

HasGlobalReadOnlyCell is part of the topo.Factory interface.

type KubernetesVersion

type KubernetesVersion string

KubernetesVersion is Kubernetes's idea of a version. It implements topo.Version.

func (KubernetesVersion) String

func (v KubernetesVersion) String() string

String is part of the topo.Version interface.

type NodeReference

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

NodeReference contains the data relating to a node

func (*NodeReference) ToData

func (n *NodeReference) ToData() vtv1beta1.VitessTopoNodeData

ToData converts a nodeReference to the data type used in the VitessTopoNode

type Server

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

Server is the implementation of topo.Server for Kubernetes.

func NewServer

func NewServer(_, root string) (*Server, error)

NewServer returns a new k8stopo.Server.

func (*Server) Close

func (s *Server) Close()

Close implements topo.Server.Close.

func (*Server) Create

func (s *Server) Create(ctx context.Context, filePath string, contents []byte) (topo.Version, error)

Create is part of the topo.Conn interface.

func (*Server) Delete

func (s *Server) Delete(ctx context.Context, filePath string, version topo.Version) error

Delete is part of the topo.Conn interface.

func (*Server) Get

func (s *Server) Get(ctx context.Context, filePath string) ([]byte, topo.Version, error)

Get is part of the topo.Conn interface.

func (*Server) List

func (s *Server) List(ctx context.Context, filePathPrefix string) ([]topo.KVInfo, error)

List is part of the topo.Conn interface.

func (*Server) ListDir

func (s *Server) ListDir(ctx context.Context, dirPath string, full bool) ([]topo.DirEntry, error)

ListDir is part of the topo.Conn interface. It uses an internal cache to find all the objects matching a specific key and returns a slice of results sorted alphabetically to emulate the behavior of etcd, zk, consul, etc

func (*Server) Lock

func (s *Server) Lock(ctx context.Context, dirPath, contents string) (topo.LockDescriptor, error)

Lock is part of the topo.Conn interface.

func (*Server) NewLeaderParticipation

func (s *Server) NewLeaderParticipation(name, id string) (topo.LeaderParticipation, error)

NewLeaderParticipation is part of the topo.Server interface

func (*Server) Update

func (s *Server) Update(ctx context.Context, filePath string, contents []byte, version topo.Version) (topo.Version, error)

Update is part of the topo.Conn interface.

func (*Server) Watch

func (s *Server) Watch(ctx context.Context, filePath string) (*topo.WatchData, <-chan *topo.WatchData, error)

Watch is part of the topo.Conn interface.

func (*Server) WatchRecursive

func (s *Server) WatchRecursive(_ context.Context, path string) ([]*topo.WatchDataRecursive, <-chan *topo.WatchDataRecursive, error)

WatchRecursive is part of the topo.Conn interface.