Merge branch 'develop'

Author: constup

bin/projectinit.sh

@@ -6,6 +6,7 @@ source ../src/filesystem/directory_management.sh
 source ../src/info_print.sh
 source ../src/language/flow.sh
 source ../src/language/ask_flow.sh
+source ../src/tools/documentation/documentation.sh
 
 check_user_configuration
 
@@ -40,12 +41,13 @@ configure_gitattributes
 #---
 
 run_flow
+setup_documentation
 generate_project_id_card_text
 
 echo ""
 echo "-------------------------------------------------"
 echo "ProjectInit completed setting up your project at: ${project_root_dir}"
-echo "Take a look at ${project_root_dir}/PROJECTINIT_README.adoc for more info and maintenance instructions."
+echo "Take a look at ${project_root_dir}/doc/projectinit/index.adoc for more info and maintenance instructions."
 if [ "${projectinit_generate_id_card_text}" = 1 ]; then
   echo "Text version of the Project ID card is available at ${project_root_dir}/projectinit_id_card.txt"
 fi

doc/dev/globals.adoc

@@ -89,6 +89,10 @@ contains your application
 |0/1 flag
 |Flag to show if Docker compose file has secrets.
 
+|`projectinit_compose_has_root_volumes`
+|0/1 flag
+|Flag to show if Docker compose file has root volumes.
+
 |===
 
 == Project
@@ -222,9 +226,13 @@ contains your application
 |Autogenerated from `projectinit_project_name` by adding `_database` suffix. Database container service name
 
 |`projectinit_database_host_port`
-|string value
+|integer (string representation)
 |Database container host port
 
+|`projectinit_database_x_plugin_host_port`
+|integer (string representation)
+|X Plugin host port. Available for MySQL and its forks (MariaDB, Percona for MySQL).
+
 |===
 
 == Caching

src/container/docker/dev.sh

@@ -1,9 +1,21 @@
 #!/bin/bash
 
 build_dev() {
+  echo ""
+  echo "Performing configuration cleanup..."
+  cleanup_before_build
+  echo "Configuration ready..."
   echo ""
   echo "Building Dev container..."
   cd "${project_root_dir}" || exit 1
   docker compose --env-file .env.docker build
   echo "  Dev container built..."
+}
+
+cleanup_before_build() {
+  if [ "${projectinit_compose_has_root_volumes}" = 1 ]; then
+    perl -pi -e "s/~~~root volumes~~~/volumes:/g" "${project_root_dir}/compose.yaml"
+  else
+    perl -pi -e "s/~~~root volumes~~~//g" "${project_root_dir}/compose.yaml"
+  fi
 }

src/database/database_flow.sh

@@ -9,27 +9,42 @@ setup_database_docker_compose_dev() {
     "pgsql" )
       # shellcheck source=../database/pgsql/v1/pqsql.sh
       source "${tool_dir}/src/database/pgsql/v1/pqsql.sh"
-      setup_docker_compose_dev
+      setup_pgsql_docker_compose_dev
       ;;
     "mysql" )
+      projectinit_compose_has_root_volumes=1
+      projectinit_compose_has_secrets=1
       # shellcheck source=../database/mysql/v1/mysql.sh
       source "${tool_dir}/src/database/mysql/v1/mysql.sh"
-      setup_docker_compose_dev
+      setup_mysql_docker_compose_dev
+      setup_mysql_my_cnf_dev
+      setup_mysql_dev_entrypoint
+      setup_mysql_dev_dockerfile
       ;;
     "percona" )
+      projectinit_compose_has_root_volumes=1
+      projectinit_compose_has_secrets=1
       # shellcheck source=../database/percona/v1/percona.sh
       source "${tool_dir}/src/database/percona/v1/percona.sh"
-      setup_docker_compose_dev
+      setup_percona_docker_compose_dev
+      setup_percona_my_cnf_dev
+      setup_percona_dev_entrypoint
+      setup_percona_dev_dockerfile
       ;;
     "mariadb" )
+      projectinit_compose_has_root_volumes=1
+      projectinit_compose_has_secrets=1
       # shellcheck source=../database/mariadb/v1/mariadb.sh
       source "${tool_dir}/src/database/mariadb/v1/mariadb.sh"
-      setup_docker_compose_dev
+      setup_mariadb_docker_compose_dev
+      setup_mariadb_my_cnf_dev
+      setup_mariadb_dev_entrypoint
+      setup_mariadb_dev_dockerfile
       ;;
   esac
 
   if [ ! "${projectinit_database_type}" = "no database" ]; then
-    perl -pi -e "s/(.*depends_on:.*)/\1\n      - ${projectinit_database_service_name}/" "${project_root_dir}/compose.yaml"
+    perl -pi -e "s/(.*depends_on:.*)/\1\n      ${projectinit_database_service_name}:\n        condition: service_healthy/" "${project_root_dir}/compose.yaml"
   fi
 }
 
