Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AMI Verification changes (PMM-13053) #1301

Open
wants to merge 13 commits into
base: PMM3-branch
Choose a base branch
from
62 changes: 31 additions & 31 deletions docs/install-pmm/install-pmm-server/aws/aws.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
# Install PMM Server on AWS Marketplace
# Install PMM Server from AWS Marketplace

You can run an instance of PMM Server hosted at AWS Marketplace.

Assuming that you have an AWS (Amazon Web Services) account, locate *Percona Monitoring and Management Server* in [AWS Marketplace](https://aws.amazon.com/marketplace) or use [this link](https://aws.amazon.com/marketplace/pp/B077J7FYGX).

![!](../../../_images/PMM_AWS_Marketplace.png)

Selecting a region and instance type in the *Pricing Information* section will give you an estimate of the costs involved. This is only an indication of costs. You will choose regions and instance types in later steps.

Percona Monitoring and Management Server is provided at no cost, but you may need to pay for infrastructure costs.

!!! note alert alert-primary ""
Disk space consumed by PMM Server depends on the number of hosts being monitored. Although each environment will be unique, you can consider the data consumption figures for the [PMM Demo](https://pmmdemo.percona.com/) web site which consumes approximately 230 MB per host per day, or approximately 6.9 GB per host at the default 30 day retention period.

For more information, see our blog post [How much disk space should I allocate for Percona Monitoring and Management?](https://www.percona.com/blog/2017/05/04/how-much-disk-space-should-i-allocate-for-percona-monitoring-and-management/).

To install PMM Server on AWS:
To install PMM Server from AWS Marketplace:
{.power-number}

1. Click **Continue to Subscribe**.
1. Access the AWS Marketplace: Go to [AWS Marketplace](https://aws.amazon.com/marketplace) and search for **Percona Monitoring and Management Server** or [access the PMM Server listing] directly.

2. **Subscribe to this software**: Check the terms and conditions and click *Continue to Configuration*.
2. Subscribe to PMM Server: click **Continue to Subscribe** on the PMM Server listing page, review the terms and conditions, then click **Continue to Configuration**.

3. **Configure this software**:
3. Configure PMM Server: Select the latest version (recommended), choose the AWS region where you want to deploy PMM, then click **Continue to Launch**.
4. Launch the PMM Server:

1. Select a value for **Software Version**. (The latest is {{release}}.)
2. Select a region. (You can change this in the next step.)
3. Click **Continue to Launch**.
4.1. Choose **Launch from Website** to configure and launch directly from the AWS Marketplace or **Launch through EC2** if you prefer launching via the EC2 Management Console for more customization.

4.2. In the **EC2 Instance Type** field, select an appropriate instance type based on your monitoring needs and anticipated load.

4.3. In the **VPC Settings** field, choose an existing VPC or create a new one to host your PMM Server.

4.4. In the **Subnet Settings** field, select an existing subnet or create a new one within your VPC.

4.5. In the **Security Group Settings** field, choose an existing security group or create a new one based on the default settings provided by the seller.

4.6. In the **Key Pair Settings** field, select an existing key pair for SSH access, or create a new one if necessary.

4.7. Click **Launch** to deploy the PMM Server.

4. **Launch this software**:
Once the instance is launched, it will appear in the EC2 console.

1. **Choose Action**: Select a launch option. **Launch from Website** is a quick way to make your instance ready. For more control, choose *Launch through EC2*.
Make sure to assign a meaningful name to the instance to help distinguish it from others in your environment.

2. **EC2 Instance Type**: Select an instance type.
## Security consideration

3. **VPC Settings**: Choose or create a VPC (virtual private cloud).
- Ensure that your security group allows inbound traffic on ports **22** (SSH), **80** (HTTP), and **443** (HTTPS).
- If PMM needs to monitor an RDS instance, make sure it can access port **3306** on the RDS.

4. **Subnet Settings**: Choose or create a subnet.
## Service costs

5. **Security Group Settings**: Choose a security group or click *Create New Based On Seller Settings
While Percona Monitoring and Management Server itself is provided at no cost, be aware that you will incur AWS infrastructure costs based on the EC2 instance type, storage, and data transfer.

6. **Key Pair Settings**: Choose or create a key pair.
## Disk space consumption

7. Click **Launch**.
The disk space required by PMM Server depends on the number of monitored hosts and the retention period for the data.

As a reference, the [PMM Demo](https://pmmdemo.percona.com/) site consumes approximately 230 MB per host per day, which totals around 6.9 GB per host over a 30-day retention period.
Tip: You can estimate your disk space needs based on the number of hosts and the desired retention period.

For more information, see our blog post [How much disk space should I allocate for Percona Monitoring and Management](https://www.percona.com/blog/2017/05/04/how-much-disk-space-should-i-allocate-for-percona-monitoring-and-management/).
2 changes: 1 addition & 1 deletion docs/install-pmm/install-pmm-server/aws/limit_access.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Limit Access to the instance
# Limit Access to an AWS instance

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Remove PMM Server
# Remove PMM Server from AWS

To remove PMM Server:
{.power-number}


1. Find the instance in the EC2 Console.

Expand Down
84 changes: 52 additions & 32 deletions docs/install-pmm/install-pmm-server/aws/run.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,79 @@
# Run the instance
# Launch PMM Server on AWS

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 may continue with configuration of PMM Server.
After [installing PMM Server from AWS Marketplace](../aws/aws.md):
{.power-number}

!!! note alert alert-primary "Note"
When started the next time after rebooting, your instance may acquire another IP address. You may choose to set up an elastic IP to avoid this problem.
1. Wait until the AWS console reports that the instance is running.

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.
2. Select your instance and open its IP address in a web browser. You can find the IP address in the **IPv4 Public IP** column or at the top of the **Properties** panel under the **Public IP** field:

![!image](../../../_images/aws-marketplace.pmm.ec2.properties.png)
![!image](../../../_images/aws-marketplace.pmm.ec2.properties.png)

To run the instance, copy and paste its public IP address into the location bar of your browser. In the **Percona Monitoring and Management** welcome page that opens, enter the instance ID.
3. On the Percona Monitoring and Management Welcome page, enter the instance ID in the EC2 console to initialize PMM Server.
4. Log in using the default credentials:
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved
- Username: `admin`
- Password: <your instance ID>

![!image](../../../_images/installation-wizard.ami.instance-id-verification.png)
5. Change the default credentials then use the new ones on the PMM Server home page.

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.
![PMM Home Dashboard](../../../_images/PMM_Home_Dashboard.png)

Hover the cursor over the instance ID for the Copy button to appear.
These credentials not only manage access to the PMM web interface but also facilitate authentication between the PMM Server and PMM Clients. You will need to reuse these credentials when configuring PMM Clients on other hosts.

![!image](../../../_images/aws-marketplace.pmm.ec2.properties.instance-id.png)
!!! note alert alert-primary ""
For SSH access instructions, see [Connecting to Your Linux Instance Using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html). Replace the user name `ec2-user` with `admin`.

catalinaadam marked this conversation as resolved.
Show resolved Hide resolved
Paste the instance in the **Instance ID** field of the **Percona Monitoring and Management** welcome page and click **Submit**.
## Configure PMM Server IP Settings

PMM Server provides user access control, and therefore you will need user credentials to access it:
### Configure PMM Server to use a private IP only

![!image](../../../_images/PMM_Login.jpg)
By default, your EC2 instance will have a private IP for internal VPC network access. To use only the private IP:

- Default user name: `admin`
- Default password: `admin`
#### During EC2 instance creation

You will be prompted to change the default password every time you log in.
{.power-number}
1. In the **Network Settings** section, uncheck **Auto-assign public IP**.
2. Do not assign an Elastic IP to the instance.

The PMM Server is now ready and the home page opens.
#### For an existing instance
{.power-number}

![!image](../../../_images/PMM_Home_Dashboard.png)
1. If a public IP is assigned, remove it by disassociating it in the EC2 console.
2. If an Elastic IP is assigned, disassociate it from the instance.

You are creating a username and password that will be used for two purposes:
#### To access your PMM Server using only a private IP
{.power-number}

1. authentication as a user to PMM - the credentials to log in to PMM.
1. Ensure you're connected to your VPC.
2. Use the private IP address to access the PMM Server dashboard.

2. authentication between PMM Server and PMM Clients - you will re-use these credentials on another host when configuring PMM Client for the first time on a server, for example (DO NOT RUN ON THIS PMM SERVER YOU JUST CREATED):
### Configure PMM Server to use an Elastic IP (pptional)

For a static, public-facing IP address:
{.power-number}

```sh
pmm-admin config --server-insecure-tls --server-url=https://admin:admin@<IP Address>:443
```
1. Allocate an Elastic IP address in the EC2 console.
2. Associate the Elastic IP address with your EC2 instance's Network interface ID.

!!! note alert alert-primary ""
For instructions about how to access your instances by using an SSH client, see [Connecting to Your Linux Instance Using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html)

Make sure to replace the user name `ec2-user` used in this document with `admin`.
!!! note alert alert-primary ""
Associating a new Elastic IP to an instance with an existing Elastic IP will disassociate the old one, but it will remain allocated to your account

For detailed information on EC2 instance IP addressing, see the [AWS documentation on using instance addressing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html).

## Resize the EBS volume

To increase available disk space:
{.power-number}

## Resize the EBS Volume
1. Increase the size of the EBS volume as needed. For instructions, see [Modifying the Size, IOPS, or Type of an EBS Volume on Linux](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html).
2. After updating the EBS volume, PMM Server will auto-detect changes within approximately 5 minutes and reconfigure itself.

Your AWS 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.
## PMM Client configuration example

The procedure of resizing EBS volumes is described in the Amazon documentation: [Modifying the Size, IOPS, or Type of an EBS Volume on Linux](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html).
When setting up PMM Client on another host, use a command similar to this (DO NOT RUN ON THE PMM SERVER):

After the EBS volume is updated, PMM Server instance will auto-detect changes in approximately 5 minutes or less and will reconfigure itself for the updated conditions.
```sh
pmm-admin config --server-insecure-tls --server-url=https://admin:admin@<IP Address>:443
```
Replace `admin:admin` with your actual credentials and `<IP Address>` with your PMM Server's IP.
Loading