plugin

Documentation

Index

• Constants
• type Metadata
• type Plugin
  • func (p Plugin) MarshalJSON() ([]byte, error)
  • func (p Plugin) MarshalYAML() (interface{}, error)
  • func (p *Plugin) UnmarshalJSON(data []byte) error
  • func (p *Plugin) UnmarshalYAML(unmarshal func(any) error) error

Constants

const (
	LatestVersion   = "latest"
	DefaultRegistry = "perses.dev"
)

Types

type Metadata

type Metadata struct {
	// Version is optional. If not provided, it means the latest version available in the Perses instance.
	// Version needs to follow the semantic versioning format (e.g., "1.0.0" or "v1.0.0")
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
	// Registry is optional. If not provided, it means the default registry is: "perses.dev".
	Registry string `json:"registry,omitempty" yaml:"registry,omitempty"`
}

type Plugin

type Plugin struct {
	// Kind is the type of the plugin (e.g., Panel, Variable, Datasource, etc.).
	Kind string `json:"kind" yaml:"kind"`
	// Metadata is an optional field that contains additional information such as version and registry of the plugin.
	Metadata *Metadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	Spec any `json:"spec" yaml:"spec"`
}

func (Plugin) MarshalJSON

func (p Plugin) MarshalJSON() ([]byte, error)

func (Plugin) MarshalYAML

func (p Plugin) MarshalYAML() (interface{}, error)

func (*Plugin) UnmarshalJSON

func (p *Plugin) UnmarshalJSON(data []byte) error

func (*Plugin) UnmarshalYAML

func (p *Plugin) UnmarshalYAML(unmarshal func(any) error) error