README
¶
Cluster API Provider Tink
This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production.
Cluster API Provider Tinkerbell (CAPT) is the implementation of Cluster API Provider for Tinkerbell.
Goal
- It acts as a bridge between Cluster API (a Kubernetes sig-lifecycle project) and Tinkerbell
- It simplifies Kubernetes cluster management using Tinkerbell as underline infrastructure provider
- Create, update, delete Kubernetes clusters in a declarative fashion.
Current state
7th December 2020 marks the first commit for this project, it starts as a porting from CAPP (cluster api provider packet).
Currently, it is possible to bootstrap both single instance and HA Control Plane workload clusters using hardware managed by Tinkerbell.
Integration with PBnJ for remote power management and secure deprovisioning of instances is still outstanding and must be handled externally.
See docs/README.md for more information on setting up a development environment.
Technical preview
This project is under active development and you should expect issues, pull requests and conversation ongoing in the bi-weekly community meeting. Feel free to join if you are curious or if you have any question.
Documentation
¶
Overview ¶
Copyright 2020 The Kubernetes 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 controllers contains Cluster API controllers for Tinkerbell.
|
Package controllers contains Cluster API controllers for Tinkerbell. |
|
hack
|
|
|
boilerplate/test
Package test contains test boilerplate.
|
Package test contains test boilerplate. |
|
internal
|
|
|
templates
Package templates provides methods for rendering templates used for creating Tinkerbell machines for ClusterAPI.
|
Package templates provides methods for rendering templates used for creating Tinkerbell machines for ClusterAPI. |
|
tink
|
|
|
api/v1alpha1
Package v1alpha1 contains API Schema definitions for the Tinkerbell v1alpha1 API group
|
Package v1alpha1 contains API Schema definitions for the Tinkerbell v1alpha1 API group |
|
client
Package client contains a client wrapper for Tinkerbell.
|
Package client contains a client wrapper for Tinkerbell. |
|
client/fake
Package fake contains a fake client wrapper for Tinkerbell.
|
Package fake contains a fake client wrapper for Tinkerbell. |
|
controllers/common
Package common contains common controller logic for Tinkerbell controllers.
|
Package common contains common controller logic for Tinkerbell controllers. |
|
controllers/hardware
Package hardware contains controller for Tinkerbell Hardware.
|
Package hardware contains controller for Tinkerbell Hardware. |
|
controllers/template
Package template contains controller for Tinkerbell Templates.
|
Package template contains controller for Tinkerbell Templates. |
|
controllers/workflow
Package workflow contains controllers for Tinkerbell workflow.
|
Package workflow contains controllers for Tinkerbell workflow. |
|
test/utils
Package utils contains test utilities for cluster-api-provider-tinkerbell.
|
Package utils contains test utilities for cluster-api-provider-tinkerbell. |