Prerequisites › Configure CA API Gateway Virtual Appliance

Configure CA API Gateway Virtual Appliance

Introduction

This document walks you through how to download, configure, and run the CA API Gateway Virtual Appliance in an on-premise configuration.

The term Virtual Appliance refers to that this version is supplied as a staged Red Hat Linux VM image that comes with the CA API Gateway software preinstalled. Once running within a compatible VM host, it requires only minimal configuration to start publishing and using services through the CA API Gateway.

The target audience for this document is anyone who:

• Is using a CA Application Development product that supports CA API Gateway, for example, CA App Services Orchestrator or CA Plex r7.2.
• Has a requirement to host and manage a CA API Gateway within their own Local Area Network, that is, on-premise.

Prerequisites

To successfully download, configure, and run the CA API Gateway Virtual Appliance, follow these steps:

1. Run the virtual appliance on a 64-bit PC with at least 16 GB of RAM.
2. Have access to a CA API Gateway Customer Support Portal username and password.
3. Obtain a CA API Gateway license file (contact CA Support for details).
4. Comply with all other prerequisites listed in the CA API Gateway – XML Accelerator (Virtual Appliance) Getting Started Guide.

Notes:

• You may have received items (2) and (3) as part of a customer validation program in which you are enrolled. If you are enrolled in multiple customer validation programs that require the use of a running CA API Gateway instance, the same details are shared between all validation programs in which you are enrolled.
• Do not hesitate to contact CA Support for assistance getting access to the CA API Gateway Customer Portal, obtaining a CA API Gateway license file, or both.

Download and Installation Instructions

To run a CA API Gateway instance, download the following CA API Management components:

• SSG_64bit_VirtualAppliance_v8.2.00.ova: This Open Virtualization Format (OVA) file contains the CA API Gateway virtual appliance that you runs under a compatible VM host.
• CA API Gateway Virtual Appliance Getting Started, Rev2.1.pdf: This 12 page document contains details on how to configure, license, and run the CA API Gateway Virtual Appliance.
• CA API Gateway Policy Manager 8.2.00 Installer.exe: This installs the desktop version of the Policy Manager Client. It is a Windows-based tool that allows you to connect to, view, and manage the CA API Gateway and the services that are published within it.

To download the necessary files, follow these steps:

1. Go to http://www.layer7tech.com/support and log in using your CA API Gateway Support Portal credentials.
2. On the main page, select Downloads.
3. In the Content Search section, select the following files and click Search:
   1. Select VMware Appliance Image.

      Locate the SSG_64bit_VirtualAppliance_v8.2.00.ova file and download it.

   2. Select Documentation.

      Locate the CA API Gateway Virtual Appliance Getting Started, Rev2.1.pdf document and download it.

   3. Select Policy Manager.

      Locate the Layer 7 Policy Manager 8.2.00 Installer.exe file, download, and install it.

You have now downloaded the files necessary to install and manage the CA API Gateway.

Follow the steps in the CA API Gateway – XML Accelerator (Virtual Appliance) Getting Started guide to find out how to:

1. Run the CA API Gateway Virtual Appliance under VMware Player, Workstation, or ESX Server.
2. Configure the running CA API Gateway Virtual Appliance instance.
3. Install the CA API Gateway license that the CA Support team provided.

Next Steps

Once you have successfully connected to the CA API Gateway Virtual Appliance using the Policy Manager and installed a license, you are ready to start publishing services into CA API Gateway.