Postgres

- In-project documentation

Documentation

- fixes for healthcheck documentation

Author: constup

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

@@ -4,7 +4,7 @@ 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.
+* Healthcheck is implemented directly in the Docker image (custom Dockerfile).
 * Custom `my.cnf` MariaDB configuration file and directory are prepared.
 
 === Configuration files
@@ -50,13 +50,13 @@ Resources:
 
 === Healthcheck
 
-Official MariaDB healthcheck script is implemented in Docker Compose. It makes sure that the MariaDB container is up
+Basic healthcheck mechanism has been implemented in the custom Dockerfile. It makes sure that the database service 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]
+* link:https://docs.docker.com/reference/dockerfile/#healthcheck[Healthcheck in Dockerfile]
 
 === Custom MariaDB configuration
 

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

@@ -4,7 +4,7 @@ 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.
+* Healthcheck is implemented directly in the Docker image (custom Dockerfile).
 * Custom `my.cnf` MySQL configuration file and directory are prepared.
 
 === Configuration files
@@ -50,12 +50,12 @@ Resources:
 
 === Healthcheck
 
-Basic healthcheck mechanism has been implemented in Docker Compose. It makes sure that the MySQL container is up before
-allowing your application to run.
+Basic healthcheck mechanism has been implemented in the custom Dockerfile. It makes sure that the database service is up
+before allowing your application to run.
 
 Resources:
 
-* link:https://docs.docker.com/reference/compose-file/services/#healthcheck[Healthcheck Docker service property]
+* link:https://docs.docker.com/reference/dockerfile/#healthcheck[Healthcheck in Dockerfile]
 
 === Custom MySQL configuration
 

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

@@ -4,7 +4,7 @@ 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.
+* Healthcheck is implemented directly in the Docker image (custom Dockerfile).
 * Custom `my.cnf` MySQL configuration file and directory are prepared.
 * Default authentication is set to non-deprecated `caching_sha2_password` method for both MySQL daemon and client.
 * Percona telemetry is disabled.
@@ -52,12 +52,12 @@ Resources:
 
 === Healthcheck
 
-Basic healthcheck mechanism has been implemented in Docker Compose. It makes sure that the Percona MySQL container is
-up before allowing your application to run.
+Basic healthcheck mechanism has been implemented in the custom Dockerfile. It makes sure that the database service is up
+before allowing your application to run.
 
 Resources:
 
-* link:https://docs.docker.com/reference/compose-file/services/#healthcheck[Healthcheck Docker service property]
+* link:https://docs.docker.com/reference/dockerfile/#healthcheck[Healthcheck in Dockerfile]
 
 === Custom MySQL configuration
 

src/database/pgsql/container/docker/v1/template/documentation/implemented_configuration.adoc

@@ -0,0 +1,48 @@
+== 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 directly in the Docker image (custom Dockerfile).
+
+=== Configuration files
+
+* Database credentials (Docker Compose secrets):
+** link:../../compose_secrets/postgres_db.txt[`compose_secrets/postgres_db.txt`]
+** link:../../compose_secrets/postgres_password.txt[`compose_secrets/postgres_password.txt`]
+** link:../../compose_secrets/postgres_user.txt[`compose_secrets/postgres_user.txt`]
+* Dockerfile:
+** link:../../projectinit_docker/dev/pgsql/Dockerfile[`projectinit_docker/dev/pgsql/Dockerfile`]
+** link:../../projectinit_docker/prod/pgsql/Dockerfile[`projectinit_docker/prod/pgsql/Dockerfile`]
+
+=== 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
+
+Basic healthcheck mechanism has been implemented in the custom Dockerfile. It makes sure that the database service is up
+before allowing your application to run.
+
+Resources:
+
+* link:https://docs.docker.com/reference/dockerfile/#healthcheck[Healthcheck in Dockerfile]
+* link:https://www.postgresql.org/docs/current/app-pg-isready.html[`pg_isready`]

src/database/pgsql/container/docker/v1/template/documentation/index.adoc

@@ -0,0 +1,24 @@
+= PostgreSQL
+:toc:
+:toclevels: 5
+
+== Introduction
+
+|===
+|Description|Link
+
+|Homepage
+|https://www.postgresql.org/
+
+|Docker Official image (used here)
+|https://hub.docker.com/_/postgres
+
+|===
+
+[IMPORTANT]
+====
+PostgreSQL server has been set up with *minimum configuration only*, so you can start working. It's up to you how you'd
+like to configure it for development and production.
+====
+
+~~~implemented configuration~~~

src/tools/documentation/documentation.sh

@@ -10,6 +10,14 @@ setup_documentation() {
 
 setup_database_documentation() {
   case $projectinit_database_type in
+    "pgsql" )
+      cp -f "${tool_dir}/src/database/pgsql/container/docker/v1/template/documentation/index.adoc" "${project_root_dir}/doc/projectinit/postgresql.adoc"
+      case $projectinit_container_type in
+        "docker" )
+          perl -pi -e "s/~~~implemented configuration~~~/$(<"${tool_dir}/src/database/pgsql/container/docker/v1/template/documentation/implemented_configuration.adoc" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${project_root_dir}/doc/projectinit/postgresql.adoc"
+          ;;
+      esac
+      ;;
     "percona" )
       cp -f "${tool_dir}/src/database/percona/v1/template/documentation/index.adoc" "${project_root_dir}/doc/projectinit/percona_mysql.adoc"
       case $projectinit_container_type in