history

Documentation

Index

• Constants
• func ControllerRevisionName(prefix string, hash uint32) string
• func EqualRevision(lhs *apps.ControllerRevision, rhs *apps.ControllerRevision) bool
• func FindEqualRevisions(revisions []*apps.ControllerRevision, needle *apps.ControllerRevision) []*apps.ControllerRevision
• func HashControllerRevision(revision *apps.ControllerRevision, probe *uint32) uint32
• func NewControllerRevision(parent metav1.Object, parentKind schema.GroupVersionKind, ...) (*apps.ControllerRevision, error)
• func SortControllerRevisions(revisions []*apps.ControllerRevision)
• type Interface
  • func NewFakeHistory(informer appsinformers.ControllerRevisionInformer) Interface
  • func NewHistory(client clientset.Interface, lister appslisters.ControllerRevisionLister) Interface

Constants

const ControllerRevisionHashLabel = "controller.kubernetes.io/hash"

ControllerRevisionHashLabel is the label used to indicate the hash value of a ControllerRevision's Data.

Functions

func ControllerRevisionName

func ControllerRevisionName(prefix string, hash uint32) string

ControllerRevisionName returns the Name for a ControllerRevision in the form prefix-hash. If the length of prefix is greater than 223 bytes, it is truncated to allow for a name that is no larger than 253 bytes.

func EqualRevision

func EqualRevision(lhs *apps.ControllerRevision, rhs *apps.ControllerRevision) bool

EqualRevision returns true if lhs and rhs are either both nil, or both point to non-nil ControllerRevisions that contain semantically equivalent data. Otherwise this method returns false.

func FindEqualRevisions

func FindEqualRevisions(revisions []*apps.ControllerRevision, needle *apps.ControllerRevision) []*apps.ControllerRevision

FindEqualRevisions returns all ControllerRevisions in revisions that are equal to needle using EqualRevision as the equality test. The returned slice preserves the order of revisions.

func HashControllerRevision

func HashControllerRevision(revision *apps.ControllerRevision, probe *uint32) uint32

HashControllerRevision hashes the contents of revision's Data using FNV hashing. If probe is not nil, the byte value of probe is added written to the hash as well.

func NewControllerRevision

func NewControllerRevision(parent metav1.Object,
	parentKind schema.GroupVersionKind,
	selector labels.Selector,
	data runtime.RawExtension,
	revision int64) (*apps.ControllerRevision, error)

NewControllerRevision returns the a ControllerRevision with a ControllerRef pointing parent and indicating that parent is of parentKind. The ControllerRevision has labels matching selector, contains Data equal to data, and has a Revision equal to revision. If the returned error is nil, the returned ControllerRevision is valid. If the returned error is not nil, the returned ControllerRevision is invalid for use.

func SortControllerRevisions

func SortControllerRevisions(revisions []*apps.ControllerRevision)

SortControllerRevisions sorts revisions by their Revision.

Types

type Interface

type Interface interface {
	// ListControllerRevisions lists all ControllerRevisions matching selector and owned by parent or no other
	// controller. If the returned error is nil the returned slice of ControllerRevisions is valid. If the
	// returned error is not nil, the returned slice is not valid.
	ListControllerRevisions(parent metav1.Object, selector labels.Selector) ([]*apps.ControllerRevision, error)
	// CreateControllerRevision attempts to create the revision as owned by parent via a ControllerRef. If name
	// collision occurs, a unique identifier is added to the hash of the revision and it is renamed using
	// ControllerRevisionName. Implementations may cease to attempt to retry creation after some number of attempts
	// and return an error. If the returned error is not nil, creation failed. If the returned error is nil, the
	// returned ControllerRevision has been created.
	CreateControllerRevision(parent metav1.Object, revision *apps.ControllerRevision) (*apps.ControllerRevision, error)
	// DeleteControllerRevision attempts to delete revision. If the returned error is not nil, deletion has failed.
	DeleteControllerRevision(revision *apps.ControllerRevision) error
	// UpdateControllerRevision updates revision such that its Revision is equal to newRevision. Implementations
	// may retry on conflict. If the returned error is nil, the update was successful and returned ControllerRevision
	// is valid. If the returned error is not nil, the update failed and the returned ControllerRevision is invalid.
	UpdateControllerRevision(revision *apps.ControllerRevision, newRevision int64) (*apps.ControllerRevision, error)
	// AdoptControllerRevision attempts to adopt revision by adding a ControllerRef indicating that the parent
	// Object of parentKind is the owner of revision. If revision is already owned, an error is returned. If the
	// resource patch fails, an error is returned. If no error is returned, the returned ControllerRevision is
	// valid.
	AdoptControllerRevision(parent metav1.Object, parentKind schema.GroupVersionKind, revision *apps.ControllerRevision) (*apps.ControllerRevision, error)
	// ReleaseControllerRevision attempts to release parent's ownership of revision by removing parent from the
	// OwnerReferences of revision. If an error is returned, parent remains the owner of revision. If no error is
	// returned, the returned ControllerRevision is valid.
	ReleaseControllerRevision(parent metav1.Object, revision *apps.ControllerRevision) (*apps.ControllerRevision, error)
}

Interface provides an interface allowing for management of a Controller's history as realized by recorded ControllerRevisions. An instance of Interface can be retrieved from NewHistory. Implementations must treat all pointer parameters as "in" parameter, and they must not be mutated.

func NewFakeHistory

func NewFakeHistory(informer appsinformers.ControllerRevisionInformer) Interface

NewFakeHistory returns an instance of Interface that uses informer to create, update, list, and delete ControllerRevisions. This method should be used to create an Interface for testing purposes.

func NewHistory

func NewHistory(client clientset.Interface, lister appslisters.ControllerRevisionLister) Interface

NewHistory returns an instance of Interface that uses client to communicate with the API Server and lister to list ControllerRevisions. This method should be used to create an Interface for all scenarios other than testing.