Documentation ¶
Index ¶
- Constants
- func MachineStageStrings() []string
- func MetaKeyTagToID(t uint8) resource.ID
- type DevicesStatus
- type DevicesStatusCondition
- type DevicesStatusExtension
- type DevicesStatusSpec
- type Diagnostic
- type DiagnosticExtension
- type DiagnosticSpec
- type EventSinkConfig
- type EventSinkConfigExtension
- type EventSinkConfigSpec
- type ExtensionServiceConfig
- type ExtensionServiceConfigExtension
- type ExtensionServiceConfigFile
- type ExtensionServiceConfigSpec
- type ExtensionServiceConfigStatus
- type ExtensionServiceConfigStatusCondition
- type ExtensionServiceConfigStatusExtension
- type ExtensionServiceConfigStatusSpec
- type ExtensionStatus
- type ExtensionStatusExtension
- type ExtensionStatusSpec
- type KernelModuleSpec
- type KernelModuleSpecExtension
- type KernelModuleSpecSpec
- type KernelParam
- type KernelParamDefaultSpec
- type KernelParamDefaultSpecExtension
- type KernelParamDefaultSpecSpec
- type KernelParamSpec
- type KernelParamSpecExtension
- type KernelParamSpecSpec
- type KernelParamStatus
- type KernelParamStatusExtension
- type KernelParamStatusSpec
- type KernelParamsSetCondition
- type KmsgLogConfig
- type KmsgLogConfigExtension
- type KmsgLogConfigSpec
- type MachineResetSignal
- type MachineResetSignalExtension
- type MachineResetSignalSpec
- type MachineStage
- type MachineStatus
- type MachineStatusExtension
- type MachineStatusSpec
- type MachineStatusStatus
- type MaintenanceServiceConfig
- type MaintenanceServiceConfigExtension
- type MaintenanceServiceConfigSpec
- type MaintenanceServiceRequest
- type MaintenanceServiceRequestExtension
- type MaintenanceServiceRequestSpec
- type MetaKey
- type MetaKeyExtension
- type MetaKeySpec
- type MetaLoaded
- type MetaLoadedExtension
- type MetaLoadedSpec
- type MountStatus
- type MountStatusExtension
- type MountStatusSpec
- type PlatformMetadata
- type PlatformMetadataExtension
- type PlatformMetadataSpec
- type SecurityState
- type SecurityStateExtension
- type SecurityStateSpec
- type UniqueMachineToken
- type UniqueMachineTokenExtension
- type UniqueMachineTokenSpec
- type UnmetCondition
- type WatchdogTimerConfig
- type WatchdogTimerConfigExtension
- type WatchdogTimerConfigSpec
- type WatchdogTimerStatus
- type WatchdogTimerStatusExtension
- type WatchdogTimerStatusSpec
Constants ¶
const ( // UniqueMachineTokenType is type of [UniqueMachineToken] resource. UniqueMachineTokenType = resource.Type("UniqueMachineTokens.runtime.talos.dev") // UniqueMachineTokenID is the ID of [UniqueMachineToken] resource. UniqueMachineTokenID = resource.ID("unique-machine-token") )
const DevicesID = resource.ID("devices")
DevicesID is the ID of DevicesStatus resource.
const DevicesStatusType = resource.Type("DevicesStatuses.runtime.talos.dev")
DevicesStatusType is type of DevicesStatus resource.
const DiagnosticType = resource.Type("Diagnostics.runtime.talos.dev")
DiagnosticType is type of Diagnostic resource.
const EventSinkConfigID resource.ID = "event-sink"
EventSinkConfigID is a resource ID for EventSinkConfig.
const EventSinkConfigType = resource.Type("EventSinkConfigs.runtime.talos.dev")
EventSinkConfigType is type of EventSinkConfig resource.
const ExtensionServiceConfigStatusType = resource.Type("ExtensionServiceConfigStatuses.runtime.talos.dev")
ExtensionServiceConfigStatusType is a type of ExtensionServiceConfig.
const ExtensionServiceConfigType = resource.Type("ExtensionServiceConfigs.runtime.talos.dev")
ExtensionServiceConfigType is a type of ExtensionServiceConfig.
const ExtensionStatusType = resource.Type("ExtensionStatuses.runtime.talos.dev")
ExtensionStatusType is type of Extension resource.
const KernelModuleSpecType = resource.Type("KernelModuleSpecs.runtime.talos.dev")
KernelModuleSpecType is type of KernelModuleSpec resource.
const KernelParamDefaultSpecType = resource.Type("KernelParamDefaultSpecs.runtime.talos.dev")
KernelParamDefaultSpecType is type of KernelParam resource for default kernel params.
const KernelParamSpecType = resource.Type("KernelParamSpecs.runtime.talos.dev")
KernelParamSpecType is type of KernelParam resource.
const KernelParamStatusType = resource.Type("KernelParamStatuses.runtime.talos.dev")
KernelParamStatusType is type of KernelParam resource.
const KmsgLogConfigID resource.ID = "kmsg-log"
KmsgLogConfigID is a resource ID for KmsgLogConfig.
const KmsgLogConfigType = resource.Type("KmsgLogConfigs.runtime.talos.dev")
KmsgLogConfigType is type of KmsgLogConfig resource.
const MachineResetSignalID = resource.ID("machine")
MachineResetSignalID is singleton MachineResetSignal resource ID.
const MachineResetSignalType = resource.Type("MachineResetSignals.runtime.talos.dev")
MachineResetSignalType is type of MachineResetSignal resource.
const MachineStatusID = resource.ID("machine")
MachineStatusID is singleton MachineStatus resource ID.
const MachineStatusType = resource.Type("MachineStatuses.runtime.talos.dev")
MachineStatusType is type of MachineStatus resource.
const MaintenanceServiceConfigID resource.ID = "maintenance"
MaintenanceServiceConfigID is a resource ID for MaintenanceConfig.
const MaintenanceServiceConfigType = resource.Type("MaintenanceServiceConfigs.runtime.talos.dev")
MaintenanceServiceConfigType is type of MaintenanceConfig resource.
const MaintenanceServiceRequestID resource.ID = "maintenance"
MaintenanceServiceRequestID is a resource ID for MaintenanceConfig.
const MaintenanceServiceRequestType = resource.Type("MaintenanceServiceRequests.runtime.talos.dev")
MaintenanceServiceRequestType is type of MaintenanceServiceConfig resource.
const MetaKeyType = resource.Type("MetaKeys.runtime.talos.dev")
MetaKeyType is type of MetaKey resource.
const MetaLoadedID = resource.ID("meta-loaded")
MetaLoadedID is the ID of MetaLoaded resource.
const MetaLoadedType = resource.Type("MetaLoads.runtime.talos.dev")
MetaLoadedType is type of MetaLoaded resource.
const MountStatusType = resource.Type("MountStatuses.runtime.talos.dev")
MountStatusType is type of Mount resource.
const NamespaceName resource.Namespace = v1alpha1.NamespaceName
NamespaceName contains configuration resources.
const PlatformMetadataID resource.ID = "platformmetadata"
PlatformMetadataID is the ID for Metadata resource platform.
const PlatformMetadataType = resource.Type("PlatformMetadatas.talos.dev")
PlatformMetadataType is type of Metadata resource.
const SecurityStateID = resource.ID("securitystate")
SecurityStateID is the ID of the security state resource.
const SecurityStateType = resource.Type("SecurityStates.talos.dev")
SecurityStateType is the type of the security state resource.
const WatchdogTimerConfigID resource.ID = "timer"
WatchdogTimerConfigID is a resource ID for WatchdogTimerConfig.
const WatchdogTimerConfigType = resource.Type("WatchdogTimerConfigs.runtime.talos.dev")
WatchdogTimerConfigType is type of WatchdogTimerConfig resource.
const WatchdogTimerStatusType = resource.Type("WatchdogTimerStatuses.runtime.talos.dev")
WatchdogTimerStatusType is type of WatchdogTimerStatus resource.
Variables ¶
This section is empty.
Functions ¶
func MachineStageStrings ¶ added in v1.7.0
func MachineStageStrings() []string
MachineStageStrings returns a slice of all String values of the enum
func MetaKeyTagToID ¶ added in v1.4.0
MetaKeyTagToID converts a tag to ID for MetaKey resource.
Types ¶
type DevicesStatus ¶ added in v1.5.0
type DevicesStatus = typed.Resource[DevicesStatusSpec, DevicesStatusExtension]
DevicesStatus resource holds status of hardware devices (overall).
func NewDevicesStatus ¶ added in v1.5.0
func NewDevicesStatus(namespace resource.Namespace, id resource.ID) *DevicesStatus
NewDevicesStatus initializes a DevicesStatus resource.
type DevicesStatusCondition ¶ added in v1.7.1
type DevicesStatusCondition struct {
// contains filtered or unexported fields
}
DevicesStatusCondition implements condition which waits for devices to be ready.
func NewDevicesStatusCondition ¶ added in v1.7.1
func NewDevicesStatusCondition(state state.State) *DevicesStatusCondition
NewDevicesStatusCondition builds a condition which waits for devices to be ready.
func (*DevicesStatusCondition) String ¶ added in v1.7.1
func (condition *DevicesStatusCondition) String() string
type DevicesStatusExtension ¶ added in v1.5.0
type DevicesStatusExtension struct{}
DevicesStatusExtension is auxiliary resource data for DevicesStatus.
func (DevicesStatusExtension) ResourceDefinition ¶ added in v1.5.0
func (DevicesStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type DevicesStatusSpec ¶ added in v1.5.0
type DevicesStatusSpec struct { // Devices are settled down and ready to be used. Ready bool `yaml:"ready" protobuf:"1"` }
DevicesStatusSpec is the spec for devices status.
func (DevicesStatusSpec) DeepCopy ¶ added in v1.5.0
func (o DevicesStatusSpec) DeepCopy() DevicesStatusSpec
DeepCopy generates a deep copy of DevicesStatusSpec.
type Diagnostic ¶ added in v1.8.0
type Diagnostic = typed.Resource[DiagnosticSpec, DiagnosticExtension]
Diagnostic resource contains warnings produced by Talos Diagnostics.
func NewDiagnostic ¶ added in v1.8.0
func NewDiagnostic(namespace resource.Namespace, id resource.ID) *Diagnostic
NewDiagnostic initializes a Diagnostic resource.
type DiagnosticExtension ¶ added in v1.8.0
type DiagnosticExtension struct{}
DiagnosticExtension is auxiliary resource data for Diagnostic.
func (DiagnosticExtension) ResourceDefinition ¶ added in v1.8.0
func (DiagnosticExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type DiagnosticSpec ¶ added in v1.8.0
type DiagnosticSpec struct { // Short message describing the problem. Message string `yaml:"message" protobuf:"1"` // Details about the problem. Details []string `yaml:"details" protobuf:"2"` }
DiagnosticSpec is the spec for devices status.
func (DiagnosticSpec) DeepCopy ¶ added in v1.8.0
func (o DiagnosticSpec) DeepCopy() DiagnosticSpec
DeepCopy generates a deep copy of DiagnosticSpec.
func (*DiagnosticSpec) DocumentationURL ¶ added in v1.8.0
func (spec *DiagnosticSpec) DocumentationURL(id string) string
DocumentationURL returns the URL to the documentation for the warning.
type EventSinkConfig ¶ added in v1.5.0
type EventSinkConfig = typed.Resource[EventSinkConfigSpec, EventSinkConfigExtension]
EventSinkConfig resource holds configuration for Talos event log streaming.
func NewEventSinkConfig ¶ added in v1.5.0
func NewEventSinkConfig() *EventSinkConfig
NewEventSinkConfig initializes a EventSinkConfig resource.
type EventSinkConfigExtension ¶ added in v1.5.0
type EventSinkConfigExtension struct{}
EventSinkConfigExtension is auxiliary resource data for EventSinkConfig.
func (EventSinkConfigExtension) ResourceDefinition ¶ added in v1.5.0
func (EventSinkConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type EventSinkConfigSpec ¶ added in v1.5.0
type EventSinkConfigSpec struct {
Endpoint string `yaml:"endpoint" protobuf:"1"`
}
EventSinkConfigSpec describes configuration of Talos event log streaming.
func (EventSinkConfigSpec) DeepCopy ¶ added in v1.5.0
func (o EventSinkConfigSpec) DeepCopy() EventSinkConfigSpec
DeepCopy generates a deep copy of EventSinkConfigSpec.
type ExtensionServiceConfig ¶ added in v1.7.0
type ExtensionServiceConfig = typed.Resource[ExtensionServiceConfigSpec, ExtensionServiceConfigExtension]
ExtensionServiceConfig represents a resource that describes status of rendered extensions service config files.
func NewExtensionServiceConfigSpec ¶ added in v1.7.0
func NewExtensionServiceConfigSpec(namespace resource.Namespace, id resource.ID) *ExtensionServiceConfig
NewExtensionServiceConfigSpec initializes a new ExtensionServiceConfigSpec.
type ExtensionServiceConfigExtension ¶ added in v1.7.0
type ExtensionServiceConfigExtension struct{}
ExtensionServiceConfigExtension provides auxiliary methods for ExtensionServiceConfig.
func (ExtensionServiceConfigExtension) ResourceDefinition ¶ added in v1.7.0
func (ExtensionServiceConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type ExtensionServiceConfigFile ¶ added in v1.7.0
type ExtensionServiceConfigFile struct { Content string `yaml:"content" protobuf:"1"` MountPath string `yaml:"mountPath" protobuf:"2"` }
ExtensionServiceConfigFile describes extensions service config files.
type ExtensionServiceConfigSpec ¶ added in v1.7.0
type ExtensionServiceConfigSpec struct { Files []ExtensionServiceConfigFile `yaml:"files,omitempty" protobuf:"1"` Environment []string `yaml:"environment,omitempty" protobuf:"2"` }
ExtensionServiceConfigSpec describes status of rendered extensions service config files.
func (ExtensionServiceConfigSpec) DeepCopy ¶ added in v1.7.0
func (o ExtensionServiceConfigSpec) DeepCopy() ExtensionServiceConfigSpec
DeepCopy generates a deep copy of ExtensionServiceConfigSpec.
type ExtensionServiceConfigStatus ¶ added in v1.7.0
type ExtensionServiceConfigStatus = typed.Resource[ExtensionServiceConfigStatusSpec, ExtensionServiceConfigStatusExtension]
ExtensionServiceConfigStatus represents a resource that describes status of rendered extensions service config files.
func NewExtensionServiceConfigStatusSpec ¶ added in v1.7.0
func NewExtensionServiceConfigStatusSpec(namespace resource.Namespace, id resource.ID) *ExtensionServiceConfigStatus
NewExtensionServiceConfigStatusSpec initializes a new ExtensionServiceConfigStatusSpec.
type ExtensionServiceConfigStatusCondition ¶ added in v1.7.0
type ExtensionServiceConfigStatusCondition struct {
// contains filtered or unexported fields
}
ExtensionServiceConfigStatusCondition implements condition which waits for extension service config to be available.
func NewExtensionServiceConfigStatusCondition ¶ added in v1.7.0
func NewExtensionServiceConfigStatusCondition(state state.State, serviceName string) *ExtensionServiceConfigStatusCondition
NewExtensionServiceConfigStatusCondition builds a condition which waits for extension service config to be available.
func (*ExtensionServiceConfigStatusCondition) String ¶ added in v1.7.0
func (condition *ExtensionServiceConfigStatusCondition) String() string
type ExtensionServiceConfigStatusExtension ¶ added in v1.7.0
type ExtensionServiceConfigStatusExtension struct{}
ExtensionServiceConfigStatusExtension provides auxiliary methods for ExtensionServiceConfig.
func (ExtensionServiceConfigStatusExtension) ResourceDefinition ¶ added in v1.7.0
func (ExtensionServiceConfigStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type ExtensionServiceConfigStatusSpec ¶ added in v1.7.0
type ExtensionServiceConfigStatusSpec struct {
SpecVersion string `yaml:"specVersion" protobuf:"1"`
}
ExtensionServiceConfigStatusSpec describes status of rendered extensions service config files.
func (ExtensionServiceConfigStatusSpec) DeepCopy ¶ added in v1.7.0
func (o ExtensionServiceConfigStatusSpec) DeepCopy() ExtensionServiceConfigStatusSpec
DeepCopy generates a deep copy of ExtensionServiceConfigStatusSpec.
type ExtensionStatus ¶
type ExtensionStatus = typed.Resource[ExtensionStatusSpec, ExtensionStatusExtension]
ExtensionStatus resource holds status of installed system extensions.
func NewExtensionStatus ¶
func NewExtensionStatus(namespace resource.Namespace, id resource.ID) *ExtensionStatus
NewExtensionStatus initializes a ExtensionStatus resource.
type ExtensionStatusExtension ¶ added in v1.4.0
type ExtensionStatusExtension struct{}
ExtensionStatusExtension is auxiliary resource data for ExtensionStatus.
func (ExtensionStatusExtension) ResourceDefinition ¶ added in v1.4.0
func (ExtensionStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type ExtensionStatusSpec ¶
type ExtensionStatusSpec = extensions.Layer
ExtensionStatusSpec is the spec for system extensions.
type KernelModuleSpec ¶
type KernelModuleSpec = typed.Resource[KernelModuleSpecSpec, KernelModuleSpecExtension]
KernelModuleSpec resource holds information about Linux kernel module to load.
func NewKernelModuleSpec ¶
func NewKernelModuleSpec(namespace resource.Namespace, id resource.ID) *KernelModuleSpec
NewKernelModuleSpec initializes a KernelModuleSpec resource.
type KernelModuleSpecExtension ¶ added in v1.4.0
type KernelModuleSpecExtension struct{}
KernelModuleSpecExtension is auxiliary resource data for KernelModuleSpec.
func (KernelModuleSpecExtension) ResourceDefinition ¶ added in v1.4.0
func (KernelModuleSpecExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type KernelModuleSpecSpec ¶
type KernelModuleSpecSpec struct { Name string `yaml:"string" protobuf:"1"` Parameters []string `yaml:"parameters" protobuf:"2"` }
KernelModuleSpecSpec describes Linux kernel module to load.
func (KernelModuleSpecSpec) DeepCopy ¶
func (o KernelModuleSpecSpec) DeepCopy() KernelModuleSpecSpec
DeepCopy generates a deep copy of KernelModuleSpecSpec.
type KernelParam ¶
type KernelParam interface {
TypedSpec() *KernelParamSpecSpec
}
KernelParam interface.
type KernelParamDefaultSpec ¶
type KernelParamDefaultSpec = typed.Resource[KernelParamDefaultSpecSpec, KernelParamDefaultSpecExtension]
KernelParamDefaultSpec implements meta.ResourceDefinitionProvider interface.
func NewKernelParamDefaultSpec ¶
func NewKernelParamDefaultSpec(namespace resource.Namespace, id resource.ID) *KernelParamDefaultSpec
NewKernelParamDefaultSpec initializes a KernelParamDefaultSpec resource.
type KernelParamDefaultSpecExtension ¶ added in v1.4.0
type KernelParamDefaultSpecExtension struct{}
KernelParamDefaultSpecExtension is the typed.Extension for KernelParamDefaultSpec.
func (KernelParamDefaultSpecExtension) ResourceDefinition ¶ added in v1.4.0
func (KernelParamDefaultSpecExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type KernelParamDefaultSpecSpec ¶
type KernelParamDefaultSpecSpec = KernelParamSpecSpec
KernelParamDefaultSpecSpec is same as KernelParamSpecSpec.
type KernelParamSpec ¶
type KernelParamSpec = typed.Resource[KernelParamSpecSpec, KernelParamSpecExtension]
KernelParamSpec resource holds sysctl flags to define.
func NewKernelParamSpec ¶
func NewKernelParamSpec(namespace resource.Namespace, id resource.ID) *KernelParamSpec
NewKernelParamSpec initializes a KernelParamSpec resource.
type KernelParamSpecExtension ¶ added in v1.4.0
type KernelParamSpecExtension struct{}
KernelParamSpecExtension is the typed.Extension for KernelParamSpec.
func (KernelParamSpecExtension) ResourceDefinition ¶ added in v1.4.0
func (KernelParamSpecExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type KernelParamSpecSpec ¶
type KernelParamSpecSpec struct { Value string `yaml:"value" protobuf:"1"` IgnoreErrors bool `yaml:"ignoreErrors" protobuf:"2"` }
KernelParamSpecSpec describes status of the defined sysctls.
func (KernelParamSpecSpec) DeepCopy ¶
func (o KernelParamSpecSpec) DeepCopy() KernelParamSpecSpec
DeepCopy generates a deep copy of KernelParamSpecSpec.
type KernelParamStatus ¶
type KernelParamStatus = typed.Resource[KernelParamStatusSpec, KernelParamStatusExtension]
KernelParamStatus resource holds defined sysctl flags status.
func NewKernelParamStatus ¶
func NewKernelParamStatus(namespace resource.Namespace, id resource.ID) *KernelParamStatus
NewKernelParamStatus initializes a KernelParamStatus resource.
type KernelParamStatusExtension ¶ added in v1.4.0
type KernelParamStatusExtension struct{}
KernelParamStatusExtension is auxiliary resource data for KernelParamStatus.
func (KernelParamStatusExtension) ResourceDefinition ¶ added in v1.4.0
func (KernelParamStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type KernelParamStatusSpec ¶
type KernelParamStatusSpec struct { Current string `yaml:"current" protobuf:"1"` Default string `yaml:"default" protobuf:"2"` Unsupported bool `yaml:"unsupported" protobuf:"3"` }
KernelParamStatusSpec describes status of the defined sysctls.
func (KernelParamStatusSpec) DeepCopy ¶
func (o KernelParamStatusSpec) DeepCopy() KernelParamStatusSpec
DeepCopy generates a deep copy of KernelParamStatusSpec.
type KernelParamsSetCondition ¶
type KernelParamsSetCondition struct {
// contains filtered or unexported fields
}
KernelParamsSetCondition implements condition which waits for the kernels to be in sync.
func NewKernelParamsSetCondition ¶
func NewKernelParamsSetCondition(state state.State, props ...*kernel.Param) *KernelParamsSetCondition
NewKernelParamsSetCondition builds a coondition which waits for the kernel to be in sync.
func (*KernelParamsSetCondition) String ¶
func (condition *KernelParamsSetCondition) String() string
type KmsgLogConfig ¶ added in v1.5.0
type KmsgLogConfig = typed.Resource[KmsgLogConfigSpec, KmsgLogConfigExtension]
KmsgLogConfig resource holds configuration for kernel message log streaming.
func NewKmsgLogConfig ¶ added in v1.5.0
func NewKmsgLogConfig() *KmsgLogConfig
NewKmsgLogConfig initializes a KmsgLogConfig resource.
type KmsgLogConfigExtension ¶ added in v1.5.0
type KmsgLogConfigExtension struct{}
KmsgLogConfigExtension is auxiliary resource data for KmsgLogConfig.
func (KmsgLogConfigExtension) ResourceDefinition ¶ added in v1.5.0
func (KmsgLogConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type KmsgLogConfigSpec ¶ added in v1.5.0
KmsgLogConfigSpec describes configuration for kmsg log streaming.
func (KmsgLogConfigSpec) DeepCopy ¶ added in v1.5.0
func (o KmsgLogConfigSpec) DeepCopy() KmsgLogConfigSpec
DeepCopy generates a deep copy of KmsgLogConfigSpec.
type MachineResetSignal ¶ added in v1.6.0
type MachineResetSignal = typed.Resource[MachineResetSignalSpec, MachineResetSignalExtension]
MachineResetSignal resource is created to signal that the machine is going to be reset soon.
This resource is created when all remaining actions are local to the node, and network communication is not required.
func NewMachineResetSignal ¶ added in v1.6.0
func NewMachineResetSignal() *MachineResetSignal
NewMachineResetSignal initializes a MachineResetSignal resource.
type MachineResetSignalExtension ¶ added in v1.6.0
type MachineResetSignalExtension struct{}
MachineResetSignalExtension is auxiliary resource data for MachineResetSignal.
func (MachineResetSignalExtension) ResourceDefinition ¶ added in v1.6.0
func (MachineResetSignalExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MachineResetSignalSpec ¶ added in v1.6.0
type MachineResetSignalSpec struct{}
MachineResetSignalSpec describes the spec of MachineResetSignal.
func (MachineResetSignalSpec) DeepCopy ¶ added in v1.6.0
func (o MachineResetSignalSpec) DeepCopy() MachineResetSignalSpec
DeepCopy generates a deep copy of MachineResetSignalSpec.
type MachineStage ¶
type MachineStage int
MachineStage describes the stage of the machine boot/run process.
const ( MachineStageUnknown MachineStage = iota // unknown MachineStageBooting // booting MachineStageInstalling // installing MachineStageMaintenance // maintenance MachineStageRunning // running MachineStageRebooting // rebooting MachineStageShuttingDown // shutting down MachineStageResetting // resetting MachineStageUpgrading // upgrading )
Machine stages.
func MachineStageString ¶
func MachineStageString(s string) (MachineStage, error)
MachineStageString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func MachineStageValues ¶
func MachineStageValues() []MachineStage
MachineStageValues returns all values of the enum
func (MachineStage) IsAMachineStage ¶
func (i MachineStage) IsAMachineStage() bool
IsAMachineStage returns "true" if the value is listed in the enum definition. "false" otherwise
func (MachineStage) MarshalText ¶
func (i MachineStage) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for MachineStage
func (MachineStage) String ¶
func (i MachineStage) String() string
func (*MachineStage) UnmarshalText ¶
func (i *MachineStage) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for MachineStage
type MachineStatus ¶
type MachineStatus = typed.Resource[MachineStatusSpec, MachineStatusExtension]
MachineStatus resource holds information about aggregated machine status.
func NewMachineStatus ¶
func NewMachineStatus() *MachineStatus
NewMachineStatus initializes a MachineStatus resource.
type MachineStatusExtension ¶ added in v1.4.0
type MachineStatusExtension struct{}
MachineStatusExtension is auxiliary resource data for MachineStatus.
func (MachineStatusExtension) ResourceDefinition ¶ added in v1.4.0
func (MachineStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MachineStatusSpec ¶
type MachineStatusSpec struct { Stage MachineStage `yaml:"stage" protobuf:"1"` Status MachineStatusStatus `yaml:"status" protobuf:"2"` }
MachineStatusSpec describes status of the defined sysctls.
func (MachineStatusSpec) DeepCopy ¶
func (o MachineStatusSpec) DeepCopy() MachineStatusSpec
DeepCopy generates a deep copy of MachineStatusSpec.
type MachineStatusStatus ¶
type MachineStatusStatus struct { Ready bool `yaml:"ready" protobuf:"1"` UnmetConditions []UnmetCondition `yaml:"unmetConditions" protobuf:"2"` }
MachineStatusStatus describes machine current status at the stage.
type MaintenanceServiceConfig ¶ added in v1.5.0
type MaintenanceServiceConfig = typed.Resource[MaintenanceServiceConfigSpec, MaintenanceServiceConfigExtension]
MaintenanceServiceConfig resource holds configuration for maintenance service API.
func NewMaintenanceServiceConfig ¶ added in v1.5.0
func NewMaintenanceServiceConfig() *MaintenanceServiceConfig
NewMaintenanceServiceConfig initializes a MaintenanceConfig resource.
type MaintenanceServiceConfigExtension ¶ added in v1.5.0
type MaintenanceServiceConfigExtension struct{}
MaintenanceServiceConfigExtension is auxiliary resource data for MaintenanceConfig.
func (MaintenanceServiceConfigExtension) ResourceDefinition ¶ added in v1.5.0
func (MaintenanceServiceConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MaintenanceServiceConfigSpec ¶ added in v1.5.0
type MaintenanceServiceConfigSpec struct { ListenAddress string `yaml:"listenAddress" protobuf:"1"` ReachableAddresses []netip.Addr `yaml:"reachableAddresses" protobuf:"2"` }
MaintenanceServiceConfigSpec describes configuration for maintenance service API.
func (MaintenanceServiceConfigSpec) DeepCopy ¶ added in v1.5.0
func (o MaintenanceServiceConfigSpec) DeepCopy() MaintenanceServiceConfigSpec
DeepCopy generates a deep copy of MaintenanceServiceConfigSpec.
type MaintenanceServiceRequest ¶ added in v1.5.0
type MaintenanceServiceRequest = typed.Resource[MaintenanceServiceRequestSpec, MaintenanceServiceRequestExtension]
MaintenanceServiceRequest resource indicates that the maintenance service should run.
func NewMaintenanceServiceRequest ¶ added in v1.5.0
func NewMaintenanceServiceRequest() *MaintenanceServiceRequest
NewMaintenanceServiceRequest initializes a MaintenanceConfig resource.
type MaintenanceServiceRequestExtension ¶ added in v1.5.0
type MaintenanceServiceRequestExtension struct{}
MaintenanceServiceRequestExtension is auxiliary resource data for MaintenanceConfig.
func (MaintenanceServiceRequestExtension) ResourceDefinition ¶ added in v1.5.0
func (MaintenanceServiceRequestExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MaintenanceServiceRequestSpec ¶ added in v1.5.0
type MaintenanceServiceRequestSpec struct{}
MaintenanceServiceRequestSpec indicates that maintenance service API should be started.
func (MaintenanceServiceRequestSpec) DeepCopy ¶ added in v1.5.0
func (o MaintenanceServiceRequestSpec) DeepCopy() MaintenanceServiceRequestSpec
DeepCopy generates a deep copy of MaintenanceServiceRequestSpec.
type MetaKey ¶ added in v1.4.0
type MetaKey = typed.Resource[MetaKeySpec, MetaKeyExtension]
MetaKey resource holds value of a key in META partition.
type MetaKeyExtension ¶ added in v1.4.0
type MetaKeyExtension struct{}
MetaKeyExtension is auxiliary resource data for MetaKey.
func (MetaKeyExtension) ResourceDefinition ¶ added in v1.4.0
func (MetaKeyExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MetaKeySpec ¶ added in v1.4.0
type MetaKeySpec struct {
Value string `yaml:"value" protobuf:"1"`
}
MetaKeySpec describes status of the defined sysctls.
func (MetaKeySpec) DeepCopy ¶ added in v1.4.0
func (o MetaKeySpec) DeepCopy() MetaKeySpec
DeepCopy generates a deep copy of MetaKeySpec.
type MetaLoaded ¶ added in v1.6.0
type MetaLoaded = typed.Resource[MetaLoadedSpec, MetaLoadedExtension]
MetaLoaded resource appears when all meta keys are loaded.
func NewMetaLoaded ¶ added in v1.6.0
func NewMetaLoaded() *MetaLoaded
NewMetaLoaded initializes a MetaLoaded resource.
type MetaLoadedExtension ¶ added in v1.6.0
type MetaLoadedExtension struct{}
MetaLoadedExtension is auxiliary resource data for MetaLoaded.
func (MetaLoadedExtension) ResourceDefinition ¶ added in v1.6.0
func (MetaLoadedExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MetaLoadedSpec ¶ added in v1.6.0
type MetaLoadedSpec struct {
Done bool `yaml:"done" protobuf:"1"`
}
MetaLoadedSpec is the spec for meta loaded. The Done field is always true when resource exists.
func (MetaLoadedSpec) DeepCopy ¶ added in v1.6.0
func (o MetaLoadedSpec) DeepCopy() MetaLoadedSpec
DeepCopy generates a deep copy of MetaLoadedSpec.
type MountStatus ¶
type MountStatus = typed.Resource[MountStatusSpec, MountStatusExtension]
MountStatus resource holds defined sysctl flags status.
func NewMountStatus ¶
func NewMountStatus(namespace resource.Namespace, id resource.ID) *MountStatus
NewMountStatus initializes a MountStatus resource.
type MountStatusExtension ¶ added in v1.4.0
type MountStatusExtension struct{}
MountStatusExtension is auxiliary resource data for MountStatus.
func (MountStatusExtension) ResourceDefinition ¶ added in v1.4.0
func (MountStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type MountStatusSpec ¶
type MountStatusSpec struct { Source string `yaml:"source" protobuf:"1"` Target string `yaml:"target" protobuf:"2"` FilesystemType string `yaml:"filesystemType" protobuf:"3"` Options []string `yaml:"options" protobuf:"4"` Encrypted bool `yaml:"encrypted" protobuf:"5"` EncryptionProviders []string `yaml:"encryptionProviders,omitempty" protobuf:"6"` }
MountStatusSpec describes status of the defined sysctls.
func (MountStatusSpec) DeepCopy ¶
func (o MountStatusSpec) DeepCopy() MountStatusSpec
DeepCopy generates a deep copy of MountStatusSpec.
type PlatformMetadata ¶
type PlatformMetadata = typed.Resource[PlatformMetadataSpec, PlatformMetadataExtension]
PlatformMetadata resource holds.
func NewPlatformMetadataSpec ¶
func NewPlatformMetadataSpec(namespace resource.Namespace, _ resource.ID) *PlatformMetadata
NewPlatformMetadataSpec initializes a MetadataSpec resource.
type PlatformMetadataExtension ¶ added in v1.4.0
type PlatformMetadataExtension struct{}
PlatformMetadataExtension provides auxiliary methods for PlatformMetadata.
func (PlatformMetadataExtension) ResourceDefinition ¶ added in v1.4.0
func (PlatformMetadataExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type PlatformMetadataSpec ¶
type PlatformMetadataSpec struct { Platform string `yaml:"platform,omitempty" protobuf:"1"` Hostname string `yaml:"hostname,omitempty" protobuf:"2"` Region string `yaml:"region,omitempty" protobuf:"3"` Zone string `yaml:"zone,omitempty" protobuf:"4"` InstanceType string `yaml:"instanceType,omitempty" protobuf:"5"` InstanceID string `yaml:"instanceId,omitempty" protobuf:"6"` ProviderID string `yaml:"providerId,omitempty" protobuf:"7"` Spot bool `yaml:"spot,omitempty" protobuf:"8"` InternalDNS string `yaml:"internalDNS,omitempty" protobuf:"9"` ExternalDNS string `yaml:"externalDNS,omitempty" protobuf:"10"` }
PlatformMetadataSpec describes platform metadata properties.
func (PlatformMetadataSpec) DeepCopy ¶
func (o PlatformMetadataSpec) DeepCopy() PlatformMetadataSpec
DeepCopy generates a deep copy of PlatformMetadataSpec.
type SecurityState ¶ added in v1.5.0
type SecurityState = typed.Resource[SecurityStateSpec, SecurityStateExtension]
SecurityState is the security state resource.
func NewSecurityStateSpec ¶ added in v1.5.0
func NewSecurityStateSpec(namespace resource.Namespace) *SecurityState
NewSecurityStateSpec initializes a security state resource.
type SecurityStateExtension ¶ added in v1.5.0
type SecurityStateExtension struct{}
SecurityStateExtension provides auxiliary methods for SecurityState.
func (SecurityStateExtension) ResourceDefinition ¶ added in v1.5.0
func (SecurityStateExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements typed.Extension interface.
type SecurityStateSpec ¶ added in v1.5.0
type SecurityStateSpec struct { SecureBoot bool `yaml:"secureBoot" protobuf:"1"` UKISigningKeyFingerprint string `yaml:"ukiSigningKeyFingerprint,omitempty" protobuf:"2"` PCRSigningKeyFingerprint string `yaml:"pcrSigningKeyFingerprint,omitempty" protobuf:"3"` }
SecurityStateSpec describes the security state resource properties.
func (SecurityStateSpec) DeepCopy ¶ added in v1.5.0
func (o SecurityStateSpec) DeepCopy() SecurityStateSpec
DeepCopy generates a deep copy of SecurityStateSpec.
type UniqueMachineToken ¶ added in v1.6.0
type UniqueMachineToken = typed.Resource[UniqueMachineTokenSpec, UniqueMachineTokenExtension]
UniqueMachineToken resource appears when all meta keys are loaded.
func NewUniqueMachineToken ¶ added in v1.6.0
func NewUniqueMachineToken() *UniqueMachineToken
NewUniqueMachineToken initializes a UniqueMachineToken resource.
type UniqueMachineTokenExtension ¶ added in v1.6.0
type UniqueMachineTokenExtension struct{}
UniqueMachineTokenExtension is auxiliary resource data for UniqueMachineToken.
func (UniqueMachineTokenExtension) ResourceDefinition ¶ added in v1.6.0
func (UniqueMachineTokenExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type UniqueMachineTokenSpec ¶ added in v1.6.0
type UniqueMachineTokenSpec struct {
Token string `yaml:"token" protobuf:"1"`
}
UniqueMachineTokenSpec is the spec for the machine unique token. Token can be empty if machine wasn't assigned any.
func (UniqueMachineTokenSpec) DeepCopy ¶ added in v1.6.0
func (o UniqueMachineTokenSpec) DeepCopy() UniqueMachineTokenSpec
DeepCopy generates a deep copy of UniqueMachineTokenSpec.
type UnmetCondition ¶
type UnmetCondition struct { Name string `yaml:"name" protobuf:"1"` Reason string `yaml:"reason" protobuf:"2"` }
UnmetCondition is a failure which prevents machine from being ready at the stage.
type WatchdogTimerConfig ¶ added in v1.7.0
type WatchdogTimerConfig = typed.Resource[WatchdogTimerConfigSpec, WatchdogTimerConfigExtension]
WatchdogTimerConfig resource holds configuration for watchdog timer.
func NewWatchdogTimerConfig ¶ added in v1.7.0
func NewWatchdogTimerConfig() *WatchdogTimerConfig
NewWatchdogTimerConfig initializes a WatchdogTimerConfig resource.
type WatchdogTimerConfigExtension ¶ added in v1.7.0
type WatchdogTimerConfigExtension struct{}
WatchdogTimerConfigExtension is auxiliary resource data for WatchdogTimerConfig.
func (WatchdogTimerConfigExtension) ResourceDefinition ¶ added in v1.7.0
func (WatchdogTimerConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type WatchdogTimerConfigSpec ¶ added in v1.7.0
type WatchdogTimerConfigSpec struct { Device string `yaml:"device" protobuf:"1"` Timeout time.Duration `yaml:"timeout" protobuf:"2"` }
WatchdogTimerConfigSpec describes configuration of watchdog timer.
func (WatchdogTimerConfigSpec) DeepCopy ¶ added in v1.7.0
func (o WatchdogTimerConfigSpec) DeepCopy() WatchdogTimerConfigSpec
DeepCopy generates a deep copy of WatchdogTimerConfigSpec.
type WatchdogTimerStatus ¶ added in v1.7.0
type WatchdogTimerStatus = typed.Resource[WatchdogTimerStatusSpec, WatchdogTimerStatusExtension]
WatchdogTimerStatus resource holds status of watchdog timer.
func NewWatchdogTimerStatus ¶ added in v1.7.0
func NewWatchdogTimerStatus(id string) *WatchdogTimerStatus
NewWatchdogTimerStatus initializes a WatchdogTimerStatus resource.
type WatchdogTimerStatusExtension ¶ added in v1.7.0
type WatchdogTimerStatusExtension struct{}
WatchdogTimerStatusExtension is auxiliary resource data for WatchdogTimerStatus.
func (WatchdogTimerStatusExtension) ResourceDefinition ¶ added in v1.7.0
func (WatchdogTimerStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
ResourceDefinition implements meta.ResourceDefinitionProvider interface.
type WatchdogTimerStatusSpec ¶ added in v1.7.0
type WatchdogTimerStatusSpec struct { Device string `yaml:"device" protobuf:"1"` Timeout time.Duration `yaml:"timeout" protobuf:"2"` FeedInterval time.Duration `yaml:"feedInterval" protobuf:"3"` }
WatchdogTimerStatusSpec describes configuration of watchdog timer.
func (WatchdogTimerStatusSpec) DeepCopy ¶ added in v1.7.0
func (o WatchdogTimerStatusSpec) DeepCopy() WatchdogTimerStatusSpec
DeepCopy generates a deep copy of WatchdogTimerStatusSpec.
Source Files ¶
- condition.go
- deep_copy.generated.go
- devices_status.go
- diagnostic.go
- event_sink_config.go
- extension_services_config.go
- extension_services_config_status.go
- extension_status.go
- kernel_module_spec.go
- kernel_params_spec.go
- kernel_params_status.go
- kmsg_log_config.go
- machine_reset_signal.go
- machine_status.go
- machinestage.go
- machinestage_enumer.go
- maintenance_config.go
- maintenance_request.go
- meta_key.go
- meta_loaded.go
- mount_status.go
- platform_metadata.go
- runtime.go
- security_status.go
- unique_machine_token.go
- watchdog_timer_config.go
- watchdog_timer_status.go