Skip to content

feat(api): add get hpa and hpa status endpoint #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat(api): add get hpa and hpa status endpoint #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6b7b467
feat(hpa): add handler and service for hpa information
M4XGO Mar 14, 2025
720de7f
feat(hpa): add a new api endpoint to get the hpa information
M4XGO Mar 14, 2025
10fc5cc
feat(hpa): add a api in server
M4XGO Mar 14, 2025
ae48052
feat(doc): add new api in swagger doc
M4XGO Mar 14, 2025
16f6430
fix(api): update endpoint name
M4XGO Mar 14, 2025
7ec62c5
fix(doc): regenerate with enpoint name corrections
M4XGO Mar 14, 2025
daec021
fix(test): update tests
M4XGO Mar 14, 2025
589524e
fix(doc): rm 503 error
M4XGO Mar 14, 2025
30a1dbe
fix(handler): rm unnecessary if statement
M4XGO Mar 25, 2025
8e149ba
fix(handler): rm unnecessary if statement too
M4XGO Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion cmd/serv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,19 @@ var serv = &cobra.Command{
time := clock.RealClock{}

eventService := services.NewEventService(prescalingEvents, time)
hpaService := services.NewHPAService(client.Clientset)

eventHandler := handlers.NewEventHandlers(eventService)
statusHandler := handlers.NewStatusHandlers()
hpaHandler := handlers.NewHPAHandlers(hpaService)

collector := exporter.NewPrescalingCollector(
prescaling.NewPrescaling(client, eventService),
)

prometheus.MustRegister(collector)

return server.NewServer(statusHandler, eventHandler).Initialize()
return server.NewServer(statusHandler, eventHandler, hpaHandler).Initialize()
},
}

