update docs

Signed-off-by: Anton Kukushkin <kukushkin.anton@gmail.com>
awslabs · Feb 16, 2024 · c3fceed · c3fceed
1 parent 16ae342
commit c3fceed
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 3 deletions.
diff --git a/modules/mlflow/mlflow-fargate/README.md b/modules/mlflow/mlflow-fargate/README.md
@@ -4,6 +4,8 @@
 
 This module runs Mlflow on AWS Fargate.
 
+By default, uses EFS for backend storage.
+
 ### Architecture
 
 ![Mlflow on AWS Fargate Module Architecture](docs/_static/mlflow-fargate-module-architecture.png "Mlflow on AWS Fargate Module Architecture")
@@ -63,13 +65,15 @@ parameters:
 - `ECSClusterName`: Name of the ECS cluster.
 - `ServiceName`: Name of the service.
 - `LoadBalancerDNSName`: Load balancer DNS name.
+- `EFSFileSystemId`: EFS file system id.
 
 #### Output Example
 
 ```
 {
   "ECSClusterName": "mlops-mlops-mlflow-mlflow-fargate-EcsCluster97242B84-xxxxxxxxxxxx",
   "ServiceName": "mlops-mlops-mlflow-mlflow-fargate-MlflowLBServiceEBACC043-xxxxxxxxxxxx",
-  "LoadBalancerDNSName": "xxxxxxxxxxxx.elb.us-east-1.amazonaws.com"
+  "LoadBalancerDNSName": "xxxxxxxxxxxx.elb.us-east-1.amazonaws.com",
+  "EFSFileSystemId": "fs-xxxxxxxxxxx",
 }
 ```
diff --git a/modules/mlflow/mlflow-fargate/app.py b/modules/mlflow/mlflow-fargate/app.py
@@ -38,7 +38,6 @@ def _param(name: str) -> str:
 task_memory_limit_mb = os.getenv(_param("TASK_MEMORY_LIMIT_MB"), DEFAULT_TASK_MEMORY_LIMIT_MB)
 autoscale_max_capacity = os.getenv(_param("AUTOSCALE_MAX_CAPACITY"), DEFAULT_AUTOSCALE_MAX_CAPACITY)
 artifacts_bucket_name = os.getenv(_param("ARTIFACTS_BUCKET_NAME"))
-# TODO: add persistent backend store
 
 if not vpc_id:
     raise ValueError("Missing input parameter vpc-id")
@@ -80,6 +79,7 @@ def _param(name: str) -> str:
             "ServiceName": stack.service.service.service_name,
             "LoadBalancerDNSName": stack.service.load_balancer.load_balancer_dns_name,
             "LoadBalancerAccessLogsBucketArn": stack.lb_access_logs_bucket.bucket_arn,
+            "EFSFileSystemId": stack.fs.file_system_id,
         }
     ),
 )

