deploy

Documentation

Index

• func AddNode(c *gin.Context)
• func AddSSHCertificate(c *gin.Context)
• func CheckNodeList(c *gin.Context)
• func ClearWizard(c *gin.Context)
• func DeleteNode(c *gin.Context)
• func Deploy(c *gin.Context)
• func DownloadKubeConfig(c *gin.Context)
• func DownloadLog(c *gin.Context)
• func GetCertificateList(c *gin.Context)
• func GetCheckingNodeListResult(c *gin.Context)
• func GetCluster(c *gin.Context)
• func GetDeployReport(c *gin.Context)
• func GetNode(c *gin.Context)
• func GetNodeList(c *gin.Context)
• func GetWizardProgress(c *gin.Context)
• func SetCluster(c *gin.Context)
• func TestConnectNode(c *gin.Context)
• func UpdateNode(c *gin.Context)
• func UploadBatchNodes(c *gin.Context)

Functions

func AddNode

func AddNode(c *gin.Context)

@ID AddNode @Summary Add Node Information @Description Add deployment candidate to node list @Tags node @Accept application/json @Produce application/json @Param node body api.NodeData true "Node information" @Success 201 {object} api.NodeData @Failure 400 {object} h.AppErr @Failure 409 {object} h.AppErr @Router /api/v1/deploy/wizard/nodes [post]

func AddSSHCertificate

func AddSSHCertificate(c *gin.Context)

@ID AddSSHCertificate @Summary Add SSH login private key @Description Add SSH login private key @Tags ssh_certificate @Accept application/json @Produce application/json @Param certificate body api.SSHCertificate true "Certificate information" @Success 201 {object} api.SuccessfulOption @Router /api/v1/ssh_certificates [post]

func CheckNodeList

func CheckNodeList(c *gin.Context)

@ID CheckNodeList @Summary check node list @Description Check if the node meets the pre-deployment requirements @Tags checking @Produce application/json @Success 201 {object} api.SuccessfulOption @Router /api/v1/deploy/wizard/checks [post]

func ClearWizard

func ClearWizard(c *gin.Context)

@ID ClearWizard @Summary Clear all of current deploy wizard data @Description Clear all data, include current progress, cluster and node data. deploying progress or error. @Tags wizard @Success 204 @Router /api/v1/deploy/wizard/progresses [delete]

func DeleteNode

func DeleteNode(c *gin.Context)

@ID DeleteNode @Summary Delete a node @Description Delete a node from deployment candidate node list @Tags node @Produce application/json @Param ip path string true "Node IP Address" @Success 204 @Failure 400 {object} h.AppErr @Failure 404 {object} h.AppErr @Failure 409 {object} h.AppErr @Router /api/v1/deploy/wizard/nodes/{ip} [delete]

func Deploy

func Deploy(c *gin.Context)

@ID LaunchDeployment @Summary Launch deployment @Description Launch deployment @Tags deploy @Produce application/json @Success 201 {object} api.SuccessfulOption @Failure 404 {object} h.AppErr @Router /api/v1/deploy/wizard/deploys [post]

func DownloadKubeConfig

func DownloadKubeConfig(c *gin.Context)

@ID DownloadKubeConfig @Summary Download kubeconfig file content @Description Download kubeconfig file @Tags kubeconfig @Produce text/plain @Success 200 {string} string "Kube Config File Content" @Failure 400 {object} h.AppErr @Failure 404 {object} h.AppErr @Router /api/v1/deploy/wizard/kubeconfigs [get]

func DownloadLog

func DownloadLog(c *gin.Context)

@ID DownloadLog @Summary Download the log detail @Description Download the deployment log details to check the cause of the error @Tags log @Produce text/plain @Param id path int true "Log ID" @Success 200 {string} string "Log File Content" @Failure 400 {object} h.AppErr @Failure 404 {object} h.AppErr @Router /api/v1/deploy/wizard/logs/{id} [get]

func GetCertificateList

func GetCertificateList(c *gin.Context)

