dockerWrapper

This a docker orchestartion, deployment and container management tool. It can be used to automate the provisioning, swarm creation and orchestration, deployment management and monitoring. This Application uses 'docker-machine', docker SDK and docker API to automate your all tasks.

Pre-Requisite

You need to have docker, docker-machine installed on your machine to make this application get going.

Usage

This application will be used for:

Provisioning
Swarm Creation
Deployment
Monitoring
Auto-Scaling

Components

Poperty file

It's a JSON file, where we will be mentioning all our provisioning requirements and ask to wrapper application to automate that. of the nodes to be created will be mentioned in config.json file. There should be separate JSON files for every swarm cluster created. This application can be used for provisioning of different types of drivers like virtualbox, AWS, digitalOcean etc. Since this application uses docker-machine for provisioning purpose, therefore it supports all drivers that are being supported the docker-machine. For details refer: https://docs.docker.com/machine/drivers/

Format of the JSON file is :

Properties are mentioned in the json file in a key:value fashion. Default properties are:

role: Can be manager/slave
driver: Type of driver

Other properties depends on the type of driver, which can be found on docker-machine documentation page. Example, for virtualbox refer: https://docs.docker.com/machine/drivers/virtualbox/#options

Mention the options in a key:value fashion, removing the driver prefix from the option. For example,

--virtualbox-memory will be "memory": in JSON file

--virtualbox-cpu-count will be "cpu-count": in JSON file

Example of a JSON file:

{
  "master": {
    "role": "manager",
    "driver": "virtualbox",
    "memory": 1024,
    "cpu-count": 1
  },
  "worker": {
    "driver": "virtualbox",
    "role": "slave"
  }
}

Deployment Script

It's a YAML or YML file, where we will be metioning all our deployment requirements and wrapper will take care of it. We are using Docker-Compose file version:3 for deployment description. The deployment descriptions/options are same as that of docker-compose file version:3. Refer for more details: https://docs.docker.com/compose/compose-file/

Functions

Provisioning:

Provisioning can be done by running:

wrapper create -p <path to JSON file>

For more info, type wrapper create --help

Swarm Creation

Swarm creation is done by running

wrapper swarmit

For more info, type wrapper swarmit --help

Deploy

Deployment is done by the following command

wrapper deploy -p <path to the YAML file> all/<service name which you want to deploy>

For more info, type wrapper deploy --help

Re-Deploy

Re-Deployment of a single service or the whole stack can be done by following command:

wrapper redeploy -p <path to the YAML file> all/<service name which you want to redeploy>

For more info, type wrapper redeploy --help

Clean-Up

Deleting a single server/node or the whole cluster can be done by following command

wrapper wrapup all/<node name>

For more info, type wrapper wrapup --help

NOTE: This application maintains it's state in a file named shape.memory, under any circumstance you shouldn't touch this or edit it manually.

                         ```With Great Power, Comes Great Responsibility```

shubhasish/dockerWrapper