ZAIO deployment on AWS / EC2
This is a guide to run a fully functional Zentral instance on Amazon AWS. We will be using the Zentral all in one pre-build AMI (Amazon image).
Note: We also provide a guide for a Google Cloud based setup – please look here.
To follow this tutorial, you will need an admin access to the AWS web console – Getting Started with Amazon EC2 .
Note: This tutorial is only a first step toward a production deployment on AWS.
Note: We have uploaded a video to go along this tutorial.
Find the Zentral all in one image
You can find the links to start the latest images in the description of the latest release. Pick the one in your favorite region.
Note: "Zentral all in one" AMI is not available in all AWS regions
Pick an instance type
You can start with a
t2.medium instance type. We strongly advice against using any kind of "smaller" instances. A lot of software will be running on the instance (ELK, postgres, prometheus, django app, …)
Then click on the Next: Configure Instance Details button.
Configure instance details
You can skip this form to run a default instance in the default VPC.
Click on the Next: Add Storage button.
If you'd like to create a new, distinct VPC:
- You'll be first prompted to create/assign a subnet (local range, smallest is 28 so may as well start with /26 for entire new VPC)
- Follow the following instructions afterwards so that it gets a public IP and routing from the internet works
Here is a link to the documentation about VPC Internet Gateway, if you want to dig deeper.
You can start with one 8GB general purpose SSD volume. But that would be only enough to store a limited amount of events. As a rule of thumb, you will need about 7GB + 1GB for every million of events stored, but that can vary a lot depending on your inventory sources, and the kind of events you are collecting.
Click on the Next: Add Tags button.
You can skip this section.
Click on the Next: Configure Security Group button.
Configure security groups
The required open ports are 22, 80, and 443. If you also want to be able to ship logs with filebeat, you need to open the 5044 port too.
If you are new to this, just create a new security group for the Zentral instance:
- Pick a name and a description
- Add a rule for SSH. (you can restrict the allowed ip ranges if you like)
- Add a rule for HTTP
- Add a custom TCP rule for port 443 (HTTPS). Do not forget the ip range – Unrestricted IPv4/v6:
- Add a custom TCP rule for port 5044 (HTTPS). Again, do not forget the ip range.
Here is a link to the documentation about the Security Groups, if you want to dig deeper.
Click on the Next: Review and Launch button.
Review and launch
You can review the settings for the new instance.
Click on the Launch button. A modal will popup, to pick or create a ssh key pair to be able to log into the instance. If you do not have a ssh key pair yet:
- select Create a new key pair
- give it a name
- click on the Download Key Pair button
- save the file in your
$HOME/.sshdir for example
- make the file readable only for your user
chmod 0600 ~/.ssh/TheNameOfTheKeyPairFile
Once you have a ssh key pair, click on the Launch Instances button, and your instance will start!
Setup the domain name(s) for your instance
Zentral requires at leat one domain name resolving to the IP address of the launched instance. If you want to ship logs with filebeat, and experiment with the MDM, you will need a second domain name (to separate the endpoints requiring client certificate authentication).
- In the AWS console, find the public IP address of the instance that is starting. No need to wait for the instance to be fully up.
- Use this IP to setup a first required A record. (zentral.example.com for the rest of this tutorial)
- You can setup a second A record pointing to be able to test all the Zentral functionalities. (zentral-clicertauth.example.com for the rest of this tutorial)
- Test the resolution of these records! You cannot move on to the next section before they are setup.
Log onto your instance
You need the path to the key pair you have just setup. The default username is
ssh -i ~/.ssh/TheNameOfTheKeyPairFile email@example.com
Once logged in, you can use a command line tool to setup your instance. Because this last step is the same for a Google Cloud deployment, we have kept it on a separate wiki page.