common

Documentation

Index

• Constants
• type BindingInfo
• type ClientInfo
  • func (c ClientInfo) Url() string
• type ConfigurationStruct
  • func LoadFromFile(profile string, configDir string) (configuration *ConfigurationStruct, err error)
• type Credentials
• type EdgeXClients
• type InsecureSecrets
• type InsecureSecretsInfo
• type LoggingInfo
• type PipelineFunction
• type PipelineInfo
• type RegistryInfo
• type SecretStoreInfo
• type ServiceInfo
• type StoreAndForwardInfo
• type WritableInfo

Constants

const (
	LoggingClientName       = "Logging"
	CoreCommandClientName   = "Command"
	CoreDataClientName      = "CoreData"
	NotificationsClientName = "Notifications"
	MetadataClientName      = "Metadata"
	SchedulerClientName     = "Scheduler"
	AgentClientName         = "Agent"
)

Types

type BindingInfo

type BindingInfo struct {
	// Type of trigger to start pipeline
	//
	// example: messagebus
	// required: true
	// enum: messagebus,http
	Type           string
	SubscribeTopic string
	PublishTopic   string
}

BindingInfo contains Metadata associated with each binding

type ClientInfo

type ClientInfo struct {
	// Host is the hostname or IP address of a service.
	Host string
	// Port defines the port on which to access a given service
	Port int
	// Protocol indicates the protocol to use when accessing a given service
	Protocol string
}

ClientInfo provides the host and port of another service in the eco-system.

func (ClientInfo) Url

func (c ClientInfo) Url() string

type ConfigurationStruct

type ConfigurationStruct struct {
	// Writable
	Writable WritableInfo
	// Logging
	Logging LoggingInfo
	// Registry
	Registry RegistryInfo
	// Service
	Service ServiceInfo
	// MessageBus
	MessageBus types.MessageBusConfig
	// Binding
	Binding BindingInfo
	// ApplicationSettings
	ApplicationSettings map[string]string
	// Clients
	Clients map[string]ClientInfo
	// Database
	Database db.DatabaseInfo
	// SecretStore
	SecretStore SecretStoreInfo
}

ConfigurationStruct swagger:model ConfigurationStruct

func LoadFromFile

func LoadFromFile(profile string, configDir string) (configuration *ConfigurationStruct, err error)

LoadFromFile loads .toml file for configuration

type Credentials

type Credentials struct {
	Username string
	Password string
}

Credentials encapsulates username-password attributes.

type EdgeXClients

type EdgeXClients struct {
	LoggingClient          logger.LoggingClient
	EventClient            coredata.EventClient
	ReadingClient          coredata.ReadingClient
	CommandClient          command.CommandClient
	ValueDescriptorClient  coredata.ValueDescriptorClient
	NotificationsClient    notifications.NotificationsClient
	AddressableClient      metadata.AddressableClient
	DeviceClient           metadata.DeviceClient
	ProvisionWatcherClient metadata.ProvisionWatcherClient
	IntervalClient         scheduler.IntervalClient
	IntervalActionClient   scheduler.IntervalActionClient
	AgentClient            agent.AgentClient
}

type InsecureSecrets

type InsecureSecrets map[string]InsecureSecretsInfo

InsecureSecrets is used to hold the secrets stored in the configuration

type InsecureSecretsInfo

type InsecureSecretsInfo struct {
	Path    string
	Secrets map[string]string
}

InsecureSecretsInfo encapsulates info used to retrieve insecure secrets

type LoggingInfo

type LoggingInfo struct {
	EnableRemote bool
	File         string
}

LoggingInfo is used to indicate whether remote logging should be used or not. If not, File designates the location of the log file to output logs to

type PipelineFunction

type PipelineFunction struct {
	// Name	string
	Parameters  map[string]string
	Addressable models.Addressable
}

type PipelineInfo

type PipelineInfo struct {
	ExecutionOrder           string
	UseTargetTypeOfByteArray bool
	Functions                map[string]PipelineFunction
}

type RegistryInfo

type RegistryInfo struct {
	Host string
	Port int
	Type string
}

RegistryInfo is used for defining settings for connection to the registry.

type SecretStoreInfo

type SecretStoreInfo struct {
	vault.SecretConfig
	// TokenFile provides a location to a token file.
	TokenFile string
}

SecretStoreInfo encapsulates configuration properties used to create a SecretClient.

type ServiceInfo

type ServiceInfo struct {
	BootTimeout   string
	CheckInterval string
	ClientMonitor string
	Host          string
	HTTPSCert     string
	HTTPSKey      string
	Port          int
	Protocol      string
	StartupMsg    string
	ReadMaxLimit  int
	Timeout       string
}

ServiceInfo is used to hold and configure various settings related to the hosting of this service

type StoreAndForwardInfo

type StoreAndForwardInfo struct {
	Enabled       bool
	RetryInterval string
	MaxRetryCount int
}

type WritableInfo

type WritableInfo struct {
	// Set level of logging to report
	//
	// example: TRACE
	// required: true
	// enum: TRACE,DEBUG,INFO,WARN,ERROR
	LogLevel        string
	Pipeline        PipelineInfo
	StoreAndForward StoreAndForwardInfo
	InsecureSecrets InsecureSecrets
}

WritableInfo is used to hold configuration information that is considered "live" or can be changed on the fly without a restart of the service.