lca

Documentation

Index

• type AdditionalOptions
• type ImageBasedUpgradeBuilder
  • func PullImageBasedUpgrade(apiClient *clients.Settings) (*ImageBasedUpgradeBuilder, error)
  • func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForPostReboot() *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForUpgradeCompletion() *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisabledInitMonitor() *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureInitMonitorTimeoutSeconds(seconds uint) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) Delete() (*ImageBasedUpgradeBuilder, error)
  • func (builder *ImageBasedUpgradeBuilder) Exists() bool
  • func (builder *ImageBasedUpgradeBuilder) Get() (*lcav1.ImageBasedUpgrade, error)
  • func (builder *ImageBasedUpgradeBuilder) Update() (*ImageBasedUpgradeBuilder, error)
  • func (builder *ImageBasedUpgradeBuilder) WaitUntilStageComplete(stage string) (*ImageBasedUpgradeBuilder, error)
  • func (builder *ImageBasedUpgradeBuilder) WithExtraManifests(extraManifestsConfigMapName, extraManifestsConfigMapNamespace string) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithOadpContent(oadpContentConfigMapName, oadpContentConfigMapNamespace string) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithOptions(options ...AdditionalOptions) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithSeedImage(seedImage string) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithSeedImagePullSecretRef(pullSecretName string) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithSeedImageVersion(seedImageVersion string) *ImageBasedUpgradeBuilder
  • func (builder *ImageBasedUpgradeBuilder) WithStage(stage string) *ImageBasedUpgradeBuilder
• type SeedGeneratorAdditionalOptions
• type SeedGeneratorBuilder
  • func NewSeedGeneratorBuilder(apiClient *clients.Settings, name string) *SeedGeneratorBuilder
  • func PullSeedGenerator(apiClient *clients.Settings, name string) (*SeedGeneratorBuilder, error)
  • func (builder *SeedGeneratorBuilder) Create() (*SeedGeneratorBuilder, error)
  • func (builder *SeedGeneratorBuilder) Delete() (*SeedGeneratorBuilder, error)
  • func (builder *SeedGeneratorBuilder) Exists() bool
  • func (builder *SeedGeneratorBuilder) Get() (*lcasgv1.SeedGenerator, error)
  • func (builder *SeedGeneratorBuilder) WaitUntilComplete(timeout time.Duration) (*SeedGeneratorBuilder, error)
  • func (builder *SeedGeneratorBuilder) WithOptions(options ...SeedGeneratorAdditionalOptions) *SeedGeneratorBuilder
  • func (builder *SeedGeneratorBuilder) WithRecertImage(recertImage string) *SeedGeneratorBuilder
  • func (builder *SeedGeneratorBuilder) WithSeedImage(seedImage string) *SeedGeneratorBuilder

Types

type AdditionalOptions

type AdditionalOptions func(builder *ImageBasedUpgradeBuilder) (*ImageBasedUpgradeBuilder, error)

AdditionalOptions additional options for imagebasedupgrade object.

type ImageBasedUpgradeBuilder

type ImageBasedUpgradeBuilder struct {
	// ImageBasedUpgrade definition. Used to store the imagebasedupgrade object.
	Definition *lcav1.ImageBasedUpgrade

	// Created imagebasedupgrade object.
	Object *lcav1.ImageBasedUpgrade
	// contains filtered or unexported fields
}

ImageBasedUpgradeBuilder provides struct for the imagebasedupgrade object containing connection to the cluster and the imagebasedupgrade definitions.

func PullImageBasedUpgrade

func PullImageBasedUpgrade(apiClient *clients.Settings) (*ImageBasedUpgradeBuilder, error)

PullImageBasedUpgrade pulls existing imagebasedupgrade from cluster.

