Skip to content

Commit 4049b31

Browse files
authored
🌱 Add Tinkerbell to the providers list (kubernetes-sigs#10487)
* Add Tinkerbell to the providers list * Add Tinkerbell docs * Update TinkerbellProviderName to conform with new naming scheme
1 parent 63c37ef commit 4049b31

File tree

7 files changed

+28
-1
lines changed

7 files changed

+28
-1
lines changed

cmd/clusterctl/client/config/providers_client.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ const (
5656
OCIProviderName = "oci"
5757
OpenStackProviderName = "openstack"
5858
PacketProviderName = "packet"
59+
TinkerbellProviderName = "tinkerbell-tinkerbell"
5960
SideroProviderName = "sidero"
6061
VCloudDirectorProviderName = "vcd"
6162
VSphereProviderName = "vsphere"
@@ -191,6 +192,11 @@ func (p *providersClient) defaults() []Provider {
191192
url: "https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/latest/infrastructure-components.yaml",
192193
providerType: clusterctlv1.InfrastructureProviderType,
193194
},
195+
&provider{
196+
name: TinkerbellProviderName,
197+
url: "https://github.com/tinkerbell/cluster-api-provider-tinkerbell/releases/latest/infrastructure-components.yaml",
198+
providerType: clusterctlv1.InfrastructureProviderType,
199+
},
194200
&provider{
195201
name: Metal3ProviderName,
196202
url: "https://github.com/metal3-io/cluster-api-provider-metal3/releases/latest/infrastructure-components.yaml",

cmd/clusterctl/client/config_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
9999
config.PacketProviderName,
100100
config.ProxmoxProviderName,
101101
config.SideroProviderName,
102+
config.TinkerbellProviderName,
102103
config.VCloudDirectorProviderName,
103104
config.VclusterProviderName,
104105
config.VirtinkProviderName,
@@ -159,6 +160,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
159160
config.PacketProviderName,
160161
config.ProxmoxProviderName,
161162
config.SideroProviderName,
163+
config.TinkerbellProviderName,
162164
config.VCloudDirectorProviderName,
163165
config.VclusterProviderName,
164166
config.VirtinkProviderName,

cmd/clusterctl/cmd/config_repositories_test.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ outscale InfrastructureProvider https://github.com/outscale/clu
148148
packet InfrastructureProvider https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/latest/ infrastructure-components.yaml
149149
proxmox InfrastructureProvider https://github.com/ionos-cloud/cluster-api-provider-proxmox/releases/latest/ infrastructure-components.yaml
150150
sidero InfrastructureProvider https://github.com/siderolabs/sidero/releases/latest/ infrastructure-components.yaml
151+
tinkerbell-tinkerbell InfrastructureProvider https://github.com/tinkerbell/cluster-api-provider-tinkerbell/releases/latest/ infrastructure-components.yaml
151152
vcd InfrastructureProvider https://github.com/vmware/cluster-api-provider-cloud-director/releases/latest/ infrastructure-components.yaml
152153
vcluster InfrastructureProvider https://github.com/loft-sh/cluster-api-provider-vcluster/releases/latest/ infrastructure-components.yaml
153154
virtink InfrastructureProvider https://github.com/smartxworks/cluster-api-provider-virtink/releases/latest/ infrastructure-components.yaml
@@ -336,6 +337,10 @@ var expectedOutputYaml = `- File: core_components.yaml
336337
Name: sidero
337338
ProviderType: InfrastructureProvider
338339
URL: https://github.com/siderolabs/sidero/releases/latest/
340+
- File: infrastructure-components.yaml
341+
Name: tinkerbell-tinkerbell
342+
ProviderType: InfrastructureProvider
343+
URL: https://github.com/tinkerbell/cluster-api-provider-tinkerbell/releases/latest/
339344
- File: infrastructure-components.yaml
340345
Name: vcd
341346
ProviderType: InfrastructureProvider

docs/book/src/clusterctl/provider-contract.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,7 @@ providers.
330330
| CAPO | cluster.x-k8s.io/provider=infrastructure-openstack |
331331
| CAPOCI | cluster.x-k8s.io/provider=infrastructure-oci |
332332
| CAPP | cluster.x-k8s.io/provider=infrastructure-packet |
333+
| CAPT | cluster.x-k8s.io/provider=infrastructure-tinkerbell |
333334
| CAPV | cluster.x-k8s.io/provider=infrastructure-vsphere |
334335
| CAPVC | cluster.x-k8s.io/provider=infrastructure-vcluster |
335336
| CAPVCD | cluster.x-k8s.io/provider=infrastructure-vcd |

docs/book/src/reference/glossary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ Cluster API Provider Outscale
102102
### CAPOCI
103103
Cluster API Provider Oracle Cloud Infrastructure (OCI)
104104

105+
### CAPT
106+
Cluster API Provider Tinkerbell
107+
105108
### CAPV
106109
Cluster API Provider vSphere
107110

docs/book/src/user/quick-start.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ before configuring a cluster with Cluster API. Instructions are provided for com
861861
Otherwise, you can look at the `clusterctl generate cluster` [command][clusterctl generate cluster] documentation for details about how to
862862
discover the list of variables required by a cluster templates.
863863
864-
{{#tabs name:"tab-configuration-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,IBM Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenStack,Outscale,Proxmox,VCD,vcluster,Virtink,vSphere"}}
864+
{{#tabs name:"tab-configuration-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,IBM Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenStack,Outscale,Proxmox,Tinkerbell,VCD,vcluster,Virtink,vSphere"}}
865865
{{#tab Akamai (Linode)}}
866866
867867
```bash
@@ -1241,6 +1241,14 @@ export ALLOWED_NODES="[pve1,pve2,pve3]"
12411241
12421242
For more information about prerequisites and advanced setups for Proxmox, see the [Proxmox getting started guide].
12431243
1244+
{{#/tab }}
1245+
{{#tab Tinkerbell}}
1246+
1247+
```bash
1248+
export TINKERBELL_IP=<hegel ip>
1249+
```
1250+
For more information please visit [Tinkerbell getting started guide].
1251+
12441252
{{#/tab }}
12451253
{{#tab VCD}}
12461254
@@ -1763,3 +1771,4 @@ kind delete cluster
17631771
[workload cluster]: ../reference/glossary.md#workload-cluster
17641772
[CAPI Operator quickstart]: ./quick-start-operator.md
17651773
[Proxmox getting started guide]: https://github.com/ionos-cloud/cluster-api-provider-proxmox/blob/main/docs/Usage.md
1774+
[Tinkerbell getting started guide]: https://github.com/tinkerbell/cluster-api-provider-tinkerbell/blob/main/docs/QUICK-START.md

hack/tools/release/internal/update_providers/provider_issues.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ var (
5656
"kubernetes-sigs/cluster-api-provider-openstack",
5757
"kubernetes-sigs/cluster-api-operator",
5858
"kubernetes-sigs/cluster-api-provider-packet",
59+
"tinkerbell/cluster-api-provider-tinkerbell",
5960
"kubernetes-sigs/cluster-api-provider-vsphere",
6061
"metal3-io/cluster-api-provider-metal3",
6162
}

0 commit comments

Comments
 (0)