client

README

EdgeX Foundry Export Client Service

Export Client Registration micro service - allows clients to register for data from EdgeX (via MQTT, REST, Azure IoT Hub, Google IoT Core, and other connectors today) and specify compression, encryption, format (JSON, XML), and destination of data. Export Client dictates how and where Export Distro sends EdgeX data.

Install and Deploy Native

Prerequisites

Serveral EdgeX Foundry services depend on ZeroMQ for communications by default. The easiest way to get and install ZeroMQ is to use or follow the following setup script: https://gist.github.com/katopz/8b766a5cb0ca96c816658e9407e83d00.

Note: Setup of the ZeroMQ library is not supported on Windows plaforms.

Installation and Execution

To fetch the code and build the microservice execute the following:

cd $GOPATH/src
go get github.com/edgexfoundry/edgex-go
cd $GOPATH/src/github.com/edgexfoundry/edgex-go
# pull the 3rd party / vendor packages
make prepare
# build the microservice
make cmd/export-client/export-client
# get to the export client microservice executable
cd cmd/export-client
# run the microservice (may require other dependent services to run correctly)
./export-client

Install and Deploy via Docker Container

This project has facilities to create and run Docker containers. A Dockerfile is included in the repo. Make sure you have already run make prepare to update the dependecies. To do a Docker build using the included Docker file, run the following:

Prerequisites

See https://docs.docker.com/install/ to learn how to obtain and install Docker.

Installation and Execution

cd $GOPATH/src
go get github.com/edgexfoundry/edgex-go
cd $GOPATH/src/github.com/edgexfoundry/edgex-go
# To create the Docker image
sudo make docker_export_client
# To create a containter from the image
sudo docker create --name "[DOCKER_CONTAINER_NAME]" --network "[DOCKER_NETWORK]" [DOCKER_IMAGE_NAME]
# To run the container
sudo docker start [DOCKER_CONTAINER_NAME]

Note - creating and running the container above requires Docker network setup, may require dependent containers to be setup on that network, and appropriate port access configuration (among other start up parameters). For this reason, EdgeX recommends use of Docker Compose for pulling, building, and running containers. See The Getting Started Guides for more detail.

Community

• Chat: https://edgexfoundry.slack.com
• Mainling lists: https://lists.edgexfoundry.org/mailman/listinfo

License

Apache-2.0

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. ******************************************************************************

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

• Copyright 2018
• Dell Inc.
• Cavium *
• 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

• Variables
• func Destruct()
• func Init(useRegistry bool) bool
• func Retry(useRegistry bool, useProfile string, timeout int, wait *sync.WaitGroup, ...)
• func StartHTTPServer(errChan chan error)
• type ConfigurationStruct
• type MemDB
  • func (mc *MemDB) AddRegistration(reg contract.Registration) (string, error)
  • func (m *MemDB) CloseSession()
  • func (m *MemDB) Connect() error
  • func (mc *MemDB) DeleteRegistrationById(id string) error
  • func (mc *MemDB) DeleteRegistrationByName(name string) error
  • func (mc *MemDB) RegistrationById(id string) (contract.Registration, error)
  • func (mc *MemDB) RegistrationByName(name string) (contract.Registration, error)
  • func (mc *MemDB) Registrations() ([]contract.Registration, error)
  • func (mc *MemDB) ScrubAllRegistrations() error
  • func (mc *MemDB) UpdateRegistration(reg contract.Registration) error
• type WritableInfo

Variables

var LoggingClient logger.LoggingClient

Functions

func Destruct

func Destruct()

func Init

func Init(useRegistry bool) bool

func Retry

func Retry(useRegistry bool, useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)

func StartHTTPServer

func StartHTTPServer(errChan chan error)

Types

type ConfigurationStruct

type ConfigurationStruct struct {
	Writable  WritableInfo
	Clients   map[string]config.ClientInfo
	Databases map[string]config.DatabaseInfo
	Logging   config.LoggingInfo
	Registry  config.RegistryInfo
	Service   config.ServiceInfo
}

var Configuration *ConfigurationStruct

type MemDB

type MemDB struct {
	// contains filtered or unexported fields
}

func (*MemDB) AddRegistration

func (mc *MemDB) AddRegistration(reg contract.Registration) (string, error)

func (*MemDB) CloseSession

func (m *MemDB) CloseSession()

func (*MemDB) Connect

func (m *MemDB) Connect() error

func (*MemDB) DeleteRegistrationById

func (mc *MemDB) DeleteRegistrationById(id string) error

func (*MemDB) DeleteRegistrationByName

func (mc *MemDB) DeleteRegistrationByName(name string) error

func (*MemDB) RegistrationById

func (mc *MemDB) RegistrationById(id string) (contract.Registration, error)

func (*MemDB) RegistrationByName

func (mc *MemDB) RegistrationByName(name string) (contract.Registration, error)

func (*MemDB) Registrations

func (mc *MemDB) Registrations() ([]contract.Registration, error)

func (*MemDB) ScrubAllRegistrations

func (mc *MemDB) ScrubAllRegistrations() error

func (*MemDB) UpdateRegistration

func (mc *MemDB) UpdateRegistration(reg contract.Registration) error

type WritableInfo

type WritableInfo struct {
	LogLevel string
}