platform

package

v1.7.1 Latest Latest Go to latest Published: May 1, 2024 License: MPL-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/siderolabs/talos

Links

Open Source Insights

Documentation ¶

Overview ¶

Package platform provides functions to get the runtime.Platform.

Index ¶

Constants
func CurrentPlatform() (p runtime.Platform, err error)
func FireEvent(ctx context.Context, p runtime.Platform, e Event)
func NewPlatform(platform string) (p runtime.Platform, err error)
type Event

Constants ¶

View Source

const (
	// EventTypeActivate is the activate event string.
	EventTypeActivate = "activate"
	// EventTypeFailure is the failure event string.
	EventTypeFailure = "failure"
	// EventTypeInfo is the info event string.
	EventTypeInfo = "info"
	// EventTypeConfigLoaded is the config loaded event string.
	EventTypeConfigLoaded = "talos.prov.config.loaded"
	// EventTypeRebooted is the reboot event string.
	EventTypeRebooted = "talos.prov.host.rebooted"
	// EventTypeInstalled is the installation event string.
	EventTypeInstalled = "talos.prov.os.installed"
	// EventTypeUpgraded is the upgrade event string.
	EventTypeUpgraded = "talos.prov.os.upgraded"
)

nb: these events currently map to those expected by equinix metal. if/when we do other platforms, we should maybe generalize this and map the events inside each platform.

Variables ¶

This section is empty.

Functions ¶

func CurrentPlatform ¶

func CurrentPlatform() (p runtime.Platform, err error)

CurrentPlatform is a helper func for discovering the current platform.

func FireEvent ¶

func FireEvent(ctx context.Context, p runtime.Platform, e Event)

FireEvent will call the implemented platform's event function if we know it has one. Error logging is handled in this function and we don't return any error values to the sequencer.

func NewPlatform ¶

func NewPlatform(platform string) (p runtime.Platform, err error)

NewPlatform initializes and returns a runtime.Platform.

Types ¶

type Event ¶

type Event struct {
	Type    string
	Message string
	Error   error
}

Event is a struct used below in FireEvent in hopes that we can reuse some of this eventing in other platforms if possible.

Source Files ¶

View all Source files

platform.go

Directories ¶

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

Path	Synopsis
akamai Package akamai contains the Akamai implementation of the [platform.Platform].	Package akamai contains the Akamai implementation of the [platform.Platform].
aws Package aws contains the AWS implementation of the [platform.Platform].	Package aws contains the AWS implementation of the [platform.Platform].
azure Package azure contains the Azure implementation of the [platform.Platform].	Package azure contains the Azure implementation of the [platform.Platform].
container Package container contains the Container implementation of the [platform.Platform].	Package container contains the Container implementation of the [platform.Platform].
internal/files Package files provides internal methods to container platform to read files.	Package files provides internal methods to container platform to read files.
digitalocean Package digitalocean contains the Digital Ocean implementation of the [platform.Platform].	Package digitalocean contains the Digital Ocean implementation of the [platform.Platform].
equinixmetal Package equinixmetal contains the Equinix Metal implementation of the [platform.Platform].	Package equinixmetal contains the Equinix Metal implementation of the [platform.Platform].
errors Package errors contains errors used by the platform package.	Package errors contains errors used by the platform package.
exoscale Package exoscale contains the Exoscale platform implementation.	Package exoscale contains the Exoscale platform implementation.
gcp Package gcp contains the GCP implementation of the [platform.Platform].	Package gcp contains the GCP implementation of the [platform.Platform].
hcloud Package hcloud contains the Hcloud implementation of the [platform.Platform].	Package hcloud contains the Hcloud implementation of the [platform.Platform].
internal
address Package address provides utility functions for address parsing.	Package address provides utility functions for address parsing.
netutils Package netutils provides network-related helpers for platform implementation.	Package netutils provides network-related helpers for platform implementation.
metal Package metal contains the metal implementation of the [platform.Platform].	Package metal contains the metal implementation of the [platform.Platform].
oauth2 Package oauth2 implements OAuth2 Device Flow to authenticate machine config download.	Package oauth2 implements OAuth2 Device Flow to authenticate machine config download.
url Package url handles expansion of the download URL for the config.	Package url handles expansion of the download URL for the config.
nocloud Package nocloud provides the NoCloud platform implementation.	Package nocloud provides the NoCloud platform implementation.
opennebula Package opennebula provides the OpenNebula platform implementation.	Package opennebula provides the OpenNebula platform implementation.
openstack Package openstack provides the Openstack platform implementation.	Package openstack provides the Openstack platform implementation.
oracle Package oracle provides the Oracle platform implementation.	Package oracle provides the Oracle platform implementation.
scaleway Package scaleway provides the Scaleway platform implementation.	Package scaleway provides the Scaleway platform implementation.
upcloud Package upcloud provides the UpCloud platform implementation.	Package upcloud provides the UpCloud platform implementation.
vmware Package vmware provides the VMware platform implementation.	Package vmware provides the VMware platform implementation.
vultr Package vultr provides the Vultr platform implementation.	Package vultr provides the Vultr platform implementation.