router

Documentation

Index

• Constants
• type Extension
  • func (e Extension) MarshalJSON() ([]byte, error)
• type Handler
  • func Register(resource endpoints.Resource) *Handler
  • func (h *Handler) RegisterExtension(extensionService *corev1.Service) *Extension
  • func (h *Handler) UnregisterExtension(extensionService *corev1.Service) *Extension
  • func (h *Handler) UnregisterExtensionByMeta(extensionService metav1.Object) *Extension
• type RedactedExtension

Constants

const ExtensionBundleLocationKey = "tekton-dashboard-bundle-location"

ExtensionBundleLocationKey IS the UI bundle location annotation key

const ExtensionDisplayNameKey = "tekton-dashboard-display-name"

ExtensionDisplayNameKey is the display name annotation key

const ExtensionEndpointDelimiter = "."

ExtensionEndpointDelimiter is the Delimiter to be used between the extension endpoints annotation value

const ExtensionLabelKey = "tekton-dashboard-extension"

ExtensionLabelKey is the label key required by services to be registered as a dashboard extension

const ExtensionLabelValue = "true"

ExtensionLabelValue is the label value required by services to be registered as a dashboard extension

const ExtensionRoot = "/v1/extensions"

ExtensionRoot is the URL root when accessing extensions

const ExtensionURLKey = "tekton-dashboard-endpoints"

ExtensionURLKey specifies the valid extension paths, defaults to "/"

Types

type Extension

type Extension struct {
	Name           string   `json:"name"`
	URL            *url.URL `json:"url"`
	Port           string   `json:"port"`
	DisplayName    string   `json:"displayname"`
	BundleLocation string   `json:"bundlelocation"`
	// contains filtered or unexported fields
}

Extension is the back-end representation of an extension. A service is an extension when it is in the dashboard namespace with the dashboard label key/value pair. Endpoints are specified with the extension URL annotation

func (Extension) MarshalJSON

func (e Extension) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Extension into JSON. This override is explicitly declared since url.URL will marshal each component, where a single field of the string representation is desired. An alias for Extension is used to prevent a stack overflow

type Handler

type Handler struct {
	*restful.Container

	sync.RWMutex
	// contains filtered or unexported fields
}

Handler is an HTTP handler with internal configuration to avoid global state

func Register

func Register(resource endpoints.Resource) *Handler

Register returns an HTTP handler that has the Dashboard REST API registered

func (*Handler) RegisterExtension

func (h *Handler) RegisterExtension(extensionService *corev1.Service) *Extension

RegisterExtension registers a discovered extension service as a webservice to the container/mux. The extension should have a unique name

func (*Handler) UnregisterExtension

func (h *Handler) UnregisterExtension(extensionService *corev1.Service) *Extension

UnregisterExtension unregisters an extension. This should be called BEFORE registration of extensionService on informer update

func (*Handler) UnregisterExtensionByMeta

func (h *Handler) UnregisterExtensionByMeta(extensionService metav1.Object) *Extension

UnregisterExtensionByMeta unregisters an extension by its metadata. This should be called BEFORE registration of extensionService on informer update

type RedactedExtension

type RedactedExtension struct {
	Name           string `json:"name"`
	DisplayName    string `json:"displayname"`
	BundleLocation string `json:"bundlelocation"`
	// contains filtered or unexported fields
}