chore: add docker examples

Author: Throyer

.github/workflows/deploy-staging.yml

@@ -5,7 +5,8 @@ target/
 !**/src/test/**
 
 ### docker ###
-.volumes/
+docker/.volumes/
+docker/.env
 
 ### STS ###
 .apt_generated

.gitignore

@@ -29,6 +29,7 @@
 - [Running a specific test](#tests)
 - [Swagger](#swagger)
 - [Database Migrations](#database-migrations)
+- [Docker](#docker-examples)
 - [Environment variables](#environment-variables)
 
 # Features
@@ -114,6 +115,27 @@ Creating database migration files
 
 ---
 
+## Docker examples
+docker compose for development
+```bash
+cd docker
+docker-compose -p common-api-development -f docker-compose.dev.yml up -d
+```
+
+Building image for production
+```bash
+cd docker
+DOCKER_BUILDKIT=1 docker build -f Dockerfile.prod -t common-api:4.1.1 .
+```
+
+docker compose for production
+```bash
+cd docker
+cp .env.example .env
+
+docker-compose -p common-api -f docker-compose.prod.yml up -d
+```
+
 ## Environment variables
 
 | **Description**                          | **Parameter**                      | **Default values**        |
@@ -139,7 +161,7 @@ Creating database migration files
 > ```shell
 > # to change the value of some environment variable at runtime
 > # on execution, just pass it as a parameter. (like --SERVER_PORT=80).
-> $ java -jar api-4.1.0.RELEASE.jar --SERVER_PORT=80
+> $ java -jar api-4.1.1.RELEASE.jar --SERVER_PORT=80
 > ```
 
 

README.md

@@ -0,0 +1,3 @@
+DB_URL=database:3306/common_app
+DB_USERNAME=root
+DB_PASSWORD=root

docker/.env.example

@@ -1,26 +1,26 @@
 version: '3'
 services:
 
-  postgresql:
+  database:
     image: postgres:13
     restart: unless-stopped
-    container_name: postgres-container
+    container_name: common-database
     command: ["postgres", "-c", "log_statement=all", "-c", "log_destination=stderr"]
     ports:
       - "5432:5432"
     environment:
-      - POSTGRES_USER=root
-      - POSTGRES_PASSWORD=root
-      - POSTGRES_DB=common_app
-      - TZ=America/Sao_Paulo
-      - PGTZ=America/Sao_Paulo
+      POSTGRES_USER: ${DB_USERNAME}
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_DB: ${DB_NAME}
+      TZ: America/Sao_Paulo
+      PGTZ: America/Sao_Paulo
     volumes:
       - ./.volumes/database:/var/lib/postgresql/data
-
+  
   api:
     image: maven:3.8.3
     restart: unless-stopped
-    container_name: api-container
+    container_name: common-api
     links:
       - postgresql
     depends_on:
@@ -29,9 +29,9 @@ services:
       - "8080:8080"
       - "8000:8000"
     environment:
-      DB_URL: "postgresql:5432/common_app"
-      DB_USERNAME: "root"
-      DB_PASSWORD: "root"
+      DB_URL: database:5432/${DB_NAME}
+      DB_USERNAME: ${DB_USERNAME}
+      DB_PASSWORD: ${DB_PASSWORD}
     volumes:
       - ./:/app
       - ./.volumes/maven:/root/.m2

Dockerfile renamed to docker/Dockerfile.prod

@@ -0,0 +1,30 @@
+version: '3'
+services:
+
+  database:
+    image: postgres:13
+    restart: unless-stopped
+    container_name: common-database
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: ${DB_USERNAME}
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_DB: ${DB_NAME}
+      TZ: America/Sao_Paulo
+      PGTZ: America/Sao_Paulo
+    volumes:
+      - ./.volumes/database:/var/lib/postgresql/data
+
+  api:
+    image: common-api:4.1.1
+    restart: unless-stopped
+    container_name: common-api
+    links:
+      - database
+    ports:
+      - 8080:80
+    environment:
+      DB_URL: database:5432/${DB_NAME}
+      DB_USERNAME: ${DB_USERNAME}
+      DB_PASSWORD: ${DB_PASSWORD}

docker-compose.yml renamed to docker/docker-compose.dev.yml

@@ -9,7 +9,7 @@
     </parent>
     <groupId>com.github.throyer.common.spring-boot</groupId>
     <artifactId>api</artifactId>
-    <version>4.1.0</version>
+    <version>4.1.1</version>
     <name>CRUD API</name>
 
     <description>Exemplo de api simples com Spring Boot</description>