Install and Setup Overview

The installation and the setup of API Manager involve installing the product, deploying it in the method that is best suited for your requirements, and setting it up to run in the production environment. If you already have an older version of WSO2 API Manager or one of its components, you can follow the upgrading instructions in this guide.

This section provides installation and setup instructions for the following three components of WSO2 API Manager that you need to operate as three separate runtimes.

API Manager

This component manages APIs. To install and set up this component, see the following topics.

Installing

To install and run the API Manager in virtual machines, see the following topics.

Installing the API Manager Runtime Explains how to download the API Manager component as a binary and install it on a virtual machine.
Running the API-M Runtime Explains how you can execute the API-M runtime and start using its features.
Running API-M as a Linux Service Explains how to install and run the API Manager as a Linux service.
Running API-M as a Windows Service Explains how to install and run the API Manager as a Windows service.

Setting up

To set up the API Manager component, see the following topics.

Applying WSO2 WUM Updates Explains how to get the latest updates that are available for a particular release of the API Manager.
Setting up a Key Manager The key manager of the API Manager handles all clients, security, and access token-related operations. This section covers the following topics:
Setting up Databases The API Manager is shipped with an H2 database for storing data. This guide explains the default H2 databases used within API Manager as well as how to switch to a different database supported for the API Manager such as MSSQL, MySQL, PostgreSQL, Oracle, MariaDB, IBM DB2, and Oracle RAC. In addition, this section covers how to manage data growth and improve performance when storing metadata and runtime data in databases.
Setting up Proxy Server and the Load Balancer A load balancer or reverse proxy is required to map external traffic with ports and URLs that the APi Manager component uses internally. This section covers the following topics relating to the proxy server and the load balancer.
Securing the API Manager Covers the different ways in which you can secure the API Manager and the data it handles. The topics covered are as follows:
Configuring User Stores You can configure primary user stores as well as secondary user stores for the API Manager component. This section explains the concept of user stores and provides instructions to configure primary user stores. The topics covered are as follows:
SSO Explains how to configure SSO (Single Sign On) for the API Manager component with an external identity provider. The topics covered are as follows.
  • Configuring Identity Server As External IDP with OIDC
  • Configuring Identity Server As External IDP with SAML
  • Using OKTA As An External IDP With OIDC
  • Using OKTA As An External IDP With SAML
  • Advanced Configurations Covers some advance configurations including how to change the transport used by the API Manager component from the default PassThrough transport to a different transport, how to configure caching, and how to change the user interfaces of the API Manager component.
  • Changing the Default Transport
  • Configuring Caching
  • Customizing the Management Console
  • Deploying

    To deploy the API Manager runtime, see the topics given below.

    Deployment Patterns This explains all the deployment patterns you can follow when you deploy WSO2 API manager. These patterns involve deploying the API Manager component together with Micro Integrator and Streaming Integrator components in clustered setups.
    All-in-One Deployment This describes the all-in-one deployment patterns where you can deploy all the sub components of the API Manager component in one instance.
    Distributed Deployment This describes the distributed deployment patterns where you can deploy the sub-components of the API Manager component in a distributed manner in order to handle a high volume of requests in an efficient manner.
    Deploy API-M on Kubernetes using the Operator Explains how the WSO2 API Manager Kubernetes operator deploys the API Manager component in Kubernetes.
    Deploy API-M on Kubernetes using Helm Resources Explains how Helm resources deploy the API Manager component in Kubernetes.
    Deploy APIs on Kubernetes Explains how the Kubernetes operator can deploy APIs in Kubernetes as managed APIs.

    CI/CD

    To implement continuous integration and continuous deployment pipelines for APIs on API Manager, see the topics given below.

    CI/CD for APIs - Overview Find out about the methods of implementing CI/CD for APIs using the API Controller (apictl).
    Building a CI/CD Pipeline for APIs using the CLI See the instructions on how to implement a CI/CD pipeline for APIs using the API Controller (apictl).
    Building a CI/CD Pipeline for APIs using Jenkins See the instructions on how to implement a CI/CD pipeline for APIs using Jenkins and the API Controller (apictl).

    See the topics given below to manage APIs, API products, Apps, etc. in the API-M runtime by using the API Controller (apictl).

    Getting Started with WSO2 API Controller Explains how to set up the API Controller.
    Managing APIs and API Products This section covers the following topics.
  • Managing APIs and API Products
  • Importing APIs Via Dev First Approach
  • Migrating APIs to Different Environments
  • Migrating API Products (with or without dependent APIs) to Different Environments
  • Managing Applications This section covers the following topics.
  • Managing Applications
  • Migrating Apps to Different Environments
  • Managing Microgateways Explains how to interract with multiple microgateways via the API Controller
    Advanced Topics This section covers the following topics.
  • Creating Custom Users to Perform API Controller Operations
  • Configuring Environment Specific Parameters
  • Using Dynamic Data in API Controller Projects
  • Configuring Different Endpoint Types
  • Formatting the outputs of get commands
  • Upgrading

    To upgrade to the current API Manager component from a previous version, see the topics given below.

    Upgrading from WSO2 API-M 3.2.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 3.1.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 3.0.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 2.6.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 2.5.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 2.2.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 2.1.0 to WSO2 API-M 4.0.0
    Upgrading from WSO2 API-M 2.0.0 to WSO2 API-M 4.0.0

    Micro Integrator

    This component develops complex integration services that can be exposed as managed APIs.

    Installing

    To install and run the Micro Integrator on a virtual machine, see the topics given below.

    Installing the Micro Integrator Runtime Explains how to download the Micro Integrator runtime as a binary and install it on a virtual machine.
    Running the Micro Integrator Runtime Explains how you can execute the Micro Integrator runtime and start using its features.
    Running the Micro Integrator as a Windows Service Explains how to install and run the Micro Integrator as a Windows service.

    To install and run the Micro Integrator Dashboard on a virtual machine, see the topics given below.

    Installing the Micro Integrator Dashboard Explains how to download the Micro Integrator Dashboard as a binary and install it on a virtual machine.
    Running the Micro Integrator Dashboard Explains how you can execute the Micro Integrator Dashboard and start using its features.

    Setting up

    To set up and configure the Micro Integrator runtime, see the topics given below.

    Applying WSO2 Updates Explains how to get the latest updates that are available for a particular release of the Micro Integrator.
    Data Stores Explains how to set up a user store, databases (multiple types), and a file-based registry. The topics covered are as follows:
    Securing the Micro Integrator Covers the different ways in which you can secure the Micro Integrator and the data it handles. The topic covered are as follows:
    Performance Explains how to configure the Micro Integrator at different levels to optimize performance.
  • Tuning JVM Performance
  • Tuning Network and OS Performance
  • Tuning JDBC Configurations
  • Tuning the HTTP Transport
  • Tuning the JMS Transport
  • Tuning the VFS Transport
  • Tuning the RabbitMQ Transport
  • Tuning the Inbound Endpoints
  • Message Brokers Explains how to set up the Micro Integrator component to integrate with message brokers such as RabbitMQ, Kafka, and JMS. The topics covered are as follows:
  • AMQP (RabbitMQ)
  • Deploying RabbitMQ
  • Connecting to RabbitMQ
  • JMS
  • Connecting to ActiveMQ
  • Connecting to Apache Artemis
  • Connecting to HornetQ
  • Connecting to IBM Websphere App Server
  • Connecting to IBM WebSphere MQ
  • Connecting to JBoss MQ
  • Connecting to MSMQ
  • Connecting to Swift MQ
  • Connecting to TIBCO EMS
  • Connecting to Weblogic
  • Connecting to WSO2 MB
  • Connecting to Multiple Brokers
  • Kafka
  • Azure Service Bus
  • Transports Explains how to configure the Micro Integrator component to work with a range of transports. These include all the widely used transports including HTTP/S, JMS, VFS, as well as domain-specific transports such as FIX.
    Multi-HTTPS Transport Explains how to enable dynamic SSL profiles for the Micro Integrator component and how to dynamically load the SSL profiles at runtime using a periodic schedule or JMX invocation.
    Message Builders and Formatters When the Micro Integrator receives a request via a mode of transport, the transport uses a **message builder** to process the payload and convert it to SOAP. Similarly, when the Micro Integrator sends a message via a mode of transport, the publishing transport uses a **message formatter** to present the payload in the required format. This section explains how to configure these message builders and message formatters.
    Message Relay Enabling message relay allows the Micro Integrator component to to pass messages along without building or processing them unless specifically requested to do so. This way, the Micro Integrator can handle a higher throughput.
    Observability There are two possible observability solutions that you can enable for the Micro Integrator component. This section explains how to set them up and well as how to configure logging. The topics covered are as follows:
  • Setting up Cloud-Native Observability on a VM
  • Setting up Cloud-Native Observability on Kubernetes
  • Setting up Classic Observability Deployment
  • Configuring Logs
  • Enabling Logs for a Component
  • Configuring Logs
  • Managing Log Growth
  • Masking Sensitive Information in Logs
  • Timestamp Conversion for RDBMS Explains how to enable/disable time stamp conversions for the RDBMS databases configured for the Micro Integrator component..

    Deploying

    To deploy the Micro Integrator runtime, see the topics given below.

    Deployment Patterns This explains all the deployment patterns you can follow when you deploy WSO2 API manager. These patterns involve deploying the API Manager component together with Micro Integrator and Streaming Integrator components in clustered setups.
    Configuring a Micro Integrator Cluster Explains how to set up a two-node Micro Integrator cluster.
    Deployment Synchronization Set up deployment synchronization for the Micro Integrator.

    CI/CD

    To implement continuous integration and continuous deployment pipelined for integrations, see the topics given below.

    CI/CD for Integrations - Overview Find out about the methods of implementing CI/CD for integrations in the Micro Integrator.
    Building a CI/CD Pipeline for Integrations (VM deployment) See the instructions on how to implement a CI/CD pipeline for integrations in a VM deployment of the Micro Integrator.
    Building a CI/CD Pipeline for Integrations (K8s deployment) See the instructions on how to implement a CI/CD pipeline for integrations in a Kubernetes deployment of the Micro Integrator.

    To manage integration artifacts and logs in the Micro Integrator by using the API Controller (apictl), see the topics given below.

    Getting Started with WSO2 API Controller Explains how to set up the API Controller.
    Managing Integrations Explains how to manage integrations with the API Controller.

    Upgrading

    The Micro integrator of WSO2 Enterprise Integrator is the predecessor of the Micro Integrator component of WSO2 API Manager. To upgrade from a WSO2 Enterprise Integrator version, see the following topics.

    Upgrading from WSO2 EI 7.1.x to WSO2 API-M 4.0.0
    Upgrading from WSO2 EI 7.0.x to WSO2 API-M 4.0.0
    Upgrading from WSO2 EI 6.6.x to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.5.x to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.4.x to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.3.x to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.2.x to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.1.1 to WSO2 API-M 4.0.0
    Migrating from WSO2 EI 6.1.0 to WSO2 API-M 4.0.0

    Streaming Integrator

    This component develops streaming solutions that can be exposed as managed APIs asynchronously.

    Installing

    To install and run the Streaming Integrator, see the following topics.

    Installing the Streaming Integrator Runtime Explains how to download the Streaming Integrator runtime as a binary and install it on a virtual machine.
    Running the Streaming Integrator Runtime Explains how you can execute the Streaming Integrator runtime and start using its features.
    Running the Streaming Integrator as a Linux Service Explains how to install and run the Streaming Integrator as a Linux service.
    Running the Streaming Integrator as a Windows Service Explains how to install and run the Streaming Integrator as a Windows service.
    Installing the Streaming Integrator on Containers Explains how to install the Streaming Integrator component in different containerized environments. The topics covered are as follows:
  • Installing the Streaming Integrator on Docker
  • Installing the Streaming Integrator on kubernetes
  • Setting up

    Setting up the Streaming Integrator component involves performing the following tasks.


    Applying WSO2 Updates Explains how to get the latest updates that are available for a particular release of the Streaming Integrator.
    Production Checklist Lists all the setup tasks you need to complete in order to run the Streaming Integrator component in a production environment.
    Performance Analysis Results This has the results of the performance tests carried out for the Streaming Integrator component.
    Configuring Business Rules Deployment Explains how to configure a Streaming Integrator node to use a specified business rule template. Business rules templates are templates Streaming applications and queries that allow you to use the streaming logic ofWSO2 API Manager without writing queries from scratch.
    Configuring Data Sources Explains how to configure the data sources vis which the Streaming Integrator server and the Streaming Integrator Tooling connect to databases. This section also explains the default data sources configured for the Streaming Integrator and the Streaming Integrator Tooling.
    Securing the Streaming Integrator Explains how to secure the Streaming Integrator component and the data it handles. The topics covered are as follows.
  • General Data Protection Regulations
  • Working with Keystores
  • Protecting Sensitive Data via the Secure Vault
  • Supporting Different Transports Explains the setup tasks you need to complete to allow the Streaming Integrator component to work with different transports.
    Configuring State Persistence Explains how to prevent the loss of data that can result from a system failure by persisting the state of Streaming Integrator component periodically either into a database system or into the file system.
    Configuring Cluster Coordination Explains how to configure a cluster coordination strategy that determines how the Streaming Integrator nodes in a cluster coordinate with each other.
    Adding Third Party Non OSGi Libraries The Streaming Integrator component is OSGi-based. Therefore, when you are adding non-OSGi libraries to the Streaming Integrator pack, you need to first convert them into OSGi bundles. This section provides instructions to do this.
    Configuring Default Ports Explains the default ports that the Streaming Integrator component uses for different purposes when the port offset is 0.
    Changing the Host Name and Context Path of Web UI Applications Explains how to change the host name and the context path specified in the URLS via which the user interfaces of the Streaming Integrator are accessed.
    Enabling Logs for Received Event Count Explains how to configure the Streaming Integrator component to log the total number of events it received via its sources per given time interval.

    Deploying

    See the topics given below for instructions on setting up a Streaming Integrator deployment.

    Deployment Patterns This explains all the deployment patterns you can follow when you deploy WSO2 API manager. These patterns involve deploying the API Manager component together with Micro Integrator and Streaming Integrator components in clustered setups.
    Single-Node Streaming Integrator Deployment Instructions on setting up a single-node Streaming Integrator deployment.
    Minimum HA Streaming Integrator Deployment Instructions on setting up a Streaming Integrator deployment with minimum high availablity.
    Active-Active Streaming Integrator Deployment Instructions on setting up an Active-Active Streaming Integrator deployment.
    Scalable Streaming Integrator Deployment Instructions on setting up a scalable Streaming Integrator deployment.

    Reference

    Common Runtime and Configuration Artifacts Describes some artifacts that are commonly used with the API Manager component.
    Default Product Ports Explains the defauly ports used by the API Manager component.
    Product Compatibility Provides details relating to the compatibility of the API Manager component with different operating systems and JDKs, databases, key managers, web browsers, and other WSO2 products.
    Supported Cipher Suites Provides details of the supported cipher suites.
    Top