diff --git a/modules/mlflow/mlflow-fargate/docs/_static/mlflow-fargate-module-architecture.png b/modules/mlflow/mlflow-fargate/docs/_static/mlflow-fargate-module-architecture.png
diff --git a/modules/mlflow/mlflow-fargate/docs/_static/mlflow-fargate-module-architecture.xml b/modules/mlflow/mlflow-fargate/docs/_static/mlflow-fargate-module-architecture.xml
@@ -1 +1 @@
-<mxfile modified="2024-02-14T14:20:45.369Z" host="design-inspector.a2z.com" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36" etag="9M_D4LgKPnhiKZj73G-q" version="10.1.8" type="device"><diagram id="MkE2kDHcsj_W3wBg-wOKL" name="Page-1">7V1bd5u6Ev41eVSWBOL26NhJd85uz+lK2u72KUuAsGkweAGO7fz6M+JiA8bE2cExpKReiTWI0W2k+fRpoBfyeL7+FLLF7Etgc+9Cwvb6Qp5cSJKhUvgtBJtUoCqZYBq6dioiO8G9+8wzIc6kS9fmUSljHARe7C7KQivwfW7FJRkLw2BVzuYEXrnUBZvyPcG9xbx96T+uHc9SqS5pO/lf3J3O8pKJaqRX5izPnLUkmjE7WBVE8vWFPA6DIE6/zddj7om+y/slu8/n61hcubV/MG+ZVUvVthrueBQsQ4tPeGSF7iIOQrgpzIRp7ocLeZTXgocu89xnFruBj554GMHfNNdTloVlXRbWKM7KvOdz5seuNWExGwd+zFyfh8doT++OQ9effnZjHjIvHbuY+3Gp1YswWPAwzqxmFsdivEcX0g18IHvgBdPNZcStZejGm0s2Z8+Bf2nzJ7jsBEvfTmoACdtl05DN0ZMbLbc1AzmTJEUxFBVZsu0gakkWMqluQBJrjqoz0zLSIb5J63x7d7vXra+qFVixO/WR60cLsFPRlzdWMF8EPrQ8goROmY5NxUGKSiVEGdGQoegK4qZjm6riUJNb7XZNtIliPkdzMWVhPECCqSIbiqEhKukyoo6qIB0bGDGuao5hy9ygRrFT4Eu9JeRXa2wzv5SZe73pb2ddWLaL1xg86YnBk8Hg/ziDD8zfwllJ2GMm+MukXZm5gmFYrvdts8j6fMpBv2uhbd+l+fKZ4sl3JJh8Gf+H4/U39PN5Ypn3zyjVVp5bUbzJnVooeoULDfhCvlrNwDDvFywZ5RV4cZDN4rmoFoGvjut5Y+hjaMnEhxqAyGbRLLldXAejh+5g3siD4QaZGcRxMIcLaUXFZb4+OK0zUWg73xdgt2mtCi48ingsOuNHcWrJhdZ94sGcx+EGMuelqFlfZgZDaDbPVzsHTlU9lc0KzlvSKwvCdKt7ZwJHrj5N49KNRenkE5w6CjEM4iBHtlSY4BQmuIkxwkRWVMxMQ3LooQm+rcNqtbpcyZdBKKYrqDPErBWjIUkIjAZFG2j3GvlQoByLSdPmElZaPaYC36IoDpdWvAy5qIdJOWeWjjDlCqIcFi9dNWBdtRXVMQ2qmZrZ7QZ+xDW60dl+ebyWHid/WdHvh3/k1dUUrf739+f3ccBYsSxFJhayJUoQNSwZ2mELa5E1TbMUKqnO0e1oXl66hiXacpui+qnnbPCiqhcLF+VCa9RpnPihVGTmgh9fx7kMNJrVfEnDC3fXuuWnhVV2xA+2Tham/GukL+9+Pv09iaNw/IAUpdERLwJXTDT4rlzBBxbnMb5Q4MpYpC4lpSKoprWygOynhI6yoJrWygJSVU8q5ZNqBQuCvVRJPa6UjwsVhI98FSxjmPR8vN3LC3giUIELhl/BIAWEUgdgHLCxjE0gUp7OOl5ohd14MpTzdbKuX7JVJOHLKSCjRVLmrZW4zJrLD2LoQUEcBo88rxQszhLVdULrAVMVI8WBKIVlKY87wtIiaIGY8UlqIuOs1oUiRqMr7UovAjB8TpxlkDLOUvdxlpzzOCWcJUut4aymadcNnNW4jjdXv2vr+IA3avDGgKN7j6Mbp2iCFl5TuIQxFoXD6niTlGzNYAGBYlOYcmy53/1HP1j5XwVB3UmA+q6orpkbmTFADN4xgExVGwEZt6c8hwlBGM+CaeAz73onvSpzJwUUwtdu/FOIAeGkqV9ZJvF9si4mNoXEV2gCeD/Rb6nMB0/4M1cqEr92WkVypypJbYqpqrLfPI43GQ5iyzgQIGvbrM+BgCFJOWnXida/hCCKi0D9LiQ/pmHhlDduV4jWIigJuQeG/MQrGk4EMFIz6i3AyKvfNYBx5TH/8b/gi28nr2DVWmbQ9x2UTRwLqypHsq4KWMIx0mVMkWpxh4L3xUzBLTRDO3U7VKKZHGY5shxAVpRhgpim2Egn3JYBV0hKhszfyfGrClE0VcJIoybUR8McnI1hI9MwHUU1VcukA4HWLQJtQCWv45qux/dw09hbRsIpv5V1csCnspiXgU7Dovg64qmWfKojoGpJqH0iqpQtoYZqSqgK62TavpDsZ8vZpH1hnayOOqveTWruJpW7DxNXFfIG/t2I8dgjtODajaZfY1q4NnFDUJR6e18gtgqvBPdMsDIGl1HDRDnJT5Umyjmoz8KAvwaRm6nfntc1k1QW1ErMotLR4AskG0tWRUg47lrU4wDrlq+/Ked2Bcla9i03/vMxXnKGVnLGS9LUPcZLryG8Tn6u2JdYh3fBb71huyysgTfmFElMA8esMo6YqSiIQSUdnZqSZbTsZDvAdvWaC6p48zOwQj06wOwcErt7M/7iVngM9pIG7DVgrw+FvYThnw93qRou4a66k8az4K6cmO4n7upotMjJcRcYlGE4EkFMIhhRrBngwySGVMdmALyIww8fqA246zy4625AW51DW1sMdQ/LNx6BB3NYkvcelPN6sFULqyL5GFS1e+RlQFWdR1UqHsmy9jpUJWkaIeofhKrA7rsDqiS9I2SW1mtQ1fIhXm9AFeeUmrLBkEVNE0AVuHzTUAmSHKpzixgyzw1nAFXdAFUHvPYAszoDs2rBUmPQU/2aZDQip7fEPOWxStsApJ7FKmVPgR0Rq9SiAz5VqFLD4PfWnRp/qDv9cIEjPVrjP3zY07+LT9PbHa2zhdmduhmvjbI7J3Nz7bEIyoVcnwNmwx/YHTPfOhSqVH8olup48EDDg5ncn6wfL+MSfWB0+sPoDOdkx5yT1c+F87E88HOplHmergQt6b0Gpi17w94AU1s3JMdhGlJ1jBHVsYZ0wyBIURQsEdnm28PZ7gDTP5vnafDxA9fTY67nwLPDJ3vA7SzPkmn7BM2Bdks9YGiahqwHnrC5+l1zhV19CqvtbW7zfOjOPvfD0yoDKTg8TXbaGOab/Pkv/I1Fj28OZ47ArcbLxUOcKHuZryHNITgv7t4LYOLIjXyZN8jeplMhGTC+ur6R6nbuz7AwXJYaKbp3x1rA0CWsxbk255RICZ1T2J0TTd2KCht0pWaDTrV8Z3+654r6HYvRti/vzSa9j45ieI/Ox6Yhqr5r4B46Azxa4x6a8cGfEWjSvB17OdKkxzxGX9BCc/W7hha6uv9/n+P6gcYYaIwOoNOBxnh/NNEcHjKgiWPQxFlesZfcOgpDtilkyMJ5dpq/CsGODFFzjiOPU8Al7/FifllSKyaf1mBnx9umtAB1+hK80Fz9Aep0CeoM7/8boM4AdfoEdV4+sUm5Lnw7+gK/7wLvwGPRrzi0CRMlR8AnqRE+vSkctP4gZqwRmdwcOrXpXKBnAkh4eP3E0zBjcjj4M0jw5MWZjokU+eyvP2l2vH1FQS3jhuF4aDgeGo6H/uXxUI2jPMMJ0QBvTsLk0FMxOWchX+RjyRf9HORLO56d9tuzt/z+rjPzG/LH4DdO/gDpwG8M/MbAb7wrv/E9auG/NWBW5i1eBBJF57gPJPLd+3LujRKVRxANSXuvmPU4TUBG3SOq9VxEAYXUcinnYgsIqZyj1LzXS65hC9STswVyvzFFy164M2zBC8sr0y0F27aNGDN0RHWLI0aYhRRmKA7smSnXWu6ZDpAFvd5Kp2vysHt+N+cpei0I4kLWT8JkvggDBuH/AQ==</diagram></mxfile>
+<mxfile modified="2024-02-16T16:21:46.131Z" host="design-inspector.a2z.com" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36" etag="8RrXlRqHpwgGKitaxPPN" version="10.1.8" type="device"><diagram id="MkE2kDHcsj_W3wBg-wOKL" name="Page-1">7V1bd5s4EP41eVSOBOL26NhJN7vtbk/Spu1TjgBh02DwARzb+fU74mIDxsRp7BgS2pzEGoSuo5lPnwZ8Jg+ny08hm02+BDb3ziRsL8/k0ZkkGSqF30KwSgWqkgnGoWunIrIR3LpPPBPiTDp3bR6VMsZB4MXurCy0At/nVlySsTAMFuVsTuCVa52xMd8S3FrM25b+cO14kkp1SdvI/+LueJLXTFQjvTJleeasJ9GE2cGiIJIvz+RhGARx+mm6HHJPjF0+Ltl9Pl/G4sq1fce8edYsbVPCDY+CeWjxEY+s0J3FQQg3hZkwzX1/Jg/yVvDQZZ77xGI38NEjDyP4m+Z6zLKwbMjCmoKzOm/5lPmxa41YzIaBHzPX5+E+pad3x6Hrjz+7MQ+Zl85dzP241OtZGMx4GGdaM4ljMd+DM+kKfiB74AXj1XnErXnoxqtzNmVPgX9u80e47ARz305aAAnbZeOQTdGjG83XLQM5kyRFMRQVWbLtIGpJFjKpbkASa46qM9My0im+Stt8fXO9NawvahVosTv2ketHM9BTMZZXVjCdBT70PIKETpmOTcVBikolRBnRkKHoCuKmY5uq4lCTW4cdmmgVxXyKpmLJwnyABFNFNhRDQ1TSZUQdVUE6NjBiXNUcw5a5QY3ioMCHek3Ir9boZn4pU/d61V+vurCsFy9ReNIRhSe9wn84hQ/M38JZSdhjJvjLpF+ZuoJiWK73bTXLxnzMoXzXQuuxS/PlK8WTb0gw+jL8m+PlN/TzaWSZt08oLa28tqJ4lTu1UIwKFyXgM/liMQHFvJ2xZJYX4MVBNomnolkEPjqu5w1hjKEnIx9aACKbRZPkdnEdlB6Gg3kDD6YbZGYQx8EULqQNFZf5cueyzkSh7Xyfgd6mrSq48CjisRiMu+LSkgu9+8SDKY/DFWTOa1GzsVyVocRi47+pqqeyScF3U1KxB+N10RsN2NP4NE1LO2zS0dc3dRRiGMRBjmypsL4prG8TY4SJrKiYmYbk0F3re92GxWJxvpDPg1CsVijOEItWzIYkIdAZFK2g30vkQ4VyLNbMIS1YyXiMBbxFURzOrXgectEOk3LOLB1hyhVEOdguXTXArNqK6pgG1UzNbHcH36OJbvS1Xx4upYfRX1b0+/6HvLgYo8V//3x+G/+LFctSZGIhGwwNooYlQz9soS2ypmmWQiXV2bsfzealbVDiUF5TND91nA1OVPVi4aFc6I06jhM3lIrMXHD3dZjLoESzmi/peOHuWq/8OLPKfvje1snMlH8N9PnNz8d/RnEUDu+RojT64VngioUGn5UL+AHjPMRnClwZitS5pFQE1bRWFpDtlCijLKimtbKAVIsnlfpJtYEFwVaqVDyu1I8LDYQf+SKYx7Do+XC9lRfoRIACFxS/AkEKAKUOvzigYxmZQKQ8nQ28KBU248lUTpeJXT9ni0jC52MARrOkzmsrcZk1l+/F1EMBcRg88LxRYJwlquuE1uOlKkSKA1ELy1Ied4SmRdADseKT1EjGWasLVQwGF9qFXsRf+JQwyyBlmKVu4yw5h1RFnAVjdTCc1bTs2oGzGu14c/PbZsd7vFGDN3oc3Xkc3bhEE7TwksoljLGoHKzjVVKzNQEDAtWmMGXfer/7D36w8L8KfrqVAPVNUV0zNTJhgBi8fQCZqjYCMm6PeQ4TgjCeBOPAZ97lRnpRpk4KKIQv3finEAPCSVO/skzi82hZTKwKia/QBfB+YtxSmQ+e8GdeqEj82pQqkpuiktSqmKoW9pvH8SrDQWweBwJkrbv1ORAwJKknHTrR++cQRNEI1O9C8lMaFo5543aFaAcEJSH3QJEfeaWEIwGMVI06CzDy5vcAowMAo9te4tjgQVWIoqkSRho1YUg1zKEpho1Mw3QU1VQtkx4XPFx4zH/4F6b3evQCJvjAhz7b42ITx8KqypGsq0LTOUa6jClSLe5QQIyYKfgA3dCO3Q+VaCYHz4QsBxYrZZggpik20gm3ZcDCkpLtJtvJNV0Ob+GmoTePhFN+LevkgE9lMS8DnQYFexnxVEs+1RFQtSTUNhFVypZQQzU1VIV1Mm1bSLaz5WzStrBOVkedVe8mNXeTyt27iasKeQP/r8R8bBFacO1K0y8xLVwbuSEUlHp7XyC2Cq8E94ywMoTlV8NEOcm/Kk2Uc1CfhQJ/DSI3K359XNdMUlnQKrGKSieDz5BsLPHCkHDcpWjHDtYtNzYp53YByVr2LVf+0zFecoZWcsZL0tQtxkuvIbz0Y58rdiXU4U18YWfAqIU1QH+cIolpAARVxhEzFQUxaKSjU1OyjAODuhawXZ3mgire/ASsUIcOMFuHxG5ejb+4Fe6DvaQee/XY611hL6H4p8NdqoZLuKvupPEkuCsnpruJu1oaLXJ03AUKZRiORBCTCEYUawb4MIkh1bEZAC/i8N0Haj3uOg3uuunRVuvQ1hpD3YL5xgPwYA5L8t5C4bwebNXCqkjeB1VpParqDqpS8UCWtZehKknTCFE/EKoCvW8PqJL0lpBZWqdB1YEPRDoDqjin1JQNhixqmgCqwOWbhkqQ5FCdW8SQea44PahqB6ja4bV7mNUamFULlhqDnuptktGInF4T85THKq0DkDoWq5Q9BbZHrNIBHfCxQpUaJr+z7tT4oO703QUqdcjG9yFLTbay8yFLx+5GByKWNodiHougXsj1OWA2/IHdMfOtXaFK9YdiaRn3HpRwbyb3J/bjeVyi94xOdxid/pxsn3Oy+rVwOpYH/p0rZZ6nLUFLeqeB6YG9YWeAqa0bkuMwDak6xojqWEO6YRCkKAqWiGzz9eFse4Dpx+Z5Gnx8z/V0mOvZ8ezw0R5wO8mzZNo2QbOj31IHGJqmKeuAJ2xu/odzhe+Oo+kfJusmM3P8p7AOTc002/APzc00xTBf5c9/4W8senh1OHMEbjWez+7jpLDn+RrSHILz7O69ACb23MiXeYPsbToVkgHji8srqW7n/gSTfl7qpBjeDWsBU5ewFqfanFMiJXROYXdONHUtKmzQlZoNOtXynf3xnivqdizGoe1ij0zavEnv36PTahqi6rt67uH9cQ/N+OBjBJo0Q9vnI006zGN0BS00N79HCx1ACz2P0Wke41T7/7cJMfnYNMbB0ERzeEiPJvZBEyd5xV5y6yAM2aqQIQvn2ZT8VQg2ZIiacxx5nAIurcRn88uSWlH5tAUbPV535QBQpyvBC83N76FOD3V6qNNDnT+HOv37/5pPbFKuC18PvsDvm8Db8Vj0Cw5twqSQPeCT1AifXhUOWn8QM9SITK52ndq0LtAzASQ8vHzkaZgx2R38GSR48uxEx0SKfPLXnzQbsa6ioAPb4B4F9cdD/fHQHx4P1TjKE5wQtR5Od5PJocdick5Cvsj7ki/6KciXw3h22m3PfuD3d/Wevec3en7jRfyG/D74jaM/9NxxfuN7dICvNWBW5i2eBRJF57gNJPLd+3zqDZIi9yAakv5eMOthnICMukdU67mIAgqp5VJOxRYQUjlHqXmvl1zDFqhHZwvkbmOKA1u01mCKZ9w50y0F27aNGDN0RHWLI0aYhRRmKA7smSnXDjwyLSALOr2VTm1yv3vu3O75bnJ39/D34NMP5XYJeOW/H4M7+i9Sj/f6rtqvLMyv/MFXFrY/nmLHENc8Ztrh7yxs0qMO+N/m5rfN/z63r2jWuK7vj9r3BXDvfkPek0jvjkRq2ab+8kp8zdFj4M2nr49X4E50H8UMBi2094I7/XveO/RWsP497/u8Fay4BE759YVq5V1g8psHkjSjoa5C0/7Joe4ghT6Q5H2zX2Xw0rNgb4Y2xagFQVzI+kmozhexVEH4Pw==</diagram></mxfile>
diff --git a/modules/mlflow/mlflow-fargate/stack.py b/modules/mlflow/mlflow-fargate/stack.py
@@ -80,6 +80,7 @@ def __init__(
             ),
             environment={
                 "BUCKET": f"s3://{artifacts_bucket_name}",
+                "DUMMY": "DUMMY",
             },
             logging=ecs.LogDriver.aws_logs(stream_prefix="mlflow"),
         )