rainbond: github.com/goodrain/rainbond/worker/master/volumes/provider/lib/controller Index | Files | Directories

package controller

import "github.com/goodrain/rainbond/worker/master/volumes/provider/lib/controller"


Package Files

controller.go volume.go


const (
    // DefaultResyncPeriod is used when option function ResyncPeriod is omitted
    DefaultResyncPeriod = 15 * time.Minute
    // DefaultThreadiness is used when option function Threadiness is omitted
    DefaultThreadiness = 4
    // DefaultExponentialBackOffOnError is used when option function ExponentialBackOffOnError is omitted
    DefaultExponentialBackOffOnError = true
    // DefaultCreateProvisionedPVRetryCount is used when option function CreateProvisionedPVRetryCount is omitted
    DefaultCreateProvisionedPVRetryCount = 5
    // DefaultCreateProvisionedPVInterval is used when option function CreateProvisionedPVInterval is omitted
    DefaultCreateProvisionedPVInterval = 10 * time.Second
    // DefaultFailedProvisionThreshold is used when option function FailedProvisionThreshold is omitted
    DefaultFailedProvisionThreshold = 15
    // DefaultFailedDeleteThreshold is used when option function FailedDeleteThreshold is omitted
    DefaultFailedDeleteThreshold = 15
    // DefaultLeaderElection is used when option function LeaderElection is omitted
    DefaultLeaderElection = true
    // DefaultLeaseDuration is used when option function LeaseDuration is omitted
    DefaultLeaseDuration = 15 * time.Second
    // DefaultRenewDeadline is used when option function RenewDeadline is omitted
    DefaultRenewDeadline = 10 * time.Second
    // DefaultRetryPeriod is used when option function RetryPeriod is omitted
    DefaultRetryPeriod = 2 * time.Second
    // DefaultMetricsPort is used when option function MetricsPort is omitted
    DefaultMetricsPort = 0
    // DefaultMetricsAddress is used when option function MetricsAddress is omitted
    DefaultMetricsAddress = ""
    // DefaultMetricsPath is used when option function MetricsPath is omitted
    DefaultMetricsPath = "/metrics"

func ClaimsInformer Uses

func ClaimsInformer(informer cache.SharedInformer) func(*ProvisionController) error

ClaimsInformer sets the informer to use for accessing PersistentVolumeClaims. Defaults to using a internal informer.

func ClassesInformer Uses

func ClassesInformer(informer cache.SharedInformer) func(*ProvisionController) error

ClassesInformer sets the informer to use for accessing StorageClasses. The informer must use the versioned resource appropriate for the Kubernetes cluster version (that is, v1.StorageClass for >= 1.6, and v1beta1.StorageClass for < 1.6). Defaults to using a internal informer.

func CreateProvisionedPVInterval Uses

func CreateProvisionedPVInterval(createProvisionedPVInterval time.Duration) func(*ProvisionController) error

CreateProvisionedPVInterval is the interval between retries when we create a PV object for a provisioned volume. Defaults to 10 seconds.

func CreateProvisionedPVRetryCount Uses

func CreateProvisionedPVRetryCount(createProvisionedPVRetryCount int) func(*ProvisionController) error

CreateProvisionedPVRetryCount is the number of retries when we create a PV object for a provisioned volume. Defaults to 5.

func ExponentialBackOffOnError Uses

func ExponentialBackOffOnError(exponentialBackOffOnError bool) func(*ProvisionController) error

ExponentialBackOffOnError determines whether to exponentially back off from failures of Provision and Delete. Defaults to true.

func FailedDeleteThreshold Uses

func FailedDeleteThreshold(failedDeleteThreshold int) func(*ProvisionController) error

FailedDeleteThreshold is the threshold for max number of retries on failures of Delete. Defaults to 15.

func FailedProvisionThreshold Uses

func FailedProvisionThreshold(failedProvisionThreshold int) func(*ProvisionController) error

FailedProvisionThreshold is the threshold for max number of retries on failures of Provision. Defaults to 15.

func GetPersistentVolumeClaimClass Uses

func GetPersistentVolumeClaimClass(claim *v1.PersistentVolumeClaim) string

GetPersistentVolumeClaimClass returns StorageClassName. If no storage class was requested, it returns "".

func LeaderElection Uses

func LeaderElection(leaderElection bool) func(*ProvisionController) error

LeaderElection determines whether to enable leader election or not. Defaults to true.

func LeaderElectionNamespace Uses

func LeaderElectionNamespace(leaderElectionNamespace string) func(*ProvisionController) error

LeaderElectionNamespace is the kubernetes namespace in which to create the leader election object. Defaults to the same namespace in which the the controller runs.

func LeaseDuration Uses

func LeaseDuration(leaseDuration time.Duration) func(*ProvisionController) error

LeaseDuration is the duration that non-leader candidates will wait to force acquire leadership. This is measured against time of last observed ack. Defaults to 15 seconds.

func MetricsAddress Uses

func MetricsAddress(metricsAddress string) func(*ProvisionController) error

MetricsAddress sets the ip address that metrics serve serves on.

func MetricsPath Uses

func MetricsPath(metricsPath string) func(*ProvisionController) error

MetricsPath sets the endpoint path of metrics server.

func MetricsPort Uses

func MetricsPort(metricsPort int32) func(*ProvisionController) error

MetricsPort sets the port that metrics server serves on. Default: 0, set to non-zero to enable.

func RenewDeadline Uses

func RenewDeadline(renewDeadline time.Duration) func(*ProvisionController) error

RenewDeadline is the duration that the acting master will retry refreshing leadership before giving up. Defaults to 10 seconds.

func ResyncPeriod Uses

func ResyncPeriod(resyncPeriod time.Duration) func(*ProvisionController) error

ResyncPeriod is how often the controller relists PVCs, PVs, & storage classes. OnUpdate will be called even if nothing has changed, meaning failed operations may be retried on a PVC/PV every resyncPeriod regardless of whether it changed. Defaults to 15 minutes.

func RetryPeriod Uses

func RetryPeriod(retryPeriod time.Duration) func(*ProvisionController) error

RetryPeriod is the duration the LeaderElector clients should wait between tries of actions. Defaults to 2 seconds.

func Threadiness Uses

func Threadiness(threadiness int) func(*ProvisionController) error

Threadiness is the number of claim and volume workers each to launch. Defaults to 4.

func VolumesInformer Uses

func VolumesInformer(informer cache.SharedInformer) func(*ProvisionController) error

VolumesInformer sets the informer to use for accessing PersistentVolumes. Defaults to using a internal informer.

type BlockProvisioner Uses

type BlockProvisioner interface {
    // SupportsBlock returns whether provisioner supports block volume.
    SupportsBlock() bool

BlockProvisioner is an optional interface implemented by provisioners to determine whether it supports block volume.

type IgnoredError Uses

type IgnoredError struct {
    Reason string

IgnoredError is the value for Delete to return to indicate that the call has been ignored and no action taken. In case multiple provisioners are serving the same storage class, provisioners may ignore PVs they are not responsible for (e.g. ones they didn't create). The controller will act accordingly, i.e. it won't emit a misleading VolumeFailedDelete event.

func (*IgnoredError) Error Uses

func (e *IgnoredError) Error() string

type ProvisionController Uses

type ProvisionController struct {
    // contains filtered or unexported fields

ProvisionController is a controller that provisions PersistentVolumes for PersistentVolumeClaims.

func NewProvisionController Uses

func NewProvisionController(
    client kubernetes.Interface,
    provisioners map[string]Provisioner,
    kubeVersion string,
    options ...func(*ProvisionController) error,
) *ProvisionController

NewProvisionController creates a new provision controller using the given configuration parameters and with private (non-shared) informers.

func (*ProvisionController) HasRun Uses

func (ctrl *ProvisionController) HasRun() bool

HasRun returns whether the controller has Run

func (*ProvisionController) Run Uses

func (ctrl *ProvisionController) Run(stop <-chan struct{})

Run starts all of this controller's control loops

type Provisioner Uses

type Provisioner interface {
    // Provision creates a volume i.e. the storage asset and returns a PV object
    // for the volume
    Provision(VolumeOptions) (*v1.PersistentVolume, error)
    // Delete removes the storage asset that was created by Provision backing the
    // given PV. Does not delete the PV object itself.
    // May return IgnoredError to indicate that the call has been ignored and no
    // action taken.
    Delete(*v1.PersistentVolume) error
    Name() string

Provisioner is an interface that creates templates for PersistentVolumes and can create the volume as a new resource in the infrastructure provider. It can also remove the volume it created from the underlying storage provider.

type Qualifier Uses

type Qualifier interface {
    // ShouldProvision returns whether provisioning for the claim should
    // be attempted.
    ShouldProvision(*v1.PersistentVolumeClaim) bool

Qualifier is an optional interface implemented by provisioners to determine whether a claim should be provisioned as early as possible (e.g. prior to leader election).

type VolumeOptions Uses

type VolumeOptions struct {
    // Reclamation policy for a persistent volume
    PersistentVolumeReclaimPolicy v1.PersistentVolumeReclaimPolicy
    // PV.Name of the appropriate PersistentVolume. Used to generate cloud
    // volume name.
    PVName string

    // PV mount options. Not validated - mount of the PVs will simply fail if one is invalid.
    MountOptions []string

    // PVC is reference to the claim that lead to provisioning of a new PV.
    // Provisioners *must* create a PV that would be matched by this PVC,
    // i.e. with required capacity, accessMode, labels matching PVC.Selector and
    // so on.
    PVC *v1.PersistentVolumeClaim
    // Volume provisioning parameters from StorageClass
    Parameters map[string]string

    // Node selected by the scheduler for the volume.
    SelectedNode *v1.Node
    // Topology constraint parameter from StorageClass
    AllowedTopologies []v1.TopologySelectorTerm

VolumeOptions contains option information about a volume https://github.com/kubernetes/kubernetes/blob/release-1.4/pkg/volume/plugins.go



Package controller imports 28 packages (graph) and is imported by 2 packages. Updated 2019-07-04. Refresh now. Tools for package owners.