Here you will find instructions to setup WaveMaker Enterprise (WME) using the WME Installer and WME Setup Portal. This section talks about the pre-requisites, requirements and verification needed before proceeding with the WME Setup.
WME - an Overview
Before proceeding with the set up, let us take a look at what constitutes WaveMaker Enterprise (WME). WME platform is made up of the following three components:
- WaveMaker Studio - a modern RAD platform for collaborative development of multi-device apps,
- WaveMaker Cloud - a container based platform for app deployments within a private cloud, and
- Launchpad - WaveMaker's administrative console where you can configure users, additional Studio/Cloud instances for scaling, configure external VCS, etc. Launchpad is automatically installed when you setup WaveMaker Enterprise .
- Platform Containers: consisting of multiple internal services needed to run the WME platform like Studio, Cloud, VCS etc.. Each of these services runs in a separate Docker Container. Services talk to each other via REST service. Platform Containers make calls to the Docker Engine for operations like starting a new user container, stopping / starting a container etc..
- User Containers: Each user gets a container for developing apps. Containers are used to isolate each user’s workspace from other users.
- App Containers: Each WaveMaker app that is deployed into the internal WaveMaker Cloud is allocated a separate container. Thus the deployed apps are also isolated from each other.
Prerequisites to Setup WME
You can setup WaveMaker Enterprise on any machine.
This document uses words like VM, Instance to refer a machine.
The machine can be hosted on any cloud provider(like AWS EC2, GCP, Azure .etc) or enterprise cloud or baremetal. All machine allocated to WME platform should not have any other running process.
The following are prerequisites to setup WaveMaker Enterprise. The below-mentioned system requirements allow for limited app developments and deployments. You can increase this capacity by adding Developer Workspace and App Deployment instances thus scaling your WME.
WME Setup System Requirements
WaveMaker Enterprise can be installed on any machine with Operating system Ubuntu 16.04.6 LTS. Before you start setting up the WaveMaker Enterpris, here is a list of a minimum and recommended System Requirements for the WME Platform Instance:
System Requirements for Additional Instances
Adding an instance to either User workspace or Deployed Apps aids in the scalability of the WME setup in terms of application development and deployment, respectively. Each addedUser workspace or Deployed Apps instances would allow for a specific number of app developments and app deployments. These numbers will vary based on the WME version, refer to the table below for the exact numbers.
|WME Version||Developer logins per 16GB WaveMaker Studio Instance||App Deployments per 16GB WaveMaker Cloud Instance|
The actual app development and deployment support are further determined by your license terms. This means that, even if your infrastructure has the capacity, the apps that can be developed and deployed is restricted by your license terms. Similarly, even though your license terms allow, the apps that can be developed and deployed are limited by the infrastructure capacity. Note different instances needs to be added to each stage in the release pipeline as explained in the Increasing Deployment Capacity section.
WME Installer File Requirements
The following files should be shared with you by the WaveMaker team:
- WME installer deb file and its corresponding checksum (sha1sum) file, communicated to you by the WaveMaker team.
- WME base ova or WME base AMI if you want launch instances with WaveMaker base image formats.
- License Key (.zip format) issued by WaveMaker, communicated to you by the WaveMaker team.
- You need to download the above files before starting the installation.
You need to verify the WME Installer/OVA/License file (.deb/.ova file communicated to you by the WaveMaker team) using checksum command before installing it.
To verify on Linux
- Using the following command, go to the directory where .ova file and checksum files are downloaded
# cd /home/ubuntu
- To verify the file integrity of the VM image, run the following checksum command:
# sha1sum -c [checksum-filename]
- After running the command, the result should be displayed as OK, which means the checksum is verified and the file is OK.
To verify on Windows
- First, download the FCIV utility package (to download, follow instructions from here)
# cd /home/ubuntu
- After download, from command prompt, run the following command:
FCIV -sha1 pathfilename.ext
- In Windows, after running the command, the result should be manually verified with the values present in their respective files (checksum file shared to you by email).
Note (Applicable for both Windows and Linux): Do not proceed further to installation if checksum verification fails. Invalid checksum indicates a likely corrupted download. Try downloading the file again or contact [WaveMaker Support](mailto: email@example.com).
You will be needing IP Addresses for the following.
- one static IP for accessing the Platform machine from your network and
- an IP range to be assigned to the Docker containers internally.
- VM Access:
Machine Static IP: This is the IP assigned to machine during setup and should be accessible on your network, or
In case of VM's, it will be the local IP address, which should be routable from in your LAN.
In case of AWS instance: Private static IP for the instance within your VPC (assigned via eth0 or via ENI on eth1,ens5)
DNS Mapping: Map a domain to the above IP for easy access:
Domain Domain URL Description WaveMaker Studio
This domain will be used to access WaveMaker Studio WaveMaker Deployed Apps
These domains will be used to access WaveMaker Studio apps deployed onto WaveMaker Cloud
Note: In the preceding table,
[mycompany]is used as an example. You may have to replace
[mycompany]with your appropriate domain name.
- Docker Container Access: You will be needing to assign a /16 CIDR to Docker during setup. This IP range should not be in use anywhere on your network and can be completely different from your network’s range. These IPs are assigned internally by Docker to containers and these IPs won’t be exposed on your network. For example, if your network is using a 10.x.x.x range and the range 192.168.x.x is not used anywhere in your network, you may assign this 192.168.x.x range to Docker. See here for the possible LAN IP ranges.