Creating an IBM API Management Version 2.0 environment

Transcription

1 Understand the tasks required to create an IBM API Management environment June 2013 Creating an IBM API Management Version 2.0 environment IBM API Management Version 2.0 Information Center 1

2 Table of Contents Introduction...3 Task summary...3 Planing the IBM API Management environment...3 Hardware requirements...3 Software requirements...4 Obtaining the virtual image templates...5 Creating the virtual images...6 Configuring the Gateway node...7 Accepting the Gateway license...9 Configuring Network Time Protocol (NTP) on the Gateway...9 Enabling the XML Management Interface Port...10 Configuring the Management node...10 Configuring the Analytics node...11 Configuring the Assembly Node...12 Defining the environment by using the Environment Console...14 Configuring your initial Management node...14 Creating a tenant account...17 Activating your API Manager account...17 Creating an IBM API Management Version 2.0 environment 2

3 Introduction Although IBM API Management Version 2.0 can be installed by using IBM PureApplication System, IBM Workload Deployer, or VMware, this document assumes that VMware is used. You can use the information to guide you through the various tasks that are required to create a basic IBM API Management environment. For example, an environment suitable for a development community. Task summary To define an IBM API Management environment, complete the following tasks. 1. Plan the environment that you want to implement in your enterprise. 2. Download and deploy the virtual image for each node type. 3. Configure each node and make a note of all of the network addresses. 4. Ensure that each node is initialized and active in your network. 5. Define your environment by using the Environment Console. Planing the IBM API Management environment Before you begin, ensure that you have the minimum hardware and software requirements installed. Hardware requirements One of the following IBM WebSphere DataPower Gateway appliances is required for use with IBM API Management V2.0. The IBM WebSphere DataPower appliance must be running a minimum firmware level of V6.0. IBM WebSphere DataPower Service Gateway XG45 Appliance IBM WebSphere DataPower Integration Appliance XI52 IBM WebSphere DataPower Integration Appliance XI50 IBM WebSphere DataPower Integration Blade XI50B IBM WebSphere DataPower Integration Appliance XI52 Virtual Edition IBM WebSphere DataPower Service Gateway XG45 Virtual Edition The following IBM WebSphere DataPower software feature is required for use with IBM API Management: Application Optimization One of the following IBM WebSphere Cast Iron appliances is required for use with IBM API Management V2.0 to take advantage of the rich API assembly feature. Creating an IBM API Management Version 2.0 environment 3

4 IBM WebSphere DataPower Cast Iron XH40 firmware V6.4 or later A previous level of IBM WebSphere DataPower Cast Iron XH40 Appliance with IBM WebSphere Cast Iron Hypervisor Edition V6.4 or later By using the API assembly feature, you can create APIs based on SOAP-to-REST conversions, access relational databases (IBM DB2, Microsoft SQL Server, and Oracle), access salesforce.com, or orchestrate an API implementation from multiple data sources. Software requirements IBM API Management V2.0 requires one of the following hosting environments running a minimum of the version specified: VMWare ESXi IBM Workload Deployer IBM PureApplication System W IBM API Management V2.0 requires one of the following browsers running a minimum of the version specified: Microsoft Internet Explorer V9 Mozilla Firefox 17 Google Chrome 23 Decide which node types you need, and how many nodes of each type that you want to use in your environment. IBM API Management supports four node types. Management (virtual only) Gateway Analytics (virtual only) Assembly (optional) Note: If you do not add an Assembly node you can define proxy APIs only. The Management node manages the operations of the various nodes in the IBM API Management environment and provides the tools to interface with the various nodes. The Environment Console, API Manager and Developer portal user interfaces run on the Management node. The Analytics node collects and stores information about APIs and API users, such as which APIs are being used, who is using the APIs, and how often are APIs being used. The Environment Console and API Manager user interfaces provide various views that you can use to access the statistics that are collected by the Analytics node. The Gateway node process and manages security protocols and stores relevant user and appliance authentication data. The Assembly node allows APIs to integrate with various endpoints, such as databases or Creating an IBM API Management Version 2.0 environment 4

