GuardRails - Amazon Elastic Kubernetes Service (EKS) - Installation Requirements
Recommended hardware and software requirements for installation of GuardRails on EKS
Pre-requisites
Amazon Web Service (AWS)
The following items are required:
- A working Kubernetes cluster on AWS with EKS is required
- Supported Kubernetes version: 1.20, 1.21, 1.22
- RDS instance
- Sizing for Kubernetes worker node group:
| Small | Typical | |
|---|---|---|
| Scan requests per hour * | 4 | 20 |
| Average Scan Duration * | 3 minutes | 3 minutes |
| Number of instances | 3 | 3 |
| Instance type | m5.xlarge | c5.4xlarge |
Scan requests per hour: Scan request can be triggered via the GuardRails dashboard or GitHub Pull Requests. There are many factors that may contribute to scan requests per hour, e.g the number of developers, the number of repositories, the choice of software development methods, etc.
Average Scan Duration: The average time it takes to perform a full scan.
For the above sizing, GuardRails was tested against a large collection of open source projects in various size. The resource requirement will be higher with more scan requests per hour, or longer average scan duration. Cluster resource consumption monitoring is highly recommended to provide correct sizing for resource capacity.
Kubernetes required components:
- Ingress Controller - GuardRails was tested with these ingress controllers:
- ingress-nginx: https://kubernetes.github.io/ingress-nginx/
- contour: https://projectcontour.io/
- Cert Manager: https://cert-manager.io/docs/
Tool required
To install GuardRails on Amazon Elastic Kubernetes Service (EKS), you should have the following tools installed
- kubectl: The Kubernetes command-line tool allows you to run commands against Kubernetes clusters
- KOTS: provides the framework, tools and integrations that enable the delivery and management of 3rd-party Kubernetes applications, a.k.a. Kubernetes Off-The-Shelf (KOTS) Software. How to install kots cli.