package
0.1.2
Repository: https://github.com/threefoldtech/zosbase.git
Documentation: pkg.go.dev

# Packages

Package common hold logic that is used by both the provision and primitive package it purpose is mainly to avoid circular dependencies.
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

GetContract of deployment.
GetDeployment gets a copy of the current deployment with latest state.
GetDeploymentID gets twin and deployment ID for current deployment.
GetEngine gets engine from context.
GetWorkload get the last state of the workload for the current deployment.
IsRentedNode returns true if current node is rented.
New creates a new engine.
NewMapProvisioner returns a new instance of a map provisioner.
NewSubstrateAdmins creates a substrate twins db that implements the provision.Users interface.
NewSubstrateTwins creates a substrate users db that implements the provision.Users interface.
Ok response.
No description provided by the author
UnChanged is a special response status that states that an operation has failed but this did not affect the workload status.
WithAdmins sets the admins key getter on the engine.
WithAPIGateway sets the API Gateway.
WithCallback sets a callback that is called when a deployment is being Created, Updated, Or Deleted The handler then can use the id to get current "state" of the deployment from storage and take proper action.
WithRerunAll if set forces the engine to re-run all reservations on engine start.
WithStartupOrder forces a specific startup order of types any type that is not listed in this list, will get started in an nondeterministic order.
WithTwins sets the user key getter on the engine.

# Variables

ErrDeploymentConflict returned if deployment cannot be stored because it conflicts with another deployment.
ErrDeploymentExists returned if object exist.
ErrDeploymentNotExists returned if object not exists.
ErrDeploymentUpgradeValidationError error, is returned if the deployment failed to compute upgrade steps.
ErrInvalidVersion invalid version error.
ErrNoActionNeeded can be returned by any provision method to indicate that no action has been taken in case a workload is already deployed and the engine then can skip updating the result of the workload.
ErrWorkloadExists returned if object exist.
ErrWorkloadNotExist returned by storage if workload does not exist.
ResourcesUnits are the units used to compute how much capacity is reserved on the system.
ResourcesUnits are the units used to compute how much capacity is reserved on the system.
ResourcesUnits are the units used to compute how much capacity is reserved on the system.
ResourcesUnits are the units used to compute how much capacity is reserved on the system.

# Structs

No description provided by the author
No description provided by the author
NativeEngine is the core of this package The engine is responsible to manage provision and decomission of workloads on the system.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

Engine is engine interface.
EngineOption interface.
Field interface.
Initializer interface define an extra Initialize method which is run on the provisioner before the provision engine is started.
Janitor interface.
Manager defines basic type manager functionality.
Pauser defines optional Pause, Resume method for type managers.
Provisioner interface.
No description provided by the author
Storage interface.
Twins is used to get twin public key.
Updater defines the optional Update method for a type manager.

# Type aliases

No description provided by the author
Used with Storage interface to compute capacity, exclude any deployment and or workload that returns true from the capacity calculation.
ResourceUnits type.