runtime

package
v1.8.2 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package runtime provides runtime machine configuration documents.

Index

Constants

View Source 
const (
	MinWatchdogTimeout     = 10 * time.Second
	DefaultWatchdogTimeout = time.Minute
)

Timeout constants.

View Source 
const EventSinkKind = "EventSinkConfig"

EventSinkKind is a event sink config document kind.

View Source 
const KmsgLogKind = "KmsgLogConfig"

KmsgLogKind is a kmsg log config document kind.

View Source 
const WatchdogTimerKind = "WatchdogTimerConfig"

WatchdogTimerKind is a watchdog timer config document kind.

Variables

This section is empty.

Functions

func GetFileDoc added in v1.6.0 

func GetFileDoc() *encoder.FileDoc

GetFileDoc returns documentation for the file runtime_doc.go.

Types

type EventSinkV1Alpha1 

type EventSinkV1Alpha1 struct {
	meta.Meta `yaml:",inline"`
	//   description: |
	//     The endpoint for the event sink as 'host:port'.
	//   examples:
	//     - value: >
	//        "10.3.7.3:2810"
	Endpoint string `yaml:"endpoint"`
}

EventSinkV1Alpha1 is a event sink config document. 

examples:
  - value: exampleEventSinkV1Alpha1()
alias: EventSinkConfig
schemaRoot: true
schemaMeta: v1alpha1/EventSinkConfig

func NewEventSinkV1Alpha1 

func NewEventSinkV1Alpha1() *EventSinkV1Alpha1

NewEventSinkV1Alpha1 creates a new eventsink config document.

func (*EventSinkV1Alpha1) Clone 

func (s *EventSinkV1Alpha1) Clone() config.Document

Clone implements config.Document interface.

func (*EventSinkV1Alpha1) DeepCopy 

func (o *EventSinkV1Alpha1) DeepCopy() *EventSinkV1Alpha1

DeepCopy generates a deep copy of *EventSinkV1Alpha1.

func (EventSinkV1Alpha1) Doc added in v1.6.0 

func (EventSinkV1Alpha1) Doc() *encoder.Doc

func (*EventSinkV1Alpha1) EventsEndpoint 

func (s *EventSinkV1Alpha1) EventsEndpoint() *string

EventsEndpoint implements config.RuntimeConfig interface.

func (*EventSinkV1Alpha1) KmsgLogURLs 

func (s *EventSinkV1Alpha1) KmsgLogURLs() []*url.URL

KmsgLogURLs implements config.RuntimeConfig interface.

func (*EventSinkV1Alpha1) Runtime 

func (s *EventSinkV1Alpha1) Runtime() config.RuntimeConfig

Runtime implements config.Config interface.

func (*EventSinkV1Alpha1) Validate 

func (s *EventSinkV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)

Validate implements config.Validator interface.

func (*EventSinkV1Alpha1) WatchdogTimer added in v1.7.0 

func (s *EventSinkV1Alpha1) WatchdogTimer() config.WatchdogTimerConfig

WatchdogTimer implements config.RuntimeConfig interface.

type KmsgLogV1Alpha1 

type KmsgLogV1Alpha1 struct {
	meta.Meta `yaml:",inline"`
	//   description: |
	//     Name of the config document.
	MetaName string `yaml:"name"`
	//   description: |
	//     The URL encodes the log destination.
	//     The scheme must be tcp:// or udp://.
	//     The path must be empty.
	//     The port is required.
	//   examples:
	//     - value: >
	//        "udp://10.3.7.3:2810"
	//   schema:
	//     type: string
	//     pattern: "^(tcp|udp)://"
	KmsgLogURL meta.URL `yaml:"url"`
}

KmsgLogV1Alpha1 is a event sink config document. 

examples:
  - value: exampleKmsgLogV1Alpha1()
alias: KmsgLogConfig
schemaRoot: true
schemaMeta: v1alpha1/KmsgLogConfig

func NewKmsgLogV1Alpha1 

func NewKmsgLogV1Alpha1() *KmsgLogV1Alpha1

NewKmsgLogV1Alpha1 creates a new eventsink config document.

func (*KmsgLogV1Alpha1) Clone 

func (s *KmsgLogV1Alpha1) Clone() config.Document

Clone implements config.Document interface.

func (*KmsgLogV1Alpha1) DeepCopy 

func (o *KmsgLogV1Alpha1) DeepCopy() *KmsgLogV1Alpha1

DeepCopy generates a deep copy of *KmsgLogV1Alpha1.

