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: Configure a Third-party Key Manager Configuring WSO2 Identity Server as a Key Manager
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. Configuring the Proxy Server and the Load Balancer Adding a Custom Proxy Path
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: Logins and Passwords Maintaining Logins and Passwords Securing Passwords Customizing Secure Vault Set Passwords using Environment Variables/System Properties Working with Encrypted Passwords Configuring Keystores Configuring Keystores in API Manager Keystore Basics Creating a New Keystore Renewing a CA Signed Certificate About Asymetric Cryptography Enabling HostName Verification Enabling Java Security Manager General Data Protection Regulation (GDPR) for WSO2 API Manager Configuring Transport Level Security User Account Management
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: Introduction to User Stores Configuring Primary User Stores Configuring a JDBC User Store Configuring a Read-Write LDAP User Store Configuring a Read-Only LDAP User Store Configuring a Read-Write Active Directory User Store
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 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
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 refer Upgrade WSO2 API Manager.

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.