Repository files navigation

Metaflow UI is a tool to monitorMetaflow workflows in real-time.

Using Metaflow UI requiresMetaflow Service for now.

To setup a local development environment, seedocs/README.md.

Deploying Metaflow UI requires setting up a UI service (which is different from the Metaflow service but uses the same backing database). To deploy the UI service, follow instructions atMetaflow UI Service.

Dockerfile provides support for annginx container hosting the production build of the application.

# Build Docker image$ docker build --tag metaflow-ui:latest.# Run Docker container on port 3000$ docker run -p 3000:3000 metaflow-ui:latest# Run Docker container using custom API endpoint$ docker run -p 3000:3000 -e METAFLOW_SERVICE=http://custom-ui-backend/api metaflow-ui:latest

For example, when used with a locally deployedMetaflow UI Service, the UI can be launched with

docker run -p 3000:3000 -e METAFLOW_SERVICE=http://localhost:8083/ metaflow-ui:latest

Dockerfile also supports the following environment variables to inject content into the UI's index.html:

• METAFLOW_HEAD - Inject content tohead element
• METAFLOW_BODY_BEFORE - Inject content at the beginning ofbody element
• METAFLOW_BODY_AFTER - Inject content at the end ofbody element

Use cases for these variables range from additional meta tags to analytics script injection.

Example on how to add a keyword meta tag to Metaflow UI:

METAFLOW_HEAD='<meta name="keywords" content="metaflow" />'

Seedocs/plugin-system.md to get started with plugins development.

Seedocs/README.md to learn more.

General Metaflow documentation availablehere:

We welcome contributions to Metaflow. Please see ourcontribution guide for more details.

There are several ways to get in touch with us:

• Open an issue at:https://github.com/Netflix/metaflow-ui
• Email us at:help@metaflow.org
• Chat with us on:http://chat.metaflow.org