5 HTTP-based endpoints. To provide high availability in your environment you can deploy two or more of each node type. In an environment with two Management nodes you need to define an external load balancer to distribute requests across the Management nodes. Consider whether you plan to use a combination of physical and virtual appliances, or, only virtual images. Obtaining the virtual image templates For the nodes that you are going to deploy as virtual images you need to obtain the relevant virtual image template (OVA product file). IBM API Management V2.0 provides the virtual image templates for the Management and Analytics nodes. You can obtain the Gateway node virtual image template from IBM DataPower Gateway Virtual Edition V6.0. The Assembly node virtual image template is obtained from IBM WebSphere DataPower Cast Iron Hypervisor Edition V6.4. Download the OVA file to a storage device that can be accessed by the host machine and where the software is to be installed. Each node type has its own OVA template that is used to create the node: Node Type Management Analytics Gateway Assembly OVA File Name APIManagement-ManagementAppliance.ova APIManagment-AnalyticsAppliance.ova Refer to the supplied product details WC-WCI.ova The following naming standard is used for the Management, Analytics, and Assembly OVA file names: <version>-<product name>-<component name>.ova Note: When you obtain an interim fix from the IBM Fix Central support site, the stem of the file name also includes the build identifier. For example, APIManagement- ManagementAppliance H4.ova Creating an IBM API Management Version 2.0 environment 5

6 Creating the virtual images You create each virtual image by deploying the relevant OVA template. At a minimum, one Management node, one Analytics node, and one Gateway node are required for a valid IBM API Management configuration. Regardless of what you initially define, you can add extra nodes to your environment in the future. If you are not using a physical appliance for the Gateway node, you might want to start with the Gateway OVA template because it takes more time to deploy. The images can be deployed concurrently, the process takes several minutes to complete. Deploy each virtual image by repeating the following steps: 1. Log in to your VMware vsphere Client console. In the VMware Infrastructure Client navigation pane, select the virtual machine on which to deploy the virtual image. 2. Select File > Deploy OVF Template. 3. Select the relevant location to Deploy from a file or URL. Choose the file location where you downloaded the OVA file. You can enter a URL if you want to download the OVA file from the Internet. 4. Specify the location of the OVF template. Click Next. 5. Verify the template details that are displayed. Click Next. 6. Specify the name and location for the deployed template. Click Next. 7. Select a deployment configuration option. Click Next. Standard - 1 CPU, 4GB RAM Enhanced - 2 CPU, 8GB RAM 8. Select the host or cluster on which to run the deployed template. Click Next. 9. Select a resource pool. Click Next. 10. Select the datastore in to which you want to store the virtual machine files. Enter the available disk space in GB Select a disk format option. Click Next. 11. Map the networks that are used in the OVF template to networks in your inventory. Select the IP address to be used for this appliance. Click Next. Creating an IBM API Management Version 2.0 environment 6

7 Important: Apart from the initial Management node which is automatically added, you enter this IP address in the Environment Console when you define a node. The Environment Console uses the IP network address to communicate with the appliance. 12. Verify that the options that you specified are correct. Select Power on after deployment. Click Finish. The virtual machine must be powered on when you define the node in the Environment Console. Otherwise, the IP address is not active and cannot be found. The OVF template is deployed to your virtual machine. Warning: After you successfully deploy the OVF template, do not attempt to modify the settings for hard disk 1 or hard disk 2. Deploy the relevant OVA templates to create each of the Management, Analytics, Gateway, and Assembly virtual nodes that you want to use in your IBM API Management environment. Configuring the Gateway node The Gateway node can be configured to include function that is not covered in this example. For more information, see IBM WebSphere DataPower Version 6.0 Information Center. The following example configuration is for a single Gateway node that uses static IP addresses. If you do not know the IP address details, consult your network manager. From the VMware vsphere Client console, select the Gateway image that you want to configure. 1. Enter the login name and password Login: admin Password: admin Press Enter 2. Enable Disaster Recovery mode [yes/no]?: yes 3. Enable Common Criteria Compatibility mode [yes/no]?: no 4. Please enter new password: <NewPassword> 5. Please re-enter new password to confirm: <NewPassword> Creating an IBM API Management Version 2.0 environment 7