@@ -42,22 +57,31 @@ setup_database_docker_compose_prod() {
     "pgsql" )
       # shellcheck source=../database/pgsql/v1/pqsql.sh
       source "${tool_dir}/src/database/pgsql/v1/pqsql.sh"
-      setup_docker_compose_prod
+      setup_pgsql_docker_compose_prod
       ;;
     "mysql" )
       # shellcheck source=../database/mysql/v1/mysql.sh
       source "${tool_dir}/src/database/mysql/v1/mysql.sh"
-      setup_docker_compose_prod
+      setup_mysql_docker_compose_prod
+      setup_mysql_my_cnf_prod
+      setup_mysql_prod_entrypoint
+      setup_mysql_prod_dockerfile
       ;;
     "percona" )
       # shellcheck source=../database/percona/v1/percona.sh
       source "${tool_dir}/src/database/percona/v1/percona.sh"
-      setup_docker_compose_prod
+      setup_percona_docker_compose_prod
+      setup_percona_my_cnf_prod
+      setup_percona_prod_entrypoint
+      setup_percona_prod_dockerfile
       ;;
     "mariadb" )
       # shellcheck source=../database/mariadb/v1/mariadb.sh
       source "${tool_dir}/src/database/mariadb/v1/mariadb.sh"
-      setup_docker_compose_prod
+      setup_mariadb_docker_compose_prod
+      setup_mariadb_my_cnf_prod
+      setup_mariadb_prod_entrypoint
+      setup_mariadb_prod_dockerfile
       ;;
   esac
 

src/database/mariadb/ask_mariadb.sh

@@ -16,6 +16,8 @@ ask_mariadb_config() {
   projectinit_database_password=$(read_password)
   echo "  Root password:"
   projectinit_database_root_password=$(read_password)
-  echo "  Host port:"
+  echo "  Host port for MariaDB server (container port is 3306):"
   read -r -e projectinit_database_host_port
+  echo "  Host port for X plugin (container port is 33060)"
+  read -r -e projectinit_database_x_plugin_host_port
 }

src/database/mariadb/v1/mariadb.sh

@@ -1,16 +1,16 @@
 #!/bin/bash
 
