feat(edge/update): remote update structure [EE-4040] (#7553)

api/edgetypes/edgetypes.go

@@ -0,0 +1,93 @@
+package edgetypes
+
+import portainer "github.com/portainer/portainer/api"
+
+const (
+	// PortainerAgentUpdateScheduleIDHeader represents the name of the header containing the update schedule id
+	PortainerAgentUpdateScheduleIDHeader = "X-Portainer-Update-Schedule-ID"
+	// PortainerAgentUpdateStatusHeader is the name of the header that will have the update status
+	PortainerAgentUpdateStatusHeader = "X-Portainer-Update-Status"
+	// PortainerAgentUpdateErrorHeader is the name of the header that will have the update error
+	PortainerAgentUpdateErrorHeader = "X-Portainer-Update-Error"
+)
+
+type (
+
+	// VersionUpdateStatus represents the status of an agent version update
+	VersionUpdateStatus struct {
+		Status     UpdateScheduleStatusType
+		ScheduleID UpdateScheduleID
+		Error      string
+	}
+
+	// UpdateScheduleID represents an Edge schedule identifier
+	UpdateScheduleID int
+
+	// UpdateSchedule represents a schedule for update/rollback of edge devices
+	UpdateSchedule struct {
+		// EdgeUpdateSchedule Identifier
+		ID UpdateScheduleID `json:"id" example:"1"`
+		// Name of the schedule
+		Name string `json:"name" example:"Update Schedule"`
+		// Type of the schedule
+		Time int64 `json:"time" example:"1564897200"`
+		// EdgeGroups to be updated
+		GroupIDs []portainer.EdgeGroupID `json:"groupIds" example:"1"`
+		// Type of the update (1 - update, 2 - rollback)
+		Type UpdateScheduleType `json:"type" example:"1" enums:"1,2"`
+		// Status of the schedule, grouped by environment id
+		Status map[portainer.EndpointID]UpdateScheduleStatus `json:"status"`
+		// Created timestamp
+		Created int64 `json:"created" example:"1564897200"`
+		// Created by user id
+		CreatedBy portainer.UserID `json:"createdBy" example:"1"`
+		// Version of the edge agent
+		Version string `json:"version" example:"1"`
+	}
+
+	// UpdateScheduleType represents type of an Edge update schedule
+	UpdateScheduleType int
+
+	// UpdateScheduleStatus represents status of an Edge update schedule
+	UpdateScheduleStatus struct {
+		// Status of the schedule (0 - pending, 1 - failed, 2 - success)
+		Status UpdateScheduleStatusType `json:"status" example:"1" enums:"1,2,3"`
+		// Error message if status is failed
+		Error string `json:"error" example:""`
+		// Target version of the edge agent
+		TargetVersion string `json:"targetVersion" example:"1"`
+		// Current version of the edge agent
+		CurrentVersion string `json:"currentVersion" example:"1"`
+	}
+
+	// UpdateScheduleStatusType represents status type of an Edge update schedule
+	UpdateScheduleStatusType int
+
+	VersionUpdateRequest struct {
+		// Target version
+		Version string
+		// Scheduled time
+		ScheduledTime int64
+		// If need to update
+		Active bool
+		// Update schedule ID
+		ScheduleID UpdateScheduleID
+	}
+)
+
+const (
+	_ UpdateScheduleType = iota
+	// UpdateScheduleUpdate represents an edge device scheduled for an update
+	UpdateScheduleUpdate
+	// UpdateScheduleRollback represents an edge device scheduled for a rollback
+	UpdateScheduleRollback
+)
+
+const (
+	// UpdateScheduleStatusPending represents a pending edge update schedule
+	UpdateScheduleStatusPending UpdateScheduleStatusType = iota
+	// UpdateScheduleStatusError represents a failed edge update schedule
+	UpdateScheduleStatusError
+	// UpdateScheduleStatusSuccess represents a successful edge update schedule
+	UpdateScheduleStatusSuccess
+)