8 6. Do you want to run the Install Wizard [y/n]?: y 7. Step 1 - Do you want to configure network interfaces? [y]: Press Enter Do you have this information? [y]: Press Enter For a single Gateway configuration: a) Do you want to configure the eth0 interface? [y]: Press Enter b) Do you want to enable DHCP? [y]: n c) Enter the IP address for the interface in CIDR notation: <APILoadBalancer- IPaddress> d) Enter the IP address for the default IPv4 gateway: <APILoadBalancergatewayIPaddress> e) Enter the IP address for the default IPv6 gateway: Press Enter f) Do you want to configure the eth1 interface? [y]: n Do you want to configure the eth2 interface? [y]: n Do you want to configure the eth3 interface? [y]: n 8. Step 2 - Do you want to configure network services? [y]: Press Enter Do you want to configure DNS? [y]: Press Enter Do you have this information? [y]: Press Enter Enter the IP address of the DNS server: <DNSServer-Ipaddress> 9. Step 3: Do you want to define a unique system identifier for this appliance? [y]: n 10. Step 4: Do you want to configure remote management access? [y]: Press Enter Do you have this information? [y]: Press Enter Do you want to enable ssh? [y]: Press Enter Enter the local IP address [0 for all]: Press Enter Enter the port number [22]: Press Enter Do you want to enabe WebGUI access [y]: Press Enter Enter the local IP address [0 for all]: Press Enter Enter the port number [9090]: Press Enter 11. Step 5 - Do you want to configure a user account that can reset passwords? [y]: n 12. Step 6 - Do you want to configure the hard disk array? [y]: n Do you want to review the current configuration? [y]: n Do you want to save the current configuration? [y]: Press Enter Creating an IBM API Management Version 2.0 environment 8

9 Overwrite previously saved configuration? [y/n]: y Important: Do not log out of the console until you have logged in to the Gateway (Datapower) WebGUI and accepted the license (detailed in the next section). Otherwise, you have to work through the wizard again. Accepting the Gateway license You must accept the license for each Gateway node. 1. In a browser, log in to the Gateway WebGUI a) User Name: admin b) Password: <NewPassword> c) Domain <name> d) Select Login 2. Accept the software license agreement. The Gateway restarts. The next time you log in to the Gateway console, the wizard is not displayed. Configuring Network Time Protocol (NTP) on the Gateway To configure Network Time Protocol on the Gateway node, the following example details the configuration commands that can be entered by using the command line interface (CLI ). For more information, see IBM WebSphere DataPower Version 6.0 Information Center. Consider configuring NTP on every node to ensure that there is a consistent time view. Any differences in the clocks across the nodes can cause problems. 1. Log in to the CLI of the DataPower appliance 2. Enter co 3. Enter ntp-service 4. Enter admin-state enabled 5. Enter remote-server <IPaddress> 6. Enter exit 7. Enter write mem To validate: Enter show time Creating an IBM API Management Version 2.0 environment 9

10 Enabling the XML Management Interface Port The XML Management Interface port must be enabled for IBM API Management. For more information, see IBM WebSphere DataPower Version 6.0 Information Center. For each Gateway node complete the following steps to enable the port number that is used to monitor incoming management requests: 1. In a browser, log in to the Gateway WebGUI a) User Name: admin b) Password: <NewPassword> c) Domain <name> d) Select Login 2. Select Network > Management > XML Management Interface a) Administrative State: Enabled b) Port Number: <PortNumber> c) Click Apply d) Click Save Config Configuring the Management node Each Management node must be configured. The following example covers both a single Management node configuration and a two Management node configuration. If you do not know the IP address details, consult your network manager. 1. From the VMware vsphere Client console, select the Management appliance > Console tab > click the screen > Press Enter a) Login: admin b) Password:!n0r1t5@C 2. For a single Management node configuration: a) Set the network address for the management interface: net set interface address <Management-LoadBalanceripaddress> mask <netmask> b) Set the gateway address: net set gateway static <Management-LoadBalancergatewayIPaddress> c) Set the host name for the management interface: net set hostname static <Management-LoadBalancerappliancehostname> 3. For a two Management node configuration: Creating an IBM API Management Version 2.0 environment 10

11 a) Set the network address for the management interface: net set interface address <Management-IPaddress> mask <netmask> b) Set the gateway address: net set gateway static <Management-gatewayIPaddress> c) Set the host name for the management interface: net set hostname static <Management-appliancehostname> 4. Set the DNS domain name: net set domain static <DNS-domain-name> 5. Search for hosts by using only the local domain: net set search static none 6. Set the DNS name server: net set nameserver static <DNS-nameserver-IPaddress> 7. Set the NTP server to the appropriate setting for your environment: a) If you have an NTP server on your network: net set ntp static <ntpaddress> b) If you do not have an NTP server on your network: net set ntp static none 8. Apply the network settings: net restart Configuring the Analytics node Each Analytics node must be configured. The following configuration example is for a single Analytics node. If you do not know the IP address details, consult your network manager. 1. From the VMware vsphere Client console, select the Analytics appliance > Console tab > Click the screen > Press Enter a) Login: admin b) Password:!n0r1t5@C 2. Set the network address for the management interface: net set interface address <Analytics-IPaddress> mask <netmask> Creating an IBM API Management Version 2.0 environment 11

