machineops

type AllocationPlan struct {
	// ProviderID is the pre-host locator used as the Machine's
	// host.external.providerID before the host exists. It is not necessarily
	// a native instance ID.
	ProviderID string

	// HostImage is the provider-interpreted image the host launches with.
	HostImage string
}

type AllocationPlanRequest struct {
	AllocationName string
	AllocationUID  types.UID
	// HostName is the planned name of the allocation's Machine.
	HostName       string
	ProviderConfig ProviderConfig
	Offering       unboundedv1alpha3.MachineClassOffering
}

type AllocationRequest struct {
	Name string
	// UID is the MachineAllocation incarnation that owns every provider
	// effect. Begin must key replay on it as well as on
	// OperationRequest.OperationUID.
	UID       types.UID
	ClassName string
	ClassUID  types.UID
	// HostName is the planned name of the allocation's Machine.
	HostName string
	// ProviderConfig is supplied only when HostAllocate begins. For Poll and
	// for HostRelease it is the zero ProviderConfig.
	ProviderConfig ProviderConfig
	Offering       unboundedv1alpha3.MachineClassOffering
	// UserData is first-boot data that may contain credentials: providers
	// must never log it, persist it, or copy it into a ResumeToken, status
	// message or error. It is supplied only when HostAllocate begins and is
	// empty for Poll and for HostRelease.
	UserData string
	// OwnedResources are the resources recorded as owned by the allocation,
	// including those a failed HostAllocate reported. HostRelease may act only
	// on these.
	OwnedResources []unboundedv1alpha3.ProviderOwnedResource
}

type AllocationResult struct {
	// ProviderResourceID is the provider-native host identifier.
	ProviderResourceID string
	InstanceType       string
	Zone               string
	Image              string
	// OwnedResources are the resources created for the allocation, with
	// provider-native identity. A failed HostAllocate may still report them
	// so release can clean them up.
	OwnedResources []unboundedv1alpha3.ProviderOwnedResource
}

type BeginFunc func(context.Context, OperationRequest) (BeginResult, error)

type BeginResult struct {
	Operation    ProviderOperation
	Message      string
	RequeueAfter time.Duration
}

type Capacity struct {
	// contains filtered or unexported fields
}

type ClassRequest struct {
	ClassName string
	ClassUID  types.UID
	SiteName  string
	// ProviderConfig is the content of the class's immutable provider
	// configuration.
	ProviderConfig ProviderConfig
	Auth           *OperationAuth
}

type ClassResolution struct {
	Offerings []unboundedv1alpha3.MachineClassOffering
}

type CleanupFunc func(context.Context, OperationRequest, OperationResult) error

type ExecuteFunc func(context.Context, OperationRequest) (OperationResult, error)

type Operation struct {
	// contains filtered or unexported fields
}

type OperationAuth struct {
	Mode       unboundedv1alpha3.MachineOperationCredentialAuthMode
	SecretData map[string]string
}

type OperationMode string

type OperationOption interface {
	// contains filtered or unexported methods
}

type OperationRequest struct {
	MachineName       string
	MachineUID        types.UID
	MachineGeneration int64
	OperationName     string
	OperationUID      types.UID
	// ProviderRef snapshots Machine.spec.host.external.machineRef when present.
	ProviderRef *unboundedv1alpha3.ProviderMachineSnapshot
	// ProviderID is the current canonical or legacy provider-specific host ID.
	ProviderID      string
	HostImage       string
	Operation       unboundedv1alpha3.OperationKind
	Parameters      map[string]string
	ReplaceUserData string
	Auth            *OperationAuth
	// Allocation is the allocation input for HostAllocate and HostRelease. It
	// is nil for every other operation kind.
	Allocation *AllocationRequest
}

type OperationResult struct {
	ProviderID        string
	CleanupProviderID string
	// Allocation is the allocation result reported by HostAllocate. It is
	// nil for every other operation kind.
	Allocation *AllocationResult
}

type PermanentError struct {
	Reason string
	Err    error
}

type PlanAllocationFunc func(context.Context, AllocationPlanRequest) (AllocationPlan, error)

type PollFunc func(context.Context, OperationRequest, ProviderOperation) (PollResult, error)

type PollResult struct {
	State        ProviderOperationState
	Result       OperationResult
	Reason       string
	Message      string
	RequeueAfter time.Duration
}

type Provider struct {
	// contains filtered or unexported fields
}

type ProviderConfig struct {
	// Data is the data of the ConfigMap that MachineClass.spec.providerConfigRef
	// names, the only kind of reference accepted today.
	Data map[string]string
}

type ProviderOperation struct {
	OperationID string
	ResumeToken string
}

type ProviderOperationState string

type ProviderOption interface {
	// contains filtered or unexported methods
}

type ResolveClassFunc func(context.Context, ClassRequest) (ClassResolution, error)