config

Documentation

Overview

******************************************************************************

• Copyright 2018 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

Index

• Constants
• func LoadFromFile(profile string, configuration interface{}) error
• func VerifyTomlFiles(configuration interface{}) error
• type ClientInfo
  • func (c ClientInfo) Url() string
• type DatabaseInfo
• type LoggingInfo
• type MessageQueueInfo
  • func (m MessageQueueInfo) Uri() string
• type NotificationInfo
• type RegistryInfo
• type ScheduleEventInfo
  • func (e ScheduleEventInfo) Url() string
• type ScheduleInfo
• type ServiceInfo
  • func (s ServiceInfo) HealthCheck() string
  • func (s ServiceInfo) Url() string

Constants

const (
	Consul = "consul"
)

Cannot use type string inside structs to be parsed into map[string]interface{} correctly For now using const literals for values

Functions

func LoadFromFile

func LoadFromFile(profile string, configuration interface{}) error

func VerifyTomlFiles

func VerifyTomlFiles(configuration interface{}) error

Types

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 DatabaseInfo

type DatabaseInfo struct {
	Type     string
	Timeout  int
	Host     string
	Port     int
	Username string
	Password string
	Name     string
}

DatabaseInfo defines the parameters necessary for connecting to the desired persistence layer.

type LoggingInfo

type LoggingInfo struct {
	EnableRemote bool
	File         string
	Level        string
}

LoggingInfo provides basic parameters related to where logs should be written.

type MessageQueueInfo

type MessageQueueInfo struct {
	// Host is the hostname or IP address of the broker, if applicable.
	Host string
	// Port defines the port on which to access the message queue.
	Port int
	// Protocol indicates the protocol to use when accessing the message queue.
	Protocol string
	// Indicates the message queue platform being used.
	Type string
}

MessageQueueInfo provides parameters related to connecting to a message queue

func (MessageQueueInfo) Uri

func (m MessageQueueInfo) Uri() string

type NotificationInfo

type NotificationInfo struct {
	Content           string
	Description       string
	Label             string
	PostDeviceChanges bool
	Sender            string
	Slug              string
}

Notification Info provides properties related to the assembly of notification content

type RegistryInfo

type RegistryInfo struct {
	Host string
	Port int
	Type string
}

RegistryInfo defines the type and location (via host/port) of the desired service registry (e.g. Consul, Eureka)

type ScheduleEventInfo

type ScheduleEventInfo 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
	// Event name
	Name string
	// Event http method *const prob*
	Method string
	// Event Service name
	Service string
	// Event parameters
	Parameters string
	// Event API path
	Path string
	// Associated Schedule for the Event
	Schedule string
	// Source of the Scheduler *not sure we need this*
	Scheduler string
}

TODO: We should be pulling the Service Info for Addressable from core-metadata ScheduleEventInfo item to be scheduled

func (ScheduleEventInfo) Url

func (e ScheduleEventInfo) Url() string

ScheduleEventInfo helper function

type ScheduleInfo

type ScheduleInfo struct {
	// Name of the schedule must be unique?
	Name string
	// Start time in ISO 8601 format YYYYMMDD'T'HHmmss
	Start string
	// End time in ISO 8601 format YYYYMMDD'T'HHmmss
	End string
	// Periodicity of the schedule
	Frequency string
	// Cron style regular expression indicating how often the action under schedule should occur.  Use either runOnce, frequency or cron and not all.
	Cron string
	// Boolean indicating that this schedules runs one time - at the time indicated by the start
	RunOnce bool
}

type ServiceInfo

type ServiceInfo struct {
	// BootTimeout indicates, in milliseconds, how long the service will retry connecting to upstream dependencies
	// before giving up. Default is 30,000.
	BootTimeout int
	// Health check interval
	CheckInterval string
	// Indicates the interval in milliseconds at which service clients should check for any configuration updates
	ClientMonitor int
	// Host is the hostname or IP address of the service.
	Host string
	// Port is the HTTP port of the service.
	Port int
	// The protocol that should be used to call this service
	Protocol string
	// StartupMsg specifies a string to log once service
	// initialization and startup is completed.
	StartupMsg string
	// ReadMaxLimit specifies the maximum size list supported
	// in response to REST calls to other services.
	ReadMaxLimit int
	// Timeout specifies a timeout (in milliseconds) for
	// processing REST calls from other services.
	Timeout int
}

ServiceInfo contains configuration settings necessary for the basic operation of any EdgeX service.

func (ServiceInfo) HealthCheck

func (s ServiceInfo) HealthCheck() string

HealthCheck is a URL specifying a healthcheck REST endpoint used by the Registry to determine if the service is available.

func (ServiceInfo) Url

func (s ServiceInfo) Url() string

Url provides a way to obtain the full url of the host service for use in initialization or, in some cases, responses to a caller.