Documentation
¶
Overview ¶
Package v1alpha3 contains API Schema definitions for the bootstrap v1alpha3 API group.
+kubebuilder:object:generate=true +groupName=bootstrap.cluster.x-k8s.io
Index ¶
- Constants
- Variables
- type ConfigPatches
- type HostnameSource
- type HostnameSpec
- type TalosConfig
- func (in *TalosConfig) DeepCopy() *TalosConfig
- func (in *TalosConfig) DeepCopyInto(out *TalosConfig)
- func (in *TalosConfig) DeepCopyObject() runtime.Object
- func (c *TalosConfig) GetConditions() capiv1.Conditions
- func (*TalosConfig) Hub()
- func (c *TalosConfig) SetConditions(conditions capiv1.Conditions)
- func (r *TalosConfig) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *TalosConfig) ValidateCreate() error
- func (r *TalosConfig) ValidateDelete() error
- func (r *TalosConfig) ValidateUpdate(oldRaw runtime.Object) error
- type TalosConfigList
- type TalosConfigSpec
- type TalosConfigStatus
- type TalosConfigTemplate
- func (in *TalosConfigTemplate) DeepCopy() *TalosConfigTemplate
- func (in *TalosConfigTemplate) DeepCopyInto(out *TalosConfigTemplate)
- func (in *TalosConfigTemplate) DeepCopyObject() runtime.Object
- func (*TalosConfigTemplate) Hub()
- func (r *TalosConfigTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *TalosConfigTemplate) ValidateCreate() error
- func (r *TalosConfigTemplate) ValidateDelete() error
- func (r *TalosConfigTemplate) ValidateUpdate(oldRaw runtime.Object) error
- type TalosConfigTemplateList
- func (in *TalosConfigTemplateList) DeepCopy() *TalosConfigTemplateList
- func (in *TalosConfigTemplateList) DeepCopyInto(out *TalosConfigTemplateList)
- func (in *TalosConfigTemplateList) DeepCopyObject() runtime.Object
- func (*TalosConfigTemplateList) Hub()
- func (r *TalosConfigTemplateList) SetupWebhookWithManager(mgr ctrl.Manager) error
- type TalosConfigTemplateResource
- type TalosConfigTemplateSpec
Constants ¶
const ( // DataSecretAvailableCondition documents the status of the bootstrap secret generation process. // // NOTE: When the DataSecret generation starts the process completes immediately and within the // same reconciliation, so the user will always see a transition from Wait to Generated without having // evidence that BootstrapSecret generation is started/in progress. DataSecretAvailableCondition capiv1.ConditionType = "DataSecretAvailable" // WaitingForClusterInfrastructureReason (Severity=Info) document a bootstrap secret generation process // waiting for the cluster infrastructure to be ready. // // NOTE: Having the cluster infrastructure ready is a pre-condition for starting to create machines; // the TalosConfig controller ensure this pre-condition is satisfied. WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure" // DataSecretGenerationFailedReason (Severity=Warning) documents a TalosConfig controller detecting // an error while generating a data secret; those kind of errors are usually due to misconfigurations // and user intervention is required to get them fixed. DataSecretGenerationFailedReason = "DataSecretGenerationFailed" )
const ( // ClientConfigAvailableCondition documents the status of the client config generation process. ClientConfigAvailableCondition capiv1.ConditionType = "ClientConfigAvailable" // ClientConfigGenerationFailedReason (Severity=Warning) documents a TalosConfig controller detecting // an error while generating a client config; those kind of errors are usually due to misconfigurations // and user intervention is required to get them fixed. ClientConfigGenerationFailedReason = "ClientConfigGenerationFailed" )
const (
// ConfigFinalizer allows us to clean up resources before deletion
ConfigFinalizer = "talosconfig.bootstrap.cluster.x-k8s.io"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "bootstrap.cluster.x-k8s.io", Version: "v1alpha3"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ConfigPatches ¶
type ConfigPatches struct {
Op string `json:"op"`
Path string `json:"path"`
Value apiextensions.JSON `json:"value,omitempty"`
}
func (*ConfigPatches) DeepCopy ¶
func (in *ConfigPatches) DeepCopy() *ConfigPatches
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigPatches.
func (*ConfigPatches) DeepCopyInto ¶
func (in *ConfigPatches) DeepCopyInto(out *ConfigPatches)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HostnameSource ¶
type HostnameSource string
HostnameSource is the definition of hostname source.
const HostnameSourceMachineName HostnameSource = "MachineName"
HostnameSourceMachineName sets the hostname in the generated configuration to the machine name.
type HostnameSpec ¶
type HostnameSpec struct {
// Source of the hostname.
//
// Allowed values: "MachineName" (use linked Machine's Name).
Source HostnameSource `json:"source,omitempty"`
}
HostnameSpec defines the hostname source.
func (*HostnameSpec) DeepCopy ¶
func (in *HostnameSpec) DeepCopy() *HostnameSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HostnameSpec.
func (*HostnameSpec) DeepCopyInto ¶
func (in *HostnameSpec) DeepCopyInto(out *HostnameSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TalosConfig ¶
type TalosConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TalosConfigSpec `json:"spec,omitempty"`
Status TalosConfigStatus `json:"status,omitempty"`
}
TalosConfig is the Schema for the talosconfigs API
func (*TalosConfig) DeepCopy ¶
func (in *TalosConfig) DeepCopy() *TalosConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfig.
func (*TalosConfig) DeepCopyInto ¶
func (in *TalosConfig) DeepCopyInto(out *TalosConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TalosConfig) DeepCopyObject ¶
func (in *TalosConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TalosConfig) GetConditions ¶
func (c *TalosConfig) GetConditions() capiv1.Conditions
GetConditions returns the set of conditions for this object.
func (*TalosConfig) Hub ¶
func (*TalosConfig) Hub()
func (*TalosConfig) SetConditions ¶
func (c *TalosConfig) SetConditions(conditions capiv1.Conditions)
SetConditions sets the conditions on this object.
func (*TalosConfig) SetupWebhookWithManager ¶
func (r *TalosConfig) SetupWebhookWithManager(mgr ctrl.Manager) error
func (*TalosConfig) ValidateCreate ¶
func (r *TalosConfig) ValidateCreate() error
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*TalosConfig) ValidateDelete ¶
func (r *TalosConfig) ValidateDelete() error
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
func (*TalosConfig) ValidateUpdate ¶
func (r *TalosConfig) ValidateUpdate(oldRaw runtime.Object) error
ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
type TalosConfigList ¶
type TalosConfigList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []TalosConfig `json:"items"`
}
TalosConfigList contains a list of TalosConfig
func (*TalosConfigList) DeepCopy ¶
func (in *TalosConfigList) DeepCopy() *TalosConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigList.
func (*TalosConfigList) DeepCopyInto ¶
func (in *TalosConfigList) DeepCopyInto(out *TalosConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TalosConfigList) DeepCopyObject ¶
func (in *TalosConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TalosConfigList) Hub ¶
func (*TalosConfigList) Hub()
func (*TalosConfigList) SetupWebhookWithManager ¶
func (r *TalosConfigList) SetupWebhookWithManager(mgr ctrl.Manager) error
type TalosConfigSpec ¶
type TalosConfigSpec struct {
TalosVersion string `json:"talosVersion,omitempty"` //talos version formatted like v0.8. used for backwards compatibility
GenerateType string `json:"generateType"` //none,init,controlplane,worker mutually exclusive w/ data
Data string `json:"data,omitempty"`
ConfigPatches []ConfigPatches `json:"configPatches,omitempty"`
// Set hostname in the machine configuration to some value.
Hostname HostnameSpec `json:"hostname,omitempty"`
}
TalosConfigSpec defines the desired state of TalosConfig
func (*TalosConfigSpec) DeepCopy ¶
func (in *TalosConfigSpec) DeepCopy() *TalosConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigSpec.
func (*TalosConfigSpec) DeepCopyInto ¶
func (in *TalosConfigSpec) DeepCopyInto(out *TalosConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TalosConfigStatus ¶
type TalosConfigStatus struct {
// Ready indicates the BootstrapData field is ready to be consumed
Ready bool `json:"ready,omitempty"`
// DataSecretName is the name of the secret that stores the bootstrap data script.
// +optional
DataSecretName *string `json:"dataSecretName,omitempty"`
// Talos config will be a string containing the config for download.
//
// Deprecated: please use `<cluster>-talosconfig` secret.
//
// +optional
TalosConfig string `json:"talosConfig,omitempty"`
// FailureReason will be set on non-retryable errors
// +optional
FailureReason string `json:"failureReason,omitempty"`
// FailureMessage will be set on non-retryable errors
// +optional
FailureMessage string `json:"failureMessage,omitempty"`
// ObservedGeneration is the latest generation observed by the controller.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// Conditions defines current service state of the TalosConfig.
// +optional
Conditions capiv1.Conditions `json:"conditions,omitempty"`
}
TalosConfigStatus defines the observed state of TalosConfig
func (*TalosConfigStatus) DeepCopy ¶
func (in *TalosConfigStatus) DeepCopy() *TalosConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigStatus.
func (*TalosConfigStatus) DeepCopyInto ¶
func (in *TalosConfigStatus) DeepCopyInto(out *TalosConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TalosConfigTemplate ¶
type TalosConfigTemplate struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TalosConfigTemplateSpec `json:"spec,omitempty"`
}
TalosConfigTemplate is the Schema for the talosconfigtemplates API
func (*TalosConfigTemplate) DeepCopy ¶
func (in *TalosConfigTemplate) DeepCopy() *TalosConfigTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigTemplate.
func (*TalosConfigTemplate) DeepCopyInto ¶
func (in *TalosConfigTemplate) DeepCopyInto(out *TalosConfigTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TalosConfigTemplate) DeepCopyObject ¶
func (in *TalosConfigTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TalosConfigTemplate) Hub ¶
func (*TalosConfigTemplate) Hub()
func (*TalosConfigTemplate) SetupWebhookWithManager ¶
func (r *TalosConfigTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error
func (*TalosConfigTemplate) ValidateCreate ¶ added in v0.6.0
func (r *TalosConfigTemplate) ValidateCreate() error
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*TalosConfigTemplate) ValidateDelete ¶ added in v0.6.0
func (r *TalosConfigTemplate) ValidateDelete() error
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
func (*TalosConfigTemplate) ValidateUpdate ¶ added in v0.6.0
func (r *TalosConfigTemplate) ValidateUpdate(oldRaw runtime.Object) error
ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
type TalosConfigTemplateList ¶
type TalosConfigTemplateList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []TalosConfigTemplate `json:"items"`
}
TalosConfigTemplateList contains a list of TalosConfigTemplate
func (*TalosConfigTemplateList) DeepCopy ¶
func (in *TalosConfigTemplateList) DeepCopy() *TalosConfigTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigTemplateList.
func (*TalosConfigTemplateList) DeepCopyInto ¶
func (in *TalosConfigTemplateList) DeepCopyInto(out *TalosConfigTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TalosConfigTemplateList) DeepCopyObject ¶
func (in *TalosConfigTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TalosConfigTemplateList) Hub ¶
func (*TalosConfigTemplateList) Hub()
func (*TalosConfigTemplateList) SetupWebhookWithManager ¶
func (r *TalosConfigTemplateList) SetupWebhookWithManager(mgr ctrl.Manager) error
type TalosConfigTemplateResource ¶
type TalosConfigTemplateResource struct {
Spec TalosConfigSpec `json:"spec,omitempty"`
}
TalosConfigTemplateResource defines the Template structure
func (*TalosConfigTemplateResource) DeepCopy ¶
func (in *TalosConfigTemplateResource) DeepCopy() *TalosConfigTemplateResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigTemplateResource.
func (*TalosConfigTemplateResource) DeepCopyInto ¶
func (in *TalosConfigTemplateResource) DeepCopyInto(out *TalosConfigTemplateResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TalosConfigTemplateSpec ¶
type TalosConfigTemplateSpec struct {
Template TalosConfigTemplateResource `json:"template"`
}
TalosConfigTemplateSpec defines the desired state of TalosConfigTemplate
func (*TalosConfigTemplateSpec) DeepCopy ¶
func (in *TalosConfigTemplateSpec) DeepCopy() *TalosConfigTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TalosConfigTemplateSpec.
func (*TalosConfigTemplateSpec) DeepCopyInto ¶
func (in *TalosConfigTemplateSpec) DeepCopyInto(out *TalosConfigTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.