endpoints

Documentation

Index

• Variables
• type AppResponse
• type BuildInformation
• type BuildRequest
• type Options
  • func (o Options) GetPipelinesNamespace() string
  • func (o Options) GetTriggersNamespace() string
• type PipelineRunUpdateBody
• type Properties
• type RerunRequest
• type Resource
  • func (r Resource) CheckHealth(request *restful.Request, response *restful.Response)
  • func (r Resource) EstablishResourcesWebsocket(request *restful.Request, response *restful.Response)
  • func (r Resource) GetEndpoints(request *restful.Request, response *restful.Response)
  • func (r Resource) GetIngress(request *restful.Request, response *restful.Response)
  • func (r Resource) GetProperties(request *restful.Request, response *restful.Response)
  • func (r Resource) GetToken(request *restful.Request, response *restful.Response)
  • func (r Resource) ProxyRequest(request *restful.Request, response *restful.Response)
  • func (r Resource) Rerun(name, namespace string) (*v1alpha1.PipelineRun, error)
  • func (r Resource) RerunPipelineRun(request *restful.Request, response *restful.Response)
• type ResourceBinding

Variables

var LogBroadcaster = broadcaster.NewBroadcaster(LogChannel)

var LogChannel = make(chan broadcaster.SocketData)

Define all broadcasters/channels Keep broadcaster channels open indefinitely

var ResourcesBroadcaster = broadcaster.NewBroadcaster(ResourcesChannel)

var ResourcesChannel = make(chan broadcaster.SocketData)

Types

type AppResponse

type AppResponse struct {
	ERROR   error
	MESSAGE string
	CODE    int
}

AppResponse represents an error with a code, message, and the error itself

type BuildInformation

type BuildInformation struct {
	REPOURL   string
	SHORTID   string
	COMMITID  string
	REPONAME  string
	TIMESTAMP string
}

BuildInformation - information required to build a particular commit from a Git repository.

type BuildRequest

type BuildRequest struct {
	/* Example payload
	{
		"repourl": "https://github.ibm.com/your-org/test-project",
		"commitid": "7d84981c66718ee2dda1af280f915cc2feb6ffow",
		"reponame": "test-project"
	}
	*/
	REPOURL  string `json:"repourl"`
	COMMITID string `json:"commitid"`
	REPONAME string `json:"reponame"`
	BRANCH   string `json:"branch"`
}

BuildRequest - a manual submission data struct

type Options

type Options struct {
	InstallNamespace   string
	PipelinesNamespace string
	TriggersNamespace  string
	TenantNamespace    string
	ReadOnly           bool
	WebDir             string
	LogoutURL          string
}

Options for enpoints

func (Options) GetPipelinesNamespace

func (o Options) GetPipelinesNamespace() string

GetPipelinesNamespace returns the PipelinesNamespace property if set or the InstallNamespace property otherwise (this assumes Tekton pipelines is installed in the same namespace as the dashboard if the property is not set)

func (Options) GetTriggersNamespace

func (o Options) GetTriggersNamespace() string

GetTriggersNamespace returns the TriggersNamespace property if set or the InstallNamespace property otherwise (this assumes Tekton triggers is installed in the same namespace as the dashboard if the property is not set)

type PipelineRunUpdateBody

type PipelineRunUpdateBody struct {
	STATUS string `json:"status"`
}

PipelineRunUpdateBody - represents a request that a user may provide for updating a PipelineRun Currently only modifying the status is supported but this gives us scope for adding additional fields

type Properties

type Properties struct {
	DashboardNamespace string `json:"DashboardNamespace"`
	DashboardVersion   string `json:"DashboardVersion"`
	PipelineNamespace  string `json:"PipelineNamespace"`
	PipelineVersion    string `json:"PipelineVersion"`
	TriggersNamespace  string `json:"TriggersNamespace,omitempty"`
	TriggersVersion    string `json:"TriggersVersion,omitempty"`
	IsOpenShift        bool   `json:"IsOpenShift"`
	ReadOnly           bool   `json:"ReadOnly"`
	LogoutURL          string `json:"LogoutURL,omitempty"`
	TenantNamespace    string `json:"TenantNamespace,omitempty"`
}

Properties : properties we want to be able to retrieve via REST

type RerunRequest

type RerunRequest struct {
	PIPELINERUNNAME string `json:"pipelinerunname"`
}

type Resource

type Resource struct {
	DashboardClient        dashboardclientset.Interface
	PipelineClient         pipelineclientset.Interface
	PipelineResourceClient resourceclientset.Interface
	K8sClient              k8sclientset.Interface
	RouteClient            routeclientset.Interface
	Options                Options
}

Store all types here that are reused throughout files Wrapper around all necessary clients used for endpoints

func (Resource) CheckHealth

func (r Resource) CheckHealth(request *restful.Request, response *restful.Response)

func (Resource) EstablishResourcesWebsocket

func (r Resource) EstablishResourcesWebsocket(request *restful.Request, response *restful.Response)

Establish websocket and subscribe to pipelinerun events

func (Resource) GetEndpoints

func (r Resource) GetEndpoints(request *restful.Request, response *restful.Response)

GetIngress returns the Ingress endpoint called "tektonDashboardIngressName" in the requested namespace

func (Resource) GetIngress

func (r Resource) GetIngress(request *restful.Request, response *restful.Response)

GetIngress returns the Ingress endpoint called "tektonDashboardIngressName" in the requested namespace

func (Resource) GetProperties

func (r Resource) GetProperties(request *restful.Request, response *restful.Response)

GetProperties is used to get the installed namespace for the Dashboard, the version of the Tekton Dashboard, the version of Tekton Pipelines, whether or not one's running on OpenShift, when one's in read-only mode and Tekton Triggers version (if Installed)

func (Resource) GetToken

func (r Resource) GetToken(request *restful.Request, response *restful.Response)

func (Resource) ProxyRequest

func (r Resource) ProxyRequest(request *restful.Request, response *restful.Response)

ProxyRequest does as the name suggests: proxies requests and logs what's going on

func (Resource) Rerun

func (r Resource) Rerun(name, namespace string) (*v1alpha1.PipelineRun, error)

func (Resource) RerunPipelineRun

func (r Resource) RerunPipelineRun(request *restful.Request, response *restful.Response)

RerunPipelineRun reruns a given PipelineRun by name in a given namespace

type ResourceBinding

type ResourceBinding struct {
	BINDINGNAME     string `json:"bindingname"`
	RESOURCEREFNAME string `json:"resourcerefname"`
}

ResourceBinding - a name and a reference to a resource