add admin interface to zos-api

Author: Eslam-Nawara

client/node.go

@@ -189,7 +189,7 @@ func (n *NodeClient) NetworkListInterfaces(ctx context.Context) (result map[stri
 
 // NetworkListAllInterfaces return all physical devices on a node
 func (n *NodeClient) NetworkListAllInterfaces(ctx context.Context) (result map[string]Interface, err error) {
-	const cmd = "zos.network.admin.interfaces"
+	const cmd = "zos.admin.interfaces"
 
 	err = n.bus.Call(ctx, n.nodeTwin, cmd, nil, &result)
 
@@ -199,19 +199,92 @@ func (n *NodeClient) NetworkListAllInterfaces(ctx context.Context) (result map[s
 // NetworkSetPublicExitDevice select which physical interface to use as an exit device
 // setting `iface` to `zos` will then make node run in a single nic setup.
 func (n *NodeClient) NetworkSetPublicExitDevice(ctx context.Context, iface string) error {
-	const cmd = "zos.network.admin.set_public_nic"
+	const cmd = "zos.admin.set_public_nic"
 
 	return n.bus.Call(ctx, n.nodeTwin, cmd, iface, nil)
 }
 
 // NetworkGetPublicExitDevice gets the current dual nic setup of the node.
 func (n *NodeClient) NetworkGetPublicExitDevice(ctx context.Context) (exit ExitDevice, err error) {
-	const cmd = "zos.network.admin.get_public_nic"
+	const cmd = "zos.admin.get_public_nic"
 
 	err = n.bus.Call(ctx, n.nodeTwin, cmd, nil, &exit)
 	return
 }
 
+// AdminRebootNode stops all the running services and reboots the node
+func (n *NodeClient) AdminRebootNode(ctx context.Context) error {
+	const cmd = "zos.admin.reboot"
+
+	return n.bus.Call(ctx, n.nodeTwin, cmd, nil, nil)
+}
+
+// AdminRestartService restarts a zinit service
+func (n *NodeClient) AdminRestartService(ctx context.Context, service string) error {
+	const cmd = "zos.admin.restart"
+
+	return n.bus.Call(ctx, n.nodeTwin, cmd, service, nil)
+}
+
+// AdminRestartAll restarts all zinit services
+func (n *NodeClient) AdminRestartAll(ctx context.Context) error {
+	const cmd = "zos.admin.restart_all"
+
+	return n.bus.Call(ctx, n.nodeTwin, cmd, nil, nil)
+}
+
+// AdminShowLogs returns l lines of zinit logs
+func (n *NodeClient) AdminShowLogs(ctx context.Context, l int) (logs []byte, err error) {
+	const cmd = "zos.admin.show_logs"
+
+	err = n.bus.Call(ctx, n.nodeTwin, cmd, l, &logs)
+	return
+}
+
+// AdminShowResolve return the content of /etc/resolv.conf
+func (n *NodeClient) AdminShowResolve(ctx context.Context) (res []byte, err error) {
+	const cmd = "zos.admin.show_resolve"
+
+	err = n.bus.Call(ctx, n.nodeTwin, cmd, nil, &res)
+	return
+}
+
+// AdminShowOpenConnections return information about all open connections in the node
+func (n *NodeClient) AdminShowOpenConnections(ctx context.Context) (res []byte, err error) {
+	const cmd = "zos.admin.show_open_connections"
+
+	err = n.bus.Call(ctx, n.nodeTwin, cmd, nil, &res)
+	return
+}
+
+// AdminStopWorkload stops a workload
+func (n *NodeClient) AdminStopWorkload(ctx context.Context, twinID uint32, wlID uint64) error {
+	const cmd = "zos.admin.stop_workload"
+	args := struct {
+		TwinID     uint32 `json:"twin_id"`
+		WorkloadID uint64 `json:"workload_id"`
+	}{
+		TwinID:     twinID,
+		WorkloadID: wlID,
+	}
+
+	return n.bus.Call(ctx, n.nodeTwin, cmd, args, nil)
+}
+
+// AdminResumeWorkload stops a workload
+func (n *NodeClient) AdminResumeWorkload(ctx context.Context, twinID uint32, wlID uint64) error {
+	const cmd = "zos.admin.resume_workload"
+	args := struct {
+		TwinID     uint32 `json:"twin_id"`
+		WorkloadID uint64 `json:"workload_id"`
+	}{
+		TwinID:     twinID,
+		WorkloadID: wlID,
+	}
+
+	return n.bus.Call(ctx, n.nodeTwin, cmd, args, nil)
+}
+
 // NetworkListPublicIPs list taken public IPs on the node
 func (n *NodeClient) NetworkListPublicIPs(ctx context.Context) ([]string, error) {
 	const cmd = "zos.network.list_public_ips"

docs/manual/api.md

@@ -151,13 +151,95 @@ it means it can act like an access node to user private networks
 
 ## Admin
 
-The next set of commands are ONLY possible to be called by the `farmer` only.
+The next set of commands are ONLY possible to be called by the `farmer` owning the node.
+
+### Reboot Node
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.reboot` | - | - |
+
+Stops all services then reboots the node
+
+### Restart Service
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.restart` | string | - |
+
+Restarts a service running on the node
+
+### Restart All Services
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.restart_all` | - | - |
+
+Restarts all zinit services running on the node
+
+### Show Logs
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.show_logs` | int | []byte |
+
+Shows a number of lines of zinit logs
+
+### Show Resolve
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.show_resolve` | - | []byte |
+
+Shows the content of /etc/resolv.conf
+
+### Show Open Connections
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.show_open_connections` | - | []byte |
+
+Shows information about all open connections in the node
+
+### Stop Workload
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.Stop` | `Args`  | - |
+
+Where
+
+```json
+Args {
+    "twin_id": "uint32",
+    "workload_id": "uint64",
+}
+```
+
+Stops a workload
+
+### Resume Workload
+
+| command |body| return|
+|---|---|---|
+| `zos.admin.resume` | `Args`  | - |
+
+Where
+
+```json
+Args {
+    "twin_id": "uint32",
+    "workload_id": "uint64",
+}
+```
+
+Resumes a stopped workload
 
 ### List Physical Interfaces
 
 | command |body| return|
 |---|---|---|
-| `zos.network.admin.interfaces` | - |`map[string]Interface` |
+| `zos.admin.interfaces` | - |`map[string]Interface` |
 
 Where
 
@@ -175,7 +257,7 @@ Those interfaces then can be used as an input to `set_public_nic`
 
 | command |body| return|
 |---|---|---|
-| `zos.network.admin.get_public_nic` | - |`ExitDevice` |
+| `zos.admin.get_public_nic` | - |`ExitDevice` |
 
 Where
 
@@ -193,9 +275,9 @@ returns the interface used by public traffic (for user workloads)
 
 | command |body| return|
 |---|---|---|
-| `zos.network.admin.set_public_nic` | `name` |- |
+| `zos.admin.set_public_nic` | `name` |- |
 
-name must be one of (free) names returned by `zos.network.admin.interfaces`
+name must be one of (free) names returned by `zos.admin.interfaces`
 
 ## System
 
@@ -223,7 +305,6 @@ name must be one of (free) names returned by `zos.network.admin.interfaces`
 |---|---|---|
 | `zos.system.node_features_get` | - |`[]NodeFeature` |
 
-
 Where
 
 ```json

pkg/zos_api/admin.go

@@ -4,6 +4,11 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/rs/zerolog/log"
+	"github.com/threefoldtech/zosbase/pkg/zinit"
 )
 
 func (g *ZosAPI) adminInterfacesHandler(ctx context.Context, payload []byte) (interface{}, error) {
@@ -45,3 +50,84 @@ func (g *ZosAPI) adminSetPublicNICHandler(ctx context.Context, payload []byte) (
 	}
 	return nil, g.networkerStub.SetPublicExitDevice(ctx, iface)
 }
+
+func (g *ZosAPI) adminRebootHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	zinit := zinit.Default()
+
+	return nil, zinit.Reboot()
+}
+
+func (g *ZosAPI) adminRestartServiceHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	var service string
+	if err := json.Unmarshal(payload, &service); err != nil {
+		return nil, fmt.Errorf("failed to decode input, expecting string: %w", err)
+	}
+
+	zinit := zinit.Default()
+
+	return nil, zinit.Restart(service)
+}
+
+func (g *ZosAPI) adminRestartAllHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	zinit := zinit.Default()
+
+	services, err := zinit.List()
+	if err != nil {
+		return nil, fmt.Errorf("failed to list node services, expecting string: %w", err)
+	}
+
+	for service := range services {
+		log.Debug().Str("service", service).Send()
+		if err := zinit.Restart(service); err != nil {
+			return nil, fmt.Errorf("failed to reboot service %s, expecting string: %w", service, err)
+		}
+	}
+
+	return nil, nil
+}
+
+func (g *ZosAPI) adminShowLogsHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	var n int
+	if err := json.Unmarshal(payload, &n); err != nil {
+		return nil, fmt.Errorf("failed to decode input, expecting string: %w", err)
+	}
+
+	zinit := zinit.Default()
+
+	return zinit.Log(n)
+}
+
+func (g *ZosAPI) adminShowResolveHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	path := filepath.Join("/etc", "resolv.conf")
+	return os.ReadFile(path)
+}
+
+func (g *ZosAPI) adminShowOpenConnectionsHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	return g.statisticsStub.OpenConnections(ctx)
+}
+
+func (g *ZosAPI) adminStopWorkloadHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	var args struct {
+		TwinID     uint32 `json:"twin_id"`
+		WorkloadID uint64 `json:"workload_id"`
+	}
+
+	if err := json.Unmarshal(payload, &args); err != nil {
+		return nil, fmt.Errorf("failed to decode input, expecting twin id and workload id: %w", err)
+	}
+
+	return nil, g.provisionStub.Pause(ctx, args.TwinID, args.WorkloadID)
+}
+
+func (g *ZosAPI) adminResumeWorkloadHandler(ctx context.Context, payload []byte) (interface{}, error) {
+	var args struct {
+		TwinID     uint32 `json:"twin_id"`
+		WorkloadID uint64 `json:"workload_id"`
+	}
+
+	if err := json.Unmarshal(payload, &args); err != nil {
+		return nil, fmt.Errorf("failed to decode input, expecting twin id and workload id: %w", err)
+	}
+
+	return nil, g.provisionStub.Resume(ctx, args.TwinID, args.WorkloadID)
+}

pkg/zos_api/routes.go

@@ -49,6 +49,17 @@ func (g *ZosAPI) SetupRoutes(router *peer.Router) {
 	admin.WithHandler("set_public_nic", g.adminSetPublicNICHandler)
 	admin.WithHandler("get_public_nic", g.adminGetPublicNICHandler)
 
+	admin.WithHandler("reboot", g.adminRebootHandler)
+	admin.WithHandler("restart", g.adminRestartServiceHandler)
+	admin.WithHandler("restart_all", g.adminRestartAllHandler)
+
+	admin.WithHandler("show_logs", g.adminShowLogsHandler)
+	admin.WithHandler("show_resolve", g.adminShowResolveHandler)
+	admin.WithHandler("show_open_connections", g.adminShowOpenConnectionsHandler)
+
+	admin.WithHandler("stop_workload", g.adminStopWorkloadHandler)
+	admin.WithHandler("resume_workload", g.adminResumeWorkloadHandler)
+
 	location := root.SubRoute("location")
 	location.WithHandler("get", g.locationGet)