patroni

Documentation

Index

• Variables
• type Client
  • func NewPatroniClient(restConfig *rest.Config, kubeclientset kubernetes.Interface, ...) Client
• type RestartResult

Variables

var (

	// ErrInstanceNotFound is the error thrown when a target instance cannot be found in the cluster
	ErrInstanceNotFound = errors.New("The instance does not exist in the cluster")
)

Types

type Client

type Client interface {
	ReloadCluster() error
	RestartCluster() ([]RestartResult, error)
	RestartInstances(instance ...string) ([]RestartResult, error)
}

Client defines the various actions a Patroni client is able to perform against a specified PGCluster

func NewPatroniClient

func NewPatroniClient(restConfig *rest.Config, kubeclientset kubernetes.Interface,
	clusterName, namespace string) Client

NewPatroniClient creates a new Patroni client

type RestartResult

type RestartResult struct {
	Instance string
	Error    error
}

RestartResult represents the result of a cluster restart, specifically the name of the an instance that was restarted within a cluster, and an error that can be populated in the event an instance cannot be successfully restarted.