Running PMM Server Using AWS Marketplace¶

Setting up a VPC and an EC2 Instance Type¶

In this demonstration, we use the VPC (virtual private cloud) named

vpc-484bb12f. The exact name of VPC may be different from the example discussed here.

Select VPC in the VPC Settings section.

Instead of a VPC (virtual private cloud) you may choose the EC2 Classic (no VPC) option and use a public cloud.

Selecting a subnet, you effectively choose an availability zone in the selected region. We recommend that you choose the availability zone where your RDS is located.

Note that the cost estimation is automatically updated based on your choice.

Limiting Access to the instance: security group and a key pair¶

In the Security Group section, which acts like a firewall, you may use the preselected option Create new based on seller settings to create a security group with recommended settings. In the Key Pair select an already set up EC2 key pair to limit access to your instance.

Select an already existing key pair (use the EC2 console to create one if necessary)

Select a security group which manages firewall settings.

Applying settings¶

Scroll up to the top of the page to view your settings. Then, click the Launch with 1 click button to continue and adjust your settings in the EC2 console.

Your instance settings are summarized in a special area. Click the Launch with 1 click button to continue.

Adjusting instance settings in the EC2 Console¶

Your clicking the Launch with 1 click button, deploys your instance. To continue setting up your instance, run the EC2 console. It is available as a link at the top of the page that opens after you click the Launch with 1 click button.

Your instance appears in the EC2 console in a table that lists all instances available to you. When a new instance is only created, it has no name. Make sure that you give it a name to distinguish from other instances managed via the EC2 console.

The newly created instance selected.

Running the instance¶

After you add your new instance it will take some time to initialize it. When the AWS console reports that the instance is now in a running state, you many continue with configuration of PMM Server.

With your instance selected, open its IP address in a web browser. The IP address appears in the IPv4 Public IP column or as value of the Public IP field at the top of the Properties panel.

The public IP address of the instance

To run the instance, copy and paste its public IP address to the location bar of your browser. In the Percona Monitoring and Management welcome page that opens, enter the instance ID.

Entering the instance ID when installing PMM Server

You can copy the instance ID from the Properties panel of your instance, select the Description tab back in the EC2 console. Click the Copy button next to the Instance ID field. This button appears as soon as you hover the cursor of your mouse over the ID.

Hover the cursor over the instance ID for the Copy button to appear.

Paste the instance in the Instance ID field of the Percona Monitoring and Management welcome page and click Submit.

Click Submit and enter your user name and password in the dialog window that pops up. The PMM Server is now ready and the home page opens.

Create credentials for your instance.

Click Submit and enter your user name and password in the dialog window that pops up. The PMM Server is now ready and the home page opens.

PMM Server home page

You are creating a username and password that will be used for two purposes:

1. authentication as a user to PMM - this will be the credentials you need in order to log in to PMM.

2. authentication between PMM Server and PMM Clients - you will re-use these credentials when configuring pmm-client for the first time on a server, for example:

   Run this command as root or by using the sudo command

   $ pmm-admin config --username= --password= --server=1.2.3.4
   

Resizing the EBS Volume¶

Your instance comes with a predefined size which can become a limitation. To make more disk space available to your instance, you need to increase the size of the EBS volume as needed and then your instance will reconfigure itself to use the new size.

The procedure of resizing EBS volumes is described in the Amazon documentation: Modifying the Size, IOPS, or Type of an EBS Volume on Linux.

After the EBS volume is updated, PMM Server instance will autodetect changes in approximately 5 minutes or less and will reconfigure itself for the updated conditions.

Running from Command Line¶

1. Launch the PMM Server instance using the run-instances command for the corresponding region and image. For example:

   aws ec2 run-instances \
      --image-id ami-30ad0f4d \
      --security-group-ids sg-3b6e5e46 \
      --instance-type t2.micro \
      --subnet-id subnet-4765a930 \
      --region us-east-1 \
      --key-name SSH-KEYNAME
   

   Note

   Providing the public SSH key is optional. Specify it if you want SSH access to PMM Server.

2. Set a name for the instance using the create-tags command. For example:

   aws ec2 create-tags  \
      --resources i-XXXX-INSTANCE-ID-XXXX \
      --region us-east-1 \
      --tags Key=Name,Value=OWNER_NAME-pmm
   

3. Get the IP address for accessing PMM Server from console output using the get-console-output command. For example:

   aws ec2 get-console-output \
      --instance-id i-XXXX-INSTANCE-ID-XXXX \
      --region us-east-1 \
      --output text \
      | grep cloud-init
   

Upgrading EC2 instance class¶

Upgrading to a larger EC2 instance class is supported by PMM provided you follow the instructions from the AWS manual. The PMM AMI image uses a distinct EBS volume for the PMM data volume which permits independent resize of the EC2 instance without impacting the EBS volume.

Expanding the PMM Data EBS Volume¶

The PMM data volume is mounted as an XFS formatted volume on top of an LVM volume. There are two ways to increase this volume size:

1. Add a new disk via EC2 console or API, and expand the LVM volume to include the new disk volume.
2. Expand existing EBS volume and grow the LVM volume.