func (*ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForPostReboot

func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForPostReboot() *ImageBasedUpgradeBuilder

AutoRollbackOnFailureDisableForPostReboot allows controlling AutoRollback on failure for post reboot stage.

func (*ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForUpgradeCompletion

func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisableForUpgradeCompletion() *ImageBasedUpgradeBuilder

AutoRollbackOnFailureDisableForUpgradeCompletion allows controlling AutoRollback on failure for upgrade completion stage. Enabled by default.

func (*ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisabledInitMonitor

func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureDisabledInitMonitor() *ImageBasedUpgradeBuilder

AutoRollbackOnFailureDisabledInitMonitor allows disabling the watchdog triggering a rollback upon upgrade failure within the set timeout.

func (*ImageBasedUpgradeBuilder) AutoRollbackOnFailureInitMonitorTimeoutSeconds

func (builder *ImageBasedUpgradeBuilder) AutoRollbackOnFailureInitMonitorTimeoutSeconds(
	seconds uint) *ImageBasedUpgradeBuilder

AutoRollbackOnFailureInitMonitorTimeoutSeconds allows controlling the timeout for the upgrade to complete before the rollback. Set to 1800 seconds by default.

func (*ImageBasedUpgradeBuilder) Delete

func (builder *ImageBasedUpgradeBuilder) Delete() (*ImageBasedUpgradeBuilder, error)

Delete removes the existing imagebasedupgrade from a cluster. Note that a new imagebasedupgrade with the specs from the deleted one is created instantly upon deletion.

func (*ImageBasedUpgradeBuilder) Exists

func (builder *ImageBasedUpgradeBuilder) Exists() bool

Exists checks whether the given imagebasedupgrade exists.

func (*ImageBasedUpgradeBuilder) Get

func (builder *ImageBasedUpgradeBuilder) Get() (*lcav1.ImageBasedUpgrade, error)

Get returns imagebasedupgrade object if found.

func (*ImageBasedUpgradeBuilder) Update

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

Update modifies the imagebasedupgrade resource on the cluster to match what is defined in the local definition of the builder.

func (*ImageBasedUpgradeBuilder) WaitUntilStageComplete

func (builder *ImageBasedUpgradeBuilder) WaitUntilStageComplete(stage string) (*ImageBasedUpgradeBuilder, error)

WaitUntilStageComplete waits the specified timeout for the imagebasedupgrade to complete actions for the provided stage.

func (*ImageBasedUpgradeBuilder) WithExtraManifests

func (builder *ImageBasedUpgradeBuilder) WithExtraManifests(
	extraManifestsConfigMapName, extraManifestsConfigMapNamespace string) *ImageBasedUpgradeBuilder

WithExtraManifests adds extraManifests to be used by the imagebasedupgrade. This is used to create/configure resources during upgrade.

func (*ImageBasedUpgradeBuilder) WithOadpContent

func (builder *ImageBasedUpgradeBuilder) WithOadpContent(
	oadpContentConfigMapName, oadpContentConfigMapNamespace string) *ImageBasedUpgradeBuilder

WithOadpContent adds oadpContent to be used by the imagebasedupgrade. This is used for backup/restore during upgrade.

func (*ImageBasedUpgradeBuilder) WithOptions

func (builder *ImageBasedUpgradeBuilder) WithOptions(options ...AdditionalOptions) *ImageBasedUpgradeBuilder

WithOptions creates imagebasedupgrade with generic mutation options.

func (*ImageBasedUpgradeBuilder) WithSeedImage

func (builder *ImageBasedUpgradeBuilder) WithSeedImage(
	seedImage string) *ImageBasedUpgradeBuilder

WithSeedImage sets the seed image used by the imagebasedupgrade.

func (*ImageBasedUpgradeBuilder) WithSeedImagePullSecretRef

func (builder *ImageBasedUpgradeBuilder) WithSeedImagePullSecretRef(
	pullSecretName string) *ImageBasedUpgradeBuilder

WithSeedImagePullSecretRef sets the imagebasedupgrade with reference to the pull-secret for pulling the seed image.

func (*ImageBasedUpgradeBuilder) WithSeedImageVersion

func (builder *ImageBasedUpgradeBuilder) WithSeedImageVersion(
	seedImageVersion string) *ImageBasedUpgradeBuilder

WithSeedImageVersion sets the seed image version used by the imagebasedupgrade.

func (*ImageBasedUpgradeBuilder) WithStage

func (builder *ImageBasedUpgradeBuilder) WithStage(
	stage string) *ImageBasedUpgradeBuilder

WithStage sets the stage used by the imagebasedupgrade.

type SeedGeneratorAdditionalOptions

type SeedGeneratorAdditionalOptions func(builder *SeedGeneratorBuilder) (*SeedGeneratorBuilder, error)

SeedGeneratorAdditionalOptions additional options for imagebasedupgrade object.

type SeedGeneratorBuilder

type SeedGeneratorBuilder struct {
	// SeedGenerator definition. Used to store the seedgenerator object.
	Definition *lcasgv1.SeedGenerator
	// Created seedgenerator object.
	Object *lcasgv1.SeedGenerator
	// contains filtered or unexported fields
}

SeedGeneratorBuilder provides struct for the seedgenerator object containing connection to the cluster and the seedgenerator definitions.

func NewSeedGeneratorBuilder

func NewSeedGeneratorBuilder(
	apiClient *clients.Settings,
	name string,
) *SeedGeneratorBuilder

NewSeedGeneratorBuilder creates a new instance of SeedGenerator.

func PullSeedGenerator

func PullSeedGenerator(apiClient *clients.Settings, name string) (*SeedGeneratorBuilder, error)

PullSeedGenerator pulls existing seedgenerator from cluster.

func (*SeedGeneratorBuilder) Create

func (builder *SeedGeneratorBuilder) Create() (*SeedGeneratorBuilder, error)

Create makes a seedgenerator in the cluster and stores the created object in struct.

func (*SeedGeneratorBuilder) Delete

func (builder *SeedGeneratorBuilder) Delete() (*SeedGeneratorBuilder, error)

Delete removes the existing seedgenerator from a cluster.

func (*SeedGeneratorBuilder) Exists

func (builder *SeedGeneratorBuilder) Exists() bool

Exists checks whether the given seedgenerator exists.

func (*SeedGeneratorBuilder) Get

func (builder *SeedGeneratorBuilder) Get() (*lcasgv1.SeedGenerator, error)

Get returns seedgenerator object if found.

func (*SeedGeneratorBuilder) WaitUntilComplete

func (builder *SeedGeneratorBuilder) WaitUntilComplete(timeout time.Duration) (*SeedGeneratorBuilder, error)

WaitUntilComplete waits the specified timeout for the seedgenerator to complete actions.

func (*SeedGeneratorBuilder) WithOptions

func (builder *SeedGeneratorBuilder) WithOptions(options ...SeedGeneratorAdditionalOptions) *SeedGeneratorBuilder

WithOptions creates seedgenerator with generic mutation options.

func (*SeedGeneratorBuilder) WithRecertImage

func (builder *SeedGeneratorBuilder) WithRecertImage(
	recertImage string) *SeedGeneratorBuilder

WithRecertImage sets the recert image used by the seedgenerator.

func (*SeedGeneratorBuilder) WithSeedImage

func (builder *SeedGeneratorBuilder) WithSeedImage(
	seedImage string) *SeedGeneratorBuilder

WithSeedImage sets the seed image used by the seedgenerator.