12 3. Set the gateway address: net set gateway static <Analytics-gatewayIPaddress> 4. Set the host name for the management interface: net set hostname static <Unique-Analytics-appliancehostname> 5. Set the DNS domain name: net set domain static <DNS-domain-name> 6. Search for hosts by using only the local domain: net set search static none 7. Set the DNS name server: net set nameserver static <DNS-nameserver-IPaddress> 8. Set the NTP server to the appropriate setting for your environment: a) If you have an NTL server on your network: net set ntp static <ntpaddress> b) If you do not have an NTP server on your network: net set ntp static none 9. Apply the network settings: net restart Configuring the Assembly Node Each Assembly node must be configured. The following configuration example is for a single Assembly node. If you do not know the IP address details, consult your network manager. 1. From the VMware vsphere Client console, select the Assembly appliance > Console tab > Click the screen > Press Enter Login: admin Password:!n0r1t5@C 2. Set the network address for the management interface: net set interface emgmt address <Assembly-management- IPaddress> mask <netmask> Creating an IBM API Management Version 2.0 environment 12

13 3. Set the gateway address: net set gateway static <Assembly-management-gatewayIPaddress> emgmt 4. Set the network address for the data interface: net set interface edata address <Assembly-data-IPaddress> mask <netmask> 5. Set the host name for the management interface: net set hostname static <Unique-Assembly-appliancehostname> 6. Set the DNS domain name: net set domain static <DNS-domain-name> 7. Search for hosts by using only the local domain: net set search static none 8. Set the DNS name server: net set nameserver static <DNS-nameserver-IPaddress> 9. Set the NTP server to the appropriate setting for your environment: a) If you have an NTP server on your network: net set ntp static <ntpaddress> b) If you do not have an NTL server on your network: net set ntp static none 10. Apply the network settings: net restart 10. Monitor the state of the network: net show status 11. Verify the settings by entering the following command: net show active 12. Close the session: exit Creating an IBM API Management Version 2.0 environment 13

14 Defining the environment by using the Environment Console The first time that you access the Environment Console user interface you must create an API management environment, which includes registering as the initial Environment Console user. You can use the Environment Console to configure your existing API management environments and to update settings at the environment level; for example, security certificates, load balancing options, and data storage settings. For more information, see IBM API Management Version 2.0 Information Center. Configuring your initial Management node 1. In your browser, log in to the Environment Console: 2. Create a User Account. Complete all of the fields to register as the initial Environment console user. USER NAME: admin ADDRESS: <Your Address> CONFIRM ADDRESS: <Your Address> PASSWORD: <YourPassword> CONFIRM PASSWORD: <YourPassword> Click Create 3. Define the name for your new Environment. ENVIRONMENT NAME: <MyDevelopment> Click Next 4. Connect to an existing Server. The server is used to send s, for example, when a new tenant account is requested. HOST NAME: <Your HostName> PORT: <Your HostPortNumber> USER NAME: Optional. If your server requires you to authenticate, in the USER NAME field, enter the administrative user name for the SMTP server. PASSWORD: Optional. If your server requires you to authenticate, in the PASSWORD field, enter the administrative password for the SMTP server. SENDER ADDRESS: < AddressForSending s> SENDER DESCRIPTIVE NAME: <DescriptionOf Sender (For example, IT Support Team> Click Next Creating an IBM API Management Version 2.0 environment 14

15 5. Define your Gateway Tier Configuration For a single-nic Gateway configuration: Network Interface: Select Use one network interface for internal traffic and inbound API calls Load Balancing for Inbound API Calls: Select No load balancer (only one Gateway node) If you plan to add a second Gateway node then select one of the load balancing options. Selecting No load balancer means that you cannot add a second Gateway node later. Adding a second Gateway node requires an external load balancer which needs to use the same API date port that the Gateway tier is configured to use. Required Ports: API DATA PORT FOR INBOUND API CALLS: <PortNumber> RESERVED PORT BASE FOR INTERNAL TRAFFIC: <PortNumber> The API Data Port is the port number that is exposed to API users and the reserved port base number needs to be the start of a a free range of 10 ports on the appliance. Click Next Although this example uses a single single-nic Gateway configuration, you might want to define a dual-nic Gateway configuration so that you can route the API network traffic and internal traffic on separate networks. This is relevant if the APIs are going to be published externally. You can connect one NIC to a network in your DMZ and use that for API calls and connect another NIC to an internal network. 6. Endpoints page. When you create your environment, you must define the domain names for the API Manager, the Developer Portal, and inbound API calls. Important: Ensure that the domain names that you enter are correct because these fields cannot be changed later. For a Developer Portal tenant, a subdomain of the domain name is used. The subdomain is named after the tenant. For example, if the domain name is developer.example.com and you have a tenant name of sales, the Developer Portal for this tenant uses the domain name sales.developer.example.com. a) API Manager section DOMAIN NAME: Enter the domain name through which your tenants access the API Manager user interface. b) Developer Portal section DOMAIN NAME: Enter the domain name through which your tenants access Creating an IBM API Management Version 2.0 environment 15

