Skip to content

dockerize.md

Latest commit

 

History

History
131 lines (85 loc) · 4.19 KB

dockerize.md

File metadata and controls

131 lines (85 loc) · 4.19 KB
description Bash like abstraction of local services in docker

Dockerize

When assuming the use of container in our workflow we come to face some challenges. Soon we realize that it is complicated to have a complete environment without installing any tool on the host.

Tevun's Dockerize initiative seeks to deliver a comfortable workflow for those who use Docker in their day-to-day lives.

Using it you will abstract all the services you use to develop to run with docker.

How to configure

{% hint style="danger" %} Read the steps before you run them to understand what is being done. We will modify your bash environment and we don't want cause problems to you = ) {% endhint %}

Getting started

To use dockerize you can clone or download de zip of project from Github.

Create a clone

Create with your terminal an easy-to-find folder

mkdir -p ~/.config/tevun

Make a local project clone

git clone git@github.com:tevun/dockerize.git ~/.config/tevun/dockerize

OR

Download

Download the zip of this project

wget -O ~/.config/tevun/dockerize.zip https://codeload.github.com/tevun/dockerize/zip/master

Then unzip the contents of the zip

unzip dockerize.zip && mv dockerize-master dockerize

Configuration

To use dockerize you need add the bashrc script to your terminal environment.

{% code-tabs %} {% code-tabs-item title="~/.bashrc" %}

...
source ~/.config/tevun/dockerize/.bashrc # or your custom path
...

{% endcode-tabs-item %} {% endcode-tabs %}

If you are using the project for the first time you can use our convenient configuration script to add local documents to your terminal environment.

To do this, run the configuration script

bash ~/.config/tevun/dockerize/configure.sh # or your custom path

How to use Dockerize

After add the script to terminal will be created a command engine to toggle service commands to run on "global images" and/or containers relative to the project of the folder it is in.

We currently have the following configured services:

  • artisan
  • composer
  • node
  • npm
  • php
  • phpunit
  • quasar
  • vue
  • yarn
  • react

In other words, you can simply execute:

php -v

To perform the service php in your docker host.

Smart behavior

Dockerize tries to detect which container should be run for each service. When you are in a folder that does not have a container associated with it, your output will be global.

When the current directory is associated with one container the output will be different.

Detection strategies

  • global suffix: Dockerize will first attempt to find a container that has the folder name and suffix associated with the service. You can check the service suffix in the property T_DOCKERIZE_SERVICE of file dockerize/environment/variables.ini.sample. If your project folder is foo and T_DOCKERIZE_SERVICE is app the name of your service must be foo-app to this detection match.
  • service suffix: The second try is check if there is a container with the folder name followed by an hyphen and the name of service. If your project folder is acme and you create a service with name acme-node you can perform the command node and dockerize will use this container.
  • file .dockerize: You create a file called .dockerize in your project folder and describe the name of containers of services.

Customizing

You can customize the main project settings. Go to the environment folder and evaluate the parameters that are defined there.

cd ~/.config/tevun/dockerize/environment

Common Problems

  • Address already in use:
    • message: docker: Error response from daemon: driver failed programming external connectivity on endpoint * (): Error starting userland proxy: listen tcp 0.0.0.0:: bind: address already in use.
    • solution: use the guidelines in the Customizing section and configure the ports in the images.ini file according to your port usage.

****