Beginning in v7.2.0, Metric Insights provides an interactive wizard that helps construct deployment commands by running ./installer.py --wizard.
The wizard guides you through a series of configuration questions and generates the appropriate deployment command based on your selected deployment method. This document describes all available wizard options and explains each prompt you may encounter during the wizard-driven deployment process.
TABLE OF CONTENTS:
NOTES:
- The default answer for each question is shown as a capitalized letter in parentheses. For example, in
Use verbose logging? (Y/n), the default value is Y. - Pressing Enter without providing a value accepts the default.
1. Download the Installation Package
- Access Get MI to download the installation package.
- See Access Software Downloads and License Keys via Get MI for details.
2. Unpack and Launch the Installer
- Untar the package with the following command:
tar -xvf MetricInsights-Installer-vX.X.X-Full.tar.gz- Launch the wizard:
- Simple Install:
./installer.py --wizard- Kubernetes:
./installer.py kubernetes --wizard- ECS (Cloudformation, Terraform):
./installer.py ecs --wizard- Docker Swarm:
./installer.py swarm --wizard3. Wizard Questions
Proceed to the wizard question section based on your deployment type:
Simple Install
| # | Question Text | Description |
|---|---|---|
| Do you want to use the prior command? (Y/n): | Run the last executed installation command. | |
| 1 | Use verbose logging? (Y/n): | Enable verbose logging output during
installation. |
| 2 | Assume yes on interactive questions? (Y/n): | Automatically answer "yes" to all
interactive prompts. |
| Database Settings | ||
| 3 | What is the MySQL database server hostname? (default: mysql, press Enter to use default): | MySQL hostname of the main database server. |
| 4 | What is the MySQL database name? (default: dashboard, press Enter to use default): | Name of the MySQL database to be used by
Metric Insights. |
| 5 | What is the MySQL admin username? (default: root, press Enter to use default): | MySQL admin user name to initialize the
Metric Insights database. |
| 6 | What is the MySQL admin password?: | Confirm what is the mysql admin password?: | MySQL admin user password for the database
server. |
| 7 | What timezone should MySQL use (if different from application)? (default: UTC, press Enter to use default): | Set MySQL time zone if it differs from the
application time zone. |
| System Settings | ||
| 8 | What is the base installation path? (default: /opt/mi, press Enter to use default): | Base path for Metric Insights installation. |
| 9 | What bind address should services listen on? (default: 10.8.0.234, press Enter to use default): | General bind address used by services to
listen for incoming connections. |
| 10 | What is the web service hostname? (press Enter to skip): | Additional hostname for the Web service. |
| 11 | What timezone should the application use? (default: UTC, press Enter to use default): | Set application time zone. |
| 12 | Enable high-load configuration? (Y/n): y | Enable high-load configuration optimized
for several thousand concurrent users. |
| Do you want to configure advanced parameters? (y/N): | After configuring basic settings, you can select to configure advanced settings. Selecting this option will prompt you to select available advanced configuration sections:
After completing a section, you can finish configuration by pressing | |
| Console Settings | ||
| 13 | Allow remote command execution from MI Console? (Y/n): y | Allow execution of remote commands from
the MI Console only. |
| Advanced Database Settings | ||
| 14 | What is the Data Processor hostname? (default: 10.8.0.234, press Enter to use default): | Data Processor service hostname for
external services. |
| 15 | How much RAM (in GB) does the database server have? (press Enter to skip): | Amount of RAM on the database server used
for database performance tuning. |
| 16 | What is the MySQL hostname for default dataset storage? (default: mysql, press Enter to use default): | MySQL hostname for default dataset storage. |
| 17 | What port is MySQL running on? (default: 3306, press Enter to use default): | MySQL port for the database server. |
| 18 | What is the database user host specification? (default: %, press Enter to use default): | MySQL user host specification allowing
wildcard or domain-based access. |
| 19 | What is the MySQL admin user for dataset storage? (default: root, press Enter to use default): | MySQL admin user for default dataset
storage. |
| 20 | What is the database server CA certificate filename? (press Enter to skip): | Database server CA certificate filename located in /opt/mi/ssl. |
| 21 | What is the database client certificate filename? (press Enter to skip): | Database client certificate filename located in /opt/mi/ssl. |
| 22 | What is the database client key filename? (press Enter to skip): | Database client key filename located in /opt/mi/ssl. |
| 23 | What is the MySQL admin password for dataset storage?: | Confirm what is the mysql admin password for dataset storage?: | MySQL admin password for dataset storage. |
| Dataprocessor Settings | ||
| 24 | What is the MySQL dataprocessor user password?: | Confirm what is the mysql dataprocessor user password?: | MySQL password for the dataprocessor
database user. |
| 25 | What is the Data Processor REST-API URL? (default: http://dataprocessor:8080, press Enter to use default): | Data Processor REST-API endpoint URL. |
| 26 | What is the Data Processor REST-API username? (default: dataprocessor, press Enter to use default): | Username for accessing the Data Processor
REST-API. |
| 27 | What is the Data Processor REST-API password?: | Confirm what is the data processor rest-api password?: | Password for the Data Processor REST-API
user. |
| General Settings | ||
| 28 | Skip installation of additional packages? (Y/n): y | Skip installation of any additional system
packages. |
| 29 | Show required packages and exit? (Y/n): n | Show packages required to run Metric
Insights and exit. |
| 30 | List available timezones and exit? (Y/n): n | List all available system time zones and
exit. |
| 31 | Show the last installation command and exit? (Y/n): n | Show the last installation command and
exit. |
| 32 | List supported operating systems and exit? (Y/n): y | List supported operating systems and exit. |
| Logger Settings | ||
| 33 | Disable additional logger service? (Y/n): y | Disable additional logger service used for
collecting logs. |
| Proxy Settings | ||
| 34 | Which components should bypass the proxy? | Comma-separated list of components that
should bypass the proxy. |
| 35 | What is the proxy server address?: 127.0.168 | Proxy server address. |
| Advanced System Settings | ||
| 36 | What is the default memory limit percentage for containers? | Default memory limit as a percentage for
all Docker containers. |
| 37 | What is the default CPU limit for containers? | Default CPU limit for all Docker
containers. |
| 38 | What are the per-service memory limits? | Per-service Docker memory limits
overriding the default. |
| 39 | What are the per-service CPU limits? | Per-service Docker CPU limits overriding
the default. |
| 40 | Which services should have restricted external access? | Comma-separated list of services that must
not have external access. |
| 41 | What is the AES encryption passphrase? | AES passphrase used for Metric Insights
encryption and decryption. |
| 42 | Run installation in unprivileged mode? | Skip actions requiring root access during
installation. |
| 43 | Which components should be deployed? | Comma-separated list of components to
deploy. |
| 44 | What custom components should be deployed? | Comma-separated list of custom components
to deploy. |
| 45 | What is the temporary directory path?: temp/ | Temporary directory for Metric Insights
services. |
| 46 | Only setup system packages without deploying? | Install and configure system packages
without deploying the application. |
| 47 | Enable privileged mode for all containers? | Enable privileged mode for all Docker
containers. |
| 48 | Use security Docker images? | Enable the use of security Docker images
during installation. |
| 49 | Disable User Access Rebuild process? | Skip the User Access Rebuild process
during installation. |
Kubernetes
| # | Question Text | Description |
| 1 | Where should the deployment config be saved? (default: ./, press Enter to use default): | Path and filename where the Kubernetes
deployment configuration file will be generated and saved. |
| 2 | Assume yes on interactive questions? (Y/n): | Automatically answer "yes" to all prompts,
allowing the wizard to run without further user interaction. |
| Database Settings | ||
| 3 | What is the MySQL database server hostname?: | Hostname or IP address of the MySQL server
used by Metric Insights. |
| 4 | What port is MySQL running on? (default: 3306, press Enter to use default): | Network port on which the MySQL server is
listening for connections. |
| 5 | What is the MySQL admin username? (default: miadmin, press Enter to use default): | MySQL administrative user with privileges
to initialize and manage the Metric Insights database. |
| 6 | What is the MySQL admin password?: | Confirm what is the mysql admin password?: | Password for the MySQL administrative user. |
| Dataprocessor Settings | ||
| 7 | What is the Dataprocessor hostname? (default: metricinsights-dataprocessor, press Enter to use default): | Hostname of the Dataprocessor service used
for handling data processing workloads. |
| 8 | How many CPU cores for Data-Analyzer search processes? (default: 2, press Enter to use default): | Number of CPU cores allocated for Data
Analyzer search processes. |
| Kubernetes Settings | ||
| 9 | What is the images pull secret name? (default: metricinsights-docker-registry, press Enter to use default): | Name of the Kubernetes secret used to
authenticate when pulling container images. |
| 10 | What Kubernetes version should the manifest be compatible with? (default: 1.19, press Enter to use default): | Kubernetes version that the generated
deployment manifest should be compatible with. |
| 11 | What Kubernetes namespace should be used? (default: default, press Enter to use default): | Kubernetes namespace where all Metric
Insights resources will be deployed. |
| 12 | What is the Docker registry URL? (press Enter to skip): | URL of the Docker registry from which
Metric Insights images will be pulled. |
| 13 | What Kubernetes scenario type should be used? [openshift3, k8s, helm] (default: k8s, press Enter to use default): | Type of Kubernetes environment or
deployment scenario to generate configuration for. |
| Networking Settings | ||
| 14 | What ingress controller type should be used? [nginx, traefik] (press Enter to skip): | Type of ingress controller used to expose
Metric Insights services. |
| 15 | What is the web service hostname?: | Public hostname that will be used to
access the Metric Insights web interface. |
| 16 | What is the console hostname?: | Public hostname that will be used to
access the Metric Insights Console. |
| Storage Settings | ||
| 17 | What storage class should be used? [nfs, portworx] (default: nfs, press Enter to use default): | Storage backend used for shared and
persistent data. |
| 18 | What is the Portworx storage size (in GB)? [>=1 in GB]: | Amount of persistent storage to allocate
when using Portworx. |
| 19 | What is the existing Persistent Volume Claim name? (press Enter to skip): | Name of an existing Persistent Volume
Claim to reuse instead of creating a new one. |
| System Settings | ||
| 20 | What timezone should the application use? (default: UTC, press Enter to use default): | Time zone used by the Metric Insights
application for timestamps and scheduling. |
| Web Settings | ||
| 21 | How many web instances should be deployed? [>=1] (default: 2, press Enter to use default): | Number of web service instances to deploy
for handling user traffic. |
| Advanced Database Settings | ||
| 22 | What timezone should MySQL use (if different from application)? (default: PST8PDT, press Enter to use default): | Time zone that the MySQL database engine
should use if it differs from the application time zone. |
| Advanced Kubernetes Settings | ||
| 23 | Where should credential files be stored?: | Directory where Kubernetes-related
credential files and secrets will be stored. |
| 24 | Skip generation of secrets? (Y/n): | Skip automatic generation of Kubernetes
secrets and use existing ones instead. |
| 25 | Prevent web instances on same node? (Y/n): | Ensure that web service instances are
scheduled on different Kubernetes nodes for higher
availability. |
| Advanced Networking Settings | ||
| 26 | What service type should be used? [ClusterIP, LoadBalancer, NodePort] (default: LoadBalancer, press Enter to use default): | Kubernetes service type used to expose
Metric Insights components. |
| Advanced Storage Settings | ||
| 27 | What is the Portworx storage class name? (press Enter to skip): | Name of the Portworx storage class to be
used for persistent volumes. |
| 28 | What is the shared drive folder? (press Enter to skip): | Path to the shared drive folder used for
shared application data. |
| 29 | What is the NFS server address for shared drive? (press Enter to skip): | Hostname or IP address of the NFS server
providing shared storage. |
| Advanced System Settings | ||
| 30 | Enable high-load configuration? (Y/n): | Optimize the deployment for environments
with high user concurrency. |
| 31 | Allow remote command execution? (Y/n): | Allow execution of administrative commands
remotely through the Metric Insights Console. |
ECS
CloudFormation
| # | Question Text | Description |
|---|---|---|
| 1 | Enter output file (cloudformation) or directory (terraform) path (press Enter to skip): | Path where the deployment configuration
will be generated. For CloudFormation, this is an output file
(e.g., .yml). For Terraform, this is an existing directory where
manifests will be written. |
| 2 | Enter deployment scenario type (cloudformation or terraform) [cloudformation, terraform] (default: cloudformation, press Enter to use default): | Select whether to generate a
CloudFormation template or Terraform manifests for deploying Metric
Insights on AWS ECS. |
| 3 | Enter timezone (default: UTC, press Enter to use default): | Application time zone used by Metric
Insights for timestamps and scheduling. This affects initial
installation and is ignored during updates; to change it later, use
the Metric Insights Console. |
| Docker Settings | ||
| 4 | Enter Docker registry URL (hostname or hostname:port) (press Enter to skip): | Docker registry address from which Metric
Insights container images will be pulled (hostname or
hostname:port). |
| Networking Settings | ||
| 5 | Set Network Load Balancer scheme to internal? (Y/n): | Choose whether the Network Load Balancer
is internal (private) rather than internet-facing (public). |
| 6 | Enter web service hostname (press Enter to skip): | Optional hostname (DNS name/alias) used to access the Metric Insights web interface. |
| Performance Settings | ||
| 7 | Enable high-load configuration? (Y/n): | Enable performance-optimized configuration
for high concurrency and heavy workloads. |
| Storage Settings | ||
| 8 | Select shared storage type (nfs or glusterfs) [nfs, glusterfs] (default: nfs, press Enter to use default): | Select the shared storage backend used for
the shared data folder. Note: GlusterFS is not supported for ECS
CloudFormation; use NFS. |
| Do you want to configure advanced parameters? (y/N): | Choose whether to configure advanced
options for cache, database, deployment behavior, logging,
performance, security, and storage. After completing each section,
you can finish by selecting q. | |
| Advanced Cache Settings | ||
| 9 | Enable AWS Elasticache (Redis) for PHP sessions? (Y/n): | Enable AWS ElastiCache (Redis) to store PHP session data. |
| Advanced Database Settings | ||
| 10 | Enter MySQL timezone (if different from application) (default: PST8PDT, press Enter to use default): | Set the MySQL engine time zone if it
differs from the application time zone. If not specified, the
application time zone is used. |
| Advanced Deployment Settings | ||
| 11 | Prevent web master and slave on same ECS instance? (Y/n): | Prevent scheduling the primary and
secondary web instances on the same ECS instance to improve
availability. |
| Advanced Logging Settings | ||
| 12 | Enable additional logger service? (Y/n): | Enable the additional logger service that collects application logs. |
| Advanced Performance Settings | ||
| 13 | Enter number of Data-Analyzer search processes (default: 2, press Enter to use default): | Set the number of Data Analyzer search processes to run for query/search workloads. |
| Advanced Security Settings | ||
| 14 | Allow remote command execution? (Y/n): | Allow execution of administrative remote
commands (typically used for support or advanced
administration). |
| Advanced Storage Settings | ||
| 15 | Enable shared drive in web container? (Y/n): | Enable mounting a shared network drive
into the web container to provide a shared folder. |
| 16 | Enter EFS volume ID (optional) (press Enter to skip): | Specify an AWS EFS file system/volume ID
to mount as the network shared folder. Leave blank to skip. |
Terraform
| # | Question Text | Description |
|---|---|---|
| 1 | Enter output file (cloudformation) or directory (terraform) path (press Enter to skip): | Path where the deployment configuration
will be generated. For Terraform, this must be an existing
directory where the installer will write the Terraform module
files. |
| 2 | Enter deployment scenario type (cloudformation or terraform) [cloudformation, terraform] (default: cloudformation, press Enter to use default): | Select the deployment scenario type.
Choose Terraform to generate a Terraform module instead of a
CloudFormation template. |
| 3 | Enter timezone (default: UTC, press Enter to use default): | Application time zone used by Metric
Insights for timestamps and scheduling. This affects initial
installation and is ignored during updates; to change it later, use
the Metric Insights Console. |
| Docker Settings | ||
| 4 | Enter Docker registry URL (hostname or hostname:port) (press Enter to skip): | Docker registry address from which Metric
Insights container images will be pulled. Enter a valid hostname or
hostname:port. |
| Networking Settings | ||
| 5 | Set Network Load Balancer scheme to internal? (Y/n): | Choose whether the Network Load Balancer
is internal (private) rather than internet-facing (public). |
| 6 | Enter web service hostname (press Enter to skip): | Optional hostname (DNS name/alias) used to access the Metric Insights web interface. |
| Performance Settings | ||
| 7 | Enable high-load configuration? (Y/n): | Enable performance-optimized configuration
for high concurrency and heavy workloads. |
| Storage Settings | ||
| 8 | Select shared storage type (nfs or glusterfs) [nfs, glusterfs] (default: nfs, press Enter to use default): | Enable AWS ElastiCache (Redis) to store PHP session data. |
| Do you want to configure advanced parameters? (y/N): | Choose whether to configure advanced
options for cache, database, deployment behavior, logging,
performance, security, and storage. After completing each section,
you can finish by selecting q. | |
| Advanced Cache Settings | ||
| 9 | Enable AWS Elasticache (Redis) for PHP sessions? (Y/n): | Enable AWS ElastiCache (Redis) to store PHP session data. |
| Advanced Database Settings | ||
| 10 | Enter MySQL timezone (if different from application) (default: PST8PDT, press Enter to use default): | Set the MySQL engine time zone if it
differs from the application time zone. If not specified, the
application time zone is used. |
| Advanced Deployment Settings | ||
| 11 | Prevent web master and slave on same ECS instance? (Y/n): | Prevent scheduling the primary and
secondary web instances on the same ECS instance to improve
availability. |
| Advanced Logging Settings | ||
| 12 | Enable additional logger service? (Y/n): | Enable the additional logger service that collects application logs. |
| Advanced Performance Settings | ||
| 13 | Enter number of Data-Analyzer search processes (default: 2, press Enter to use default): | Set the number of Data Analyzer search processes to run for query/search workloads. |
| Advanced Security Settings | ||
| 14 | Allow remote command execution? (Y/n): | Allow execution of administrative remote
commands (typically used for support or advanced
administration). |
| Advanced Storage Settings | ||
| 15 | Enable shared drive in web container? (Y/n): | Enable mounting a shared network drive
into the web container to provide a shared folder. |
| 16 | Enter EFS volume ID (optional) (press Enter to skip): | Specify an AWS EFS file system/volume ID
to mount as the network shared folder. Leave blank to skip. |
Swarm
| # | Question Text | Description |
|---|---|---|
| 1 | Enter output file path for Swarm deployment config (default: ./, press Enter to use default): | Path and filename where the Docker Swarm
deployment configuration file will be generated and saved. |
| 2 | Enter timezone (default: UTC, press Enter to use default): | Application time zone used by Metric
Insights for timestamps and scheduling. This affects initial
installation and is ignored during updates; to change it later, use
the Metric Insights Console. |
| Database Settings | ||
| 3 | Enter MySQL hostname: | Hostname or IP address of the MySQL server used by Metric Insights. |
| 4 | Enter MySQL database name (default: dashboard, press Enter to use default): | Name of the MySQL database that Metric Insights will use. |
| 5 | Enter MySQL port (default: 3306, press Enter to use default): | Network port on which the MySQL server is listening for connections. |
| 6 | Enter MySQL admin username (default: miadmin, press Enter to use default): | MySQL administrative user with privileges
to initialize and manage the Metric Insights database. |
| 7 | Enter MySQL admin password: | Confirm enter mysql admin password: | Password for the MySQL administrative user. |
| Deployment Settings | ||
| 8 | Enter number of web instances [>=1] (default: 2, press Enter to use default): | Number of web service instances to deploy in the Swarm stack for handling user traffic. |
| Docker Settings | ||
| 9 | Enter Docker registry URL (hostname or hostname:port) (press Enter to skip): | Docker registry address from which Metric
Insights container images will be pulled (hostname or
hostname:port). |
| Networking Settings | ||
| 10 | Enter web service hostname (press Enter to skip): | Optional hostname (DNS name/alias) used to access the Metric Insights web interface. |
| 11 | Enter Dataprocessor hostname (default: dataprocessor, press Enter to use default): | Hostname used by services to reach the Dataprocessor component. |
| Performance Settings | ||
| 12 | Enable high-load configuration? (Y/n): | Enable performance-optimized configuration
for high concurrency and heavy workloads. |
| Storage Settings | ||
| 13 | Enter NFS server address: | Hostname or IP address of the NFS server
that provides the shared data folder required by Metric
Insights. |
| 14 | Enter NFS shared folder path (default: /opt/mi/data, press Enter to use default): | Path to the shared NFS folder that will be
mounted and used for Metric Insights shared data. |
| Do you want to configure advanced parameters? (y/N): | Choose whether to configure advanced
options for database, performance, security, and storage. After
completing each section, you can finish by selecting q. | |
| Advanced Database Settings | ||
| 15 | Enter MySQL timezone (if different from application) (default: PST8PDT, press Enter to use default): | Set the MySQL engine time zone if it
differs from the application time zone. If not specified, the
application time zone is used. |
| Advanced Performance Settings | ||
| 16 | Enter number of Data-Analyzer search processes (default: 2, press Enter to use default): | Set the number of Data Analyzer search processes to run for query/search workloads. |
| Advanced Security Settings | ||
| 17 | Allow remote command execution? (Y/n): | Allow execution of administrative remote
commands (typically used for support or advanced
administration). |
| Advanced Storage Settings | ||
| 18 | Enter shared drive folder path (or leave empty to disable): | Optional host folder path to mount into
the web container as an additional shared drive. Leave empty to
disable. |
| 19 | Enter NFS server address for shared drive (press Enter to skip): | Hostname or IP address of the NFS server
providing the shared drive folder. Leave blank to skip. |
4. Finish Constructing the Command
- After the configuration is completed, the installer displays the generated command.
- Select whether to run the generated installation command ('
Y'), or to cancel ('n').