Updated README.md and refactored opentelemetry docker-compose.

Signed-off-by: Pavel Kirilin <win10@list.ru>

Author: s3rius

fastapi_template/template/{{cookiecutter.project_name}}/README.md

@@ -1,33 +1,112 @@
 # {{cookiecutter.project_name}}
 
+This project was generated using fastapi_template.
 
-Start a project with:
+## Poetry
+
+This project uses poetry. It's a modern dependency management
+tool.
+
+To run the project use this set of commands:
 
 ```bash
-docker-compose -f deploy/docker-compose.yml --project-directory . up
+poetry install
+poetry run python -m {{cookiecutter.project_name}}
 ```
 
-If you want to develop in docker with autoreload, use this command:
+This will start the server on the configured host.
+
+You can find swagger documentation at `/api/docs`.
+
+You can read more about poetry here: https://python-poetry.org/
+
+## Docker
+
+You can start the project with docker using this command:
+
+```bash
+docker-compose -f deploy/docker-compose.yml --project-directory . up --build
+```
+
+If you want to develop in docker with autoreload add `-f deploy/docker-compose.dev.yml` to your docker command.
+Like this:
 
 ```bash
 docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up
 ```
 
-This command exposes application on port 8000, mounts current directory and enables autoreload.
+This command exposes the web application on port 8000, mounts current directory and enables autoreload.
 
 But you have to rebuild image every time you modify `poetry.lock` or `pyproject.toml` with this command:
 
 ```bash
 docker-compose -f deploy/docker-compose.yml --project-directory . build
 ```
 
+{%- if cookiecutter.otlp_enabled == "True" %}
+## Opentelemetry 
+
+If you want to start your project with opentelemetry collector 
+you can add `-f ./deploy/docker-compose.otlp.yml` to your docker command.
+
+Like this:
+
+```bash
+docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.otlp.yml --project-directory . up
+```
+
+This command will start opentelemetry collector and jaeger. 
+After sending a requests you can see traces in jaeger's UI
+at http://localhost:16686/.
+
+This docker configuration is not supposed to be used in production. 
+It's only for demo purpose.
+
+You can read more about opentelemetry here: https://opentelemetry.io/
+{%- endif %}
+
+## Configuration
+
+This application can be configured with environment variables.
+
+You can create `.env` file in the root directory and place all
+environment variables here. 
+
+All environment variabels should start with "{{cookiecutter.project_name | upper}}_" prefix.
+
+For example if you see in your "{{cookiecutter.project_name}}/settings.py" a variable named like
+`random_parameter`, you should provide the "{{cookiecutter.project_name | upper}}_RANDOM_PARAMETER" 
+variable to configure the value.
+
+An exmaple of .env file:
+```bash
+{{cookiecutter.project_name | upper}}_RELOAD="True"
+{{cookiecutter.project_name | upper}}_PORT="8000"
+{{cookiecutter.project_name | upper}}_ENVIRONMENT="dev"
+```
+
+You can read more about BaseSettings class here: https://pydantic-docs.helpmanual.io/usage/settings/
 
 ## Pre-commit
 
 To install pre-commit simply run inside the shell:
 ```bash
 pre-commit install
 ```
+
+pre-commit is very useful to check your code before publishing it.
+It's configured using .pre-commit-config.yaml file.
+
+By default it runs:
+* black (formats your code);
+* mypy (validates types);
+* isort (sorts imports in all files);
+* flake8 (spots possibe bugs);
+* yesqa (removes useless `# noqa` comments).
+
+
+You can read more about pre-commit here: https://pre-commit.com/
+
 {%- if cookiecutter.enable_kube == 'True' %}
 
 ## Kubernetes

fastapi_template/template/{{cookiecutter.project_name}}/conditional_files.json

@@ -178,11 +178,18 @@
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_mysql.sql"
         ]
     },
+    "Opentelemetry support": {
+        "enabled": "{{cookiecutter.otlp_enabled}}",
+        "resources": [
+            "deploy/docker-compose.otlp.yml",
+            "deploy/otel-collector-config.yml"
+        ]
+    },
     "SQLite DB": {
         "enabled": "{{cookiecutter.db_info.name == 'sqlite'}}",
         "resources": [
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/0_20210928165300_init_sqlite.sql",
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_sqlite.sql"
         ]
     }
-}
+}

fastapi_template/template/{{cookiecutter.project_name}}/deploy/docker-compose.dev.yml

@@ -8,24 +8,3 @@ services:
     - .:/app/src/
     environment:
       {{cookiecutter.project_name | upper}}_RELOAD: "True"
-      {%- if cookiecutter.otlp_enabled == "True" %}
-      {{cookiecutter.project_name | upper}}_OPENTELEMETRY_ENDPOINT: "http://otel-collector:4317"
-      {% endif %}
-
-  {%- if cookiecutter.otlp_enabled == "True" %}
-  otel-collector:
-    image: otel/opentelemetry-collector-contrib:0.53.0
-    volumes:
-      - ./deploy/otel-collector-config.yml:/config.yml
-    command: --config config.yml
-    ports:
-      # Collector's endpoint
-      - "4317:4317"
-
-  jaeger:
-    image: jaegertracing/all-in-one:1.35
-    hostname: jaeger
-    ports:
-      # Jaeger UI
-      - 16686:16686
-  {%- endif %}

fastapi_template/template/{{cookiecutter.project_name}}/deploy/docker-compose.otlp.yml

@@ -0,0 +1,21 @@
+services:
+  api:
+    environment:
+      {{cookiecutter.project_name | upper}}_OPENTELEMETRY_ENDPOINT: "http://otel-collector:4317"
+
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:0.53.0
+    volumes:
+      - ./deploy/otel-collector-config.yml:/config.yml
+    command: --config config.yml
+    ports:
+      # Collector's endpoint
+      - "4317:4317"
+
+  jaeger:
+    image: jaegertracing/all-in-one:1.35
+    hostname: jaeger
+    ports:
+      # Jaeger UI
+      - 16686:16686
+