README.md

Tinkerbell

Tinkerbell is a bare metal provisioning and workflow engine comprised of three major components: a DHCP server (boots), a workflow engine (tinkerbell, this repository), and a metadata service (hegel). The workflow engine is comprised of a server and a CLI, which communicate over gRPC. The CLI is used to create a workflow along with its building blocks, templates and targeted hardware.

Packet Workflow

A Packet Workflow is an open-source microservice that’s responsible for handling flexible, bare metal provisioning workflows, that is...

• standalone and does not need the Packet API to function
• contains Boots, Tinkerbell, Osie, and workers
• can bootstrap any remote worker using Boots + Osie
• can run any set of actions as Docker container runtimes
• receive, manipulate, and save runtime data

Content

• Setup
• Components
  • Boots
  • Osie
  • Tinkerbell
  • Hegel
  • Database
  • Image Registry
  • Elasticsearch
  • Fluent Bit
  • Kibana
• Architecture
• Say "Hello-World!" with a Workflow
• Concepts
  • Template
  • Provisioner
  • Worker
  • Ephemeral Data
• Writing a Workflow
• Tinkerbell CLI Reference
• Troubleshooting

Website

The Tinkerbell project is hosted at tinkerbell.org.