EdgeX Foundry is a vendor-neutral open source project hosted by The Linux Foundation building a common open framework for IoT edge computing. At the heart of the project is an interoperability framework hosted within a full hardware- and OS-agnostic reference software platform to enable an ecosystem of plug-and-play components that unifies the marketplace and accelerates the deployment of IoT solutions. This repository contains the Go implementation of EdgeX Foundry microservices. It also includes files for building the services, containerizing the services, and initializing (bootstrapping) the services.
EdgeX provides docker images in our organization's DockerHub page. They can be launched easily with docker-compose.
The simplest way to get started is to fetch the latest docker-compose.yml and start the EdgeX containers:
wget https://raw.githubusercontent.com/edgexfoundry/developer-scripts/master/compose-files/docker-compose.yml
docker-compose up -d
You can check the status of your running EdgeX services by going to http://localhost:8500/
Now that you have EdgeX up and running, you can follow our API Walkthrough to learn how the different services work together to connect IoT devices to cloud services.
EdgeX Foundry is also available as a snap package, for more details on the snap, including how to install it, please refer to EdgeX snap
The current targeted version of the Go language runtime is v1.11.5
go get github.com/rjeczalik/pkgconfig/cmd/pkg-config
Several EdgeX Foundry services depend on ZeroMQ for communications by default.
The easiest way to get and install ZeroMQ on Linux is to use this setup script.
For macOS, use brew:
brew install zeromq
For directions installing ZeroMQ on Windows, please see the Windows documentation.
The necessary file will need to be added to the PKG_CONFIG_PATH environment variable.
On Linux, add this line to your local profile:
export PKG_CONFIG_PATH=/usr/local/Cellar/zeromq/4.2.5/lib/pkgconfig/For macOS, install the package with brew:
brew install pkg-configTo fetch the code and build the microservices execute the following in a directory of your choosing:
go get github.com/edgexfoundry/edgex-go
# download dependencies and build services
make build
# run the services
make run
If you are still utilizing the GOPATH as your primary working directory, you can do the following:
set GO111MODULE=on
cd $GOPATH/src
go get github.com/edgexfoundry/edgex-go
cd $GOPATH/src/github.com/edgexfoundry/edgex-go
# download dependencies and build services
make build
# run the services
make run
Note You will need to have the database running before you execute make run. If you don't want to install a database locally, you can bring one up via their respective Docker containers.
During development phase, it is important to run compiled binaries (not containers).
There is a script in bin directory that can help you launch the whole EdgeX system:
cd bin
./edgex-launch.sh
More simply, this script is invoked via the make run command referenced above.
This project has facilities to create and run your own Docker containers.
See https://docs.docker.com/install/ to learn how to obtain and install Docker.
Follow the "Installation and Execution" steps above for obtaining and building the code, then proceed as follows:
# To remove any old build artifacts
make clean
# To create the Docker images
sudo make docker
# To run the containers
sudo make run_docker
- Chat: https://edgexfoundry.slack.com
- Mailing lists: https://lists.edgexfoundry.org/mailman/listinfo