Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the Tinkerbell v1alpha1 API group
Index ¶
- Constants
- Variables
- type Action
- type DHCP
- type Disk
- type Event
- type Hardware
- type HardwareList
- type HardwareSpec
- type HardwareState
- type HardwareStatus
- type IP
- type IPXE
- type Interface
- type Netboot
- type OSIE
- type Template
- type TemplateList
- type TemplateSpec
- type TemplateState
- type TemplateStatus
- type Workflow
- type WorkflowList
- type WorkflowSpec
- type WorkflowStatus
Constants ¶
const ( // HardwareError represents hardware that is in an error state. HardwareError = HardwareState("Error") // HardwareReady represents hardware that is in a ready state. HardwareReady = HardwareState("Ready") )
const ( // TemplateError represents a template that is in an error state. TemplateError = TemplateState("Error") // TemplateReady represents a template that is in a ready state. TemplateReady = TemplateState("Ready") // TemplateIDAnnotation is used by the controller to store the // ID assigned to the template by Tinkerbell. TemplateIDAnnotation = "template.tinkerbell.org/id" // TemplateFinalizer is used by the controller to ensure // proper deletion of the template resource. TemplateFinalizer = "template.tinkerbell.org" )
const ( // WorkflowIDAnnotation is used by the controller to store the // ID assigned to the workflow by Tinkerbell. WorkflowIDAnnotation = "workflow.tinkerbell.org/id" // WorkflowFinalizer is used by the controller to ensure // proper deletion of the workflow resource. WorkflowFinalizer = "workflow.tinkerbell.org" )
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "tinkerbell.org", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct {
TaskName string `json:"task_name,omitempty"`
Name string `json:"name,omitempty"`
Image string `json:"image,omitempty"`
Timeout int64 `json:"timeout,omitempty"`
Command []string `json:"command,omitempty"`
OnTimeout []string `json:"on_timeout,omitempty"`
OnFailure []string `json:"on_failure,omitempty"`
WorkerID string `json:"worker_id,omitempty"`
Volumes []string `json:"volumes,omitempty"`
Environment []string `json:"environment,omitempty"`
}
Action represents a workflow action.
func (*Action) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Action.
func (*Action) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DHCP ¶
type DHCP struct {
MAC string `json:"mac,omitempty"`
Hostname string `json:"hostname,omitempty"`
LeaseTime int64 `json:"lease_time,omitempty"`
NameServers []string `json:"name_servers,omitempty"`
TimeServers []string `json:"time_servers,omitempty"`
Arch string `json:"arch,omitempty"`
UEFI bool `json:"uefi,omitempty"`
IfaceName string `json:"iface_name,omitempty"`
IP *IP `json:"ip,omitempty"`
}
DHCP configuration.
func (*DHCP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DHCP.
func (*DHCP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Disk ¶
type Disk struct {
//+optional
Device string `json:"device,omitempty"`
}
Disk represents a disk device for Tinkerbell Hardware.
func (*Disk) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Disk.
func (*Disk) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Event ¶
type Event struct {
TaskName string `json:"task_name,omitempty"`
ActionName string `json:"action_name,omitempty"`
ActionStatus string `json:"action_status,omitempty"`
Seconds int64 `json:"seconds,omitempty"`
Message string `json:"message,omitempty"`
CreatedAt metav1.Time `json:"created_at,omitempty"`
WorkerID string `json:"worker_id,omitempty"`
}
Event represents a workflow event.
func (*Event) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Event.
func (*Event) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Hardware ¶
type Hardware struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec HardwareSpec `json:"spec,omitempty"`
Status HardwareStatus `json:"status,omitempty"`
}
Hardware is the Schema for the Hardware API.
func (*Hardware) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Hardware.
func (*Hardware) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Hardware) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HardwareList ¶
type HardwareList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Hardware `json:"items"`
}
HardwareList contains a list of Hardware.
func (*HardwareList) DeepCopy ¶
func (in *HardwareList) DeepCopy() *HardwareList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HardwareList.
func (*HardwareList) DeepCopyInto ¶
func (in *HardwareList) DeepCopyInto(out *HardwareList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HardwareList) DeepCopyObject ¶
func (in *HardwareList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HardwareSpec ¶
type HardwareSpec struct {
// ID is the ID of the hardware in Tinkerbell
// +kubebuilder:validation:MinLength=1
ID string `json:"id"`
// UserData is the user data to configure in the hardware's
// metadata
//+optional
UserData *string `json:"userData,omitempty"`
}
HardwareSpec defines the desired state of Hardware.
func (*HardwareSpec) DeepCopy ¶
func (in *HardwareSpec) DeepCopy() *HardwareSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HardwareSpec.
func (*HardwareSpec) DeepCopyInto ¶
func (in *HardwareSpec) DeepCopyInto(out *HardwareSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HardwareStatus ¶
type HardwareStatus struct {
//+optional
TinkMetadata string `json:"tinkMetadata,omitempty"`
//+optional
TinkVersion int64 `json:"tinkVersion,omitempty"`
//+optional
Interfaces []Interface `json:"interfaces,omitempty"`
//+optional
Disks []Disk `json:"disks,omitempty"`
//+optional
State HardwareState `json:"state,omitempty"`
}
HardwareStatus defines the observed state of Hardware.
func (*HardwareStatus) DeepCopy ¶
func (in *HardwareStatus) DeepCopy() *HardwareStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HardwareStatus.
func (*HardwareStatus) DeepCopyInto ¶
func (in *HardwareStatus) DeepCopyInto(out *HardwareStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IP ¶
type IP struct {
Address string `json:"address,omitempty"`
Netmask string `json:"netmask,omitempty"`
Gateway string `json:"gateway,omitempty"`
Family int64 `json:"family,omitempty"`
}
IP configuration.
func (*IP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IP.
func (*IP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IPXE ¶
IPXE configuration.
func (*IPXE) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPXE.
func (*IPXE) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Interface ¶
type Interface struct {
//+optional
Netboot *Netboot `json:"netboot,omitempty"`
//+optional
DHCP *DHCP `json:"dhcp,omitempty"`
}
Interface represents a network interface configuration for Hardware.
func (*Interface) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Interface.
func (*Interface) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Netboot ¶
type Netboot struct {
//+optional
AllowPXE *bool `json:"allowPXE,omitempty"`
//+optional
AllowWorkflow *bool `json:"allowWorkflow,omitempty"`
//+optional
IPXE *IPXE `json:"ipxe,omitempty"`
//+optional
OSIE *OSIE `json:"osie,omitempty"`
}
Netboot configuration.
func (*Netboot) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Netboot.
func (*Netboot) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OSIE ¶
type OSIE struct {
BaseURL string `json:"baseURL,omitempty"`
Kernel string `json:"kernel,omitempty"`
Initrd string `json:"initrd,omitempty"`
}
OSIE configuration.
func (*OSIE) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OSIE.
func (*OSIE) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Template ¶
type Template struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TemplateSpec `json:"spec,omitempty"`
Status TemplateStatus `json:"status,omitempty"`
}
Template is the Schema for the Templates API.
func (*Template) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Template.
func (*Template) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Template) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateList ¶
type TemplateList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Template `json:"items"`
}
TemplateList contains a list of Templates.
func (*TemplateList) DeepCopy ¶
func (in *TemplateList) DeepCopy() *TemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateList.
func (*TemplateList) DeepCopyInto ¶
func (in *TemplateList) DeepCopyInto(out *TemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateList) DeepCopyObject ¶
func (in *TemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateSpec ¶
type TemplateSpec struct {
// +optional
Data *string `json:"data,omitempty"`
}
TemplateSpec defines the desired state of Template.
func (*TemplateSpec) DeepCopy ¶
func (in *TemplateSpec) DeepCopy() *TemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateSpec.
func (*TemplateSpec) DeepCopyInto ¶
func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateStatus ¶
type TemplateStatus struct {
State TemplateState `json:"state,omitempty"`
}
TemplateStatus defines the observed state of Template.
func (*TemplateStatus) DeepCopy ¶
func (in *TemplateStatus) DeepCopy() *TemplateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateStatus.
func (*TemplateStatus) DeepCopyInto ¶
func (in *TemplateStatus) DeepCopyInto(out *TemplateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Workflow ¶
type Workflow struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec WorkflowSpec `json:"spec,omitempty"`
Status WorkflowStatus `json:"status,omitempty"`
}
Workflow is the Schema for the Workflows API.
func (*Workflow) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Workflow.
func (*Workflow) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Workflow) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowList ¶
type WorkflowList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Workflow `json:"items"`
}
WorkflowList contains a list of Workflows.
func (*WorkflowList) DeepCopy ¶
func (in *WorkflowList) DeepCopy() *WorkflowList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowList.
func (*WorkflowList) DeepCopyInto ¶
func (in *WorkflowList) DeepCopyInto(out *WorkflowList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowList) DeepCopyObject ¶
func (in *WorkflowList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowSpec ¶
type WorkflowSpec struct {
// Name of the Template associated with this workflow.
TemplateRef string `json:"templateRef,omitempty"`
// Name of the Hardware associated with this workflow.
HardwareRef string `json:"hardwareRef,omitempty"`
}
WorkflowSpec defines the desired state of Workflow.
func (*WorkflowSpec) DeepCopy ¶
func (in *WorkflowSpec) DeepCopy() *WorkflowSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowSpec.
func (*WorkflowSpec) DeepCopyInto ¶
func (in *WorkflowSpec) DeepCopyInto(out *WorkflowSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowStatus ¶
type WorkflowStatus struct {
// State is the state of the workflow in Tinkerbell.
State string `json:"state,omitempty"`
// Data is the populated Workflow Data in Tinkerbell.
Data string `json:"data,omitempty"`
// Metadata is the metadata stored in Tinkerbell.
Metadata string `json:"metadata,omitempty"`
// Actions are the actions for this Workflow.
Actions []Action `json:"actions,omitempty"`
// Events are events for this Workflow.
Events []Event `json:"events,omitempty"`
}
WorkflowStatus defines the observed state of Workflow.
func (*WorkflowStatus) DeepCopy ¶
func (in *WorkflowStatus) DeepCopy() *WorkflowStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowStatus.
func (*WorkflowStatus) DeepCopyInto ¶
func (in *WorkflowStatus) DeepCopyInto(out *WorkflowStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.