README
¶
Tinkerbell
Tinkerbell is a bare metal provisioning engine. It supports network and ISO booting and BMC interactions as well as a metadata service, and a workflow engine for provisioning. Some of the features include:
- Cloud-init integration
- DHCP with Host reservation or ProxyDHCP
- Third party DHCP server integration
- BMC support via Redfish, IPMI, IntelAMT, and more
- Auto discovery of Hardware
- Serial over SSH
For more details, see the Tinkerbell documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
cmd
|
|
|
pkg
|
|
|
api/v1alpha1/bmc
Package v1alpha1 contains API Schema definitions for the bmc v1alpha1 API group +kubebuilder:object:generate=true +groupName=bmc.tinkerbell.org +versionName:=v1alpha1
|
Package v1alpha1 contains API Schema definitions for the bmc v1alpha1 API group +kubebuilder:object:generate=true +groupName=bmc.tinkerbell.org +versionName:=v1alpha1 |
|
api/v1alpha1/tinkerbell
Package tinkerbell contains API Schema definitions for the Tinkerbell v1alpha1 API group
|
Package tinkerbell contains API Schema definitions for the Tinkerbell v1alpha1 API group |
|
backend/file
Package file watches a file for changes and updates the in memory DHCP data.
|
Package file watches a file for changes and updates the in memory DHCP data. |
|
backend/kube
Package kube is a backend implementation that uses the Tinkerbell CRDs to get DHCP data.
|
Package kube is a backend implementation that uses the Tinkerbell CRDs to get DHCP data. |
|
otel
https://github.com/equinix-labs/otel-init-go Copyright [yyyy] [name of copyright owner]
|
https://github.com/equinix-labs/otel-init-go Copyright [yyyy] [name of copyright owner] |
|
xff
https://github.com/sebest/xff Copyright (c) 2015 Sebastien Estienne (sebastien.estienne@gmail.com)
|
https://github.com/sebest/xff Copyright (c) 2015 Sebastien Estienne (sebastien.estienne@gmail.com) |
|
internal
https://github.com/alanshaw/multiwriter
|
https://github.com/alanshaw/multiwriter |
|
internal/dhcp/handler/proxy
Package proxy implements a DHCP handler that provides proxyDHCP functionality.
|
Package proxy implements a DHCP handler that provides proxyDHCP functionality. |
|
internal/dhcp/handler/reservation
Package noop is a backend handler that does nothing.
|
Package noop is a backend handler that does nothing. |
|
internal/dhcp/otel
Package otel handles translating DHCP headers and options to otel key/value attributes.
|
Package otel handles translating DHCP headers and options to otel key/value attributes. |
|
internal/dhcp/server
Package dhcp providers UDP listening and serving functionality.
|
Package dhcp providers UDP listening and serving functionality. |
|
internal/ipxe/binary/file
Package binary handles embedding of the iPXE binaries.
|
Package binary handles embedding of the iPXE binaries. |
|
internal/ipxe/http
package bhttp is the http server for smee.
|
package bhttp is the http server for smee. |
|
tink
|
|
|
agent/internal/pkg/rand
Package rand provides utilities related to randomization.
|
Package rand provides utilities related to randomization. |
|
package tootles is the code for serving metadata (ec2 style, etc).
|
package tootles is the code for serving metadata (ec2 style, etc). |
|
internal/frontend/ec2/internal/staticroute
Package staticroute provides tools for building EC2 Instance Metadata static routes from the set of data endpoints.
|
Package staticroute provides tools for building EC2 Instance Metadata static routes from the set of data endpoints. |
|
internal/frontend/hack
Package hack contains a frontend that provides a /metadata endpoint for the rootio hub action.
|
Package hack contains a frontend that provides a /metadata endpoint for the rootio hub action. |
Click to show internal directories.
Click to hide internal directories.