-setup_docker_compose_dev() {
+setup_mariadb_docker_compose_dev() {
   local target_file
   target_file="${project_root_dir}/compose.yaml"
 
   perl -pi -e "s/~~~database service~~~/$(<"${tool_dir}/src/database/mariadb/v1/template/dev" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
   perl -pi -e "s/~~~database service name~~~/${projectinit_database_service_name}/g" "${target_file}"
   perl -pi -e "s/~~~database container name~~~/${projectinit_database_service_name}/g" "${target_file}"
-  perl -pi -e "s/~~~database server version~~~/${projectinit_database_version}/g" "${target_file}"
   perl -pi -e "s/~~~database host port~~~/${projectinit_database_host_port}/g" "${target_file}"
+  perl -pi -e "s/~~~x plugin host port~~~/${projectinit_database_x_plugin_host_port}/g" "${target_file}"
+  perl -pi -e "s/~~~root volumes~~~/~~~root volumes~~~\n  ${projectinit_database_service_name}_volume:/g" "${target_file}"
 
-  projectinit_compose_has_secrets=1
   mkdir -p "${project_root_dir}/compose_secrets"
   touch "${project_root_dir}/compose_secrets/mariadb_password.txt"
   echo "${projectinit_database_password}" >> "${project_root_dir}/compose_secrets/mariadb_password.txt"
@@ -24,7 +24,7 @@ setup_docker_compose_dev() {
   perl -pi -e "s/~~~compose secrets~~~/$(<"${tool_dir}/src/database/mariadb/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
 }
 
-setup_docker_compose_prod() {
+setup_mariadb_docker_compose_prod() {
   local target_file
   target_file="${project_root_dir}/projectinit_docker/prod/compose.yaml"
   if [ ! -d "${project_root_dir}/projectinit_docker/prod" ]; then
@@ -34,8 +34,59 @@ setup_docker_compose_prod() {
   perl -pi -e "s/~~~database service~~~/$(<"${tool_dir}/src/database/mariadb/v1/template/prod" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
   perl -pi -e "s/~~~database service name~~~/${projectinit_database_service_name}/g" "${target_file}"
   perl -pi -e "s/~~~database container name~~~/${projectinit_database_service_name}/g" "${target_file}"
-  perl -pi -e "s/~~~database server version~~~/${projectinit_database_version}/g" "${target_file}"
   perl -pi -e "s/~~~database host port~~~/${projectinit_database_host_port}/g" "${target_file}"
+  perl -pi -e "s/~~~x plugin host port~~~/${projectinit_database_x_plugin_host_port}/g" "${target_file}"
+  perl -pi -e "s/~~~root volumes~~~/~~~root volumes~~~\n  ${projectinit_database_service_name}_volume:/g" "${target_file}"
 
   perl -pi -e "s/~~~compose secrets~~~/$(<"${tool_dir}/src/database/mariadb/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
+}
+
+setup_mariadb_dev_dockerfile() {
+  local target_file
+  target_file="${project_root_dir}/projectinit_docker/dev/mariadb/Dockerfile"
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/dockerfile/dev" "${target_file}"
+  perl -pi -e "s/~~~database server version~~~/${projectinit_database_version}/g" "${target_file}"
+}
+
+setup_mariadb_prod_dockerfile() {
+  local target_file
+  target_file="${project_root_dir}/projectinit_docker/prod/mariadb/Dockerfile"
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/dockerfile/prod" "${target_file}"
+  perl -pi -e "s/~~~database server version~~~/${projectinit_database_version}/g" "${target_file}"
+}
+
+setup_mariadb_my_cnf_dev() {
+  if [ ! -d "${project_root_dir}/projectinit_docker/dev/mariadb/etc/mysql/conf.d" ]; then
+    mkdir -p "${project_root_dir}/projectinit_docker/dev/mariadb/etc/mysql/conf.d"
+  fi
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/my_cnf/dev_my.cnf" "${project_root_dir}/projectinit_docker/dev/mariadb/etc/mysql/conf.d/my.cnf"
+  chmod 644 "${project_root_dir}/projectinit_docker/dev/mariadb/etc/mysql/conf.d/my.cnf"
+}
+
+setup_mariadb_my_cnf_prod() {
+  if [ ! -d "${project_root_dir}/projectinit_docker/prod/mariadb/etc/mysql/conf.d" ]; then
+    mkdir -p "${project_root_dir}/projectinit_docker/prod/mariadb/etc/mysql/conf.d"
+  fi
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/my_cnf/prod_my.cnf" "${project_root_dir}/projectinit_docker/prod/mariadb/etc/mysql/conf.d/my.cnf"
+  chmod 644 "${project_root_dir}/projectinit_docker/prod/mariadb/etc/mysql/conf.d/my.cnf"
+}
+
+setup_mariadb_dev_entrypoint() {
+  if [ ! -d "${project_root_dir}/projectinit_docker/dev/mariadb" ]; then
+    mkdir -p "${project_root_dir}/projectinit_docker/dev/mariadb"
+  fi
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/entrypoint/dev.sh" "${project_root_dir}/projectinit_docker/dev/mariadb/entrypoint.sh"
+}
+
+setup_mariadb_prod_entrypoint() {
+  if [ ! -d "${project_root_dir}/projectinit_docker/prod/mariadb" ]; then
+    mkdir -p "${project_root_dir}/projectinit_docker/prod/mariadb"
+  fi
+
+  cp -f "${tool_dir}/src/database/mariadb/v1/template/entrypoint/prod.sh" "${project_root_dir}/projectinit_docker/prod/mariadb/entrypoint.sh"
 }

src/database/mariadb/v1/template/dev

@@ -1,16 +1,23 @@
 ~~~database service name~~~:
     container_name: ~~~database container name~~~
-    image: mariadb:~~~database server version~~~
+    build:
+      context: ./
+      dockerfile: ./projectinit_docker/dev/mariadb/Dockerfile
     restart: always
     environment:
       MARIADB_DATABASE_FILE: /run/secrets/mariadb_database
       MARIADB_USER_FILE: /run/secrets/mariadb_user
       MARIADB_PASSWORD_FILE: /run/secrets/mariadb_password
       MARIADB_ROOT_PASSWORD_FILE: /run/secrets/mariadb_root_password
     ports:
-      - '~~~database host port~~~:3306'
+      - "~~~database host port~~~:3306"
+      - "~~~x plugin host port~~~:33060"
     volumes:
-      - ./database_volume:/var/lib/mysql
+      - ~~~database service name~~~_volume:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
+      timeout: 10s
+      start_period: 1m
     secrets:
       - mariadb_database
       - mariadb_user

src/database/mariadb/v1/template/dockerfile/dev

@@ -0,0 +1,8 @@
+FROM mariadb:~~~database server version~~~
+
+ENV MARIADB_MYSQL_LOCALHOST_USER=1
+
+COPY --chown=mysql:mysql --chmod=644 ./projectinit_docker/dev/mariadb/etc/mysql/conf.d/*.cnf /etc/mysql/conf.d/
+COPY --chown=mysql:mysql ./projectinit_docker/dev/mariadb/entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/bin/bash", "/entrypoint.sh"]

src/database/mariadb/v1/template/dockerfile/prod

@@ -0,0 +1,8 @@
+FROM mariadb:~~~database server version~~~
+
+ENV MARIADB_MYSQL_LOCALHOST_USER=1
+
+COPY --chown=mysql:mysql --chmod=644 ./projectinit_docker/dev/mariadb/etc/mysql/conf.d/*.cnf /etc/mysql/conf.d/
+COPY --chown=mysql:mysql ./projectinit_docker/dev/mariadb/entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/bin/bash", "/entrypoint.sh"]

src/database/mariadb/v1/template/documentation/docker/implemented_configuration.adoc

@@ -0,0 +1,68 @@
+== Implemented configuration
+
+The following configuration has been implemented by ProjectInit:
+
+* Database credentials as Docker compose secrets.
+* Docker volume is used for persisting data on the host.
+* Healthcheck is implemented in Docker Compose.
+* Custom `my.cnf` MariaDB configuration file and directory are prepared.
+
+=== Configuration files
+
+* Database credentials (Docker Compose secrets):
+** link:../../compose_secrets/mysql_database.txt[`compose_secrets/mysql_database.txt`]
+** link:../../compose_secrets/mysql_password.txt[`compose_secrets/mysql_password.txt`]
+** link:../../compose_secrets/mysql_root_password.txt[`compose_secrets/mysql_root_password.txt`]
+** link:../../compose_secrets/mysql_user.txt[`compose_secrets/mysql_user.txt`]
+* Dockerfile:
+** link:../../projectinit_docker/dev/mariadb/Dockerfile[`projectinit_docker/dev/mariadb/Dockerfile`]
+** link:../../projectinit_docker/prod/mariadb/Dockerfile[`projectinit_docker/prod/mariadb/Dockerfile`]
+* Entry point:
+** link:../../projectinit_docker/dev/mariadb/entrypoint.sh[`projectinit_docker/dev/mariadb/entrypoint.sh`]
+** link:../../projectinit_docker/prod/mariadb/entrypoint.sh[`projectinit_docker/prod/mariadb/entrypoint.sh`]
+* Custom MariaDB configuration directory:
+** link:../../projectinit_docker/dev/mariadb/etc/mysql/conf.d/[`projectinit_docker/dev/mariadb/etc/mysql/conf.d/`]
+** link:../../projectinit_docker/prod/mariadb/etc/mysql/conf.d/[`projectinit_docker/prod/mariadb/etc/mysql/conf.d/`]
+* Custom MariaDB configuration file:
+** link:../../projectinit_docker/dev/mariadb/etc/mysql/conf.d/my.cnf[`projectinit_docker/dev/mariadb/etc/mysql/conf.d/my.cnf`]
+** link:../../projectinit_docker/prod/mariadb/etc/mysql/conf.d/my.cnf[`projectinit_docker/prod/mariadb/etc/mysql/conf.d/my.cnf`]
+
+=== Database credentials
+
+Database credentials are stored as Docker Compose secrets. The secrets are available in
+link:../../compose_secrets[`compose_secrets`] directory of your project.
+
+Resources:
+
+* link:https://docs.docker.com/compose/how-tos/use-secrets/[How to use secrets in Docker Compose]
+
+=== Persisting data on the host
+
+Docker volume is used for persisting data on the host. This is the default method recommended in the documentation of
+the official Docker image. Volume file and directory permissions are managed by Docker. You are free to mount a local
+directory instead (bind mount), however, you will need to set up the directory, its owner (user), permissions and other
+security mechanisms yourself.
+
+Resources:
+
+* link:https://docs.docker.com/engine/storage/volumes/[Docker Volumes]
+* link:https://docs.docker.com/engine/storage/bind-mounts/[Docker bind mounts]
+
+=== Healthcheck
+
+Official MariaDB healthcheck script is implemented in Docker Compose. It makes sure that the MariaDB container is up
+before allowing your application to run.
+
+Resources:
+
+* link:https://mariadb.com/kb/en/using-healthcheck-sh/[`healthcheck.sh` Official MariaDB documentation]
+* link:https://docs.docker.com/reference/compose-file/services/#healthcheck[Healthcheck Docker service property]
+
+=== Custom MariaDB configuration
+
+Custom MariaDB configuration directory is implemented and ready in
+link:../../projectinit_docker/dev/mariadb/etc/mysql/conf.d/[`projectinit_docker/dev/mariadb/etc/mysql/conf.d/`] and
+link:../../projectinit_docker/prod/mariadb/etc/mysql/conf.d/[`projectinit_docker/prod/mariadb/etc/mysql/conf.d/`]. `*.cnf` files in
+this directory will be added to the container when you build it.
+
+You can also use already added `my.cnf` file.