diff --git a/README.md b/README.md new file mode 100644 index 0000000..6549757 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Helm Chart for Metaflow services + +This chart deploys Metaflow Services in a Kubernetes cluster. Specifically, it includes: + +* a sub-chart for Metaflow Metadata service +* a sub-chart for Metaflow UI, front end and back end +* PostgreSQL to store Metadata + +PostgreSQL subchart is included to make it easier to deploy Metaflow for evaluation or development purposes. In production, we recommend to use a managed PostgreSQL offering such as AWS RDS and disable PostgreSQL sub-chart by setting `postgresql.enabled` to `false`. + +## Quickstart + +Prerequisites: +* Local Kubernetes cluster via Docker Desktop (or Minikube) + +1. Clone this repository: `git clone https://github.com/moleculemaker/metaflow-helm-chart` +2. Change directories: `cd metaflow-helm-chart/` +3. + +