runtime

Documentation

Overview

Package runtime provides runtime machine configuration documents.

Index

• Constants
• func GetFileDoc() *encoder.FileDoc
• type EventSinkV1Alpha1
  • func NewEventSinkV1Alpha1() *EventSinkV1Alpha1
  • func (s *EventSinkV1Alpha1) Clone() config.Document
  • func (o *EventSinkV1Alpha1) DeepCopy() *EventSinkV1Alpha1
  • func (EventSinkV1Alpha1) Doc() *encoder.Doc
  • func (s *EventSinkV1Alpha1) EventsEndpoint() *string
  • func (s *EventSinkV1Alpha1) KmsgLogURLs() []*url.URL
  • func (s *EventSinkV1Alpha1) Runtime() config.RuntimeConfig
  • func (s *EventSinkV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)
• type KmsgLogV1Alpha1
  • func NewKmsgLogV1Alpha1() *KmsgLogV1Alpha1
  • func (s *KmsgLogV1Alpha1) Clone() config.Document
  • func (o *KmsgLogV1Alpha1) DeepCopy() *KmsgLogV1Alpha1
  • func (KmsgLogV1Alpha1) Doc() *encoder.Doc
  • func (s *KmsgLogV1Alpha1) EventsEndpoint() *string
  • func (s *KmsgLogV1Alpha1) KmsgLogURLs() []*url.URL
  • func (s *KmsgLogV1Alpha1) Name() string
  • func (s *KmsgLogV1Alpha1) Runtime() config.RuntimeConfig
  • func (s *KmsgLogV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)

Constants

const EventSinkKind = "EventSinkConfig"

EventSinkKind is a event sink config document kind.

const KmsgLogKind = "KmsgLogConfig"

KmsgLogKind is a kmsg log config document kind.

Functions

func GetFileDoc

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

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.

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

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.