feat: add prefect server guide ; docs: update mlflow's README.md

Author: Samirnunes

mlflow-server/README.md

@@ -15,4 +15,8 @@ The necessary env vars are:
 - `MLFLOW_HOST = 0.0.0.0`
 - `MLFLOW_PORT = 80`
 
-Each description of the `MLFLOW_` variables is present in the reference:  https://mlflow.org/docs/latest/cli.html
+Each description of the `MLFLOW_` variables is present in the reference:  
+
+- https://mlflow.org/docs/latest/cli.html
+
+To authenticate in the API, you must configure in the client the env vars `MLFLOW_TRACKING_USERNAME`, `MLFLOW_TRACKING_PASSWORD` and `MLFLOW_TRACKING_URI` with the same values as the server's.

prefect-server/.dockerignore

@@ -0,0 +1,48 @@
+# IDEs
+.idea
+.vscode
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Project stuff
+.DS_Store
+mysql_data
+postgres_data
+
+# Git
+.git
+.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+
+# IPython
+profile_default/
+ipython_config.py
+
+# C extensions
+*.so
+
+# Docker
+Dockerfile
+Dockerfile.local
+docker-compose.yml
+
+# Documents
+README.md
+DEVGUIDE.md
+.pre-commit.yaml
+.coverage
+
+# Tests
+/tests

prefect-server/.gitignore

@@ -0,0 +1,157 @@
+# AI Project
+secrets/
+data/
+chroma/
+Dockerfile.local
+
+# Common Files
+*.pdf
+*.docx
+*.csv
+*.parquet
+*.txt
+*.jpg
+*.jpeg
+*.png
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

prefect-server/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: check-yaml
+        always_run: true
+    -   id: end-of-file-fixer
+        always_run: true
+    -   id: trailing-whitespace
+        always_run: true
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+        - id: ruff
+          always_run: true
+          types_or: [ python, pyi ]
+          args: [ --fix, --exclude=__init__.py]
+        - id: ruff-format
+          always_run: true
+          types_or: [ python, pyi]
+          args: [--line-length=85]
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+    -   id: mypy
+        args: [--ignore-missing-imports,
+               --allow-redefinition,
+               --follow-imports=silent,
+               --disallow-untyped-defs,
+               --warn-unreachable,
+               --show-error-context,
+               --exclude=__init__.py]

prefect-server/Dockerfile

@@ -0,0 +1,45 @@
+FROM --platform=linux/amd64 python:3.12.6-slim
+
+ENV PORT 80
+ENV APP_NAME prefect_server
+ENV WORKDIR /app
+
+ENV PYTHONPATH ${WORKDIR}/${APP_NAME}
+ENV PYTHONUNBUFFERED 1
+
+WORKDIR ${WORKDIR}
+EXPOSE ${PORT}
+
+# System update
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends netcat-openbsd curl git wget bash && \
+    rm -rf /var/lib/apt/lists/* /var/tmp/*
+
+# Install Poetry
+RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry POETRY_VERSION=1.8.5 python && \
+    cd /usr/local/bin && \
+    ln -s /opt/poetry/bin/poetry && \
+    poetry config virtualenvs.create true && \
+    poetry config virtualenvs.path --unset && \
+    poetry config virtualenvs.in-project true
+
+# Copy poetry.lock* in case it doesn't exist in the repo
+COPY ./pyproject.toml ./poetry.lock* ./
+
+
+# Installing poetry dependencies
+RUN poetry lock --no-update && \
+    poetry install --no-root --only main
+
+COPY . ./
+
+RUN wget https://github.com/Droplr/aws-env/raw/master/bin/aws-env-linux-amd64 -O /app/aws-env
+RUN chmod +x /app/aws-env
+
+# Running app with FastAPI
+RUN poetry run pip install "fastapi[standard]"
+CMD ["/bin/bash", "-c", \
+      "eval $(./aws-env) && \
+      poetry run fastapi run \
+      src/${APP_NAME}/api/app.py \
+      --port ${PORT}"]

prefect-server/README.md

@@ -0,0 +1,26 @@
+# MLflow Server Deploy Guide
+
+This repository contains a `Dockerfile` and an environment with `Poetry` that can be used to deploy a self-hosted Prefect server, considering your env vars are configured in AWS Systems Manager. Besides, the server has basic auth, that is, you must authenticate using an username and a password.
+
+The necessary env vars are:
+
+- `AWS_ACCESS_KEY_ID`
+- `AWS_REGION`
+- `AWS_SECRET_ACCESS_KEY`
+- `PREFECT_API_DATABASE_CONNECTION_URL`
+- `PREFECT_API_URL`
+- `PREFECT_RUNNER_HEARTBEAT_FREQUENCY`
+- `PREFECT_RUNNER_ENABLE`
+- `PREFECT_RUNNER_MISSED_POOLS_TOLERANCE`
+- `PREFECT_RUNNER_PROCESS_LIMIT`
+- `PREFECT_RUNNER_POOL_FREQUENCY`
+- `PREFECT_SERVER_API_HOST = 0.0.0.0`
+- `PREFECT_SERVER_API_PORT = 80`
+- `PREFECT_SERVER_API_AUTH_STRING` (must be in the format `<username>:<password>`)
+
+Each description of the `PREFECT_` variables is present in the references:  
+
+- https://docs-2.prefect.io/latest/api-ref/prefect/settings/
+- https://docs-2.prefect.io/latest/guides/settings/
+
+To authenticate in the API, you must configure in the client an env var called `PREFECT_API_AUTH_STRING` that must have the same value as the `PREFECT_SERVER_API_AUTH_STRING` server variable, and the env var `PREFECT_API_URL` with the same value as the server's.

prefect-server/poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

prefect-server/pyproject.toml

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "prefect_server"
+version = "1.0.0"
+description = ""
+authors = ["Samir Nunes da Silva"]
+readme = "README.md"
+packages = [{include = "prefect_server", from="src"}]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+prefect = "^3.1.9"
+boto3 = "^1.35.87"
+asyncpg = "^0.30.0"
+pydantic-settings = "^2.7.0"
+prometheus-client = "^0.21.1"
+fastapi = "^0.115.6"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.2"
+pytest-cov = "^5.0.0"
+ipykernel = "^6.29.5"
+pytest-asyncio = "^0.24.0"
+isort = "^5.13.2"
+black = "^24.10.0"
+mypy = "^1.13.0"
+pre-commit = "^4.0.1"
+pytest-deadfixtures = "^2.2.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"