rollback

Documentation

Overview

Package rollback contains the code for generating DeploymentConfigs representing rollbacks as well as REST support for API clients.

Index

• type Client
  • func (c Client) GenerateRollback(from, to *deployapi.DeploymentConfig, ...) (*deployapi.DeploymentConfig, error)
  • func (c Client) GetDeployment(ctx kapi.Context, name string) (*kapi.ReplicationController, error)
  • func (c Client) GetDeploymentConfig(ctx kapi.Context, name string) (*deployapi.DeploymentConfig, error)
• type GeneratorClient
• type REST
  • func NewREST(generator GeneratorClient, codec runtime.Codec) *REST
  • func (s *REST) Create(ctx kapi.Context, obj runtime.Object) (runtime.Object, error)
  • func (s *REST) New() runtime.Object
• type RollbackGenerator
  • func (g *RollbackGenerator) GenerateRollback(from, to *deployapi.DeploymentConfig, ...) (*deployapi.DeploymentConfig, error)

Types

type Client

type Client struct {
	GRFn func(from, to *deployapi.DeploymentConfig, spec *deployapi.DeploymentConfigRollbackSpec) (*deployapi.DeploymentConfig, error)
	RCFn func(ctx kapi.Context, name string) (*kapi.ReplicationController, error)
	DCFn func(ctx kapi.Context, name string) (*deployapi.DeploymentConfig, error)
}

Client provides an implementation of Generator client

func (Client) GenerateRollback

func (c Client) GenerateRollback(from, to *deployapi.DeploymentConfig, spec *deployapi.DeploymentConfigRollbackSpec) (*deployapi.DeploymentConfig, error)

GenerateRollback generates a new deploymentConfig by merging a pair of deploymentConfigs

func (Client) GetDeployment

func (c Client) GetDeployment(ctx kapi.Context, name string) (*kapi.ReplicationController, error)

GetDeployment returns the deployment with the provided context and name

func (Client) GetDeploymentConfig

func (c Client) GetDeploymentConfig(ctx kapi.Context, name string) (*deployapi.DeploymentConfig, error)

GetDeployment returns the deploymentConfig with the provided context and name

type GeneratorClient

type GeneratorClient interface {
	GenerateRollback(from, to *deployapi.DeploymentConfig, spec *deployapi.DeploymentConfigRollbackSpec) (*deployapi.DeploymentConfig, error)
	GetDeployment(ctx kapi.Context, name string) (*kapi.ReplicationController, error)
	GetDeploymentConfig(ctx kapi.Context, name string) (*deployapi.DeploymentConfig, error)
}

GeneratorClient defines a local interface to a rollback generator for testability.

type REST

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

REST provides a rollback generation endpoint. Only the Create method is implemented.

func NewREST

func NewREST(generator GeneratorClient, codec runtime.Codec) *REST

NewREST safely creates a new REST.

func (*REST) Create

func (s *REST) Create(ctx kapi.Context, obj runtime.Object) (runtime.Object, error)

Create generates a new DeploymentConfig representing a rollback.

func (*REST) New

func (s *REST) New() runtime.Object

New creates an empty DeploymentConfigRollback resource

type RollbackGenerator

type RollbackGenerator struct{}

RollbackGenerator generates a new DeploymentConfig by merging a pair of DeploymentConfigs in a configurable way.

func (*RollbackGenerator) GenerateRollback

func (g *RollbackGenerator) GenerateRollback(from, to *deployapi.DeploymentConfig, spec *deployapi.DeploymentConfigRollbackSpec) (*deployapi.DeploymentConfig, error)

GenerateRollback creates a new DeploymentConfig by merging to onto from based on the options provided by spec. The LatestVersion of the result is unconditionally incremented, as rollback candidates are should be possible to be deployed manually regardless of other system behavior such as triggering.

Any image change triggers on the new config are disabled to prevent triggered deployments from immediately replacing the rollback.