How to use docker in the development phase of a devops life cycle?

Question

I have a couple of questions related to the usage of Docker in a development phase.

I am going to propose three different scenarios of how I think Docker could be used in a development environment. Let's imagine that we are creating a REST API in Java and Spring Boot. For this I will need a MySQL database.

1. The first scenario is to have a docker-compose for development with the MySQL container and a production docker-compose with MySQL and the Java application (jar) in another container. To develop I launch the docker-compose-dev.yml to start only the database. The application is launched and debugged using the IDE, for example, IntelliJ Idea. Any changes made to the code, the IDE will recognize and relaunch the application by applying the changes.

2. The second scenario is to have, for both the development and production environment, a docker-compose with the database and application containers. That way, every time I make a change in the code, I have to rebuild the image so that the changes are loaded in the image and the containers are lauched again. This scenario may be the most typical and used for development with Docker, but it seems very slow due to the need to rebuild the image every time there is a change.

3. The third scenario consists of the mixture of the previous two. Two docker-compose. The development docker-compose contains both containers, but with mechanisms that allow a live reload of the application, mapping volumes and using, for example, Spring Dev Tools. In this way, the containers are launched and, in case of any change in the files, the application container will detect that there is a change and will be relaunched. For production, a docker-compose would be created simply with both containers, but without the functionality of live reload. This would be the ideal scenario, in my opinion, but I think it is very dependent on the technologies used since not all allow live reload.

The questions are as follows.

• Which of these scenarios is the most typical when using Docker for phase?

• Is scenario 1 well raised? That is, dockerize only external services, such as databases, queues, etc. and perform the development and debugging of the application with the IDE without using Docker for it.

The doubts and the scenarios that I raise came up after I raised the problem that scenario 2 has. With each change in the code, having to rebuild the image and start the containers again is a significant waste of time. In short, a question would be: How to avoid this?

Thanks in advance for your time.

NOTE: It may be a question subject to opinion, but it would be nice to know how developers usually deal with these problems.

Ptolemy

I'd recommend your first option out of the three; it seems like a good combination of using Docker and your IDE in modes they're both good at. – Arrivederci

@DavidMaze. Have you ever tried the situation described in scenario 3 with any technology that allows live reload? For simple curiosity. Thanks! – Ptolemy

Did you solve your questions/doubts? – Apthorp

@JRichardsz, I am open to listen to the maximum possible answers, since it is rather an exercise to know how developers usually use Docker for the development environment. – Ptolemy

When you say development environment, do you mean just the stage in which programmers "developing" a software in its laptop (localhost)? Or your question could be : How to use docker in all phases of software development life cycle (code, build, test, release, deploy, etc ) ? – Apthorp

@Apthorp Exactly, I mean when programmers develop on their laptop. But a brief explanation of each of the phases you comment on would be great. Thank you in advance. For example, what is the difference between the usage of Docker in build, release or deploy phases? – Ptolemy

Answer 1

Disclaimer: this is my own opinion on the subject as asked by Mr. Mars. Even though I did my best to back my answer with actual sources, it's mostly based on my own experience and a bit of common sense

Which of these scenarios is the most typical when using Docker for development?

I have seen all 3 scenarios iin several projects, each of them with their advantages and drawbacks. However I think scenario 3 with a Docker Compose allowing for dynamic code reload is the most advantageous in term of flexibility and consistency:

• Dev and Prod Docker Compose are close matches, meaning Dev environment is as close as possible to Prod environment
• You do not have to rebuild the image constantly when developping, but it's easy to do when you need to
• Lots of technologies support such scenario, such as Spring Dev Tools as you mentionned, but also Python Flask, etc.
• You can easily leverage Docker Compose extends a.k.a configuration sharing mechanism (also possible with scenario 2)

Is scenario 1 well raised? That is, dockerize only external services, such as databases, queues, etc. and perform the development and debugging of the application with the IDE without using Docker for it.

Scenario 1 is quite common, but the IDE environment would probably be different than the one from the Docker container (and it would be difficult to maintain a match of version for each libs, dependencies, etc. from IDE environment to Docker environment). It would also probably require to go through an intermediate step between Dev and Production to actually test the Docker image built after Dev is working before going to Production.

In my own experience doing this is great when you do not want to deal too much with Docker when actually doing dev and/or the language or technology you use is not adapted for dynamic reload as described in scenario 3. But in the end it only adds a drift between your environments and more complexity between Dev and Prod deployment method.

having to rebuild the image and start the containers again is a significant waste of time. In short, a question would be: How to avoid this?

Beside the scenarios you describe, you have ways to decently (even drastically) reduce image build time by leveraging Docker build cache and designing your Dockerfile. For example, a Python application would typically copy code as the last (or almost last) step of the build to avoid invalidating the cache, and for Java app it would be possible to split code so as to avoid compiling the entire application everytime a bit of code changes - that would depend on your actual setup.

---

I personally use a workflow roughly matching scenario 3 such as:

