Deploying Metric Insights in an Orchestrated Environment
Beginning in version 6.0, Metric Insights can be deployed using a container orchestration platform. Container orchestration allows for horizontal scaling (versus vertical) as well as a highly-available architecture. Orchestration platforms include:
- Amazon ECS (CloudFormation, Terraform)
- Docker Swarm
Metric Insights consists of services running inside of containers:
- Data Processor
- Data Analyzer
- Obtain Docker Registry Credentials
- Choose a Deployment Method (Kubernetes, Amazon ECS, Docker Swarm)
- Generate the configuration file to deploy to Amazon ECS
- Create the ECS Stack with AWS CloudFormation
- Accessing the Metric Insights Deployment
- Resources involved in running Metric Insights in ECS
Ensure that the system requirements for a Metric Insights server are met.
To deploy Metric Insights across the different orchestration platforms, the following architectural pieces are required:
- kubectl command-line tool to manage a Kubernetes deployment (not required for ECS and Docker Swarm)
- oc command-line tool to manage an OpenShift deployment
Remote Database Server to host the application database:
- MySQL v8+
- (MySQL/MariaDB v5.5+ is supported only in MI versions prior to v6.2.0)
Persistent shared storage to store the application file system
- e.g., NFS, Portworx, EFS, etc.
- Specific ports open on the network:
- 80, 443: HTTP and HTTPS ports for the UI Application Service (by default redirection to 443)
- 2550: TCP port for the Data Processor cluster within the kubernetes namespace
- 2551: TCP port for the Seed service within the kubernetes namespace
- 32550: TCP port for external access to the Data Processor cluster
- 32551: TCP port for external access to the Seed service
- 3306: MySQL port to get access from outside
- 8080,8443: HTTP and HTTPS ports for the REST API Data Processor Service (only one port is enabled at one time)
- 8081: TCP port for Monitoring Tool
For non-orchestrated deployments, see the help article on using Simple Installer.
2. Obtain Docker Registry Credentials
Contact MI Support for access to the official Metric Insights Docker Registry. Credentials are needed to pull docker images for each Metric Insights' service.
- Note: the default MI Docker Registry address (docker.metricinsights.com) is specified in the deployment configuration file for each orchestration type.
If you must use a Private Docker Registry instead, see Uploading Metric Insights Docker Images to a Private Registry about how to download our docker images and upload them to your private registry.
3. Choose Deployment Method (Kubernetes, Amazon ECS, Docker Swarm)
If deploying to Kubernetes, please see Deploying Metric Insights on Kubernetes.
If deploying to Docker Swarm, please see Deploying Container Orchestration with Docker Swarm.
If deploying to OpenShift, please see Deploying Metric Insights on OpenShift v3.
If deploying to Amazon ECS, continue below.
Amazon ECS Prerequisites:
- Database (RDS or EC2 instance with custom database deployment
- EFS or custom NFS shared storage
- Optional: If utilizing a private registry; i.e., non-Metric Insights, ensure that you have those credentials available.
4. Generate Configuration File to Deploy to Amazon ECS
The configuration file can be generated using the Metric Insights installer package:
- Download the installer package to a Linux system and unpack
- Change into the installer directory, then run the installer with the ecs command and specify a target filename to generate the configuration file:
- If the remote DB server has the same timezone as MI app:
./installer.py ecs --timezone <MI app timezone> -o <manifest filename>.json
- If the remote DB server has a different timezone than MI app:
./installer.py ecs --timezone <MI app timezone> --mysql-timezone <remote database server timezone> -o <filename>.json
- If the remote DB server has the same timezone as MI app:
- The configuration file can now be used as a template with AWS CloudFormation to create and deploy the Metric Insights environment
./installer.py ecs --help to see the list of available installer options. See Basic Console Commands section.
5. Create the ECS Stack with AWS CloudFormation
Prepare the following:
- RDS address with root credentials
- EFS address to connect to Metric Insights application
Apply the configuration file through the CloudFormation UI:
- Upload the generated json file as a template
2. Complete each field then click [Next] at the bottom of the page. Some key notes:
- To generate passwords for each service, you can either run
echo -n '<pwd>' | base64to encode a password of your choice, or run something like
openssl rand -base64 8to auto generate a password for you.
- Use the full RDS address for the field "DBHostName"
- Enter the RDS root user in the field "DBRootUserName"
- Enter the full EFS address in the field "NFSServerAddress"
- Select all Subnet IDs available in the field "SubnetIDs"
- The field "WebReplicationsCount" represents the number of web slave containers (secondary to web master).
3. Click [Next] to skip through the subsequent pages until you reach the window shown below.
- Click the checkbox to acknowledge that IAM resources might be created on deployment
- Click [Update stack]
4. Allow incoming connections to RDS for new ECS/EC2 security group to complete the deployment
- As the new ECS Stack is being deployed, go to the EC2 Console and select one of the new EC2s created for ECS
- Go to the Security Group field and select on the new security group name
- Copy the Group ID; e.g., "sg-name"
- Switch to the RDS Console and select the RDS instance being used for ECS
- Go to the VPC Security Group field and select the security group name
- Switch to the "Inbound" tab and click [Edit]
- Add the new EC2 security group to the list and then [Save]:
- Add Rule > All Traffic > Paste Group ID
On adding the group, switch back to CloudFormation to monitor the ECS Stack deployment. The deploy should complete in 5-10 minutes.
If you need to customize some processes after the application deployment, see Configuring Custom Components article.
6. Accessing Metric Insights Deployment
Once the ECS Stack is deployed:
- Switch back to the EC2 Console and select "Load Balancers" in the left menu pane.
- Identify the Load Balancer DNS name to access the Metric Insights application in a browser.
- For the best user experience, map the Load Balancer DNS name to a user-friendly name in Amazon Route 53.
Metric Insights is now deployed in ECS and browser ready.
7. Resources Involved in Running Metric Insights in ECS
- AWS ECS Task Definitions
- AWS ECS Cluster
- AWS ECS Services
- AWS EC2 Auto Scaling group
- AWS EC2 Launch Configuration
- AWS EC2 Security Groups
- AWS Target Groups
- AWS Network Load Balancer
- IAM Roles
- AWS Secret Manager
- AWS Cloud Formation (only for deployment and updates)
Non-ECS resources in AWS needed for deployment include:
- AWS RDS instance based on MySQL 8.0.20
- Requires a custom Parameter Group with log_bin_function_creators enabled
- See this KB for a list of mysql parameters to adjust
- AWS EFS Shared Storage
8. Basic Console Commands
Basic console commands can be checked by running
./installer.py ecs --help .
The following list of utilities are available to use on the host.
Note, all of these tools become available only if the Web Component is installed.