lifecycle

README

API Sercice LifeCycle

The apiservice LifeCycle is the implementation of the lifeCycle part from the unified api. The api service lifeCycle is available in all Perinets Products.

This implementation does store its resources, e.g. NodeInfo object or the ProductionInfo object persistently in the file system /var/lib/apiservice-lifeCycle/ as json files.

References

• [openAPI spec for apiservice LifeCycle] https://gitlab.com/perinet/unified-api/-/blob/main/services/LifeCycle_openapi.yaml

Dual License

This software is by default licensed via the GNU Affero General Public License version 3. However it is also available with a commercial license on request (https://perinet.io/contact).

Documentation

Index

• Constants
• func LifeCycle_Config_Get(p periHttp.PeriHttp)
• func LifeCycle_Config_Set(p periHttp.PeriHttp)
• func LifeCycle_FactoryReset_Set(p periHttp.PeriHttp)
• func LifeCycle_FirmwareProductionImage_Get(p periHttp.PeriHttp)
• func LifeCycle_FirmwareProductionImage_Set(p periHttp.PeriHttp)
• func LifeCycle_FirmwareUpdateImage_Get(p periHttp.PeriHttp)
• func LifeCycle_FirmwareUpdateImage_Set(p periHttp.PeriHttp)
• func LifeCycle_Info_Get(p periHttp.PeriHttp)
• func LifeCycle_Reboot_Set(p periHttp.PeriHttp)
• func PathsGet() []httpserver.PathInfo
• func SetServiceLifeCycle(serviceLifeCycle ServiceLifeCycle)
• type LifeCycleConfig
• type LifeCycleInfo
• type LifeCycleOEMProductionFirmwareImageStatus
• type LifeCycleStatus
• type LifeCycleUpdateFirmwareImageStatus
• type ServiceLifeCycle

Constants

const (
	API_VERSION = "23"
)

Functions

func LifeCycle_Config_Get

func LifeCycle_Config_Get(p periHttp.PeriHttp)

func LifeCycle_Config_Set

func LifeCycle_Config_Set(p periHttp.PeriHttp)

func LifeCycle_FactoryReset_Set

func LifeCycle_FactoryReset_Set(p periHttp.PeriHttp)

func LifeCycle_FirmwareProductionImage_Get

func LifeCycle_FirmwareProductionImage_Get(p periHttp.PeriHttp)

func LifeCycle_FirmwareProductionImage_Set

func LifeCycle_FirmwareProductionImage_Set(p periHttp.PeriHttp)

func LifeCycle_FirmwareUpdateImage_Get

func LifeCycle_FirmwareUpdateImage_Get(p periHttp.PeriHttp)

func LifeCycle_FirmwareUpdateImage_Set

func LifeCycle_FirmwareUpdateImage_Set(p periHttp.PeriHttp)

func LifeCycle_Info_Get

func LifeCycle_Info_Get(p periHttp.PeriHttp)

func LifeCycle_Reboot_Set

func LifeCycle_Reboot_Set(p periHttp.PeriHttp)

func PathsGet

func PathsGet() []httpserver.PathInfo

func SetServiceLifeCycle

func SetServiceLifeCycle(serviceLifeCycle ServiceLifeCycle)

Types

type LifeCycleConfig

type LifeCycleConfig struct {
	State node.NodeLifeState `json:"state"`
}

type LifeCycleInfo

type LifeCycleInfo struct {
	ApiVersion    json.Number          `json:"api_version"`
	State         node.NodeLifeState   `json:"state"`
	ErrorStatus   node.NodeErrorStatus `json:"error_status"`
	RebootCounter int                  `json:"reboot_counter"`
}

type LifeCycleOEMProductionFirmwareImageStatus

type LifeCycleOEMProductionFirmwareImageStatus struct {
	State LifeCycleStatus `json:"state"`
}

type LifeCycleStatus

type LifeCycleStatus = lifecycleStatus.Enum

type LifeCycleUpdateFirmwareImageStatus

type LifeCycleUpdateFirmwareImageStatus struct {
	State LifeCycleStatus `json:"state"`
}

type ServiceLifeCycle

type ServiceLifeCycle struct {
	StoragePath string
}