| No. | Service | Language | Image | Tag |
|---|---|---|---|---|
| 1 | whale-sentinel-common-attack-detection | Go1.24.0 | whale-sentinel-common-attack-detection | 0.1.1 |
| 2 | whale-sentinel-configuration-service | Go1.24.0 | whale-sentinel-configuration-service | 0.1.1 |
| 3 | whale-sentinel-dga-detection | Python3.12 | whale-sentinel-dga-detection | 0.1.1 |
| 4 | whale-sentinel-web-attack-detection | Python3.12 | whale-sentinel-web-attack-detection | 0.1.1 |
| 5 | whale-sentinel-gateway-service | Go1.24.0 | whale-sentinel-gateway-service | 0.1.1 |
- Create an IAM User
-
Go to AWS IAM console and create a new IAM user.
-
Assign sufficient permissions for Secrets Manager, EC2, RDS.
-
Generate and securely store the following credentials:
-
AWS_ACCESS_KEY_ID
-
AWS_SECRET_ACCESS_KEY
-
- Create AWS Secret
-
In AWS Secrets Manager, create a new secret named: AWS_SECRET_NAME
-
Create your key and secret for following keys:
-
WHALE_SENTINEL_AGENT_SECRET_KEY_NAME
-
WHALE_SENTINEL_SERVICE_SECRET_KEY_NAME
-
WHALE_SENTINEL_CONTROLLER_SECRET_KEY_NAME
-
- Download & Unzip the Latest Package Release for Deployment
-
Navigate to the Releases page.
-
Download the package in ##Package Release for Deployment and extract it.
- Configure the Docker Environment
-
Rename the sample compose file:
mv docker-compose.example.yml docker-compose.yml -
(Recommended) Change the default Redis password in redis/redis.conf and update docker-compose.yml accordingly.
- Apply Your Configuration
- Replace all placeholder values in docker-compose.yml and other config files (fluent-bit.conf, etc.) with your actual environment-specific values (e.g., AWS credentials, secret names, ports).
| Key | Description | Example / Placeholder |
|---|---|---|
AWS_REGION |
AWS region where services and secrets are hosted | your-aws-region |
AWS_ACCESS_KEY_ID |
AWS access key ID | your-aws-access-key |
AWS_SECRET_ACCESS_KEY |
AWS secret access key | your-aws-secret-key |
AWS_SECRET_NAME |
Name of the secret in AWS Secrets Manager | your-whale-sentinel-secret-name |
WHALE_SENTINEL_AGENT_SECRET_KEY_NAME |
Key name for agent component in AWS secret | your-whale-sentinel-secret-key-name |
WHALE_SENTINEL_SERVICE_SECRET_KEY_NAME |
Key name for service component in AWS secret | your-whale-sentinel-secret-key-name |
WHALE_SENTINEL_CONTROLLER_SECRET_KEY_NAME |
Key name for controller component in AWS secret | your-whale-sentinel-secret-key-name |
REDIS_PASSWORD |
Password used to access Redis | your-redis-password |
WS_CONTROLLER_PROCESSOR_URL |
URL to Whale Sentinel MDP endpoint | your-whale-sentinel-mdp-url |
OPENSEARCH_ENDPOINT |
Endpoint URL for OpenSearch | your-opensearch-endpoint |
OPENSEARCH_USERNAME |
OpenSearch username | your-opensearch-username |
OPENSEARCH_PASSWORD |
OpenSearch password | your-opensearch-password |
- Start the Services
- Run the following command to launch all services in the background:
docker-compose up -d