controllers_v1

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.

Index

• Constants
• type MiscController
  • func NewMiscController(workflowService services_shared.WorkflowService, logger utils.Logger) MiscController
  • func (u MiscController) GetLiveness(c *gin.Context)
  • func (u MiscController) GetReadiness(c *gin.Context)
  • func (u MiscController) GetVersion(c *gin.Context)

Constants

const VERSION string = "development"

use ldflags to replace this value during build:

https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications

Types

type MiscController

type MiscController struct {
	// contains filtered or unexported fields
}

MiscController data type

func NewMiscController

func NewMiscController(workflowService services_shared.WorkflowService, logger utils.Logger) MiscController

NewMiscController creates new Misc controller

func (MiscController) GetLiveness

func (u MiscController) GetLiveness(c *gin.Context)

GetLiveness

@Summary	K8s Liveness endpoint
@Tags		Misc
@Accept		json
@Produce	json
@Success	204
@Router		/v1/liveness [get]

func (MiscController) GetReadiness

func (u MiscController) GetReadiness(c *gin.Context)

GetReadiness

@Summary	K8s Readiness endpoint
@Tags		Misc
@Accept		json
@Produce	json
@Success	204
@Failure	500	{object}	utils.ResponseError
@Router		/v1/readiness [get]

func (MiscController) GetVersion

func (u MiscController) GetVersion(c *gin.Context)

GetVersion

@Summary	Get version of cray-nls service
@Tags		Misc
@Accept		json
@Produce	json
@Success	200	{object}	utils.ResponseOk
@Failure	500	{object}	utils.ResponseError
@Router		/v1/version [get]