Expand Down
94 changes: 94 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,52 @@ const docTemplate = `{
}
}
}
},
"/api/v1/hpas": {
"get": {
"description": "Checks if all HPAs in the cluster have at least the minimum number of running pods",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Check if HPAs meet their required minimums",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/services.HPAMinimumStatus"
}
}
}
}
},
"/api/v1/hpas/check": {
"get": {
"description": "Checks if the platform is correctly scaled and returns HPA details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Check the platform scaling status",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/services.PlatformScalingStatus"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -302,6 +348,54 @@ const docTemplate = `{
}
}
},
"services.HPAInfo": {
"type": "object",
"properties": {
"hpaMinReplicas": {
"type": "integer"
},
"meetsMinimum": {
"type": "boolean"
},
"minReplicasAnnotation": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"targetKind": {
"type": "string"
},
"targetName": {
"type": "string"
}
}
},
"services.HPAMinimumStatus": {
"type": "object",
"properties": {
"allHPAsMeetMinimum": {
"type": "boolean"
},
"hpaInfos": {
"type": "array",
"items": {
"$ref": "#/definitions/services.HPAInfo"
}
}
}
},
"services.PlatformScalingStatus": {
"type": "object",
"properties": {
"isPlatformScaled": {
"type": "boolean"
}
}
},
"services.PrescalingEventOutput": {
"type": "object",
"properties": {
Expand Down
94 changes: 94 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,52 @@
}
}
}
},
"/api/v1/hpas": {
"get": {
"description": "Checks if all HPAs in the cluster have at least the minimum number of running pods",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Check if HPAs meet their required minimums",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/services.HPAMinimumStatus"
}
}
}
}
},
"/api/v1/hpas/check": {
"get": {
"description": "Checks if the platform is correctly scaled and returns HPA details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Check the platform scaling status",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/services.PlatformScalingStatus"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -294,6 +340,54 @@
}
}
},
"services.HPAInfo": {
"type": "object",
"properties": {
"hpaMinReplicas": {
"type": "integer"
},
"meetsMinimum": {
"type": "boolean"
},
"minReplicasAnnotation": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"targetKind": {
"type": "string"
},
"targetName": {
"type": "string"
}
}
},
"services.HPAMinimumStatus": {
"type": "object",
"properties": {
"allHPAsMeetMinimum": {
"type": "boolean"
},
"hpaInfos": {
"type": "array",
"items": {
"$ref": "#/definitions/services.HPAInfo"
}
}
}
},
"services.PlatformScalingStatus": {
"type": "object",
"properties": {
"isPlatformScaled": {
"type": "boolean"
}
}
},
"services.PrescalingEventOutput": {
"type": "object",
"properties": {
Expand Down
62 changes: 62 additions & 0 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,37 @@ definitions:
example: "20:00:00"
type: string
type: object
services.HPAInfo:
properties:
hpaMinReplicas:
type: integer
meetsMinimum:
type: boolean
minReplicasAnnotation:
type: integer
name:
type: string
namespace:
type: string
targetKind:
type: string
targetName:
type: string
type: object
services.HPAMinimumStatus:
properties:
allHPAsMeetMinimum:
type: boolean
hpaInfos:
items:
$ref: '#/definitions/services.HPAInfo'
type: array
type: object
services.PlatformScalingStatus:
properties:
isPlatformScaled:
type: boolean
type: object
services.PrescalingEventOutput:
properties:
date:
Expand Down Expand Up @@ -218,4 +249,35 @@ paths:
summary: Get current prescaling Event
tags:
- prescalingevent
/api/v1/hpas:
get:
consumes:
- application/json
description: Checks if all HPAs in the cluster have at least the minimum number
of running pods
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/services.HPAMinimumStatus'
summary: Check if HPAs meet their required minimums
tags:
- cluster
/api/v1/hpas/check:
get:
consumes:
- application/json
description: Checks if the platform is correctly scaled and returns HPA details
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/services.PlatformScalingStatus'
summary: Check the platform scaling status
tags:
- cluster
swagger: "2.0"
67 changes: 67 additions & 0 deletions pkg/handlers/hpa_handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package handlers

import (
"net/http"

log "github.com/sirupsen/logrus"

"github.com/BedrockStreaming/prescaling-exporter/pkg/services"
"github.com/BedrockStreaming/prescaling-exporter/pkg/utils"
)

// IHPAHandlers defines the interface for HPA handlers
type IHPAHandlers interface {
CheckHPAMinimums(w http.ResponseWriter, r *http.Request)
GetPlatformScalingStatus(w http.ResponseWriter, r *http.Request)
}

// HPAHandlers implements IHPAHandlers
type HPAHandlers struct {
hpaService services.IHPAService
}

// NewHPAHandlers creates a new instance of HPAHandlers
func NewHPAHandlers(hpaService services.IHPAService) IHPAHandlers {
return &HPAHandlers{
hpaService: hpaService,
}
}

// CheckHPAMinimums
// @Summary Check if HPAs meet their required minimums
// @Description Checks if all HPAs in the cluster have at least the minimum number of running pods
// @Tags cluster
// @Accept json
// @Produce json
// @Success 200 {object} services.HPAMinimumStatus
// @Router /api/v1/hpas [get]
func (h *HPAHandlers) CheckHPAMinimums(w http.ResponseWriter, r *http.Request) {
status, err := h.hpaService.CheckHPAMinimums()
if err != nil {
log.Error(err)
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}

utils.WriteResponse(w, http.StatusOK, status)
}

// GetPlatformScalingStatus
// @Summary Check the platform scaling status
// @Description Checks if the platform is correctly scaled and returns HPA details
// @Tags cluster
// @Accept json
// @Produce json
// @Success 200 {object} services.PlatformScalingStatus
// @Router /api/v1/hpas/check [get]
func (h *HPAHandlers) GetPlatformScalingStatus(w http.ResponseWriter, r *http.Request) {
status, err := h.hpaService.GetPlatformScalingStatus()
if err != nil {
log.Error(err)
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}

// If the platform is not correctly scaled, return a 200 OK status
utils.WriteResponse(w, http.StatusOK, status)
}
Loading