package
3.13.6+incompatible
Repository: https://github.com/rackn/provision.git
Documentation: pkg.go.dev

# Functions

All returns a slice containing a single blank instance of all the Models.
AllPrefixes returns a slice containing the prefix names of all the Models.
ArchEqual returns whether two arches are equal.
Clone returns a deep copy of the passed-in Model.
DecodeYaml is a helper function for dealing with user input -- when accepting input from the user, we want to treat both YAML and JSON as first-class citizens.
DHCPOptionParser returns the appropriate string conversion and deconversion functions for a given DHCP option code.
DHCPOptionsInOrder returns the DHCP options present in the passed-in Packet in the order they appeared, excluding the Pad and End options.
No description provided by the author
No description provided by the author
No description provided by the author
GenPatch generates a JSON patch that will transform source into target.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
New returns a new blank instance of the Model with the passed-in prefix.
NewError creates a new Error with a few key parameters pre-populated.
ParseContentPrerequisites is a helper that parses a Prerequisites string from the content bundle metadata and returns a map containing the comparison functions that must pass in order for the content bundle's prerequisites to be satisfied.
No description provided by the author
Remarshal remarshals src onto dest.
SupportedArch normalizes system architectures and returns whether it is one we know how to normalize.
UpdateAllScopesWithRawModel adds new role scopes for a specialized RawModel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Access holds if the object is read-only or not swagger: model.
Action is an additional command that can be added to other Models by a Plugin.
ArchInfo tracks information required to make a BootEnv work across different system architectures.
AvailableAction is an Action that a Plugin instantiated by a PluginProvider.
BlobInfo contains information on an uploaded file or ISO.
BootEnv encapsulates the machine-agnostic information needed by the provisioner to set up a boot environment.
BsdpBootOption contains the information needed to boot their systems using the aapl BDSP boot protocol.
Bundle holds the object's store's name swagger: model.
Claim is an individial specifier for something we are allowed access to.
Content models a content bundle.
ContentMetaData holds all the metadata about a content bundle that dr-provision will use to decide how to treat the content bundle.
swagger:model.
DhcpOption is a representation of a specific DHCP option.
Error is the common Error type the API returns for any error conditions.
Event represents an action in the system.
Index holds details on the index swagger:model.
Info contains information on how the running instance of dr-provision is configured.
Interface represents a network interface that is present on the server running dr-provision.
Job contains information on a Job that is running for a specific Task on a Machine.
Job Action is something that job runner will need to do.
Lease tracks DHCP leases.
License is used to authorize acess to extended dr-provision features and functionality.
LicenseBundle is a collection of Licenses.
Machine represents a single bare-metal system that the provisioner should manage the boot environment for.
OsInfo holds information about the operating system this BootEnv maps to.
Owned holds the info about which DRP Endpoint owns this object swagger: model.
Param represents metadata about a Parameter or a Preference.
Plugin represents a single instance of a running plugin.
Plugin Provider describes the available functions that could be instantiated by a plugin.
swagger:model.
Pref tracks a global DigitalRebar Provision preference -- things like the bootenv to use for unknown systems trying to PXE boot to us, the default bootenv for known systems, etc.
Profile represents a set of key/values to use in template expansion.
Reservation tracks persistent DHCP IP address reservations.
Role is used to determine which operations on which API endpoints are permitted.
SecureData is used to store and send access controlled Param values to the locations they are needed at.
Stage encapsulates a set of tasks and profiles to apply to a Machine in a BootEnv.
Stat contains a basic statistic sbout dr-provision swagger:model.
Subnet represents a DHCP Subnet.
Task is a thing that can run on a Machine.
Template represents a template that will be associated with a boot environment.
TemplateInfo holds information on the templates in the boot environment that will be expanded into files.
swagger:model.
User is an API user of DigitalRebar Provision swagger:model.
swagger:model.
UserToken is an auth token for a specific User.
Validation holds information about whether the current model is valid or not.
Workflow contains a list of Stages.

# Interfaces

Accessor is an interface that objects that can be ReadOnly should satisfy.
Only implement this if you want actions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrorAdder is an interface that the various models that can collect errors for later repoting can satisfy.
No description provided by the author
No description provided by the author
Model is the interface that pretty much all non-Error objects returned by the API satisfy.
No description provided by the author
model object may define a GetEndpoint() method that can be used to return the owner for the object .
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
model object may define a Validate method that can be used to return errors about if the model is valid in the current datatracker.

# Type aliases

Claims is a compiled list of claims from a Role.
ClaimsList is a list of Claims derived from a Role.
No description provided by the author
Meta holds information about arbitrary things.
RawModel is a raw model that Plugins can specialize to save custom data in the dr-provision backing store.
No description provided by the author
No description provided by the author