metadata

README

EdgeX Foundry Core Metadata Service

Metadata retains and provides access to the knowledge about the devices and sensors connected to EdgeX and how to communicate with them. More specifically,it manages information about the devices and sensors connected to, and operated by, EdgeX Foundry, knows the type, and organization of data reported by the devices and sensors, and it knows how to command the devices and sensors. This service may also hold and manage other configuration metadata used by other services on the gateway – such as clean up schedules, hardware configuration (Wi-Fi connection info, MQTT queues, etc.). Non-device metadata may need to be held in a different database and/or managed by another service – depending on implementation.

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 core-metadata
# get to the core metadata microservice executable
cd cmd/core-metadata
# run the microservice (may require other dependent services to run correctly)
./core-metadata

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_core_metadata
# 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 2017 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 2017 Dell Inc.
• Copyright (c) 2019 Intel Corporation *
• 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 LoadRestRoutes(r *mux.Router, dic *di.Container)
• func Main(ctx context.Context, cancel context.CancelFunc, router *mux.Router)
• type Bootstrap
  • func NewBootstrap(router *mux.Router) *Bootstrap
  • func (b *Bootstrap) BootstrapHandler(ctx context.Context, wg *sync.WaitGroup, _ startup.Timer, dic *di.Container) bool

Constants

const (
	/* ---------------- URL PARAM NAMES -----------------------*/
	ID                  = "id"
	NAME                = "name"
	OPSTATE             = "opstate"
	URLADMINSTATE       = "adminstate"
	ADMINSTATE          = "adminState"
	URLLASTREPORTED     = "lastreported"
	LASTREPORTED        = "lastReported"
	LASTREPORTEDNOTIFY  = "lastreportednotify"
	URLLASTCONNECTED    = "lastconnected"
	LASTCONNECTED       = "lastConnected"
	LASTCONNECTEDNOTIFY = "lastconnectednotify"
	ADDRESSABLE         = "addressable"
	ADDRESSABLENAME     = "addressablename"
	ADDRESSABLEID       = "addressableid"
	CHECK               = "check"
	SERVICE             = "service"
	SERVICENAME         = "servicename"
	SERVICEID           = "serviceid"
	LABEL               = "label"
	PROFILE             = "profile"
	PROFILEID           = "profileid"
	PROFILENAME         = "profilename"
	DEVICEPROFILE       = "deviceprofile"
	UPLOADFILE          = "uploadfile"
	UPLOAD              = "upload"
	MODEL               = "model"
	MANUFACTURER        = "manufacturer"
	YAML                = "yaml"
	DEVICEREPORT        = "devicereport"
	DEVICENAME          = "devicename"
	DEVICESERVICE       = "deviceservice"
	TOPIC               = "topic"
	PORT                = "port"
	PUBLISHER           = "publisher"
	ADDRESS             = "address"
	COMMAND             = "command"
	DEVICE              = "device"
	PROVISIONWATCHER    = "provisionwatcher"
	IDENTIFIER          = "identifier"
	KEY                 = "key"
	VALUE               = "value"
	VALUEDESCRIPTORSFOR = "valueDescriptorsFor"
	UNLOCKED            = "UNLOCKED"
	ENABLED             = "ENABLED"
)

Functions

func LoadRestRoutes

func LoadRestRoutes(r *mux.Router, dic *di.Container)

func Main

func Main(ctx context.Context, cancel context.CancelFunc, router *mux.Router)

Types

type Bootstrap

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

Bootstrap contains references to dependencies required by the BootstrapHandler.

func NewBootstrap

func NewBootstrap(router *mux.Router) *Bootstrap

NewBootstrap is a factory method that returns an initialized Bootstrap receiver struct.

func (*Bootstrap) BootstrapHandler

func (b *Bootstrap) BootstrapHandler(ctx context.Context, wg *sync.WaitGroup, _ startup.Timer, dic *di.Container) bool

BootstrapHandler fulfills the BootstrapHandler contract and performs initialization needed by the metadata service.