Getting Started with Sentinel

From a fresh clone to a running, AI‑powered DevOps dashboard with auto‑healing and CLI tools.

1

Prerequisites

Before you start, install Docker, Node.js 18+, Git, and create a Groq API key.

PostgreSQL, Kestra, and mock services are launched automatically via docker-compose.yml; no separate install is needed.

2

Clone the Repository

Clone the Sentinel repo and move into the project folder.

Clone & enter
git clone https://github.com/SKfaizan-786/sentinel-devops-agent.git
cd sentinel-devops-agent
3

Configure Environment Variables

Backend (.env)

Copy the example env file and edit required values.

Backend env
cp backend/.env.example backend/.env

At minimum, set GROQ_API_KEY, check the Postgres credentials, and change JWT_SECRET for anything beyond local testing.

Frontend (.env.local)

Frontend env
cd sentinel-frontend
cp .env.example .env.local
# set NEXT_PUBLIC_BACKEND_URL to http://localhost:4000
cd ..
4

Start the Full Stack with Docker

Bring up backend, frontend, Kestra and dependencies in one step.

Docker up
docker-compose up -d

Verify containers are running:

Check containers
docker ps

You should see containers for the backend, frontend, Kestra, Postgres, and the mock services for auth, payment, and notification.

5

Initialize Backend & RBAC

Install backend dependencies and run the quick setup script.

Backend setup
cd backend
npm install
npm run quick-setup

This seeds a default admin user for local development:
admin@example.com / password123 – change this after logging in.

6

Run Frontend via npm (Optional)

If you prefer a Next.js dev server instead of the Dockerized frontend:

Frontend dev
cd sentinel-frontend
npm install
npm run dev

The app will be available at http://localhost:3000. Ensure the backend is running on port 4000.

7

CLI Quick Start

Use the Sentinel CLI to interact with the system.

Install CLI
cd cli
npm install
npm link
Example CLI commands
# Show overall system health
sentinel status

# Simulate failures (chaos tests)
sentinel simulate auth down
sentinel simulate payment degraded
sentinel simulate notification slow

# Trigger a manual heal action
sentinel heal auth

# Generate an AI incident report
sentinel report

Common Issues & Troubleshooting

Ran into a problem? Start with these frequently‑seen errors and fixes.

If `docker-compose up -d` says it cannot connect to the Docker daemon, start Docker Desktop on Windows/macOS. On Linux, run `sudo systemctl start docker && sudo systemctl enable docker` and try again.

Next Steps

Once you are comfortable with the basic setup, dive deeper into the architecture and APIs.