Skip to content

Quick Start On AWS Marketplace

Installation Requirements

This guide outlines the requirements and preparation steps needed to deploy the Whaleal Platform (WAP) and its MongoDB agent on the AWS Marketplace.

By following this guide, you can prepare for a successful deployment and avoid common setup issues.

Whaleal Platform

Hardware Requirements

Minimum Requirements: 8 cores, 16GB of RAM, 500GB disk space.

Node Number CPU Memory Disk
50 8+ 16GB+ 500GB+additional storage for logs
200 16+ 32GB+ 500GB+additional storage for logs
200+ Please contact the Whaleal Team for specific requirements.

Operating System Requirements

Operating System Version Architecture
Amazon Linux 2023 x86_64

Software Requirements

Java Environment Requirements

JAVA Version
open-jdk 17.0

Network Requirements

TCP

Ensure that all Whaleal Platform Application services can communicate effectively over TCP/IP.

  • Whaleal Platform Application Database
  • Whaleal Platform Application Agent Monitor MongoDB

Hosts

To ensure plug-and-play functionality, the Whaleal Platform Server requires the external IP to be open.

Port

The Whaleal Platform Application must meet the following basic requirements:

  • Users and the Whaleal Platform Application Agent must be able to access via HTTP/HTTPS requests.
  • The Whaleal Platform Application must be able to access the Whaleal Platform Application Database.
  • All Whaleal Platform Applications and Whaleal Platform Application Agents must be able to access the monitored and managed MongoDB services.
  • The Whaleal Platform Application must be able to send information to users via email, DingTalk, Feishu, Webhook.

The Whaleal Platform Application must open the following ports:

Service Default Port Transport Direction illustrate
Whaleal Platform 80 TCP Inbound Web Access

If a custom port is needed, please open the port.

Port at host

Service Default Port Transport Direction
ssh 22 TCP Inbound

MongoDB - Agent

Hardware Requirements

Minimum: 2 cores, 4GB RAM

Operating System

Operating System Version Architecture
Amazon 2023 x86_64

Software Requirements

Java Environment Requirements

JAVA Version
open-jdk 17.0

Network Requirements

Port

The Whaleal Platform Application Agent must meet the following basic requirements:

  • Users and the Whaleal Platform Application must be able to access the server and MongoDB.
  • Therefore, the Whaleal Platform Application must open the following ports:
Service Default Port Transport Direction
MongoDB 27017 TCP Inbound、Outbound

​ If a custom port is needed, please open the custom port.

Port at host

The Whaleal Platform Application Agent can complete most operations, but some processes require administrator access to the Whaleal Platform Application host. The following ports must be open:

Service Default Port Transport Direction
ssh 22 TCP Inbound

Installation Deployment

Subscribe to Whaleal Platform Server

Subscribe to the service

Search for Whaleal Platform in the AWS Marketplace

img

Click "Continue to Subscribe" to subscribe to the service.

img

Click "Accept Terms" to agree to the service terms.

img

Click "Continue to Configuration" to proceed with the setup.

img

Configure instance, version, region, and pricing-related information.

Note: When selecting a version, please choose the latest version.

img

Click "Continue to Launch" to proceed to the next step.

img

Select "Launch through EC2" and then click "Launch" to deploy the instance in EC2.

img

Instance deployment

Configure instance name

img

Configure instance type

Minimum instance type: 8 cores, 16GB RAM, 500GB

img

Configure key pair

img

Configure network and ports

img

Add storage volume

Minimum requirement: 500GB

img

Then create the machine

Whaleal Platform Server Deployment

Confirm that the boot services are starting on the Whaleal Platform servernginx service

image-20260123141914887

Enter the Whaleal Platform URL in your browser,Public IP address of this machine

image-20260116152543084

The initial password is admin password

Reset password on first login

image-20260123112713427

Display the home page upon successful login

image-20260123112823166

Link your AWS account to WAP

image-20260123113112512

Follow the steps to create an AWS user, copy the key information into the application, and click save.

image-20260123113132507

Deploy single-instance replica set

Uploading a MongoDB package requires manually downloading the binary installer from the MongoDB website and clicking click Upload. Note that currently only Amazon 2023 systems are supported.

image-20260116155916109

Create Project

Used to create a new project in WAP to manage and monitor a group of MongoDB instances or hosts, and to assign project members and related resources.

image-20260116154549462

Select the region and CIDR where you want to deploy MongoDB, then click Create.

image-20260116155603157

Deploying MongoDB

image-20260116154313535

Select your MongoDB configuration

image-20260116160512156

Parameter description

Configuration Name Description
Project Select the project you created
VPC Select VPC; wap-vpc is automatically created by the WAP platform.
Cluster Name Enter your MongoDB cluster name
MongoDB Version To select the MongoDB version, you need to add the downloaded installation package from the previous WAP session.
MongoDB Node Select the number of nodes in the cluster
EC2 Type Select the instance type for the cluster.
Available Zone Instance availability zone selection: Note that a cluster can only have 3 availability zones. If the number of nodes exceeds 3, there will still be duplicate nodes assigned to the same availability zone.
Storage Cluster storage configuration, select Size, Volume type, IOPS, etc.
Auto Scaling When your cluster resources reach capacity limits, AutoScale will automatically scale up the cluster instance type and increase instance storage capacity. This may result in additional costs.
Auth Level Select the MongoDB authentication authorization level
Username MongoDB cluster username
Password MongoDB cluster password
Authentication Database The default authentication database for MongoDB clusters is admin and cannot be changed.

After configuration, click Create.

image-20260120155353879

View the current progress through the logs, click on the cluster name.

image-20260120155732121

View log information

image-20260120155806150

Waiting for the MongoDB cluster to complete creation; the status should be "Healthy".

image-20260120155856291

Click the cluster name to view the node status.

image-20260120162705483