Merge pull request #496 from mwdomino/restart-app

Add shutdown route
openconfig · Aug 1, 2024 · 9b75580 · 9b75580
2 parents 7b31588 + 80e39d6
commit 9b75580
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/docs/user_guide/api/other.md b/docs/user_guide/api/other.md
@@ -15,4 +15,15 @@ Health check endpoint for Kubernetes or similar
     {
         "status": "healthy"
     }
-    ```
+    ```
+
+## /api/v1/admin/shutdown
+
+### `POST /api/v1/admin/shutdown`
+
+Gracefully shut down the application
+
+=== "Request"
+    ```bash
+    curl --request POST gnmic-api-address:port/api/v1/admin/shutdown
+    ```
diff --git a/pkg/app/api.go b/pkg/app/api.go
@@ -330,6 +330,11 @@ func (a *App) handleHealthzGet(w http.ResponseWriter, r *http.Request) {
 	w.Write(b)
 }
 
+func (a *App) handleAdminShutdown(w http.ResponseWriter, r *http.Request) {
+	a.Logger.Printf("shutting down due to user request")
+	a.Cfn()
+}
+
 func (a *App) handleClusteringMembersGet(w http.ResponseWriter, r *http.Request) {
 	if a.Config.Clustering == nil {
 		return

diff --git a/pkg/app/routes.go b/pkg/app/routes.go
@@ -20,6 +20,7 @@ func (a *App) routes() {
 	a.configRoutes(apiV1)
 	a.targetRoutes(apiV1)
 	a.healthRoutes(apiV1)
+	a.adminRoutes(apiV1)
 }
 
 func (a *App) clusterRoutes(r *mux.Router) {
@@ -64,3 +65,7 @@ func (a *App) targetRoutes(r *mux.Router) {
 func (a *App) healthRoutes(r *mux.Router) {
 	r.HandleFunc("/healthz", a.handleHealthzGet).Methods(http.MethodGet)
 }
+
+func (a *App) adminRoutes(r *mux.Router) {
+	r.HandleFunc("/admin/shutdown", a.handleAdminShutdown).Methods(http.MethodPost)
+}