Prerequisites
Following are the prerequisites for using Eggplant IAM, including information about hardware, memory, software, and supported operating systems (OSs).
Hardware Requirements
The table below shows the minimum compute resources you should plan for on the host machine running the Keycloak container(s):
| Resource | Configuration |
|---|---|
| CPU | Approximately 800 millicpu |
| Memory | 768MB |
| Storage | 8GB (Only required if using the bundled PostgreSQL database) |
Software Requirements
See the appropriate page below for the specific requirements and recommendations for the Keycloak deployment option you want:
Deploy Eggplant IAM with Docker
Windows: see Deploy Docker Desktop on Windows with WSL2 for information about the software you need to deploy Keycloak in Docker Desktop on Windows.
Linux: see Deploy Docker Engine on Linux for information about the software you need to deploy Keycloak in Docker Engine on Linux.
Deploy Eggplant IAM with Kubernetes
See Deploy with Kubernetes for information about the software you need to deploy Keycloak with Kubernetes.
Postgres Database
The Eggplant IAM solution requires a PostgreSQL database. You can choose to either, deploy one as part the Docker Compose / Helm installation process, or you can provide the details of an existing PostgreSQL instance.
If using an external database you will need to know:
- The database username / password
- Hostname / port
The database will need to be preconfigured with an existing database called keycloak
TLS Certificates
The traffic to and from Eggplant IAM contains sensitive data such as user credentials and session tokens, therefore the use of HTTPS is mandatory to protect the data in transit.
You will require public certificates, in pem format that are valid for the DNS name on which you intend to configure Eggplant IAM. The certificates can be issued by any public certificate authority. You may wish to consider using LetsEncrypt certificates which are free and offer automated means of renewal.