• a docker-compose.yml file corresponding to my Production environment
• a docker-compose.dev.yml which will override some aspect of my main Docker Compose file such as mouting code from my machine, adding dev specific flags to commands, etc. - it would be run such as

  docker-compose -f docker-compose.yml -f docker-compose.dev.yml 
  

  but it would also be possible to have a docker-compose.override.yml as Docker Compose uses by default for override
• in some situation I would have to use other overrides for specific situations such as docker-compose.ci.yml on my CI, but usually the main Docker Compose file is enough to describe my Prod environment (and if that's not the case, docker-compose.prod.yml does the trick)

Baddie

Thank you very much for this complete answer, @Pierre B. It is appreciated that you share your experience in this area. A question related to case 3. Since, a priori, is the scenario that borders on the ideal, debugging would complicate the issue a bit compared to scenario 1, right? In this case it would be necessary to debug remotely, for example in the case of Java, right? Thank you again :) – Ptolemy

In case of Java debugging you'll probably have to setup remote debugging yes. Just to moderate a bit, scenario 3 is my personnal favorite but I would not say it's ideal since that will highly depends on your situation and some scenario may be much more appropriate in some contexts. Another possibility would be to keep your Docker Compose file as in scenario 3, but simply run your app from the IDE and configure it to use the MySQL container (and if required stop the Java container, though that may not be necessary) – Baddie

Great, just what I thought. If you debug in the IDE directly while keeping the docker compose from scenario 3, it would be a very close solution to scenario 1, but without giving up everything that scenario 3 offers, since you could have the Java application in the container also. Is that right? – Ptolemy

Exactly! You can in fact do scenario 1 with scenario 3 – Baddie

When your IDE needs the JDK or some other SDK configured, how do you handle that? Do you point it to the installation in the container? – Almatadema

Answer 2

I've seen them all used in different scenarios. There are some gotchas to avoid:

1. Applications inside of a container shouldn't depend on something running outside of a container on the host. So all of your dependencies should be containerized first.

2. File permissions with host volumes can be complicated depending on your version of docker. Some of the newer Docker Desktop installs automatically handle uid mappings, but if you develop directly on Linux you'll need to ensure the containers run as the same uid as your host user.

3. Avoid making changing inside the container if that isn't mapped into a host volume, since those changes will be lost when the container is recreated.

Looking at each of the options, here's my assessment of each:

1. Containerizing just the DB: This works well when developers already have a development environment for the language of choice, and there's no risk of external dependencies creeping in, e.g. a developer upgrading their JDK install to a newer version than the image is built with. It follows the idea of containerizing the dependencies first, while also giving developers the familiar IDE integration with their application.

2. Rebuilding the Image for Every Change: This tends to be the least ideal for developer workflow, but the quickest to implement when you're not familiar with the tooling. I'll give a 4th option that I consider an improvement to this.

3. Everything in a container, volume mounts, and live reloading: This is the most complicated to implement, and requires the language itself to support things like live reloading. However, when they do, it is nearly seamless for the developers and gets them up to speed on a new project quickly without needing to install any other tooling to get started.

4. Rebuild the app in the container with volume mounts: This is a halfway point between 2 and 3. When you don't have live reloading, you likely need to recompile or restart the interpreter to see any change. Rather than rebuilding the image, I put the recompile step in the entrypoint of a development image. I'll mount the code into the container, and run a full JDK instead of just a JRE (or whatever compiler is needed). I use named volumes for any dependency caches so they don't need to download on every restart. Then the method to see the changes is to restart that one container. The steps are identical to a compiled binary outside of a container, stop the old service, recompile, and restart the service, but now it happens inside of a container that should have the same tools used when building the production image.

For option 4, I tend to use a multi-stage build that has stages for build, develop, and release. The build stage pulls in the code and compiles it, the develop stage is the same base image as build but with an entrypoint that does the compile/run, and the release stage copies the result of the build stage into a minimal runtime. Developers then have a compose file for development that creates the development image and runs that with volume mounts and any debugging ports opened.

Shag

Answer 3

First of all, docker-compose is just for development and also testing phase, not for production. Example:

With a minimal and basic docker-compose, all your containers will run in the same machine? For development purposes it is ok, but in production, put all the apps in just one machine is a risk

• Official link https://docs.docker.com/compose/production/

We will assume

• 01 java api
• 01 mysql database
• 01 web application that needs the api
• all of these applications are already in production

Quick Answer

If you need to fix or add new feature to the java api, I advice you to use an ide like eclipse or IntelliJ Idea. Why?

• Because java needs compilation.
• Compile inside a docker container will take more time due to maven dependencies
• IDE has code auto completion
• etc

In this development phase, Docker helps you with one of its most powerful features: "Bring the production containers to your localhost". Yeah, in this case, docker-compose.yml is the best option because with one file, you could start everything you need : mysql database and web app but not your java api. Open your java api with your favorite ide.

