The project demonstrates a simple way to containerize a web application called MkDocs (https://www.mkdocs.org)
- Python >= 2.7
- Docker = 19.03.0
$ git clone https://gitlab.com/lok.bruce/mkdocs.git
Here are the file structure, mkdocs.yml and directory docs/ are where you can customize your Mkdocs.
The rest of files are mainly for build file and test script
.
├── README.md
├── dockerfile
├── docs
│ ├── about.md
│ └── index.md
├── http_test.py
├── mkdockerize.sh
├── mkdocs.yml
└── .gitlab-ci.yml
run the shell script mkdockerize.sh locally, the script will:
- Check and remove the existing MkDocs container
- Build image of Mkdocs from Dockerfile.
- Run Mkdocs as a container with port 8000 expose.
Then you should be able to access http://127.0.0.1:8000 from your local web browser.
you can also view the status of running container with docker ps
$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
6ea5c6e3d9d2 py-mkdocs:latest "mkdocs serve" 5 hours ago Up 5 hours 0.0.0.0:8000->8000/tcp crazy_lovelace
Since Mkdocs is running as a container, one can attach to the container by:
$ docker exec -it <container_id> /bin/bash
then you may change any config in mkdocs.yml and docs/. The Mkdocs process will automatically pick up the changes you made.
One can also change the mkdocs.yml and docs/ where you clone the project, then re-run mkdockerize.sh. However the existing pod will be killed, and started new one with new config.
This example pipelines contains three stages test, build and deploy:
It will simply run two CI jobs to check code quality.
- Runs python syntax check
- Runs Sonarqube check (Just a placeholder, will be run on free SaaS.)
It will build the docker image from Dockerfile, then push to the GitLab's built-in registry.
When code merge to master branch, CI job will run mkdoc app as docker container. Follow by self testing if mkdoc http service is up.