Set Up

Enrich the Insights Engine with metadata from your Production Environment

Deploying the Metis Metadata Collector (MMC)

Deployment Flow

Step 1 - Deploy the MMC to a location with direct access to the Production DB. See the deployment options below
Step 2 - Configure the MMC
  • A connection string to the DB. The configured user should be a member of the predefined role pg_monitor.
  • Metis API Key
The MMC supports Postgres version 12 or higher.

Deployment Options

Option 1 - Deploy a Docker Image
Option 2 - Deploy the MMC to AWS using a CloudFormation
Option 3 - Deploy the MMC to Kubernetes using HELM Charts

Option 1 - Deploy a Metadata Collector using a Docker Image

On Linux and MacOS, run the command:
docker run \
--name metis-md-collector \
-e "" \
-e "API_GATEWAY_PATH=/md-collector" \
-e "" \
-e "WEB_APP_PORT=443" \
-e "API_KEY=abcdefg123456789" \
-e "DB_CONNECTION_STRINGS=postgresql://postgres:[email protected]:5432/db_name" \
-e "CRON_LOCAL_RUNNING_EXP=* * * * *" \
Your database must be accessible from the Docker container. Consider adding --net=host on Linux, or --add-host on Mac to configure a proper DNS.

Option 2 - Deploy a Metadata Collector using CloudFormation

Open our CloudFormation Template and use the following guide-
  1. 1.
    Make sure the following link populates the field Template URL
AWS Quick Create Stack
2. Name the stack. The default name is MetisMetadataCollector.
3. Enter a valid Cluster Name where you want to launch the PMC.
4. Enter the Connection string to the database you would like to collect metadata from, in the following pattern-
postgresql://user:[email protected]:port/database_name
You can also collect metadata from multiple databases by chaining multiple Connection Strings with a ; between them.
For Example-
postgresql://user:[email protected]:port/database_name;postgresql://user:[email protected]:port/database_name;postgresql://user:[email protected]:port/database_name;postgresql://user:[email protected]:port/database_name
4. Enter your API Key in MetisAPIKey field.
5. Choose a Security Group, make sure it has access to your database.
6. Choose a Subnet ID. If you run your database on AWS, make sure it's in the same VPC as your database's VPC.
7. Select the 3 checkboxes to acknowledge the AWS operations.
Click on Create Stack.

Option 3 - HELM Charts

Follow the instructions in the GitHub Repository.