Metadata-Version: 2.1
Name: mlflow-aws-rds-iam
Version: 0.3.0
Summary: MLflow plugins adding AWS RDS IAM auth for tracking and model registry stores
Home-page: https://gitlab.com/lzinsou/mlflow-aws-rds-iam
Keywords: mlflow,plugin,mlops,aws,rds,iam,postgresql,mysql
Author: Loris Zinsou
Author-email: lzinsou@protonmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: StrEnum (>=0.4) ; python_version < "3.11"
Requires-Dist: boto3 (>=1.26,<2)
Requires-Dist: boto3-stubs[rds] (>=1.26,<2)
Requires-Dist: mlflow (>=2,<3)
Requires-Dist: sqlalchemy (>=2.0.24)
Project-URL: Repository, https://gitlab.com/lzinsou/mlflow-aws-rds-iam
Description-Content-Type: text/markdown

MLflow AWS RDS IAM Auth Plugins
===============================

MLflow plugins adding AWS RDS IAM authentication for tracking store and model registry store.


Requirements
------------

- Python 3.10+  
- MLflow 2+  
- Boto3

Only Postgres and MySQL are supported (the AWS RDS database engines supported by MLflow as remote backend store).


Installation
------------

```console
pip install mlflow-aws-rds-iam
```


Getting Started
---------------

The plugins are mainly intented for the use of MLflow in server mode, allowing [AWS RDS IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html) for the backend store.

```console
mlflow server --backend-store-uri <database URI> --artifacts-destination <artifact store URI>
```


Configuration
-------------

If a *password* is provided in the database URI, AWS IAM authentication will be skipped, *effectively disabling the plugins*.

*Credentials* are required in order to use AWS IAM authentication. Refer to [Boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for configuration instructions.

*SSL connection to the database is enabled by default*, but can be disabled with the environment variable `MLFLOW_DISABLE_DB_SSL=true`.

Debug log of the plugins and underlying libraries (boto3, urllib3) can be enabled with `MLFLOW_AWS_RDS_IAM_DEBUG=true`.


License
-------

This project is licensed under the terms of the MIT license.


A [yzr](https://www.yzr.ai/) Free and Open Source project.

