Skip to content

Commit

Permalink
fixing broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
pokearu committed Sep 6, 2022
1 parent 6924629 commit 379d219
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Besides being the leader of the Lost Boys after Peter Pan left Neverland, Rufio is a kubernetes controller for managing baseboard management controllers (BMC) in a Tinkerbell context. Rufio can also execute jobs to perform a set of one-off management actions to bring a machine (physical hardware) to a desired state.
## Architecture
![architecture](puml/architecture.png)
Rufio controller consists of three main API types, [Machine](api/v1alpha1/machine.go), [Job](api/v1alpha1/job.go) and [Task](api/v1alpha1/task.go). An operator or an automated client like [CAPT](https://github.com/tinkerbell/cluster-api-provider-tinkerbell) can interact with Rufio using these APIs to manage the state of their physical machines.
Rufio controller consists of three main API types, [Machine](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/machine.go), [Job](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/job.go) and [Task](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/task.go). An operator or an automated client like [CAPT](https://github.com/tinkerbell/cluster-api-provider-tinkerbell) can interact with Rufio using these APIs to manage the state of their physical machines.
### Machine API
The Machine type contains the information required for communicating with the BMC of the physical hardware.
```yaml
Expand Down

0 comments on commit 379d219

Please sign in to comment.