tinkerbell

package
v1.62.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 13, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Auth

type Auth struct {
	Kubeconfig providerconfigtypes.ConfigVarString `json:"kubeconfig,omitempty"`
}

Auth.

type Config

type Config struct {
	Kubeconfig  string
	ClusterName string
	RestConfig  *rest.Config
	OSImageURL  string
}

type TinkerbellPluginSpec

type TinkerbellPluginSpec struct {
	// ClusterName specifies the name of the Tinkerbell cluster. This is used to identify
	// the cluster within a larger infrastructure or across multiple clusters.
	ClusterName providerconfigtypes.ConfigVarString `json:"clusterName"`

	// Auth contains the kubeconfig credentials needed to authenticate against the
	// Tinkerbell cluster API. This field is optional and should be provided if authentication is required.
	Auth Auth `json:"auth,omitempty"`

	// OSImageURL is the URL where the OS image for the Tinkerbell template is located.
	// This URL is used to download and stream the OS image during the provisioning process.
	OSImageURL providerconfigtypes.ConfigVarString `json:"osImageUrl"`

	// HardwareRef specifies the unique identifier of a single hardware object in the user-cluster
	// that corresponds to the machine deployment. This ensures a one-to-one mapping between a deployment
	// and a hardware object in the Tinkerbell cluster.
	HardwareRef types.NamespacedName `json:"hardwareRef"`
}

TinkerbellPluginSpec defines the required information for the Tinkerbell plugin.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL