pkg

Documentation

Overview

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

• Copyright 2019 VMWare 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. * ******************************************************************************

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

• Copyright 2019 VMWare 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
• Variables
• func DefineConfigFileLocation() string
• func GetSession(config *Configuration) (*mgo.Session, error)
• type Configuration
  • func (c *Configuration) UpdateCredentials(databases map[string]DatabaseInfo)
• type DatabaseInfo
• type MongoInfo
• type SecretStoreInfo
  • func (s SecretStoreInfo) GetSecretStoreBaseURL() string
• type ServiceInfo
• type WritableInfo

Constants

const Confdir = "res"

const ConfigFileName = "configuration.toml"

const EdgexMongoServiceKey = "edgex-mongo"

TODO should be defined in go-mod-core-contracts/clients/constants.go

const SecretStore string = "EDGEX_SECURITY_SECRET_STORE"

const VaultToken = "X-Vault-Token"

Variables

var LoggingClient logger.LoggingClient

Functions

func DefineConfigFileLocation

func DefineConfigFileLocation() string

func GetSession

func GetSession(config *Configuration) (*mgo.Session, error)

Types

type Configuration

type Configuration struct {
	Service   ServiceInfo
	Writable  WritableInfo
	Mongo     MongoInfo
	Databases map[string]DatabaseInfo
}

func (*Configuration) UpdateCredentials

func (c *Configuration) UpdateCredentials(databases map[string]DatabaseInfo)

type DatabaseInfo

type DatabaseInfo struct {
	Username string
	Password string
}

type MongoInfo

type MongoInfo struct {
	Host    string
	Port    int
	Timeout int
}

type SecretStoreInfo

type SecretStoreInfo struct {
	Server     string
	Port       int
	TokenPath  string
	CACertPath string
	Path       string
	// SNI - Server Name Identifier
	SNI                     string
	AdditionalRetryAttempts int
	RetryWaitPeriod         string
}

func (SecretStoreInfo) GetSecretStoreBaseURL

func (s SecretStoreInfo) GetSecretStoreBaseURL() string

type ServiceInfo

type ServiceInfo struct {
	// BootTimeout indicates, in milliseconds, how long the service will retry connecting to mongo database
	// before giving up. Default is 30,000.
	BootTimeout int
}

type WritableInfo

type WritableInfo struct {
	LogLevel       string
	RequestTimeout int
}