clusterversion

Documentation

Index

• Constants
• type Builder
  • func Pull(apiClient *clients.Settings) (*Builder, error)
  • func (builder *Builder) Exists() bool
  • func (builder *Builder) Get() (*configv1.ClusterVersion, error)
  • func (builder *Builder) GetNextUpdateVersionImage(stream string, acceptConditionalVersions bool) (string, error)
  • func (builder *Builder) Update() (*Builder, error)
  • func (builder *Builder) WaitUntilAvailable(timeout time.Duration) error
  • func (builder *Builder) WaitUntilConditionTrue(conditionType configv1.ClusterStatusConditionType, timeout time.Duration) error
  • func (builder *Builder) WaitUntilProgressing(timeout time.Duration) error
  • func (builder *Builder) WaitUntilUpdateHistoryStateTrue(updateHistoryState configv1.UpdateState, timeout time.Duration) error
  • func (builder *Builder) WaitUntilUpdateIsCompleted(timeout time.Duration) error
  • func (builder *Builder) WaitUntilUpdateIsStarted(timeout time.Duration) error
  • func (builder *Builder) WithDesiredUpdateChannel(updateChannel string) *Builder
  • func (builder *Builder) WithDesiredUpdateImage(desiredUpdateImage string, force bool) *Builder

Constants

const (
	// X stream.
	X = "X"
	// Y stream.
	Y = "Y"
	// Z stream.
	Z = "Z"
)

Types

type Builder

type Builder struct {
	// clusterversion definition, used to create the clusterversion object.
	Definition *configv1.ClusterVersion
	// Created clusterversion object.
	Object *configv1.ClusterVersion
	// contains filtered or unexported fields
}

Builder provides a struct for clusterversion object from the cluster and a clusterversion definition.

func Pull

func Pull(apiClient *clients.Settings) (*Builder, error)

Pull loads an existing clusterversion into Builder struct.

func (*Builder) Exists

func (builder *Builder) Exists() bool

Exists checks whether the given clusterversion exists.

func (*Builder) Get

func (builder *Builder) Get() (*configv1.ClusterVersion, error)

Get returns the ClusterVersion object from the cluster if it exists.

func (*Builder) GetNextUpdateVersionImage

func (builder *Builder) GetNextUpdateVersionImage(stream string, acceptConditionalVersions bool) (string, error)

GetNextUpdateVersionImage fetches the next recommended or conditional update for the cluster.

func (*Builder) Update

func (builder *Builder) Update() (*Builder, error)

Update renovates the existing clusterversion object with the clusterversion definition in builder.

func (*Builder) WaitUntilAvailable

func (builder *Builder) WaitUntilAvailable(timeout time.Duration) error

WaitUntilAvailable waits for timeout duration or until clusterversion is in Available state.

func (*Builder) WaitUntilConditionTrue

func (builder *Builder) WaitUntilConditionTrue(
	conditionType configv1.ClusterStatusConditionType, timeout time.Duration) error

WaitUntilConditionTrue waits for timeout duration or until clusterversion gets to a specific status.

func (*Builder) WaitUntilProgressing

func (builder *Builder) WaitUntilProgressing(timeout time.Duration) error

WaitUntilProgressing waits for timeout duration or until clusterversion is in Progressing state.

func (*Builder) WaitUntilUpdateHistoryStateTrue

func (builder *Builder) WaitUntilUpdateHistoryStateTrue(
	updateHistoryState configv1.UpdateState, timeout time.Duration) error

WaitUntilUpdateHistoryStateTrue waits until there is a history entry indicating an updateHistoryState.

func (*Builder) WaitUntilUpdateIsCompleted

func (builder *Builder) WaitUntilUpdateIsCompleted(timeout time.Duration) error

WaitUntilUpdateIsCompleted waits until there is a history entry indicating the update completed.

func (*Builder) WaitUntilUpdateIsStarted

func (builder *Builder) WaitUntilUpdateIsStarted(timeout time.Duration) error

WaitUntilUpdateIsStarted waits until there is a history entry indicating the update start.

func (*Builder) WithDesiredUpdateChannel

func (builder *Builder) WithDesiredUpdateChannel(updateChannel string) *Builder

WithDesiredUpdateChannel adds the desired channel to the clusterversion struct.

func (*Builder) WithDesiredUpdateImage

func (builder *Builder) WithDesiredUpdateImage(desiredUpdateImage string, force bool) *Builder

WithDesiredUpdateImage adds the desired image to the clusterversion struct.