feat(docs, docker-best-practices): add minimum-poetry and poetry-mult…

…istage

docs/docker-best-practices.md

@@ -11,31 +11,68 @@ menu:
 
 # Docker Best Practices
 
-## Introduction
+- [Best Practices](#best-practices)
+- [Imags examples and use cases](#imags-examples-and-use-cases)
+  - [Minimum-poetry](#minimum-poetry)
+    - [Specifics](#specifics)
+    - [Use cases](#use-cases)
+  - [Poetry-multistage](#poetry-multistage)
+    - [Specifics](#specifics-1)
+    - [Use cases](#use-cases-1)
+
+Poetry is a very valuable tool for increasing the robustness and reproducibility of a virtual environment on which your python code is based. When integrating Poetry into a Docker image, adopting some best practices will help improve build efficiency, container security, and help achieve lighter images. In this section, we will explore best practices for creating optimized and secure Docker images for projects managed with Poetry.
+This section is a developing project, so you are warmly invited to contribute new suggestions.
+
+## Best Practices
 
-....blabla
 The following best practices should be kept in mind
 
-- [optional] set the latest python version, in order to get the latest patch
-- [highly suggested] use pip to install poetry
-- [critical] never hardcode credentials to private sources
-- ...
+- [optional] Set the latest python version, in order to get the latest security patch.
+  - CAVEAT: It might reduce the reproducibility of the code, between one image build and another, since some function might change from one version of python to another.
+- [highly suggested] Use `pip` to install poetry (see https://python-poetry.org/docs/#ci-recommendations).
+- [highly suggested] Clear Poetry cache after the installation.
+- [critical] Never hardcode credentials to private sources.
+- [optional] Install Poetry in a dedicated venv
+- [highly suggested] Install the virtual env in the Python project (see `POETRY_VIRTUALENVS_IN_PROJECT`). This will be more convenient for carrying the env around with everything you need, making the project more self-contained.
+- [highly suggested] Take advantage of Docker's layer caching mechanism to rebuild the image much faster. This means that you should reduce the variability points in the Dockerfile and the files linked to it (e.g. ARGS that may change). In alternative you can move them as far down in the Dockerfile as possible. For more info please see:
+  - https://docs.docker.com/build/cache/
+  - https://pythonspeed.com/docker/
+- [highly suggested] copy source code only after `poetry install`. For more info see:
+  - https://python-poetry.org/docs/faq/#poetry-busts-my-docker-cache-because-it-requires-me-to-copy-my-source-files-in-before-installing-3rd-party-dependencies
+
+## Imags examples and use cases
+
+Below are general examples of Docker images, along with their typical use cases, to help you get started with developing your specific application.
+
+### Minimum-poetry
+
+[Minimum-poetry](../docker-examples/minimum-poetry/README.md) is the minimum-constructible image containing poetry, from an official python base image.
+
+Expected size: ~218 MB, virtual env layer excluded.
+
+#### Specifics
+
+- Based on *python:3.11-slim* official image.
+- Just installs Poetry via pip.
+- A basic virtual environment is created passing a pyproject.toml, via build context.
+
+#### Use cases
 
-## Use cases
+As in the case of [Minimum-poetry](../docker-examples/minimum-poetry/README.md), this image is useful when you need to create a virtual self-content  environment, complex at will.
 
-The following are general use cases that you can use a starting point for your specific case
+### Poetry-multistage
 
-### UC1: Dev environment
+[Poetry-multistage](./../docker-examples/poetry-multistage/README.md) is a minimum-constructible multistage image containing Poetry, from an official Python base image. It is very similar to [Minimum-poetr](#minimum-poetry), except that it may be more complex as it implements at least 2 more best practices.
 
-Here is an example of how to create a dev container aimed to host a basic development env. Once the image is built nobody can make OS changes, except the admin. An example of usage is a container used by a team.
+Expected size: ~130MB, virtual env layer excluded.
 
 #### Specifics
 
-- Unprivileged User.
-- multistage, in order to make the image lighter
-- ...
+- Based on *python:3.11-slim* official image.
+- Installs Poetry via pip.
+- A basic virtual environment is created in the project folder (`POETRY_VIRTUALENVS_IN_PROJECT=1`, `POETRY_VIRTUALENVS_CREATE=1`).
+- A multistage build is implemented, allowing you to directly copy only the project virtual env and set its reference in path, so as to minimize memory waste.
 
-#### Dockerfile
+#### Use cases
 
-FROM python .......
-....
+The usefulness of this image lies in the Dockerfile that shows an example of how to build a multistage image, to optimize the construction of the virtual environment. Always use it as a starting point for your images that you want to optimize in size.