config

Documentation

Index

• type Child
• type Node
• type OAuth2
• type Root
• type TLS

Types

type Child

type Child struct {
	Name   string       `json:"name,omitempty"`
	Traits []trait.Name `json:"traits,omitempty"`
}

type Node

type Node struct {
	Host string `json:"host,omitempty"` // for accepted values see grpc.Dial

	// TLS allows us to override the default enrollment managed TLS configuration.
	TLS TLS `json:"tls,omitempty"`

	// Name is the Smart Core name for the remote node.
	// Used when discovering traits.
	// If absent then the remote node should support empty/default names for Parent requests.
	Name string `json:"name,omitempty"`

	// Children is a list of children that should be announced by the proxy server.
	// If empty then all devices on the proxy host will be available (provided the user has authorization)
	Children []Child `json:"children,omitempty"`

	// SkipChild skips associating the node and node children with this nodes parent trait.
	// When true this doesn't stop clients of this node from communicating with the child, but it does stop discovery of
	// this name from working.
	SkipChild bool `json:"skipChild,omitempty"`

	OAuth2 *OAuth2 `json:"oauth2,omitempty"`
}

Node is a networked Smart Core node, identified by its host.

type OAuth2

type OAuth2 struct {
	TokenEndpoint    string `json:"tokenEndpoint"`    // HTTP(S) URL of the OAuth 2 token endpoint
	ClientID         string `json:"clientId"`         // OAuth 2 client ID to authenticate with
	ClientSecretFile string `json:"clientSecretFile"` // Path to a file containing the OAuth 2 client secret
}

type Root

type Root struct {
	driver.BaseConfig

	// Nodes represent Smart Core nodes that this controller is proxying.
	Nodes []Node `json:"nodes"`
}

Root describes the configuration available to the proxy driver.

type TLS

type TLS struct {
	// These override the default enrollment PKI and are useful for testing and if running without a management node.
	InsecureNoClientCert bool `json:"insecureNoClientCert,omitempty"` // don't present a client certificate when connecting to proxy servers
	InsecureSkipVerify   bool `json:"insecureSkipVerify,omitempty"`   // don't verify proxy server certificates
}