siderolink

Documentation

Overview

Package siderolink provides SideroLink machine configuration documents.

Index

• Constants
• func GetFileDoc() *encoder.FileDoc
• type ConfigV1Alpha1
  • func NewConfigV1Alpha1() *ConfigV1Alpha1
  • func (s *ConfigV1Alpha1) APIUrl() *url.URL
  • func (s *ConfigV1Alpha1) Clone() config.Document
  • func (o *ConfigV1Alpha1) DeepCopy() *ConfigV1Alpha1
  • func (ConfigV1Alpha1) Doc() *encoder.Doc
  • func (s *ConfigV1Alpha1) Redact(replacement string)
  • func (s *ConfigV1Alpha1) SideroLink() config.SideroLinkConfig
  • func (s *ConfigV1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]string, error)

Constants

const Kind = "SideroLinkConfig"

Kind is a siderolink config document kind.

Functions

func GetFileDoc

func GetFileDoc() *encoder.FileDoc

GetFileDoc returns documentation for the file ./siderolink_doc.go.

Types

type ConfigV1Alpha1

type ConfigV1Alpha1 struct {
	meta.Meta `yaml:",inline"`
	//   description: |
	//     SideroLink API URL to connect to.
	//   examples:
	//     - value: >
	//        "https://siderolink.api/join?token=secret"
	//   schema:
	//     type: string
	//     pattern: "^(https|grpc)://"
	APIUrlConfig meta.URL `yaml:"apiUrl"`
}

ConfigV1Alpha1 is a SideroLink connection machine configuration document.

examples:
  - value: exampleConfigV1Alpha1()
alias: SideroLinkConfig
schemaRoot: true
schemaMeta: v1alpha1/SideroLinkConfig

func NewConfigV1Alpha1

func NewConfigV1Alpha1() *ConfigV1Alpha1

NewConfigV1Alpha1 creates a new siderolink config document.

func (*ConfigV1Alpha1) APIUrl

func (s *ConfigV1Alpha1) APIUrl() *url.URL

APIUrl implements config.SideroLink interface.

func (*ConfigV1Alpha1) Clone

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

Clone implements config.Document interface.

func (*ConfigV1Alpha1) DeepCopy

func (o *ConfigV1Alpha1) DeepCopy() *ConfigV1Alpha1

DeepCopy generates a deep copy of *ConfigV1Alpha1.

func (ConfigV1Alpha1) Doc

func (ConfigV1Alpha1) Doc() *encoder.Doc

func (*ConfigV1Alpha1) Redact

func (s *ConfigV1Alpha1) Redact(replacement string)

Redact implements config.SecretDocument interface.

func (*ConfigV1Alpha1) SideroLink

func (s *ConfigV1Alpha1) SideroLink() config.SideroLinkConfig

SideroLink implements config.SideroLink interface.

func (*ConfigV1Alpha1) Validate

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

Validate implements config.Validator interface.