v1

Documentation

Index

• Constants
• func NewDexReverseProxy(target string) func(c *gin.Context)
• func NewHandler(dexObj *DexObject) (*handler, error)
• func NewNoAuthHandler(dexObj *DexObject) (*noAuthHandler, error)
• type ActiveStatus
• type ClusterSummaryResponse
• type DexObject
  • func NewDexObject(baseURL string, baseHref string, dexURL string) (*DexObject, error)
  • func (d *DexObject) Authenticate(c *gin.Context) (*authn.UserInfo, error)
• type DexRewriteURLRoundTripper
  • func NewDexRewriteURLRoundTripper(dexServerAddr string, T http.RoundTripper) DexRewriteURLRoundTripper
  • func (s DexRewriteURLRoundTripper) RoundTrip(r *http.Request) (*http.Response, error)
• type ISBService
  • func NewISBService(status string, isb *v1alpha1.InterStepBufferService) ISBService
• type ISBServices
• type IsbServiceSummary
• type K8sEventsResponse
  • func NewK8sEventsResponse(timestamp int64, eventType, objectKind, objectName, reason, message string) K8sEventsResponse
• type LoginResponse
  • func NewLoginResponse(url string) LoginResponse
• type NamespaceSummary
  • func NewNamespaceSummary(namespace string, pipelineSummary PipelineSummary, ...) NamespaceSummary
• type NumaflowAPIResponse
  • func NewNumaflowAPIResponse(errMsg *string, data interface{}) NumaflowAPIResponse
• type PipelineInfo
  • func NewPipelineInfo(status string, lag *int64, pl *v1alpha1.Pipeline) PipelineInfo
• type PipelineSummary
• type Pipelines

Constants

const (
	ValidTypeCreate = "valid-create"
	ValidTypeUpdate = "valid-update"
)

Constants for the validation of the pipeline

const (
	ISBServiceStatusHealthy  = "healthy"
	ISBServiceStatusCritical = "critical"
	ISBServiceStatusWarning  = "warning"
	ISBServiceStatusInactive = "inactive"
)

const (
	PipelineStatusHealthy  = "healthy"
	PipelineStatusCritical = "critical"
	PipelineStatusWarning  = "warning"
	PipelineStatusInactive = "inactive"
)

Functions

func NewDexReverseProxy

func NewDexReverseProxy(target string) func(c *gin.Context)

NewDexReverseProxy sends the dex request to the dex server.

func NewHandler

func NewHandler(dexObj *DexObject) (*handler, error)

NewHandler is used to provide a new instance of the handler type

func NewNoAuthHandler

func NewNoAuthHandler(dexObj *DexObject) (*noAuthHandler, error)

NewNoAuthHandler is used to provide a new instance of the handler type

Types

type ActiveStatus

type ActiveStatus struct {
	Healthy  int `json:"Healthy"`
	Warning  int `json:"Warning"`
	Critical int `json:"Critical"`
}

ActiveStatus contains the number of objects in healthy, warning, and critical status.

type ClusterSummaryResponse

type ClusterSummaryResponse []NamespaceSummary

ClusterSummaryResponse is a list of NamespaceSummary of all the namespaces in a cluster wrapped in a list.

type DexObject

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

DexObject is a struct that holds details for dex handlers.

func NewDexObject

func NewDexObject(baseURL string, baseHref string, dexURL string) (*DexObject, error)

NewDexObject returns a new DexObject.

func (*DexObject) Authenticate

func (d *DexObject) Authenticate(c *gin.Context) (*authn.UserInfo, error)

type DexRewriteURLRoundTripper

type DexRewriteURLRoundTripper struct {
	DexURL *url.URL
	T      http.RoundTripper
}

DexRewriteURLRoundTripper is an HTTP RoundTripper to rewrite HTTP requests to the specified dex server address. This is used when reverse proxying Dex to avoid the API server from unnecessarily communicating to the numaflow server through its externally facing load balancer, which is not always permitted in firewalled/air-gapped networks.

func NewDexRewriteURLRoundTripper

