common

Documentation

Index

• func RestCheckNs(c echo.Context) error
• func RestDelAllNs(c echo.Context) error
• func RestDelNs(c echo.Context) error
• func RestDeleteObject(c echo.Context) error
• func RestDeleteObjects(c echo.Context) error
• func RestGetAllConfig(c echo.Context) error
• func RestGetAllNs(c echo.Context) error
• func RestGetConfig(c echo.Context) error
• func RestGetConnConfig(c echo.Context) error
• func RestGetConnConfigList(c echo.Context) error
• func RestGetHealth(c echo.Context) error
• func RestGetNs(c echo.Context) error
• func RestGetObject(c echo.Context) error
• func RestGetObjects(c echo.Context) error
• func RestGetRegion(c echo.Context) error
• func RestGetRegionList(c echo.Context) error
• func RestGetSwagger(c echo.Context) error
• func RestInitAllConfig(c echo.Context) error
• func RestInitConfig(c echo.Context) error
• func RestInspectResources(c echo.Context) error
• func RestPostConfig(c echo.Context) error
• func RestPostNs(c echo.Context) error
• func RestPutNs(c echo.Context) error
• func Send(c echo.Context, httpCode int, json interface{}) error
• func SendExistence(c echo.Context, httpCode int, existence bool) error
• func SendMessage(c echo.Context, httpCode int, msg string) error
• func Validate(c echo.Context, params []string) error
• type Existence
• type JSONResult
• type ObjectList
• type RestGetAllConfigResponse
• type RestGetAllNsResponse
• type RestInspectResourcesRequest
• type Status
• type TbConnectionName

Functions

func RestCheckNs

func RestCheckNs(c echo.Context) error

func RestDelAllNs

func RestDelAllNs(c echo.Context) error

RestDelAllNs godoc @Summary Delete all namespaces @Description Delete all namespaces @Tags [Namespace] Namespace management @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns [delete]

func RestDelNs

func RestDelNs(c echo.Context) error

RestDelNs godoc @Summary Delete namespace @Description Delete namespace @Tags [Namespace] Namespace management @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId} [delete]

func RestDeleteObject

func RestDeleteObject(c echo.Context) error

func RestDeleteObject is a rest api wrapper for DeleteObject. RestDeleteObject godoc @Summary Delete an object @Description Delete an object @Tags [Admin] System management @Accept json @Produce json @Param key query string true "delete object value by key" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /object [delete]

func RestDeleteObjects

func RestDeleteObjects(c echo.Context) error

func RestDeleteObjects is a rest api wrapper for DeleteObjects. RestDeleteObjects godoc @Summary Delete child objects along with the given object @Description Delete child objects along with the given object @Tags [Admin] System management @Accept json @Produce json @Param key query string true "Delete child objects based on the given key string" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /objects [delete]

func RestGetAllConfig

func RestGetAllConfig(c echo.Context) error

RestGetAllConfig godoc @Summary List all configs @Description List all configs @Tags [Admin] System environment @Accept json @Produce json @Success 200 {object} RestGetAllConfigResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config [get]

func RestGetAllNs

func RestGetAllNs(c echo.Context) error

RestGetAllNs godoc @Summary List all namespaces or namespaces' ID @Description List all namespaces or namespaces' ID @Tags [Namespace] Namespace management @Accept json @Produce json @Param option query string false "Option" Enums(id) @Success 200 {object} JSONResult{[DEFAULT]=RestGetAllNsResponse,[ID]=common.IdList} "Different return structures by the given option param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns [get]

func RestGetConfig

func RestGetConfig(c echo.Context) error

RestGetConfig godoc @Summary Get config @Description Get config @Tags [Admin] System environment @Accept json @Produce json @Param configId path string true "Config ID" @Success 200 {object} common.ConfigInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config/{configId} [get]

func RestGetConnConfig

func RestGetConnConfig(c echo.Context) error

RestGetConnConfig func is a rest api wrapper for GetConnConfig. RestGetConnConfig godoc @Summary Get registered ConnConfig info @Description Get registered ConnConfig info @Tags [Admin] Cloud environment management @Accept json @Produce json @Param connConfigName path string true "Name of connection config (cloud config)" @Success 200 {object} common.ConnConfig @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /connConfig/{connConfigName} [get]

func RestGetConnConfigList

func RestGetConnConfigList(c echo.Context) error

RestGetConnConfigList func is a rest api wrapper for GetConnConfigList. RestGetConnConfigList godoc @Summary List all registered ConnConfig @Description List all registered ConnConfig @Tags [Admin] Cloud environment management @Accept json @Produce json @Success 200 {object} common.ConnConfigList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /connConfig [get]

func RestGetHealth

func RestGetHealth(c echo.Context) error

RestGetHealth func is for checking Tumblebug server health. RestGetHealth godoc @Summary Check Tumblebug is alive @Description Check Tumblebug is alive @Tags [Admin] System management @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /health [get]

func RestGetNs

func RestGetNs(c echo.Context) error

