From 065c494d4219be20b877eb831b445a097b819e84 Mon Sep 17 00:00:00 2001
From: Alan Moran <bonzofenix@gmail.com>
Date: Thu, 6 Jun 2024 16:36:23 +0200
Subject: [PATCH] WIP: Refactor server

---
 src/autoscaler/healthendpoint/server.go | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/src/autoscaler/healthendpoint/server.go b/src/autoscaler/healthendpoint/server.go
index 81d4d3186f..3635a0feaf 100644
--- a/src/autoscaler/healthendpoint/server.go
+++ b/src/autoscaler/healthendpoint/server.go
@@ -1,5 +1,29 @@
 package healthendpoint
 
+// package healthendpoint runs the health endpoint server for diferent autoscaler components
+//
+// The health endpoint server is used to expose the health
+// and readiness check endpoints for the autoscaler components.
+//
+// It provides the following functionalities:
+// - Expose the health and readiness check endpoints
+// - Expose the prometheus metrics
+// - Expose the pprof endpoints
+// - Basic authentication for health and readiness check endpoints
+// - Basic authentication for pprof endpoints
+// - Basic authentication for prometheus metrics
+//
+// The healthendpoint package provide the following checkers:
+// - NewHTTPChecker
+// - NewTCPChecker
+// - NewDatabaseChecker
+//
+// The health endpoint server is used by the following autoscaler components:
+// - metricsforwarder
+// - scalingengine
+// - eventgenerator
+// - scheduler
+
 import (
 	"net/http"
 	"net/http/pprof"