16 the Developer Portal user interface. b) Inbound API Calls section DOMAIN NAME: Enter the domain name and port through which your APIs are called. The tenant sub-domain also applies to the API calls domain name. ASSOCIATED DNS CERTIFICATE: Select Generate a self-signed certificate c) Click Next 7. Configure Topology page a) Select Gateway Tier and click Add Node (for each Gateway appliance that you want to use) Configure Gateway Node page (For a single-nic Gateway) Internal Traffic section 1. HOST NAME: <Gateway-IPaddress> 2. NETWORK INTERFACE: <GatewayNetworkInterfaceName> For example, eth1 XML Management Interface section 1. USER NAME: admin 2. PASSWORD: <Password> 3. XML MANAGEMENT PORT: <PortNumber> 4. Do not select The XML management interface on this node uses a custom security certificate. Click Save b) Select Analytics Tier and click Add Node (for each Analytics appliance that you want to use) Configure Analytics Node page HOST NAME: <Analytics-IPaddress> USER NAME: admin PASSWORD:!n0r1t5@C Enter the same user name and password that you specified during the initialization of the appliance. Click Save c) Select Assembly Tier and click Add Node (for each Assembly appliance that you want to use) Configure Assembly Node page HOST NAME: <Assembly-management-IPaddress> USER NAME: admin PASSWORD:!n0r1t5@C Creating an IBM API Management Version 2.0 environment 16

17 8. Click Finish Enter the same user name and password that you specified during the initialization of the appliance. Click Save Creating a tenant account To use the IBM API Management environment that you have just created, you must create a tenant account and add a user for that tenant account. 1. From the Environment Console, in the drop-down navigation, click Manage Tenants > Create New Tenant a) New Account: <UniqueTenantAccountName> The tenant name is automatically generated from the tenant account name, but any non-alphanumeric characters, such as spaces and hyphens, are removed. For example, if you entered My I.T. Company for the new account name, the corresponding tenant name is myitcompany. b) In the Details panel, complete the required fields: FIRST NAME: <FirstNameOfTenantAccountHolder> LAST NAME: <LastNameOfTenantAccountHolder> <TenantAccountHolder> c) Click Create and Send Invite. A note is sent to the address that you entered. d) Click Finish Activating your API Manager account 1. In your account, open the Activation note. To confirm the registration and activate your account, you must select the link that is provided. You receive another two s. One note contains your admin@tenantname IBM API Manager user name. The other note contains your password. The admin user ID has the authority to create and define APIs, to invite other API authors to access the account, and manage the company Developer Portal. 2. Select the link that is included in the Login details for your company name APIs . Creating an IBM API Management Version 2.0 environment 17

18 3. In the API Manager user interface, enter the user name that is included in the Login details for your company name APIs In the API Manager user interface, enter the password sent in the Your IBM API Management login password . The Getting Started with IBM API Manager view opens. You can now start to define your API environment. In the Getting Started with IBM API Manager view, you can click one of the three options displayed: Create to define and implement your APIs. Socialize to customize and publish your Developer Portal. Manage to analyze your API traffic. For more information, see IBM API Management Version 2.0 Information Center. The sample Create a proxy API tutorial in the IBM API Manager section of the information center, guides you through how to define, implement, and test a proxy API. Creating an IBM API Management Version 2.0 environment 18

19 Copyright IBM Corporation 2013 US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, ibm.com, Cast Iron, DataPower, and WebSphere are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copyright and trademark information at ml. All statements regarding IBM plans, directions, and intent are subject to change or withdrawal without notice. Creating an IBM API Management Version 2.0 environment 19