RestGetNs godoc @Summary Get namespace @Description Get namespace @Tags [Namespace] Namespace management @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.NsInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId} [get]

func RestGetObject

func RestGetObject(c echo.Context) error

func RestGetObject is a rest api wrapper for GetObject. RestGetObject godoc @Summary Get value of an object @Description Get value of an object @Tags [Admin] System management @Accept json @Produce json @Param key query string true "get object value by key" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /object [get]

func RestGetObjects

func RestGetObjects(c echo.Context) error

func RestGetObjects is a rest api wrapper for GetObjectList. RestGetObjects godoc @Summary List all objects for a given key @Description List all objects for a given key @Tags [Admin] System management @Accept json @Produce json @Param key query string true "retrieve objects by key" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /objects [get]

func RestGetRegion

func RestGetRegion(c echo.Context) error

RestGetRegion func is a rest api wrapper for GetRegion. RestGetRegion godoc @Summary Get registered region info @Description Get registered region info @Tags [Admin] Cloud environment management @Accept json @Produce json @Param regionName path string true "Name of region to retrieve" @Success 200 {object} common.Region @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /region/{regionName} [get]

func RestGetRegionList

func RestGetRegionList(c echo.Context) error

RestGetRegionList func is a rest api wrapper for GetRegionList. RestGetRegionList godoc @Summary List all registered regions @Description List all registered regions @Tags [Admin] Cloud environment management @Accept json @Produce json @Success 200 {object} common.RegionList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /region [get]

func RestGetSwagger

func RestGetSwagger(c echo.Context) error

RestGetSwagger func is to get API document web. RestGetSwagger godoc @Summary Get API document web @Description Get API document web @Tags [Admin] System management @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /swaggerActive [get]

func RestInitAllConfig

func RestInitAllConfig(c echo.Context) error

RestInitAllConfig godoc @Summary Init all configs @Description Init all configs @Tags [Admin] System environment @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /config [delete]

func RestInitConfig

func RestInitConfig(c echo.Context) error

RestInitConfig godoc @Summary Init config @Description Init config @Tags [Admin] System environment @Accept json @Produce json @Param configId path string true "Config ID" @Success 200 {object} common.ConfigInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config/{configId} [delete]

func RestInspectResources

func RestInspectResources(c echo.Context) error

RestInspectResources godoc @Summary Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP @Description Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP @Tags [Admin] Cloud environment management @Accept json @Produce json @Param connectionName body RestInspectResourcesRequest true "Specify connectionName and resource type" @Success 200 {object} mcis.TbInspectResourcesResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /inspectResources [post]

func RestPostConfig

func RestPostConfig(c echo.Context) error

RestPostConfig godoc @Summary Create or Update config @Description Create or Update config (SPIDER_REST_URL, DRAGONFLY_REST_URL, ...) @Tags [Admin] System environment @Accept json @Produce json @Param config body common.ConfigReq true "Key and Value for configuration" @Success 200 {object} common.ConfigInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config [post]

func RestPostNs

func RestPostNs(c echo.Context) error

RestPostNs godoc @Summary Create namespace @Description Create namespace @Tags [Namespace] Namespace management @Accept json @Produce json @Param nsReq body common.NsReq true "Details for a new namespace" @Success 200 {object} common.NsInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns [post]

func RestPutNs

func RestPutNs(c echo.Context) error

function RestPutNs not yet implemented

// RestPutNs godoc // @Summary Update namespace // @Description Update namespace // @Tags [Namespace] Namespace management // @Accept json // @Produce json // @Param namespace body common.NsInfo true "Details to update existing namespace" // @Success 200 {object} common.NsInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId} [put]

func Send

func Send(c echo.Context, httpCode int, json interface{}) error

func SendExistence

func SendExistence(c echo.Context, httpCode int, existence bool) error

func SendMessage

func SendMessage(c echo.Context, httpCode int, msg string) error

func Validate

func Validate(c echo.Context, params []string) error

Types

type Existence

type Existence struct {
	Exists bool `json:"exists"`
}

type JSONResult

type JSONResult struct {
}

JSONResult's data field will be overridden by the specific type

type ObjectList

type ObjectList struct {
	Object []string `json:"object"`
}

ObjectList struct consists of object IDs

type RestGetAllConfigResponse

type RestGetAllConfigResponse struct {
	//Name string     `json:"name"`
	Config []common.ConfigInfo `json:"config"`
}

Response structure for RestGetAllConfig

type RestGetAllNsResponse

type RestGetAllNsResponse struct {
	//Name string     `json:"name"`
	Ns []common.NsInfo `json:"ns"`
}

Response structure for RestGetAllNs

type RestInspectResourcesRequest

type RestInspectResourcesRequest struct {
	ConnectionName string `json:"connectionName"`
	Type           string `json:"type" example:"vNet" enums:"vNet,securityGroup,sshKey,vm"`
}

Request struct for RestInspectResources

type Status

type Status struct {
	Message string `json:"message"`
}

type TbConnectionName

type TbConnectionName struct {
	ConnectionName string `json:"connectionName"`
}