EC2 Developer Setup
For development, you might want to set up an Amazon EC2 instance as the resource requirements for Armada are substantial. A typical Armada installation requires a system with at least 16GB of memory to perform well. Running Armada on a laptop made before ~2017 will typically eat battery life and result in a slower UI.
Note: As of June 2022, not all Armada dependencies reliably build on a Mac M1 using standard package management. So if you have an M1 Mac, working on EC2 or another external server is your best bet.
- We suggest a t3.xlarge instance from aws ec2 with AmazonLinux as the OS. 16 GB of memory is suggested.
- During selection of instance, Add a large volume to your ec2 instance. 100 gb of storage is recommended.
- When selecting the instance, you will have the opportunity to choose a security group. You may need to make a new one. Be sure to add a rule allowing inbound communication on port 22 so that you can access your server via SSH. We recommend that you restrict access to the IP address from which you access the Internet, or a small CIDR block containing it.
If you want to use your browser to access Armada Lookout UI or other web-based interfaces, you will also need to grant access to their respective ports. For added security, consider using an SSH tunnel from your local machine to your development server instead of opening those ports. You can add LocalForward to your ssh config:
LocalForward 4000 localhost:3000
The procedure to install Docker on AMI 2 (Amazon Linux 2) running on either EC2 or Lightsail instance is as follows:
1. Login into remote AWS server using the ssh command:
2. Apply pending updates using the yum command:
sudo yum update
3. Search for Docker package:
sudo yum search docker
4. Get version information:
sudo yum info docker
5. Install docker, run:
sudo yum install docker
6. Add group membership for the default ec2-user so you can run all docker commands without using the sudo command:
sudo usermod -a -G docker ec2-user
# Reload a Linux user's group assignments to docker w/o logout
$ cd $HOME/.docker
$ mkdir cli-plugins
$ cd cli-plugins
$ curl -SL https://github.com/docker/compose/releases/download/v2.17.3/docker-compose-linux-x86_64 -o docker-compose
$ chmod 755 docker-compose
Then verify it with:
Getting the Docker Compose Plugin
Armadas setup assumes You have the docker compose plugin installed. If you do not have it installed, you can use the following guide:
Then test it with:
docker compose version
ssh into your EC2 instance, become root and download the go package from golang.org.
1. Extract the archive you downloaded into /usr/local, creating a Go tree in /usr/local/go with the following command:
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.20.1.linux-amd64.tar.gz
2. Configure .bashrc
Switch back to ec2-user and add the following line to your ~/.bashrc file
3. Configure go Environment
Add the following lines to your ~/.bashrc file as well, also create a golang folder under /home/ec2-user.
# Go envs
4. Test go
Verify that you’ve installed Go by opening a command prompt and typing the following command:
go version go1.20.1 linux/amd64
1. Install Kind
go install email@example.com
# You can replace v0.11.1 with the latest stable kind version
2. Move the KinD Binary to /usr/local/bin
- You can find the kind binary inside the directory go/bin
- Move it to /usr/local/bin - mv go/bin/kind /usr/local/bin
- Make sure you have a path setup for /usr/local/bin
1. Install Latest Version of Kubectl:
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
chmod +x kubectl
mv kubectl /usr/local/bin
1. Install helm:
curl -sSL https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
2. We can verify the version
helm version --short
Install python3 (>= 3.7)
1. Check if Python is already installed or not on our AWS EC2.
2. At first update, Ubuntu packages by using the following command.
sudo apt update
3. If Python3 is not installed on your AWS EC2, then install Python3 using the following command.
sudo apt-get install python3.7
4. We have successfully installed Python3 on AWS EC2, to check if Python3 is successfully installed or not, verify using the following command.
Install .NET for linux
1. Before you install .NET, run the following commands to add the Microsoft package signing key to your list of trusted keys and add the Microsoft package repository. Open a terminal and run the following commands:
sudo rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm
2. Install the SDK
sudo yum install dotnet-sdk-7.0
3. Install the runtime
sudo yum install aspnetcore-runtime-7.0
We suggest using the remote code extension for VS Code if that is your IDE of choice.
Please see Our Developer Docs for more information on how to get started with the codebase.