AWS Installation Guide
Instructions to install in AWS infra
Infrastructure Requirements
Minimal Installation:
You need a system with a minimum of 16 CPUs. We recommend using 2 nodes with 8 cores each, totalling 64GB.
All machines must reside in the same availability zone to avoid data transfer charges across zones. Our Obsrv installer will automatically create the EKS cluster for you.
Networking Environment:
Ensure your environment has a CIDR of 23 (512 IP addresses).
For example, a VPC with CIDR
10.0.0.0/23
will have IP addresses ranging from10.0.0.0
to10.0.1.255
.Subnets must be created in all availability zones within your region
Software Prerequisites
Installation of Obsrv requires the following CLI tools as prerequisites. Please note that the following instructions for installing the prerequisites are provided only for Linux based operating systems. Please follow the instructions for the specific tools depending upon your operating system.
Terraform
Terraform CLI version 1.5.x or older. Versions above 1.5.x are not MPL licensed.
Download from here - https://developer.hashicorp.com/terraform/install
Terragrunt
Terragrunt CLI version 0.48 or later.
Download from here - https://terragrunt.gruntwork.io/docs/getting-started/install/
Terrahelp
Terrahelp version 0.7.5 or later
Download from here - https://github.com/opencredo/terrahelp?tab=readme-ov-file#installation
Helm
Helm version 3.10.2 or later
Download from here - https://helm.sh/docs/intro/install/
AWS CLI
AWS CLI tool version 2.10 or later.
Download from here - https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
Installation Steps:
Clone the
obsrv-automation
repository:Navigate to the setup directory:
Update Configuration Files: Update the configurations in both
setup.conf
andcluster_overides.tf
files to match your environment settings. Example configuration incluster_overides.tf
S3 Bucket:
Obsrv installation requires a S3 bucket to be created which will be subsequently used for storing the cluster state. The bucket name will then be referenced in the installation script mentioned below. For e.g, if the bucket created is obsrv-tfstate, please ensure it is updated in the
obsrv.conf
under the environment variable.Example configuration in
setup.conf
:The
AWS_DEFAULT_REGION
environment variable will control the AWS region in which the cluster will be created. Please make sure that the region is updated according to your installation needs. TheAWS_TERRAFORM_BACKEND_BUCKET_REGION
is used to store the terraform stateRun Installation Script: Execute the following command to start the installation process:
Before installing please provide executable permission to installation script
chmod +x ./obsrv.sh
Note: Setting
install_dependencies=true
will automatically download and install all required dependencies. If preferred, you can manually download the dependencies instead.
Monitor Installation Progress: The script will begin installing Obsrv within the AWS cluster. Monitor the progress and follow any on-screen prompts or instructions.
Completion: Once the installation process is complete, verify that Obsrv has been successfully installed and configured within your AWS cluster. One simple and quick way to check if you are able to communicate with the cluster is to run the command
kubectl get svc --all-namespaces
. This will list all the services running as a part of the Obsrv installation
Upgrade Steps:
Take latest code from
obsrv-automation
repositoryEnsure all the configuration configured during the installation is properly updated in all places.
Run the terraform to upgrade the cluster to the latest versions.
Last updated