Add Tinkerbell docs

kubernetes-sigs · Apr 23, 2024 · c98616f · c98616f
1 parent c68457f
commit c98616f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/docs/book/src/clusterctl/provider-contract.md b/docs/book/src/clusterctl/provider-contract.md
@@ -330,6 +330,7 @@ providers.
 | CAPO          | cluster.x-k8s.io/provider=infrastructure-openstack    |
 | CAPOCI        | cluster.x-k8s.io/provider=infrastructure-oci          |
 | CAPP          | cluster.x-k8s.io/provider=infrastructure-packet       |
+| CAPT          | cluster.x-k8s.io/provider=infrastructure-tinkerbell   |
 | CAPV          | cluster.x-k8s.io/provider=infrastructure-vsphere      |
 | CAPVC         | cluster.x-k8s.io/provider=infrastructure-vcluster     |
 | CAPVCD        | cluster.x-k8s.io/provider=infrastructure-vcd          |

diff --git a/docs/book/src/reference/glossary.md b/docs/book/src/reference/glossary.md
@@ -99,6 +99,9 @@ Cluster API Provider Outscale
 ### CAPOCI
 Cluster API Provider Oracle Cloud Infrastructure (OCI)
 
+### CAPT
+Cluster API Provider Tinkerbell
+
 ### CAPV
 Cluster API Provider vSphere
 

diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md
@@ -852,7 +852,7 @@ before configuring a cluster with Cluster API. Instructions are provided for com
 Otherwise, you can look at the `clusterctl generate cluster` [command][clusterctl generate cluster] documentation for details about how to
 discover the list of variables required by a cluster templates.
 
-{{#tabs name:"tab-configuration-infrastructure" tabs:"AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,IBM Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenStack,Outscale,Proxmox,VCD,vcluster,Virtink,vSphere"}}
+{{#tabs name:"tab-configuration-infrastructure" tabs:"AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,IBM Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenStack,Outscale,Proxmox,Tinkerbell,VCD,vcluster,Virtink,vSphere"}}
 {{#tab AWS}}
 
 ```bash
@@ -1220,6 +1220,12 @@ export ALLOWED_NODES="[pve1,pve2,pve3]"
 
 For more information about prerequisites and advanced setups for Proxmox, see the [Proxmox getting started guide].
 
+{{#/tab }}
+{{#tab Tinkerbell}}
+
+export TINKERBELL_IP=<hegel ip>
+Please visit [Tinkerbell getting started guide].
+
 {{#/tab }}
 {{#tab VCD}}
 
@@ -1741,3 +1747,4 @@ kind delete cluster
 [workload cluster]: ../reference/glossary.md#workload-cluster
 [CAPI Operator quickstart]: ./quick-start-operator.md
 [Proxmox getting started guide]: https://github.com/ionos-cloud/cluster-api-provider-proxmox/blob/main/docs/Usage.md
+[Tinkerbell getting started guide]: https://github.com/tinkerbell/cluster-api-provider-tinkerbell/blob/main/docs/QUICK-START.md