@ID GetSSHCertificate @Summary Get SSH login keys list @Description Get SSH login certificate keys list @Tags ssh_certificate @Produce application/json @Success 200 {object} api.GetSSHCertificateListResponse @Router /api/v1/ssh_certificates [get]

func GetCheckingNodeListResult

func GetCheckingNodeListResult(c *gin.Context)

@ID GetCheckNodeListResult @Summary Get the result of check node @Description Get the result of the check node @Tags checking @Produce application/json @Success 200 {object} api.GetCheckingResultResponse @Router /api/v1/deploy/wizard/checks [get]

func GetCluster

func GetCluster(c *gin.Context)

@ID GetCluster @Summary Get Cluster Information @Description Describe cluster information @Tags cluster @Produce application/json @Success 200 {object} api.Cluster @Router /api/v1/deploy/wizard/clusters [get]

func GetDeployReport

func GetDeployReport(c *gin.Context)

@ID GetDeploymentReport @Summary Get the result of deployment @Description Get the result of the deployment @Tags deploy @Produce application/json @Success 200 {object} api.GetDeploymentReportResponse @Router /api/v1/deploy/wizard/deploys [get]

func GetNode

func GetNode(c *gin.Context)

@ID GetNode @Summary Get a node information @Description Get a node information @Tags node @Produce application/json @Param ip path string true "Node IP Address" @Success 200 {object} api.NodeData @Failure 400 {object} h.AppErr @Failure 404 {object} h.AppErr @Router /api/v1/deploy/wizard/nodes/{ip} [get]

func GetNodeList

func GetNodeList(c *gin.Context)

@ID GetNodeList @Summary Get nodes information @Description Get nodes information @Tags node @Produce application/json @Success 200 {object} api.GetNodeListResponse @Router /api/v1/deploy/wizard/nodes [get]

func GetWizardProgress

func GetWizardProgress(c *gin.Context)

@ID GetWizardProgress @Summary Get all of current deploy wizard data @Description Get all data, include current progress, cluster and node data. deploying progress or error. @Tags wizard @Produce application/json @Success 200 {object} api.GetWizardResponse @Router /api/v1/deploy/wizard/progresses [get]

func SetCluster

func SetCluster(c *gin.Context)

@ID SetCluster @Summary Set Cluster Information @Description Store new cluster information @Tags cluster @Accept application/json @Produce application/json @Param cluster body api.Cluster true "RequiredFields: shortName, name, kubeAPIServerConnectType" @Success 201 {object} api.SuccessfulOption @Failure 400 {object} h.AppErr @Failure 409 {object} h.AppErr @Router /api/v1/deploy/wizard/clusters [post]

func TestConnectNode

func TestConnectNode(c *gin.Context)

@ID TestSSH @Summary Test a node connection @Description Try to connection a node using ssh @Tags ssh @Accept application/json @Produce application/json @Param node body api.ConnectionData true "Node information" @Success 201 {object} api.SuccessfulOption @Failure 400 {object} h.AppErr @Failure 409 {object} h.AppErr @Failure 500 {object} h.AppErr @Router /api/v1/ssh/tests [post]

func UpdateNode

func UpdateNode(c *gin.Context)

@ID UpdateNode @Summary Update Node Information @Description Update a node information which in deployment candidate node list @Tags node @Accept application/json @Produce application/json @Param node body api.UpdateNodeData true "Node information" @Param ip path string true "Node IP Address" @Success 200 {object} api.NodeData @Failure 400 {object} h.AppErr @Failure 404 {object} h.AppErr @Failure 409 {object} h.AppErr @Router /api/v1/deploy/wizard/nodes/{ip} [put]

func UploadBatchNodes

func UploadBatchNodes(c *gin.Context)

@ID UploadBatchNodes @Summary Upload batch nodes configuration @Description Upload batch nodes configuration file to node list @Tags nodes @Accept text/plain @Produce application/json @Param nodes body string true "node list" @Success 201 {object} api.GetNodeListResponse @Router /api/v1/deploy/wizard/batchnodes [post]