Install and Setup Overview¶
The installation guide of the Micro Integrator explains how to set up the Micro Integrator on a single server node or container.
|Installation Prerequisites||See the system requirements for setting up and using the Micro Integrator of WSO2 EI 7.|
|Install via the Installer||Follow the instructions on downloading the Micro Integrator and installing the server on a VM by using the installer.|
|Install via the Binary||Follow the instructions on downloading the Micro Integrator and installing the server on a VM by using the binary distribution.|
|Run the Micro Integrator on Containers||Use the Docker images of the Micro Integrator from Docker Hub and deploy an integration solution in Docker or Kubernetes.|
Follow the topics in this section to migrate to the latest version of WSO2 EI 7 from a previous version.
You can set up a Micro Integrator deployment either in a VM environment or a Kubernetes environment.
Deploy on Kubernetes¶
Follow the topics in this section if you are setting up a Micro Integrator deployment in a Kubernetes environment.
|Kubernetes Deployment Patterns||Understand the various deployment patterns that you can use. You can select the appropriate pattern for your requirement.|
|Building a CICD Pipeline||Follow the step-by-step instructions on how to build a pipeline to manage the continuous integration and continuous deployment process.|
Deploy on a Virtual Machine¶
Follow the topics in this section if you are setting up a Micro Integrator deployment in a VM environment.
|Clustered Deployment||Follow the instructions on how to set up a clustered deployment in a VM environment.|
|Deployment Synchronization||Follow the instructions on configuring deployment synchronization for the nodes in your cluster.|
|Load Balancing||Follow the instructions on configuring an external load balancer to front the nodes in a cluster.|
|Configuring a Proxy Server||Follow the instructions on configuring a proxy server to front your Micro Integrator deployment.|
|Enable SSL Tunneling through Proxy Server||Follow the instructions on how to enable secure socket layer (SSL) tunneling through the proxy server.|
Deployment Best Practices¶
Follow the topics for best practices to follow when setting up a Micro Integrator deployment.
|Product Deployment Checklist||Once you have set up your development verify with this checklist to ensure that you have followed all the required standards.|
|Health Check||Check the health of your Micro Integrator nodes before routing traffic.|
|Changing Default Ports||See the instructions on changing the default ports.|
|Troubleshooting a Production Deployment||This section explains how you can troubleshoot your cluster in a VM deployment.|
|Backup and Recovery||The section explains how to configure backup and recovery for your deployment.|
|Managing Configurations across Environments||When you have multiple environments such as DEV, QA, UAT, and PROD, you can follow these instructions to remotely manage the configurations in each environment without modifying the artifacts or configuration file.|
Configuring a User Store Set up an LDAP or RDBMS to store user credentials. Managing Users Add, remove, or update users in the user store.
Setting up Databases This section explains how to set up a database and connect it to the nodes in your cluster in your Micro Integrator. The following database types are supported:
Follow the topics in this section to configure security for your Micro Integrator instance.
|Creating New Keystores||Create new kestores to replace the default keystores in your Micro Integrator.|
|Renew a CA-signed Certificate||Renew a CA certificate in the keystore of your Micro Integrator.|
|Configuring Keystores||Update the keystore configurations by pointing to the new keystores.|
|GDPR for the Micro Integrator||Learn about GDPR compliance in the Micro Integrator.|
|Identity Anonymization Tool||Find out more about the ForgetMe tool, which is used for anonymizing personal data saved in the Micro Integrator.|
|Encrypting Secrets using WSO2 Secure Vault||Encrypt sensitive data in your configuration files and synapse configurations using WSO2 Secure Vault.|
|Using HashiCorp Secrets||Store your secrets in the HashiCorp vault and access them from synapse configurations in the Micro Integrator.|
|Using Symmetric Encryption||As an alternative to asymmetric encryption using keystores, use single key encryption.|
|Securing the Management API||The management API of the Micro Integrator powers the Micro Integrator CLI tool as well as the Dashboard. This section explains how the management API can be secured.|
|Customizing Error Messages||See the instructions on how to create custom error messages.|
Performance and Capacity Planning¶
You can have a look at the result of performance tests conducted for the Micro Integrator in the Micro Integrator repo.
Follow the topics in this section to optimize the performance of your Micro Integrator instance.
- Tuning JVM Performance
- Tuning Network and OS Performance
- Tuning JDBC Performance
- Tuning the HTTP Transport
- Tuning the JMS Transport
- Tuning the VFS Transport
- Tuning the RabbitMQ Transport
- Tuning the Inbound Endpoints
The following topics explain how to connect the Micro Integrator with an external message broker.
The follow topics explain configurations specific to various scenarios and features of the Micro Integrator.
- Configuring Time Stamp Conversion for RDBMS
- Configuring Message Builders and Formatters
- Configuring Message Relay
- Configuring Transports
- Configuring Multi-HTTPS