use /actuator/health for backend health checks

[BobanL]

DEVOPS PULL REQUEST

Related Issue

• During the Spring boot 3 update, we noticed that the deployments were failing because the app gateway was checking the health status on the / endpoint. The / endpoint was failing our security rules because we did not also permit access to /index.html. It seems better that we just remove access to / and then use /actuator/health for health check accross the app.

Changes Proposed

• Add probe to app_gateway for backend services that will check the /actuator/health endpoint
• Replace all places where the backend's /health was being check with /actuator/health
• Remove access to / endpoint in security config
• Remove index.html

Additional Information

• The /health endpoint only ever returns 200 OK which is not that useful. SpringBoot already gives us more information in actuator so I thought it would be best to just remove it to reduce confusion.
• App Gateway uses health probes to do backend health checks and app services uses the new endpoint
  Dev5 now:
  

Dev6:

Testing

• Verify 401 not authorized on /health and / and 200 OK on /actuator/health
• Application can be deployed, feel free to redeploy to dev5 (Currently deployed on dev5)

[zdeveloper]

LGTM! thank you for uncovering and fixing this

[fzhao99]

🎉

three cheers for boban

[alismx]

Does /api/actuator/health endpoint work for metabase? I thought the standard metabase healthcheck endpoint was /api/health.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[BobanL]

@alismx

Is the plan to remove the static-http(s) probes in your other PR?

No, Static-http probe will stay to check the status of the static site.

Does /api/actuator/health endpoint work for metabase? I thought the standard metabase healthcheck endpoint was /api/health.

Good callout, I have reverted the health check for metabase!

[alismx]

Looks good! Thanks for these updates.