webserver

Documentation

Overview

Package webserver contains the web server powering probes, backups and metrics

Index

• Constants
• type BackupClient
  • func NewBackupClient() BackupClient
• type BackupConnectionPhase
• type BackupResultData
• type Error
• type PluginBackupCommand
  • func NewPluginBackupCommand(cluster *apiv1.Cluster, backup *apiv1.Backup, client client.Client, ...) *PluginBackupCommand
  • func (b *PluginBackupCommand) Close()
  • func (b *PluginBackupCommand) Start(ctx context.Context)
• type Response
  • func (body Response[T]) EnsureDataIsPresent() error
• type StartBackupRequest
• type StopBackupRequest
  • func NewStopBackupRequest(backupName string) *StopBackupRequest
• type Webserver
  • func NewLocalWebServer(instance *postgres.Instance) (*Webserver, error)
  • func NewRemoteWebServer(instance *postgres.Instance, cancelFunc context.CancelFunc, ...) (*Webserver, error)
  • func NewWebServer(server *http.Server) *Webserver
  • func (ws *Webserver) Start(ctx context.Context) error

Constants

const (
	// DefaultReadTimeout is the default value to be used by the webservers
	DefaultReadTimeout = 20 * time.Second
	// DefaultReadHeaderTimeout is the default value to be used by the webservers
	DefaultReadHeaderTimeout = 3 * time.Second
)

Types

type BackupClient

type BackupClient interface {
	StatusWithErrors(ctx context.Context, pod *corev1.Pod) (*Response[BackupResultData], error)
	Start(ctx context.Context, pod *corev1.Pod, sbq StartBackupRequest) error
	Stop(ctx context.Context, pod *corev1.Pod, sbq StopBackupRequest) error
}

BackupClient is a struct capable of interacting with the instance backup endpoints

func NewBackupClient

func NewBackupClient() BackupClient

NewBackupClient creates a client capable of interacting with the instance backup endpoints

type BackupConnectionPhase

type BackupConnectionPhase string

BackupConnectionPhase a connection phase of the backup

const (
	Starting  BackupConnectionPhase = "starting"
	Started   BackupConnectionPhase = "started"
	Closing   BackupConnectionPhase = "closing"
	Completed BackupConnectionPhase = "completed"
)

A backup phase

type BackupResultData

type BackupResultData struct {
	BeginLSN   postgresUtils.LSN     `json:"beginLSN,omitempty"`
	EndLSN     postgresUtils.LSN     `json:"endLSN,omitempty"`
	LabelFile  []byte                `json:"labelFile,omitempty"`
	SpcmapFile []byte                `json:"spcmapFile,omitempty"`
	BackupName string                `json:"backupName,omitempty"`
	Phase      BackupConnectionPhase `json:"phase,omitempty"`
}

BackupResultData is the result of executing pg_start_backup and pg_stop_backup

type Error

type Error struct {
	// One of a server-defined set of error codes
	Code string `json:"code"`
	// A human-readable representation of the error.
	Message string `json:"message"`
	// An array of details about specific errors that led to this reported error.
	Details []Error `json:"details,omitempty"`
}

Error an error response from http webserver

type PluginBackupCommand

type PluginBackupCommand struct {
	Cluster  *apiv1.Cluster
	Backup   *apiv1.Backup
	Client   client.Client
	Recorder record.EventRecorder
	Log      log.Logger
	Plugins  repository.Interface
}

PluginBackupCommand represent a backup command that is being executed

func NewPluginBackupCommand

func NewPluginBackupCommand(
	cluster *apiv1.Cluster,
	backup *apiv1.Backup,
	client client.Client,
	recorder record.EventRecorder,
) *PluginBackupCommand

NewPluginBackupCommand initializes a BackupCommand object, taking a physical backup using Barman Cloud

func (*PluginBackupCommand) Close

func (b *PluginBackupCommand) Close()

Close closes all the connections to the plugins

func (*PluginBackupCommand) Start

func (b *PluginBackupCommand) Start(ctx context.Context)

Start starts a backup using the Plugin

type Response

type Response[T interface{}] struct {
	Data  *T     `json:"data,omitempty"`
	Error *Error `json:"error,omitempty"`
}

Response a response from the http webserver

func (Response[T]) EnsureDataIsPresent

func (body Response[T]) EnsureDataIsPresent() error

EnsureDataIsPresent returns an error if the data is field is nil

type StartBackupRequest

type StartBackupRequest struct {
	ImmediateCheckpoint bool   `json:"immediateCheckpoint"`
	WaitForArchive      bool   `json:"waitForArchive"`
	BackupName          string `json:"backupName"`
	Force               bool   `json:"force,omitempty"`
}

StartBackupRequest the required data to execute the pg_start_backup

type StopBackupRequest

type StopBackupRequest struct {
	BackupName string `json:"backupName"`
}

StopBackupRequest the required data to execute the pg_stop_backup

func NewStopBackupRequest

func NewStopBackupRequest(backupName string) *StopBackupRequest

NewStopBackupRequest constructor

type Webserver

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

Webserver wraps a webserver to make it a kubernetes Runnable

func NewLocalWebServer

func NewLocalWebServer(instance *postgres.Instance) (*Webserver, error)

NewLocalWebServer returns a webserver that allows connection only from localhost

func NewRemoteWebServer

func NewRemoteWebServer(
	instance *postgres.Instance,
	cancelFunc context.CancelFunc,
	exitedConditions concurrency.MultipleExecuted,
) (*Webserver, error)

NewRemoteWebServer returns a webserver that allows connection from external clients

func NewWebServer

func NewWebServer(server *http.Server) *Webserver

NewWebServer creates a Webserver as a Kubernetes Runnable, given a http.Server

func (*Webserver) Start

func (ws *Webserver) Start(ctx context.Context) error

Start starts a webserver listener, implementing the K8s runnable interface