api

Documentation

Overview

Package api provides the handlers for the Vela API.

Usage:

import "github.com/go-vela/worker/api"

Index

• func CancelBuild(c *gin.Context)
• func GetBuild(c *gin.Context)
• func GetExecutor(c *gin.Context)
• func GetExecutors(c *gin.Context)
• func GetPipeline(c *gin.Context)
• func GetRepo(c *gin.Context)
• func Health(c *gin.Context)
• func Metrics() http.Handler
• func Register(c *gin.Context)
• func Shutdown(c *gin.Context)
• func Version(c *gin.Context)

Functions

func CancelBuild

func CancelBuild(c *gin.Context)

CancelBuild represents the API handler to cancel a build currently running on an executor.

This function performs a hard cancellation of a build on worker. Any build running during this time will immediately be stopped.

func GetBuild

func GetBuild(c *gin.Context)

GetBuild represents the API handler to capture the build currently running on an executor.

func GetExecutor

func GetExecutor(c *gin.Context)

GetExecutor represents the API handler to capture the executor currently running on a worker.

func GetExecutors

func GetExecutors(c *gin.Context)

GetExecutors represents the API handler to capture the executors currently running on a worker.

func GetPipeline

func GetPipeline(c *gin.Context)

GetPipeline represents the API handler to capture the pipeline currently running on an executor.

func GetRepo

func GetRepo(c *gin.Context)

GetRepo represents the API handler to capture the repo currently running on an executor.

func Health

func Health(c *gin.Context)

Health check the status of the application.

func Metrics

func Metrics() http.Handler

Metrics returns a Prometheus handler for serving go metrics.

func Register

func Register(c *gin.Context)

Register will pass the token given in the request header to the register token channel of the worker. This will unblock operation if the worker has not been registered and the provided registration token is valid.

func Shutdown

func Shutdown(c *gin.Context)

Shutdown represents the API handler to shutdown a executors currently running on an worker.

This function performs a soft shut down of a worker. Any build running during this time will safely complete, then the worker will safely shut itself down.

func Version

func Version(c *gin.Context)

Version represents the API handler to report the version information for Vela.