func (KmsgLogV1Alpha1) Doc added in v1.6.0 

func (KmsgLogV1Alpha1) Doc() *encoder.Doc

func (*KmsgLogV1Alpha1) EventsEndpoint 

func (s *KmsgLogV1Alpha1) EventsEndpoint() *string

EventsEndpoint implements config.RuntimeConfig interface.

func (*KmsgLogV1Alpha1) KmsgLogURLs 

func (s *KmsgLogV1Alpha1) KmsgLogURLs() []*url.URL

KmsgLogURLs implements config.RuntimeConfig interface.

func (*KmsgLogV1Alpha1) Name 

func (s *KmsgLogV1Alpha1) Name() string

Name implements config.NamedDocument interface.

func (*KmsgLogV1Alpha1) Runtime 

func (s *KmsgLogV1Alpha1) Runtime() config.RuntimeConfig

Runtime implements config.Config interface.

func (*KmsgLogV1Alpha1) Validate 

func (s *KmsgLogV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)

Validate implements config.Validator interface.

func (*KmsgLogV1Alpha1) WatchdogTimer added in v1.7.0 

func (s *KmsgLogV1Alpha1) WatchdogTimer() config.WatchdogTimerConfig

WatchdogTimer implements config.RuntimeConfig interface.

type WatchdogTimerV1Alpha1 added in v1.7.0 

type WatchdogTimerV1Alpha1 struct {
	meta.Meta `yaml:",inline"`
	//   description: |
	//     Path to the watchdog device.
	//   examples:
	//     - value: >
	//        "/dev/watchdog0"
	WatchdogDevice string `yaml:"device"`
	//   description: |
	//     Timeout for the watchdog.
	//
	//     If Talos is unresponsive for this duration, the watchdog will reset the system.
	//
	//     Default value is 1 minute, minimum value is 10 seconds.
	//   schema:
	//     type: string
	//     pattern: ^[-+]?(((\d+(\.\d*)?|\d*(\.\d+)+)([nuµm]?s|m|h))|0)+$
	WatchdogTimeout time.Duration `yaml:"timeout,omitempty"`
}

WatchdogTimerV1Alpha1 is a watchdog timer config document. 

examples:
  - value: exampleWatchdogTimerV1Alpha1()
alias: WatchdogTimerConfig
schemaRoot: true
schemaMeta: v1alpha1/WatchdogTimerConfig

func NewWatchdogTimerV1Alpha1 added in v1.7.0 

func NewWatchdogTimerV1Alpha1() *WatchdogTimerV1Alpha1

NewWatchdogTimerV1Alpha1 creates a new eventsink config document.

func (*WatchdogTimerV1Alpha1) Clone added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) Clone() config.Document

Clone implements config.Document interface.

func (*WatchdogTimerV1Alpha1) DeepCopy added in v1.7.0 

func (o *WatchdogTimerV1Alpha1) DeepCopy() *WatchdogTimerV1Alpha1

DeepCopy generates a deep copy of *WatchdogTimerV1Alpha1.

func (*WatchdogTimerV1Alpha1) Device added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) Device() string

Device implements config.WatchdogTimerConfig interface.

func (WatchdogTimerV1Alpha1) Doc added in v1.7.0 

func (WatchdogTimerV1Alpha1) Doc() *encoder.Doc

func (*WatchdogTimerV1Alpha1) EventsEndpoint added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) EventsEndpoint() *string

EventsEndpoint implements config.RuntimeConfig interface.

func (*WatchdogTimerV1Alpha1) KmsgLogURLs added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) KmsgLogURLs() []*url.URL

KmsgLogURLs implements config.RuntimeConfig interface.

func (*WatchdogTimerV1Alpha1) Runtime added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) Runtime() config.RuntimeConfig

Runtime implements config.Config interface.

func (*WatchdogTimerV1Alpha1) Timeout added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) Timeout() time.Duration

Timeout implements config.WatchdogTimerConfig interface.

func (*WatchdogTimerV1Alpha1) Validate added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)

Validate implements config.Validator interface.

func (*WatchdogTimerV1Alpha1) WatchdogTimer added in v1.7.0 

func (s *WatchdogTimerV1Alpha1) WatchdogTimer() config.WatchdogTimerConfig

WatchdogTimer implements config.RuntimeConfig interface.

Source Files

View all Source files

Directories

Path Synopsis
Package extensions provides extensions config documents.
 Package extensions provides extensions config documents.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.