pit

command module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2015 License: MPL-2.0 Imports: 4 Imported by: 0

README

Dockpit

Painless isolation for your (micro)service development process. Comes with a minimal web UI to set up dependencies in predictive states and a CLI to quickly switch between them. It uses Docker to make each isolation predictable and portable. All packed in a single lightweight (~10mb) binary that works on OSX, Linux and Windows.

Why

Dockpit was created after user research on the development of (micro)services showed the difficulty of managing the dependencies of a single service: External and internal API's responses, databases, message ques, etc. They all need to be setup and respond consistently in order to develop and test features that depend on them. Currently, this is often done through fragile shell scripts or dedicated internal tooling, both requiring significant effort to maintain. Dockpit was created as an alternative to make managing these dependencies quick, predictable and, dare I say, fun.

Getting Started

NOTE: You'll need to have Docker installed and running, the official guides for setting up Docker can be found here.


First, download any of the prebuild binaries or use the Go toolchain:

go get -u github.com/dockpit/pit

Make sure you're in the project directory of the (micro)service you're looking to isolate and then run the start command:

cd ~/my_project
pit start

A text-based UI becomes available in your shell and a web interface is now being served on http://localhost:3838, follow on-screen instructions there to setup your first isolation.

Todo

  • Allow clearing the current isolation from text ui
  • Add timeout and message when Docker is not running

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL