It is now part of 👉 nuvlaedge/nuvlaedge 👈.
This repository contains the source code for the NuvlaEdge Compute API - the microservice which is responsible for relaying the host's Docker socket via TCP, making the NuvlaEdge secure and non-disruptive to the hosting device.
This microservice is an integral component of the NuvlaEdge Engine.
NOTE: this microservice is part of a loosely coupled architecture, thus when deployed by itself, it might not provide all of its functionalities. Please refer to https://github.com/nuvlaedge/deployment for a fully functional deployment
This repository is already linked with Travis CI, so with every commit, a new Docker image is released.
There is a POM file which is responsible for handling the multi-architecture and stage-specific builds.
If you're developing and testing locally in your own machine, simply run docker build . or even deploy the microservice via the local compose files to have your changes built into a new Docker image, and saved into your local filesystem.
If you're developing in a non-master branch, please push your changes to the respective branch, and wait for Travis CI to finish the automated build. You'll find your Docker image in the nuvladev organization in Docker hub, names as nuvladev/compute-api:<branch>.
- Docker (version 18 or higher)
- Docker Compose (version 1.23.2 or higher)
| HOSTNAME | the hostname used as CN when generating the TLS credentials for the API |
Simply run docker-compose up --build
This microservice is completely automated, meaning that as long as all the proper environment variables have been correctly set and the right dependencies have been met, the respective Docker container will start by itself, automatically generate TLS credentials (if not present yet) and relay Docker's socket via TCP onto port 5000.
You can check that the API is successfully running by doing: curl -k https://localhost:5000/containers/json -k --cacert ca.pem --cert cert.pem --key key.pem.
The pem certificates can be found inside the running container, at /srv/nuvlaedge/shared/.
This is an open-source project, so all community contributions are more than welcome. Please read CONTRIBUTING.md
Copyright © 2021, SixSq SA