Documentation
¶
Overview ¶
* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *
* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *
MIT License ¶
(C) Copyright 2022 Hewlett Packard Enterprise Development LP
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HookController ¶
type HookController struct {
// contains filtered or unexported fields
}
HookController data type
func NewHookController ¶
func NewHookController(workflowService services.WorkflowService, logger utils.Logger) HookController
NewHookController creates new Ncn controller
type NcnController ¶
type NcnController struct {
// contains filtered or unexported fields
}
NcnController data type
func NewNcnController ¶
func NewNcnController(workflowService services.WorkflowService, logger utils.Logger) NcnController
NewNcnController creates new Ncn controller
func (NcnController) NcnsCreateRebootWorkflow ¶
func (u NcnController) NcnsCreateRebootWorkflow(c *gin.Context)
NcnsCreateRebootWorkflow @Summary End to end rolling reboot ncns @Param include body models.CreateRebootWorkflowRequest true "hostnames to include" @Tags NCN Lifecycle Events @Accept json @Produce json @Success 200 {object} models.CreateRebootWorkflowResponse @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/ncns/reboot [post]
func (NcnController) NcnsCreateRebuildWorkflow ¶
func (u NcnController) NcnsCreateRebuildWorkflow(c *gin.Context)
NcnsCreateRebuildWorkflow @Summary End to end rolling rebuild ncns @Param include body models.CreateRebuildWorkflowRequest true "hostnames to include" @Tags NCN Lifecycle Events @Accept json @Produce json @Success 200 {object} models.CreateRebuildWorkflowResponse @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/ncns/rebuild [post]
type WorkflowController ¶
type WorkflowController struct {
// contains filtered or unexported fields
}
Controller data type
func NewWorkflowController ¶
func NewWorkflowController(Service services.WorkflowService, logger utils.Logger) WorkflowController
NewController creates new controller
func (WorkflowController) DeleteWorkflow ¶
func (u WorkflowController) DeleteWorkflow(c *gin.Context)
DeleteWorkflow @Summary Delete a ncn workflow @Param name path string true "name of workflow" @Tags Workflow Management @Accept json @Produce json @Success 200 {object} utils.ResponseOk @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/workflows/{name} [delete]
func (WorkflowController) GetWorkflows ¶
func (u WorkflowController) GetWorkflows(c *gin.Context)
GetWorkflows @Summary Get status of a ncn workflow @Param labelSelector query string false "Label Selector" @Tags Workflow Management @Accept json @Produce json @Success 200 {object} []models.GetWorkflowResponse @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/workflows [get]
func (WorkflowController) RerunWorkflow ¶
func (u WorkflowController) RerunWorkflow(c *gin.Context)
RerunWorkflows @Summary Rerun a workflow, all steps will run @Param name path string true "name of workflow" @Tags Workflow Management @Accept json @Produce json @Success 200 {object} utils.ResponseOk @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/workflows/{name}/rerun [put]
func (WorkflowController) RetryWorkflow ¶
func (u WorkflowController) RetryWorkflow(c *gin.Context)
RetryWorkflows @Summary Retry a failed ncn workflow, skip passed steps @Param name path string true "name of workflow" @Param retryOptions body models.RetryWorkflowRequestBody true "retry options" @Tags Workflow Management @Accept json @Produce json @Success 200 {object} utils.ResponseOk @Failure 400 {object} utils.ResponseError @Failure 404 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /nls/v1/workflows/{name}/retry [put]
Source Files