README
¶
Cluster API Provider Tinkerbell
Kubernetes-native declarative infrastructure for Kubernetes clusters using Tinkerbell.
What is the Cluster API Provider Tinkerbell
The Cluster API brings declarative, Kubernetes-style APIs to Kubernetes cluster creation, configuration and management.
The API itself is shared across multiple cloud providers allowing for true hybrid deployments of Kubernetes, both on-premises and off.
Quick Start
See the Quick Start.
Kubernetes versions with published Images
Pre-built images are pushed to the GitHub Container Registry. We currently publish images for Ubuntu 18.04 and Ubuntu 20.04.
Current state
See the release docs for each version to find details on features and CAPI compatibility.
See docs/README.md for more information on setting up a development environment.
Documentation
¶
Overview ¶
Copyright 2022 The Tinkerbell Authors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1beta1
Package v1beta1 contains API Schema definitions for the infrastructure v1beta1 API group.
|
Package v1beta1 contains API Schema definitions for the infrastructure v1beta1 API group. |
|
Package controller provides the controller-runtime scheme for Tinkerbell and BMC resources.
|
Package controller provides the controller-runtime scheme for Tinkerbell and BMC resources. |
|
cluster
Package cluster contains Cluster API controller for the TinkerbellCluster CR.
|
Package cluster contains Cluster API controller for the TinkerbellCluster CR. |
|
machine
Package machine contains Cluster API controller for the TinkerbellMachine CR.
|
Package machine contains Cluster API controller for the TinkerbellMachine CR. |
|
pkg
|
|
|
build
Package build provides functions to retrieve source control version information.
|
Package build provides functions to retrieve source control version information. |