management-api
This repository contains the source code for the NuvlaBox Management API - this microservice provides the management API for the NuvlaBox
This microservice is an integral component of the NuvlaBox 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/nuvlabox/deployment for a fully functional deployment
Build the NuvlaBox Management API
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/management-api:<branch>.
Deploy the NuvlaBox Management API
Prerequisites
- Docker (version 18 or higher)
- Docker Compose (version 1.23.2 or higher)
Launching the NuvlaBox Management API
Simply run docker-compose up --build
Contributing
This is an open-source project, so all community contributions are more than welcome. Please read CONTRIBUTING.md
Copyright
Copyright © 2021, SixSq SA