px

Documentation

Index

• type Cluster
  • func NewPXClusterProvider(dockerRegistrySecret, kubeconfig string) (Cluster, error)
• type DeleteOptions
• type SharedAppsScaleDownMode
• type UpgradeOptions

Types

type Cluster

type Cluster interface {
	// Create creates the given cluster
	Create(c *apiv1beta1.Cluster) error
	// Status returns the current status of the given cluster
	Status(c *apiv1beta1.Cluster) (*apiv1beta1.ClusterStatus, error)
	// Upgrade upgrades the given cluster
	Upgrade(c *apiv1beta1.Cluster, opts *UpgradeOptions) error
	// Delete removes all components of the given cluster
	Delete(c *apiv1beta1.Cluster, opts *DeleteOptions) error
}

Cluster an interface to manage a storage cluster

func NewPXClusterProvider

func NewPXClusterProvider(dockerRegistrySecret, kubeconfig string) (Cluster, error)

NewPXClusterProvider creates a new PX cluster

type DeleteOptions

type DeleteOptions struct {
	// WipeCluster instructs if Portworx cluster metadata needs to be wiped off
	WipeCluster bool
	// WiperImage is the docker tag to use for the node wiper
	WiperImage string
	// WiperTag is the docker tag to use for the node wiper
	WiperTag string
}

DeleteOptions are options to customize the delete process

type SharedAppsScaleDownMode

type SharedAppsScaleDownMode string

SharedAppsScaleDownMode is type for choosing behavior of scaling down shared apps

const (
	// SharedAppsScaleDownAuto is mode where shared px apps will be scaled down only when px major version is upgraded
	SharedAppsScaleDownAuto SharedAppsScaleDownMode = "auto"
	// SharedAppsScaleDownOn is mode where shared px apps will be scaled down without any version checks
	SharedAppsScaleDownOn SharedAppsScaleDownMode = "on"
	// SharedAppsScaleDownOff is mode where shared px apps will not be scaled down
	SharedAppsScaleDownOff SharedAppsScaleDownMode = "off"
)

type UpgradeOptions

type UpgradeOptions struct {
	SharedAppsScaleDown SharedAppsScaleDownMode
	TimeoutPerNode      int
}

UpgradeOptions are options to customize the upgrade process