rollout

Documentation

Overview

Package rollout contains the rollout manager, allowing CloudNative-PG to spread Pod rollouts depending on the passed configuration

Index

• type Manager
  • func New(clusterRolloutDelay, instancesRolloutDelay time.Duration) *Manager
  • func (manager *Manager) CoordinateRollout(cluster client.ObjectKey, instanceName string) Result
• type Result

Types

type Manager

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

Manager is the rollout manager. It is safe to use concurrently

func New

func New(clusterRolloutDelay, instancesRolloutDelay time.Duration) *Manager

New creates a new rollout manager with the passed configuration

func (*Manager) CoordinateRollout

func (manager *Manager) CoordinateRollout(
	cluster client.ObjectKey,
	instanceName string,
) Result

CoordinateRollout is called to check whether this rollout is allowed or not by the manager

type Result

type Result struct {
	// This is true when the Pod can be rolled out immediately
	RolloutAllowed bool

	// This is set with the amount of time the operator need
	// to wait to rollout that Pod
	TimeToWait time.Duration
}

Result is the output of the rollout manager, telling the operator how much time we need to wait to rollout a Pod