New: Add docker compose example

Author: pedroamador

examples/docker/devcontrol/actions/destroy.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# @description Destroy the platform
+#
+# @example
+#   destroy
+#
+# @arg $1 Task: "brief", "help" or "exec"
+#
+# @exitcode The exit code of the statements of the action
+# @exitcode 1  If the task is not implemented
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function destroy() {
+
+    # Init
+    local briefMessage="Environment removal"
+    local helpMessage="Destroy the docker-compose platform and the data volumes using 'docker-compose down -v'"
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            docker-compose down -v
+            ;;
+        *)
+            showNotImplemtedMessage $1 ${FUNCNAME[0]}
+            return 1
+    esac
+}
+
+# Main
+destroy "$@"

examples/docker/devcontrol/actions/enter.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# @description Access to a container console using bash
+#
+# @example
+#   enter web
+#
+# @arg $1 Task: "brief", "help" or "exec"
+# @arg $2 Service: "web", "app" or "duing"
+#
+# @exitcode The exit status of the `docker-compose exec bash` command
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function enter() {
+
+    # Init
+    local briefMessage="Enter with a console to a service: 'app' (default), 'db' or 'duing'"
+    local helpMessage="""Use 'docker-compose' to exec a bash terminal in a service"""
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            service=$2
+            docker-compose exec ${service} bash
+            ;;
+        *)
+            showNotImplemtedMessage ${FUNCNAME[0]} $1
+            return 1
+    esac
+}
+
+# Main
+enter "$@"

examples/docker/devcontrol/actions/logs.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# @description Show logs
+#
+# @example
+#   logs
+#
+# @arg $1 Task: "brief", "help" or "exec"
+#
+# @exitcode The exit status of the statements of the action
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function logs() {
+
+    # Init
+    local briefMessage="Show logs"
+    local helpMessage="Show logs of the containers of the platform using 'docker-compose logs'"
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            docker-compose logs --tail=100 -f
+            ;;
+        *)
+            showNotImplemtedMessage ${FUNCNAME[0]} $1
+            return 1
+    esac
+}
+
+# Main
+logs "$@"

examples/docker/devcontrol/actions/start.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# @description Start the platform
+#
+# @example
+#   start
+#
+# @arg $1 Task: "brief", "help" or "exec"
+#
+# @exitcode The exit code of the statements of the action
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function start() {
+
+    # Init
+    local briefMessage="Environment start and load initial data"
+    local helpMessage="Start the docker-compose platform"
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            checkDocker
+            docker-compose up -d
+            ;;
+        *)
+            showNotImplemtedMessage $1 ${FUNCNAME[0]}
+            return 1
+    esac
+}
+
+# Main
+start "$@"

examples/docker/devcontrol/actions/status.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# @description Show status of the docker platform
+#
+# @example
+#   status
+#
+# @arg $1 Task: "brief", "help" or "exec"
+#
+# @exitcode The exit code of the `docker-compose ps` command
+# @exitcode 1  If the task is not implemented
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function status() {
+
+    # Init
+    local briefMessage="Get status of the local docker development environment"
+    local helpMessage="Execute the 'docker-compose ps' command"
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            docker-compose ps
+            ;;
+        *)
+            showNotImplemtedMessage ${FUNCNAME[0]} $1
+            return 1
+    esac
+}
+
+# Main
+status "$@"

examples/docker/devcontrol/actions/stop.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# @description Stop the platform
+#
+# @example
+#   stop
+#
+# @arg $1 Task: "brief", "help" or "exec"
+#
+# @exitcode The exit code of the statements of the action
+# @exitcode 1  If the task is not implemented
+#
+# @stdout "Not implemented" message if the requested task is not implemented
+#
+function stop() {
+
+    # Init
+    local briefMessage="Platform stop"
+    local helpMessage="Stop the docker-compose platform"
+
+
+    # Task choosing
+    case $1 in
+        brief)
+            showBriefMessage ${FUNCNAME[0]} "$briefMessage"
+            ;;
+        help)
+            showHelpMessage ${FUNCNAME[0]} "$helpMessage"
+            ;;
+        exec)
+            docker-compose stop
+            ;;
+        *)
+            showNotImplemtedMessage $1 ${FUNCNAME[0]}
+            return 1
+    esac
+}
+
+# Main
+stop "$@"

examples/docker/devcontrol/global/startup.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# @file devcontrol/global/startup.sh
+# @brief devcontrol startup script and functions
+echo "Devcontrol Docker Example (c) 2019"
+echo
+
+# @description Check presence of docker-related pieces in the system
+# The function aborts the execution if the system dont have docker installed
+#
+# @example
+#   checkDocker
+#
+# @noargs
+#
+# @exitcode 0  If docker exist, abort execution if other case and return 1 to the system
+#
+# @stdout Show "Docker not present. Exiting -" message if missing docker
+#
+function checkDocker() {
+    which docker docker-compose > /dev/null 2>&1 || bash -c 'echo "Missing docker: aborting"; exit  1'
+}
+export -f checkDocker