Added API Action Request (#951)

* add api action request

Author: aphralG

api/grpc/mpi/v1/command.pb.go

@@ -191,7 +191,37 @@ message ConfigUploadRequest {
 }
 
 // Perform an associated API action on an instance
-message APIActionRequest {}
+message APIActionRequest {
+    // the identifier associated with the instance
+    string instance_id = 1;
+    // types of API actions possible
+    oneof action {
+        NGINXPlusAction nginx_plus_action = 2;
+    }
+}
+
+// Perform an action using the NGINX Plus API on an instance
+message NGINXPlusAction {
+    // types of actions possible with NGINX Plus API
+    oneof action {
+        UpdateHTTPUpstreamServers update_http_upstream_servers = 2;
+        GetHTTPUpstreamServers get_http_upstream_servers = 3;
+    }
+}
+
+// Update HTTP Upstream Servers for an instance 
+message UpdateHTTPUpstreamServers {
+    // the name of the upstream to update
+    string http_upstream_name = 1;
+    // a list of upstream servers 
+    repeated google.protobuf.Struct servers = 2;
+}
+
+// Get HTTP Upstream Servers for an instance 
+message GetHTTPUpstreamServers {
+    // the name of the upstream
+    string http_upstream_name = 1;
+}
 
 // Request an update on a particular command
 message CommandStatusRequest {}

api/grpc/mpi/v1/command.pb.validate.go

@@ -51,6 +51,7 @@
     - [CreateConnectionResponse](#mpi-v1-CreateConnectionResponse)
     - [DataPlaneResponse](#mpi-v1-DataPlaneResponse)
     - [FileServer](#mpi-v1-FileServer)
+    - [GetHTTPUpstreamServers](#mpi-v1-GetHTTPUpstreamServers)
     - [HealthRequest](#mpi-v1-HealthRequest)
     - [HostInfo](#mpi-v1-HostInfo)
     - [Instance](#mpi-v1-Instance)
@@ -62,6 +63,7 @@
     - [InstanceRuntime](#mpi-v1-InstanceRuntime)
     - [ManagementPlaneRequest](#mpi-v1-ManagementPlaneRequest)
     - [MetricsServer](#mpi-v1-MetricsServer)
+    - [NGINXPlusAction](#mpi-v1-NGINXPlusAction)
     - [NGINXPlusRuntimeInfo](#mpi-v1-NGINXPlusRuntimeInfo)
     - [NGINXRuntimeInfo](#mpi-v1-NGINXRuntimeInfo)
     - [ReleaseInfo](#mpi-v1-ReleaseInfo)
@@ -71,6 +73,7 @@
     - [UpdateDataPlaneHealthResponse](#mpi-v1-UpdateDataPlaneHealthResponse)
     - [UpdateDataPlaneStatusRequest](#mpi-v1-UpdateDataPlaneStatusRequest)
     - [UpdateDataPlaneStatusResponse](#mpi-v1-UpdateDataPlaneStatusResponse)
+    - [UpdateHTTPUpstreamServers](#mpi-v1-UpdateHTTPUpstreamServers)
 
     - [InstanceHealth.InstanceHealthStatus](#mpi-v1-InstanceHealth-InstanceHealthStatus)
     - [InstanceMeta.InstanceType](#mpi-v1-InstanceMeta-InstanceType)
@@ -601,6 +604,12 @@ and recommendations outlined in https://static.sched.com/hosted_files/kccncna17/
 Perform an associated API action on an instance
 
 
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| instance_id | [string](#string) |  | the identifier associated with the instance |
+| nginx_plus_action | [NGINXPlusAction](#mpi-v1-NGINXPlusAction) |  |  |
+
+
 
 
 
@@ -773,6 +782,21 @@ The file settings associated with file server for configurations
 
 
 
+<a name="mpi-v1-GetHTTPUpstreamServers"></a>
+
+### GetHTTPUpstreamServers
+Get HTTP Upstream Servers for an instance
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| http_upstream_name | [string](#string) |  | the name of the upstream |
+
+
+
+
+
+
 <a name="mpi-v1-HealthRequest"></a>
 
 ### HealthRequest
@@ -943,6 +967,22 @@ The metrics settings associated with origins (sources) of the metrics and destin
 
 
 
+<a name="mpi-v1-NGINXPlusAction"></a>
+
+### NGINXPlusAction
+Perform an action using the NGINX Plus API on an instance
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| update_http_upstream_servers | [UpdateHTTPUpstreamServers](#mpi-v1-UpdateHTTPUpstreamServers) |  |  |
+| get_http_upstream_servers | [GetHTTPUpstreamServers](#mpi-v1-GetHTTPUpstreamServers) |  |  |
+
+
+
+
+
+
 <a name="mpi-v1-NGINXPlusRuntimeInfo"></a>
 
 ### NGINXPlusRuntimeInfo
@@ -1080,6 +1120,22 @@ Respond to a UpdateDataPlaneStatusRequest - intentionally empty
 
 
 
+
+<a name="mpi-v1-UpdateHTTPUpstreamServers"></a>
+
+### UpdateHTTPUpstreamServers
+Update HTTP Upstream Servers for an instance
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| http_upstream_name | [string](#string) |  | the name of the upstream to update |
+| servers | [google.protobuf.Struct](#google-protobuf-Struct) | repeated | a list of upstream servers |
+
+
+
+
+
 
 
 

api/grpc/mpi/v1/command.proto

@@ -23,4 +23,5 @@ const (
 	RollbackWriteTopic           = "rollback-write"
 	DataPlaneHealthRequestTopic  = "data-plane-health-request"
 	DataPlaneHealthResponseTopic = "data-plane-health-response"
+	APIActionRequestTopic        = "api-action-request"
 )

docs/proto/protos.md

@@ -182,13 +182,40 @@ func (cp *CommandPlugin) monitorSubscribeChannel(ctx context.Context) {
 				cp.handleConfigApplyRequest(newCtx, message)
 			case *mpi.ManagementPlaneRequest_HealthRequest:
 				cp.handleHealthRequest(newCtx)
+			case *mpi.ManagementPlaneRequest_ActionRequest:
+				cp.handleAPIActionRequest(newCtx, message)
 			default:
 				slog.DebugContext(newCtx, "Management plane request not implemented yet")
 			}
 		}
 	}
 }
 
+func (cp *CommandPlugin) handleAPIActionRequest(ctx context.Context, message *mpi.ManagementPlaneRequest) {
+	if cp.config.IsFeatureEnabled(pkgConfig.FeatureAPIAction) {
+		cp.messagePipe.Process(ctx, &bus.Message{Topic: bus.APIActionRequestTopic, Data: message})
+	} else {
+		slog.WarnContext(
+			ctx,
+			"API Action Request feature disabled. Unable to process API action request",
+			"request", message,
+		)
+
+		err := cp.commandService.SendDataPlaneResponse(ctx, &mpi.DataPlaneResponse{
+			MessageMeta: message.GetMessageMeta(),
+			CommandResponse: &mpi.CommandResponse{
+				Status:  mpi.CommandResponse_COMMAND_STATUS_FAILURE,
+				Message: "API action failed",
+				Error:   "API action feature is disabled",
+			},
+			InstanceId: message.GetActionRequest().GetInstanceId(),
+		})
+		if err != nil {
+			slog.ErrorContext(ctx, "Unable to send data plane response", "error", err)
+		}
+	}
+}
+
 func (cp *CommandPlugin) handleConfigApplyRequest(newCtx context.Context, message *mpi.ManagementPlaneRequest) {
 	if cp.config.IsFeatureEnabled(pkgConfig.FeatureConfiguration) {
 		cp.messagePipe.Process(newCtx, &bus.Message{Topic: bus.ConfigApplyRequestTopic, Data: message})
@@ -206,7 +233,7 @@ func (cp *CommandPlugin) handleConfigApplyRequest(newCtx context.Context, messag
 				Message: "Config apply failed",
 				Error:   "Configuration feature is disabled",
 			},
-			InstanceId: message.GetConfigUploadRequest().GetOverview().GetConfigVersion().GetInstanceId(),
+			InstanceId: message.GetConfigApplyRequest().GetOverview().GetConfigVersion().GetInstanceId(),
 		})
 		if err != nil {
 			slog.ErrorContext(newCtx, "Unable to send data plane response", "error", err)