fix README

Author: maxadamo

Dockerfile

@@ -7,16 +7,19 @@ COPY --chmod=644 files/requirements.txt /requirements.txt
 
 RUN apt update && \
     apt full-upgrade -y && \
-    apt install -y python3-pip supervisor git && \
-    apt clean
+    apt install -y python3-pip supervisor git
 RUN pip3 install --disable-pip-version-check --no-compile --requirement /requirements.txt
 RUN git clone https://gitlab.geant.net/devops/devops-wiki.git /code
 RUN /usr/local/bin/mkdocs build --site-dir /usr/share/nginx/html
+RUN apt-get -y --purge remove python3-pip && \
+    apt-get -y --purge autoremove && \
+    apt-get clean
 RUN rm -rf /root/.cache/pip/* /var/lib/apt/lists/*
 
+COPY --chmod=644 files/default.conf /etc/nginx/conf.d/default.conf
 COPY --chmod=644 files/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
 COPY --chmod=644 files/hook.py /hook/hook.py
 COPY --chmod=755 files/05-scripts.sh /docker-entrypoint.d/05-scripts.sh
 COPY --chmod=755 files/pull-updates.sh /usr/local/bin/pull-updates.sh
 
-EXPOSE 8000 8080
+EXPOSE 8000

Dockerfile-local

@@ -12,9 +12,10 @@ RUN pip3 install --disable-pip-version-check --no-compile --requirement /require
 RUN git clone https://gitlab.geant.net/devops/devops-wiki.git /code
 RUN /usr/local/bin/mkdocs build --site-dir /usr/share/nginx/html
 
+COPY --chmod=644 files/default.conf /etc/nginx/conf.d/default.conf
 COPY --chmod=644 files/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
 COPY --chmod=644 files/hook.py /hook/hook.py
 COPY --chmod=755 files/05-scripts.sh /docker-entrypoint.d/05-scripts.sh
 COPY --chmod=755 files/pull-updates.sh /usr/local/bin/pull-updates.sh
 
-EXPOSE 8000 8080
+EXPOSE 8000

README.md

@@ -1,15 +1,20 @@
-# Terraformator
+# DevOps Wiki
 
-Terraform unchained, a django UI for Terraform, with VMware, NSX and Infoblox
+Documentation as a code Wiki using MkDocs-material.
 
+This images provides 
+
+1. [Preamble](#preamble)
 1. [Docker instructions](#docker-instructions)
 1. [Create a new release](#create-a-new-release)
 
-```bash
-cd ~terraform/terraformator
-./manage.py makemigrations
-./manage.py migrate --run-syncdb
-```
+## Preamble
+
+This container provides a hook URL (`/hook`) which trigger a pull from Git and rebuild the documentation site. You'll have to create a trigger on your CI.
+
+You also need to supply a URL in `Dockerfile`/`Dockerfile-local`, for the repository (publicly available on read-only) where you store your Wiki code.
+
+There is also a health-check URL (`/ping`).
 
 ## Docker instructions
 

files/default.conf

@@ -0,0 +1,56 @@
+server {
+    listen       80;
+    listen  [::]:80;
+    server_name  localhost;
+
+    #access_log  /var/log/nginx/host.access.log  main;
+
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+    }
+
+    #error_page  404              /404.html;
+
+    # redirect server error pages to the static page /50x.html
+    #
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+
+    location /hook {
+        proxy_pass http://localhost:8080/hook;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+    }
+
+    location /ping {
+        proxy_pass http://localhost:8080/ping;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+    }
+
+    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
+    #
+    #location ~ \.php$ {
+    #    proxy_pass   http://127.0.0.1;
+    #}
+
+    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
+    #
+    #location ~ \.php$ {
+    #    root           html;
+    #    fastcgi_pass   127.0.0.1:9000;
+    #    fastcgi_index  index.php;
+    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
+    #    include        fastcgi_params;
+    #}
+
+    # deny access to .htaccess files, if Apache's document root
+    # concurs with nginx's one
+    #
+    #location ~ /\.ht {
+    #    deny  all;
+    #}
+}

files/hook.py

@@ -4,18 +4,26 @@
 """
 import subprocess
 from flask import Flask
+from flask import jsonify
 
-hook = Flask(__name__)
+HOOK = Flask(__name__)
 
 
-@hook.route('/hook', methods=['GET', 'POST'])
+@HOOK.route("/hook", methods=["GET", "POST"])
 def trigger_script():
     """Trigger the script to pull the latest changes from MkDocs"""
     try:
-        subprocess.run(['/usr/local/bin/pull-updates.sh'], check=True)
-        return 'MkDocs updated!', 200
+        subprocess.run(["/usr/local/bin/pull-updates.sh"], check=True)
+        return "MkDocs updated!", 200
     except subprocess.CalledProcessError as e:
-        return f'Error updating MkDocs: {e}', 500
+        return f"Error updating MkDocs: {e}", 500
 
-if __name__ == '__main__':
-    hook.run(debug=False)
+
+@HOOK.route("/ping")
+def health_check():
+    """health-check"""
+    return jsonify(status="OK")
+
+
+if __name__ == "__main__":
+    HOOK.run(debug=False)

files/pull-updates.sh

@@ -3,5 +3,5 @@ PATH=/usr/sbin:/usr/bin:/sbin:/bin:/usr/local/sbin:/usr/local/bin
 
 echo "Hook received. Pulling updates..."
 cd /code
-git pull --quiet --rebase origin main  # there seems to be a problem with TTY when using git pull
+git pull --quiet --rebase origin main  # I noticed an issue with TTY when using git pull, hence the --quiet
 mkdocs build --site-dir /usr/share/nginx/html

files/supervisord.conf

@@ -16,5 +16,5 @@ stdout_logfile_maxbytes=0
 redirect_stderr=true
 user=root
 directory=/hook
-command=/usr/local/bin/gunicorn -b 0.0.0.0:8080 -t 100 --worker-tmp-dir=/dev/shm -w 2 hook:hook
+command=/usr/local/bin/gunicorn -b 0.0.0.0:8080 -t 100 --worker-tmp-dir=/dev/shm -w 2 hook:HOOK
 # for debug purpose you can add: --log-level debug