Code Monkey home page Code Monkey logo

dk-server's Introduction

DK - A sandbox provisioning service

A middleman service that enables the provisioning of docker stacks to end users through an API.

Node.js version support Coverage MIT licensed

Table of Contents

Requirements

DK requires the following to run:

  • Node.js 8.8.1+
  • npm (normally comes with Node.js)
  • Docker 17.12.0-ce+
  • Docker Swarm Mode activated

Getting Started

The main goal of this service is to create a layer of abstraction that manages user authentication, docker stack templates and docker stack creation and deletion by the end user and adminstrators.

After running the service you can access the API documentation and play with it in http://localhost/api-docs.

Usage

# Build docker image
$ npm run build

# Deploy as a container (linux and macosx only)
$ docker volume create dk_data
$ docker run -d -p 80:80 -v /var/run/docker.sock:/var/run/docker.sock -v dk_data:/dk-server/data dk-server

# Deploy as a service (linux, macosx and windows)
$ docker service create --name dk-server --publish 80:80 --constraint 'node.role == manager' --mount type=bind,src=//var/run/docker.sock,dst=/var/run/docker.sock dk-server

Contributing

To contribute to DK, clone this repo locally and commit your code on a separate branch. Please write unit tests for your code before opening a pull-request:

# Clone the repository and run
$ npm install

# Running
$ npm start

# Testing
$ npm test

# Coverage
$ npm run coverage

Support and Migration

DK server is in its alpha stage so expect breaking chances and no migration guide.

License

DK is licensed under the MIT license.
Copyright © 2018, Conrado Quilles Gomes

dk-server's People

Contributors

conradoqg avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.