endpoints

Documentation

Index

• Variables
• func IsTriggersInstalled(r Resource, namespace string) bool
• type Options
  • func (o Options) GetPipelinesNamespace() string
  • func (o Options) GetTriggersNamespace() string
• type Properties
• 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) GetProperties(request *restful.Request, response *restful.Response)
  • func (r Resource) LogsProxy(request *restful.Request, response *restful.Response)
  • func (r Resource) ProxyRequest(request *restful.Request, response *restful.Response)

Variables

var ResourcesBroadcaster = broadcaster.NewBroadcaster(ResourcesChannel)

var ResourcesChannel = make(chan broadcaster.SocketData)

Define all broadcasters/channels Keep broadcaster channels open indefinitely

Functions

func IsTriggersInstalled

func IsTriggersInstalled(r Resource, namespace string) bool

Types

type Options

type Options struct {
	InstallNamespace   string
	PipelinesNamespace string
	TriggersNamespace  string
	TenantNamespace    string
	ReadOnly           bool
	LogoutURL          string
	StreamLogs         bool
	ExternalLogsURL    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 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"`
	ReadOnly           bool   `json:"ReadOnly"`
	LogoutURL          string `json:"LogoutURL,omitempty"`
	TenantNamespace    string `json:"TenantNamespace,omitempty"`
	StreamLogs         bool   `json:"StreamLogs"`
	ExternalLogsURL    string `json:"ExternalLogsURL"`
}

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

type Resource

type Resource struct {
	Config          *rest.Config
	HttpClient      *http.Client
	DashboardClient dashboardclientset.Interface
	DynamicClient   dynamic.Interface
	K8sClient       k8sclientset.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) 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, when one's in read-only mode and Tekton Triggers version (if Installed)

func (Resource) LogsProxy

func (r Resource) LogsProxy(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