rollout

Documentation

Index

• Constants
• func DetectCandidateRevisionName(svc *run.Service, stable string) string
• func DetectStableRevisionName(svc *run.Service) string
• type Rollout
  • func New(ctx context.Context, metricsProvider metrics.Provider, ...) *Rollout
  • func (r *Rollout) Rollout() (bool, error)
  • func (r *Rollout) UpdateService(svc *run.Service) (*run.Service, error)
  • func (r *Rollout) WithClient(client runapi.Client) *Rollout
  • func (r *Rollout) WithClock(clock clockwork.Clock) *Rollout
  • func (r *Rollout) WithLogger(logger *logrus.Logger) *Rollout
• type ServiceRecord

Constants

const (
	StableRevisionAnnotation              = "rollout.cloud.run/stableRevision"
	CandidateRevisionAnnotation           = "rollout.cloud.run/candidateRevision"
	LastFailedCandidateRevisionAnnotation = "rollout.cloud.run/lastFailedCandidateRevision"
	LastRolloutAnnotation                 = "rollout.cloud.run/lastRollout"
	LastHealthReportAnnotation            = "rollout.cloud.run/lastHealthReport"
)

Annotations name for information related to the rollout.

const (
	StableTag    = "stable"
	CandidateTag = "candidate"
	LatestTag    = "latest"
)

Automatic tags.

Functions

func DetectCandidateRevisionName

func DetectCandidateRevisionName(svc *run.Service, stable string) string

DetectCandidateRevisionName attempts to deduce what revision could be considered a candidate.

func DetectStableRevisionName

func DetectStableRevisionName(svc *run.Service) string

DetectStableRevisionName returns the stable revision of the Cloud Run service.

It first checks if there's a revision with the tag "stable". If such a revision does not exist, it checks for a revision with 100% of the traffic and considers it stable.

Types

type Rollout

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

Rollout is the rollout manager.

func New

func New(ctx context.Context, metricsProvider metrics.Provider, svcRecord *ServiceRecord, strategy config.Strategy) *Rollout

New returns a new rollout manager.

func (*Rollout) Rollout

func (r *Rollout) Rollout() (bool, error)

Rollout handles the gradual rollout.

func (*Rollout) UpdateService

func (r *Rollout) UpdateService(svc *run.Service) (*run.Service, error)

UpdateService changes the traffic configuration for the revisions and update the service.

func (*Rollout) WithClient

func (r *Rollout) WithClient(client runapi.Client) *Rollout

WithClient updates the client in the rollout instance.

func (*Rollout) WithClock

func (r *Rollout) WithClock(clock clockwork.Clock) *Rollout

WithClock updates the clock in the rollout instance.

func (*Rollout) WithLogger

func (r *Rollout) WithLogger(logger *logrus.Logger) *Rollout

WithLogger updates the logger in the rollout instance.

type ServiceRecord

type ServiceRecord struct {
	*run.Service
	Project string
	Region  string
}

ServiceRecord holds a service object and information about it.