Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide explains how to set up an API Manager cluster in an Amazon Web Services (AWS) instance.

...

To create a VPC Internet gateway, go to your AWS instance and click Services -> VPC -> Internet Gateways. Then, click Create Internet Gateway  and give a name for your new gateway. Here's an example:

Creating subnets

A subnet  is  a range of IP addresses in your VPC. You can launch AWS resources into a subnet that you select. Use a public subnet for resources that must be connected to the Internet, and a private subnet for the ones that don't. 

According to the deployment pattern shared earlier, you need the following seven subnets across the three availability zones. You can use a subnet naming convention of your choice.

...

To create a new key pair, go to your AWS instance and click  Services -> EC2 -> Key pair -> Create Key Pair. Then, download the created key pair to your host machine.

Creating instances

Let's see how to create six instances as follows:

Creating a NAT instance

A network address translation (NAT) instance is used in a public subnet in your VPC to enable instances in the private subnet to initiate outbound traffic to the Internet. It also prevents the instances from receiving inbound traffic initiated by someone on the Internet.

...

  1. Find the EC2 NAT instance by clicking  Services -> EC2 -> AMI  in your AWS instance and giving the  AMI ID (e.g., ami-ad227cc4).
  2. Select the AMI and click Launch.
  3. Choose an instance type (e.g., m1.small) and proceed to c onfigure the instance details .
  4. In the Configure Instance Details page that opens, select the network and subnet and enable the public IP. Keep the default settings for the network interfaces and advanced details and proceed to  add storage information.
    Image Removed Image Added
  5. In the Add Storage page that opens, set the optimal storage and proceed to  tag the instance .
  6. Set a tag for your instance in the Tag Instance page that opens. Then, proceed to the configure a security group.
  7. In the Configure Security Group page that opens, select apim-natsg as the security group, and then click Review and Launch .
  8. In the Review page that opens, your  instance configuration summary is listed. Verify its accuracy and click  Launch .
  9. Select the key pair that you created earlier and click Launch Instances.
  10. Go to your AWS instance, click  Services -> EC2 -> Instances select  apim-natbox and note the  NAT instance that you just created listed there.

...

Creating a bastion instance

A bastion is a special-purpose server instance that is designed to be the primary access point from the Internet. It acts as a proxy to your other EC2 instances. In this guide, we use it as a base instance in our VPC and configure it to connect to other instances in our VPC via SSH.

Follow the steps below to create a bastion instance:

...

Creating a puppet master instance

puppet is a configuration management system that allows you to define the state of your IT infrastructure, then automatically enforces the correct state.

Follow the steps below to create a puppet master instance. 

...

  1. In your AWS instance, click S ervices -> RDS -> Subnet Groups -> Create DB Subnet Group.

  2. In the Create DB Subnet Group page that opens, fill in the details according to your environment  and click  Create .
    In this guide, we select the VPC that is created here and add the two subnets that are hosted in two availability  zones separately.

    Next, let's create the RDS instance. 

  3. In your AWS instance, click Services -> RDS -> Instance -> Launch DB Instance .

  4. Select MySQL as the database engine.

  5. In the second step, choose the options to use Multi-AZ deployment.

  6. In step 3, the  Specify DB Details page, enter the database settings.
    In this guide, the DB instance identifier is apim-db and master username is wso2.

  7. In the Configure Advanced Settings page, set the network, database options, and backup plans.
    Image Modified

  8. Go to your AWS instance and click  Services -> RDS -> Instances. Then,  select the database that you created earlier (in this example, it is  apim-db) and note the details of the RDS instance that you just created.  The Endpoint specifies the server URL for connecting to the database.

...

  1. Connect to the bastion instance using SSH.

    Code Block
    root# ssh -i <security certificate file path> ubuntu@<give the public IP>
  2. Connect to the MySQL server using the MySQL client.
  3. Create the databases described in https://docs.wso2.com/display/AM190/Setting+up+MySQL  using the MySQL server. Note that you can change the names of these databases as you like.

...

  1.  In your AWS instance, click Services -> EC2 -> Load Balancers -> Create Load Balancer.
  2. In the Define Load Balancer page that opens, give a name for the ELB (e.g., apim-elb-pubstore), specify the VPC, and map the incoming port to another port in the backend by configuring the Basic Configuration tab as shown below:
  3. On the Select Subnets tab, add the DMZ subnets as selected subnets and go to the next page.
  4. In the Assign Security Groups page that opens, select apim-dmz-sg as the security group and go to the next page.
  5. In the Configure Security Settings page that opens, configure the SSL details and proceed to the next page.

  6. In the Configure Health Check page that opens, set the following options and proceed to the next page.
    • Ping port: 9443

    • Ping path /services/echo?wsdl

  7. Leave the default settings in the Add EC2 Instances page that opens and proceed to the next page. You can edit the ELB later to add the instances that are fronted by this ELB.
  8. In the Add Tags page that opens, tag the ELB and click Create.
  9. Click the load balancer's name in the status message that appears confirming that the load balancer is created.
  10. Find the DNS name in the ELB’s description tab and make a note of it. You need this later for configuring the Puppet Master parameter file.

  11. Repeat the steps you used to create the apim-elb-pubstore ELB to create apim-elb-keymanager, apim-elb-gateway-mgt, and apim-elb-gateway-wkr ELBs as well.

...

 Let's see how to spawn each type of instance:

 

Spawning the PubStore instance

Navigate to Services -> EC2 -> AMIs, use the AMI ID that you created previously to find the base instance AMI, and then click Launch.

 

 




Spawning the Key Manager instance








Spawning the Gateway Manager instance





 

Spawning the Gateway Worker instance





Adding instances to the ELBs



Configuring auto-scaling