Anyway if you want to use docker to "develop", you just need the Dockerfile and perform a docker build ... when you need to run your source code in your localhost

Basic Devops Life cycle with docker

• Developer push source code changes using git
• Your continuous integration (C.I) platform detect this change and perform
  • docker build ... (In this step, unit test are triggered)
  • docker push to your private hub. Container is uploaded in this step and will be used to deployments on other servers.
  • docker run or container deploy to the next environment : testing
• Human testers ,selenium or another automation start their work
• If no errors are detected, your C.I perform perform a final deploy of the uploaded container to your production environment. No docker build are required, just deploy or docker run.

Some Tips

Docker features are awesome but sometimes add too much complexity. So stop using volumes , hard disk dependency, logs, or complex configurations. If you use volumes, what will happen when your containers are in different hosts?

Java and Nodejs are a stable languages and your rest api or web apps does not need crazy configurations. Just maven compilation and java -jar ... or npm install and npm run start.

For logs you could use https://www.graylog.org/, google stasckdriver or another log management.

And like Heroku, stop using hard disk dependency as much as possible. In heroku platform disk are disposable, it means disappear when app is restarted. So instead of local file storage, you could use another file storage service with a lot of functionalities.

With this approaches, your containers can be deployed anywhere in a simple way

Apthorp

Answer 4

I'm using something similar to your 3rd scenario for my web dev, but it is Node-based. So I have 3 docker-compose files (actually 4, one is base and having all common stuff for others) for dev, staging and production environments.

Staging docker-compose config is similar to production config excluding SSL, ports and other things that may not allow to use it locally.

I have a separate container for each service (like DB, queue), and for dev, I also have additional dev DB and queue containers mostly for running auto-tests. In dev environment, all source are mounted into containers, so it allows to use IDE/editor of choice outside the container, and see changes inside.

I use supervisor to manage my workers inside a container with workers and have some commands to restart my workers manually when I need this. Maybe you can have something similar to recompile/restart your Java app. Or if you have an idea of how to organize app source code changes detection and your app auto-reloading, than could be the best variant. By the way, you gave me an idea to research something similar suitable for my case.

For staging and production environment, my source code is included inside the corresponding container using production Dockerfile. And I have some commands to restart all stuff using an environment I need, and this typically includes rebuilding containers, but because of Docker cache, it doesn't take much time (about 20 seconds). And taking into account that switching between environments is not a too frequent operation I feel quite comfortable with this.

Production docker-compose config is used only during deployment because it enables SSL, proper ports and has some additional production stuff.

Update for details on backend app restarting using Supervisor:

This is how I use it in my projects:

A part of my Dockerfile with installing Supervisor:

FROM node:10.15.2-stretch-slim

RUN apt-get update && apt-get install -y \
  # Supervisor
    supervisor \
    ...

...

# Configs for services/workers managed by supervisor
COPY some/path/worker-configs/*.conf /etc/supervisor/conf.d/

This is an example of one of Supervisor configs for a worker:

[program:myWorkerName]
command=/usr/local/bin/node /app/workers/my-worker.js
user=root
numprocs=1
stopsignal=INT
autostart=true
autorestart=true
startretries=10

In this example in your case command should run your Java app.

And this is an example of command aliases for convenient managing Supervisor from outside of containers. I'm using Makefile as a universal runner of all commands, but this can be something else.

# Used to run all workers
su-start:
    @docker exec -t MY-WORKERS-CONTAINER-NAME supervisorctl start all

# Used to stop all workers
su-stop:
    @docker exec -t MY-WORKERS-CONTAINER-NAME supervisorctl stop all

# Used to restart all workers
su-restart:
    @docker exec -t MY-WORKERS-CONTAINER-NAME supervisorctl restart all

# Used to check status of all workers
su-status:
    @docker exec -t MY-WORKERS-CONTAINER-NAME supervisorctl status

As I described above these Supervisor commands need to be run manually, but I think it is possible to implement maybe another Node-based worker or some watcher outside of a container with workers that will detect file system changes for sources directory and run these commands automatically. I think it is possible to implement something like this using Java as well like this or this.

On the other hand, it needs to be done carefully to avoid constant restarting workers on every little change.

Igorot

Thank you, @dajnz! So to do livereload use supervisor? Or do you use another mechanism? I think the solution you are proposing is a very good solution. The purpose of the question is to know how developers usually do it. If it is not too much to ask, could you share an example of how to do what you discuss with the supervisor? For node, I have seen this and it looks very good: hackernoon.com/… – Ptolemy

Ok, let's clarify what exactly we understand by livereload. I see there are 2 meanings: 1) restarting all back-end app on back-end source change, 2) reloading web pages assets (JS, CSS, markup) when changing stuff in an editor. So what is your meaning of this? – Igorot

I am referring to the first case you comment on, that of restarting the backend application before a change in the code. Thank you and sorry. – Ptolemy

Please check my answer update with details about how I use Supervisor. – Igorot