v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the monitoring v1alpha1 API group +kubebuilder:object:generate=true +groupName=monitoring.kubesphere.io

Index

• Variables
• type ClusterDashboard
  • func (in *ClusterDashboard) DeepCopy() *ClusterDashboard
  • func (in *ClusterDashboard) DeepCopyInto(out *ClusterDashboard)
  • func (in *ClusterDashboard) DeepCopyObject() runtime.Object
• type ClusterDashboardList
  • func (in *ClusterDashboardList) DeepCopy() *ClusterDashboardList
  • func (in *ClusterDashboardList) DeepCopyInto(out *ClusterDashboardList)
  • func (in *ClusterDashboardList) DeepCopyObject() runtime.Object
• type Dashboard
  • func (in *Dashboard) DeepCopy() *Dashboard
  • func (in *Dashboard) DeepCopyInto(out *Dashboard)
  • func (in *Dashboard) DeepCopyObject() runtime.Object
  • func (_ *Dashboard) Hub()
• type DashboardList
  • func (in *DashboardList) DeepCopy() *DashboardList
  • func (in *DashboardList) DeepCopyInto(out *DashboardList)
  • func (in *DashboardList) DeepCopyObject() runtime.Object
• type DashboardSpec
  • func (in *DashboardSpec) DeepCopy() *DashboardSpec
  • func (in *DashboardSpec) DeepCopyInto(out *DashboardSpec)
• type Panel
  • func (in *Panel) DeepCopy() *Panel
  • func (in *Panel) DeepCopyInto(out *Panel)
• type PanelMeta
  • func (in *PanelMeta) DeepCopy() *PanelMeta
  • func (in *PanelMeta) DeepCopyInto(out *PanelMeta)
• type PanelType
• type Templating
  • func (in *Templating) DeepCopy() *Templating
  • func (in *Templating) DeepCopyInto(out *Templating)
• type Time
  • func (in *Time) DeepCopy() *Time
  • func (in *Time) DeepCopyInto(out *Time)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "monitoring.kubesphere.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type ClusterDashboard

type ClusterDashboard struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec DashboardSpec `json:"spec,omitempty"`
}

ClusterDashboard is the Schema for the culsterdashboards API

func (*ClusterDashboard) DeepCopy

func (in *ClusterDashboard) DeepCopy() *ClusterDashboard

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDashboard.

func (*ClusterDashboard) DeepCopyInto

func (in *ClusterDashboard) DeepCopyInto(out *ClusterDashboard)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterDashboard) DeepCopyObject

func (in *ClusterDashboard) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterDashboardList

type ClusterDashboardList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ClusterDashboard `json:"items"`
}

ClusterDashboardList contains a list of ClusterDashboard

func (*ClusterDashboardList) DeepCopy

func (in *ClusterDashboardList) DeepCopy() *ClusterDashboardList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDashboardList.

func (*ClusterDashboardList) DeepCopyInto

func (in *ClusterDashboardList) DeepCopyInto(out *ClusterDashboardList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterDashboardList) DeepCopyObject

func (in *ClusterDashboardList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Dashboard

type Dashboard struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec DashboardSpec `json:"spec,omitempty"`
}

Dashboard is the Schema for the dashboards API

func (*Dashboard) DeepCopy

func (in *Dashboard) DeepCopy() *Dashboard

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dashboard.

func (*Dashboard) DeepCopyInto

func (in *Dashboard) DeepCopyInto(out *Dashboard)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Dashboard) DeepCopyObject

func (in *Dashboard) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Dashboard) Hub

func (_ *Dashboard) Hub()

type DashboardList

type DashboardList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Dashboard `json:"items"`
}

DashboardList contains a list of Dashboard

func (*DashboardList) DeepCopy

func (in *DashboardList) DeepCopy() *DashboardList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardList.

func (*DashboardList) DeepCopyInto

func (in *DashboardList) DeepCopyInto(out *DashboardList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DashboardList) DeepCopyObject

func (in *DashboardList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DashboardSpec

type DashboardSpec struct {
	// Dashboard title
	Title string `json:"title,omitempty"`
	// Dashboard description
	Description string `json:"description,omitempty"`
	// Dashboard datasource
	DataSource string `json:"datasource,omitempty"`
	// Time range for display
	Time Time `json:"time,omitempty"`
	// Collection of panels. Panel is one of [Row](row.md), [Singlestat](#singlestat.md) or [Graph](graph.md)
	Panels []Panel `json:"panels,omitempty"`
	// Templating variables
	Templatings []Templating `json:"templating,omitempty"`
}

DashboardSpec defines the desired state of Dashboard

func (*DashboardSpec) DeepCopy

func (in *DashboardSpec) DeepCopy() *DashboardSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardSpec.

func (*DashboardSpec) DeepCopyInto

func (in *DashboardSpec) DeepCopyInto(out *DashboardSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Panel

type Panel struct {
	// panel metadata
	PanelMeta `json:",inline"`

	// A collection of queries
	// Only for panels with `graph` or `singlestat` type
	Targets []panels.Target `json:"targets,omitempty"`

	// The panel row
	Row *panels.Row `json:",inline"`
	// The panel graph
	Graph *panels.Graph `json:",inline"`
	// The panel singlestat
	SingleStat *panels.SingleStat `json:",inline"`
}

Supported panel

func (*Panel) DeepCopy

func (in *Panel) DeepCopy() *Panel

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Panel.

func (*Panel) DeepCopyInto

func (in *Panel) DeepCopyInto(out *Panel)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PanelMeta

type PanelMeta struct {
	// Name of the panel
	Title string `json:"title,omitempty"`
	// Panel ID
	Id int64 `json:"id,omitempty"`
	// Panel Type, one of `row`, `graph`, `singlestat`
	Type PanelType `json:"type"`
}

func (*PanelMeta) DeepCopy

func (in *PanelMeta) DeepCopy() *PanelMeta

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PanelMeta.

func (*PanelMeta) DeepCopyInto

func (in *PanelMeta) DeepCopyInto(out *PanelMeta)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PanelType

type PanelType string

const (
	PanelRow        PanelType = "row"
	PanelGraph      PanelType = "graph"
	PanelSingleStat PanelType = "singlestat"
)

type Templating

type Templating struct {
	// Variable name
	Name string `json:"name,omitempty"`
	// Set variable values to be the return result of the query
	Query string `json:"query,omitempty"`
}

Templating defines a variable, which can be used as a placeholder in query

func (*Templating) DeepCopy

func (in *Templating) DeepCopy() *Templating

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Templating.

func (*Templating) DeepCopyInto

func (in *Templating) DeepCopyInto(out *Templating)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Time

type Time struct {
	// Start time in the format of `^now([+-][0-9]+[smhdwMy])?$`, eg. `now-1M`.
	// It denotes the end time is set to the last month since now.
	From string `json:"from,omitempty"`
	// End time in the format of `^now([+-][0-9]+[smhdwMy])?$`, eg. `now-1M`.
	// It denotes the start time is set to the last month since now.
	To string `json:"to,omitempty"`
}

Time ranges of the metrics for display

func (*Time) DeepCopy

func (in *Time) DeepCopy() *Time

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Time.

func (*Time) DeepCopyInto

func (in *Time) DeepCopyInto(out *Time)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.