func NewDexRewriteURLRoundTripper(dexServerAddr string, T http.RoundTripper) DexRewriteURLRoundTripper

NewDexRewriteURLRoundTripper creates a new DexRewriteURLRoundTripper

func (DexRewriteURLRoundTripper) RoundTrip

func (s DexRewriteURLRoundTripper) RoundTrip(r *http.Request) (*http.Response, error)

type ISBService

type ISBService struct {
	Name       string                          `json:"name"`
	Status     string                          `json:"status"`
	ISBService v1alpha1.InterStepBufferService `json:"isbService"`
}

ISBService gives the summarized information of an InterStepBufferService

func NewISBService

func NewISBService(status string, isb *v1alpha1.InterStepBufferService) ISBService

NewISBService creates a new ISBService object with the given specifications

type ISBServices

type ISBServices []ISBService

ISBServices is a list of InterStepBufferServices

type IsbServiceSummary

type IsbServiceSummary struct {
	Active   ActiveStatus `json:"active"`
	Inactive int          `json:"inactive"`
}

IsbServiceSummary summarizes the number of active and inactive ISB Service.

type K8sEventsResponse

type K8sEventsResponse struct {
	TimeStamp int64  `json:"timestamp"`
	Type      string `json:"type"`
	// Object is in the format of "kind/name", e.g. "Pipeline/simple-pipeline"
	Object  string `json:"object"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}

func NewK8sEventsResponse

func NewK8sEventsResponse(timestamp int64, eventType, objectKind, objectName, reason, message string) K8sEventsResponse

NewK8sEventsResponse creates a new K8sEventsResponse object with the given inputs.

type LoginResponse

type LoginResponse struct {
	AuthCodeURL string `json:"AuthCodeURL"`
}

LoginResponse is the response payload for login API.

func NewLoginResponse

func NewLoginResponse(url string) LoginResponse

NewLoginResponse returns a LoginResponse object for the given url.

type NamespaceSummary

type NamespaceSummary struct {
	// IsEmpty indicates whether there are numaflow resources in the namespace.
	// resources include pipelines and ISB services.
	IsEmpty bool `json:"isEmpty"`
	// Namespace is the name of the namespace.
	Namespace         string            `json:"namespace"`
	PipelineSummary   PipelineSummary   `json:"pipelineSummary"`
	IsbServiceSummary IsbServiceSummary `json:"isbServiceSummary"`
}

NamespaceSummary summarizes information for a given namespace.

func NewNamespaceSummary

func NewNamespaceSummary(namespace string, pipelineSummary PipelineSummary,
	isbSummary IsbServiceSummary) NamespaceSummary

NewNamespaceSummary creates a new NamespaceSummary object with the given specifications.

type NumaflowAPIResponse

type NumaflowAPIResponse struct {
	// ErrMsg provides more detailed error information. If API call succeeds, the ErrMsg is nil.
	ErrMsg *string `json:"errMsg,omitempty"`
	// Data is the response body.
	Data interface{} `json:"data"`
}

func NewNumaflowAPIResponse

func NewNumaflowAPIResponse(errMsg *string, data interface{}) NumaflowAPIResponse

NewNumaflowAPIResponse creates a new NumaflowAPIResponse.

type PipelineInfo

type PipelineInfo struct {
	Name string `json:"name"`
	// Status shows whether the pipeline is healthy, warning, critical or inactive.
	Status string `json:"status"`
	// Lag shows the pipeline lag.
	Lag *int64 `json:"lag,omitempty"`
	// Pipeline contains the detailed pipeline spec.
	Pipeline v1alpha1.Pipeline `json:"pipeline"`
}

func NewPipelineInfo

func NewPipelineInfo(status string, lag *int64, pl *v1alpha1.Pipeline) PipelineInfo

NewPipelineInfo creates a new PipelineInfo object with the given status

type PipelineSummary

type PipelineSummary struct {
	Active   ActiveStatus `json:"active"`
	Inactive int          `json:"inactive"`
}

PipelineSummary summarizes the number of active and inactive pipelines.

type Pipelines

type Pipelines []PipelineInfo

Pipelines is a list of pipelines