controller

package

v0.5.0 Latest Latest Go to latest Published: Dec 19, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloud-barista/cm-grasshopper

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CheckReady(c echo.Context) error
func GetSoftwareMigrationList(c echo.Context) error
func GetSoftwareMigrationLog(c echo.Context) error
func GetSoftwareMigrationStatus(c echo.Context) error
func ListSoftwareMigrationStatus(c echo.Context) error
func MigrateSoftware(c echo.Context) error

Constants ¶

This section is empty.

Variables ¶

View Source

var IsReady = false

View Source

var OkMessage = model.SimpleMsg{}

Functions ¶

func CheckReady ¶

func CheckReady(c echo.Context) error

CheckReady func is for checking Grasshopper server health.

@ID				health-check-readyz
@Summary		Check Ready
@Description	Check Grasshopper is ready
@Tags           [Admin] System management
@Accept			json
@Produce		json
@Success		200 {object}	model.SimpleMsg			"Successfully get ready state."
@Failure		500	{object}	common.ErrorResponse	"Failed to check ready state."
@Router		/readyz [get]

func GetSoftwareMigrationList ¶ added in v0.3.1

func GetSoftwareMigrationList(c echo.Context) error

GetSoftwareMigrationList godoc

@ID				get-migration-list
@Summary		Get Migration List
@Description	Get software migration list.
@Tags			[Migration] Software migration APIs
@Accept			json
@Produce		json
@Param			sourceSoftwareModel body softwaremodel.SourceSoftwareModel true "Refined software list."
@Success		200	{object}	softwaremodel.SourceSoftwareModel	"Successfully get software migration list."
@Failure		400	{object}	common.ErrorResponse		"Sent bad request."
@Failure		500	{object}	common.ErrorResponse		"Failed to get software migration list."
@Router			/software/migration_list [post]

func GetSoftwareMigrationLog ¶ added in v0.2.2

func GetSoftwareMigrationLog(c echo.Context) error

GetSoftwareMigrationLog godoc

@ID				get-software-migration-log
@Summary		Get Software Migration Log
@Description	Get the software migration log.
@Tags			[Migration] Software migration APIs
@Accept			json
@Produce		json
@Param			executionId path string true "ID of the software migration execution."
@Success		200	{object}	model.MigrationLogRes	"Successfully get the software migration log"
@Failure		400	{object}	common.ErrorResponse	"Sent bad request."
@Failure		500	{object}	common.ErrorResponse	"Failed to get the software migration log"
@Router			/software/migrate/log/{executionId} [get]

func GetSoftwareMigrationStatus ¶ added in v0.4.2

func GetSoftwareMigrationStatus(c echo.Context) error

GetSoftwareMigrationStatus godoc

@ID				get-software-migration-status
@Summary		Get Software Migration Status
@Description	Get the software migration status.
@Tags			[Migration] Software migration APIs
@Accept			json
@Produce		json
@Param			executionId path string true "ID of the software migration execution."
@Success		200	{object}	model.MigrationLogRes	"Successfully get the software migration status"
@Failure		400	{object}	common.ErrorResponse	"Sent bad request."
@Failure		500	{object}	common.ErrorResponse	"Failed to get the software migration status"
@Router			/software/migrate/status/{executionId} [get]

func ListSoftwareMigrationStatus ¶ added in v0.4.2

func ListSoftwareMigrationStatus(c echo.Context) error

ListSoftwareMigrationStatus godoc

@ID				list-software-migration-status
@Summary		List Software Migration Status
@Description	Get a list of software migration status.
@Tags			[Migration] Software migration APIs
@Accept			json
@Produce		json
@Success		200	{object}	[]model.SoftwareMigrateRes	"Successfully get a list of software migration status"
@Failure		400	{object}	common.ErrorResponse	"Sent bad request."
@Failure		500	{object}	common.ErrorResponse	"Failed to get the software migration status"
@Router			/software/migrate/status [get]

func MigrateSoftware ¶ added in v0.2.2

func MigrateSoftware(c echo.Context) error

MigrateSoftware godoc

@ID				migrate-software
@Summary		Migrate Software
@Description	Migrate pieces of software to target.
@Tags			[Migration] Software migration APIs
@Accept			json
@Produce		json
@Param			nsId query string true "ID of target namespace."
@Param			mciId query string true "ID of target MCI."
@Param			targetSoftwareModel body softwaremodel.TargetSoftwareModel true "Software migrate request."
@Success		200	{object}	model.SoftwareMigrateRes	"Successfully migrated pieces of software."
@Failure		400	{object}	common.ErrorResponse		"Sent bad request."
@Failure		500	{object}	common.ErrorResponse		"Failed to migrate pieces of software."
@Router			/software/migrate [post]

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL