Documentation
¶
Index ¶
- Constants
- Variables
- func FilterDatasource[T DatasourceInterface](kind string, defaultDTS *bool, list []T) []T
- func GetStruct(kind Kind) (modelAPI.Entity, error)
- func IsBuiltinVariable(variableName string) bool
- func IsGlobal(kind Kind) bool
- type Dashboard
- type DashboardSpec
- type Datasource
- func (d *Datasource) GetDatasourceSpec() DatasourceSpec
- func (d *Datasource) GetKind() string
- func (d *Datasource) GetMetadata() modelAPI.Metadata
- func (d *Datasource) GetSpec() any
- func (d *Datasource) UnmarshalJSON(data []byte) error
- func (d *Datasource) UnmarshalYAML(unmarshal func(any) error) error
- type DatasourceInterface
- type DatasourceSpec
- type EphemeralDashboard
- type EphemeralDashboardSpec
- type EphemeralDashboardSpecBase
- type Folder
- type FolderSpec
- type GlobalDatasource
- func (d *GlobalDatasource) GetDatasourceSpec() DatasourceSpec
- func (d *GlobalDatasource) GetKind() string
- func (d *GlobalDatasource) GetMetadata() modelAPI.Metadata
- func (d *GlobalDatasource) GetSpec() any
- func (d *GlobalDatasource) UnmarshalJSON(data []byte) error
- func (d *GlobalDatasource) UnmarshalYAML(unmarshal func(any) error) error
- type GlobalRole
- type GlobalRoleBinding
- func (g *GlobalRoleBinding) GetKind() string
- func (g *GlobalRoleBinding) GetMetadata() modelAPI.Metadata
- func (g *GlobalRoleBinding) GetRoleBindingSpec() RoleBindingSpec
- func (g *GlobalRoleBinding) GetSpec() any
- func (g *GlobalRoleBinding) UnmarshalJSON(data []byte) error
- func (g *GlobalRoleBinding) UnmarshalYAML(unmarshal func(any) error) error
- type GlobalSecret
- type GlobalVariable
- type Health
- type Kind
- type Link
- type Metadata
- type NativeProvider
- type OAuthProvider
- type Panel
- type PanelDisplay
- type PanelSpec
- type PartialEntity
- type PartialProjectEntity
- type PluginInDevelopment
- type PluginModule
- type Project
- type ProjectMetadata
- type ProjectMetadataWrapper
- type ProjectSpec
- type PublicGlobalSecret
- type PublicNativeProvider
- type PublicSecret
- type PublicSecretSpec
- type PublicUser
- type PublicUserSpec
- type Query
- type QuerySpec
- type Role
- type RoleBinding
- type RoleBindingInterface
- type RoleBindingSpec
- type RoleInterface
- type RoleSpec
- type Secret
- type SecretSpec
- type Subject
- type User
- type UserSpec
- type Variable
- type VariableInterface
- type VariableSpec
- type View
Constants ¶
const PluginModuleKind = "PluginModule"
const WildcardProject = "*"
WildcardProject is a special project name that can be used to refer to all projects. It is used in the context of user permissions to indicate that the permission applies to all projects.
Variables ¶
var PluralKindMap = map[Kind]string{ KindDashboard: "dashboards", KindDatasource: "datasources", KindEphemeralDashboard: "ephemeraldashboards", KindFolder: "folders", KindGlobalDatasource: "globaldatasources", KindGlobalRole: "globalroles", KindGlobalRoleBinding: "globalrolebindings", KindGlobalSecret: "globalsecrets", KindGlobalVariable: "globalvariables", KindProject: "projects", KindRole: "roles", KindRoleBinding: "rolebindings", KindSecret: "secrets", KindUser: "users", KindVariable: "variables", }
Functions ¶
func FilterDatasource ¶ added in v0.11.0
func FilterDatasource[T DatasourceInterface](kind string, defaultDTS *bool, list []T) []T
func GetStruct ¶
GetStruct return a pointer to an empty struct that matches the kind passed as a parameter.
func IsBuiltinVariable ¶ added in v0.40.0
IsBuiltinVariable check if variable name is a builtin variable
Types ¶
type Dashboard ¶
type Dashboard struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec DashboardSpec `json:"spec" yaml:"spec"`
}
func (*Dashboard) GetMetadata ¶
func (*Dashboard) UnmarshalJSON ¶
type DashboardSpec ¶
type DashboardSpec struct {
Display *common.Display `json:"display,omitempty" yaml:"display,omitempty"`
// Datasources is an optional list of datasource definition.
Datasources map[string]*DatasourceSpec `json:"datasources,omitempty" yaml:"datasources,omitempty"`
Variables []dashboard.Variable `json:"variables,omitempty" yaml:"variables,omitempty"`
Panels map[string]*Panel `json:"panels" yaml:"panels"`
Layouts []dashboard.Layout `json:"layouts" yaml:"layouts"`
// Duration is the default time range to use when getting data to fill the dashboard
Duration common.Duration `json:"duration" yaml:"duration"`
// RefreshInterval is the default refresh interval to use when landing on the dashboard
RefreshInterval common.Duration `json:"refreshInterval,omitempty" yaml:"refreshInterval,omitempty"`
}
func (*DashboardSpec) UnmarshalJSON ¶
func (d *DashboardSpec) UnmarshalJSON(data []byte) error
func (*DashboardSpec) UnmarshalYAML ¶
func (d *DashboardSpec) UnmarshalYAML(unmarshal func(any) error) error
type Datasource ¶
type Datasource struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec DatasourceSpec `json:"spec" yaml:"spec"`
}
Datasource will be the datasource you can define in your project/namespace This is a resource that won't be shared across projects. A Dashboard can use it only if it is in the same project.
func (*Datasource) GetDatasourceSpec ¶ added in v0.41.1
func (d *Datasource) GetDatasourceSpec() DatasourceSpec
func (*Datasource) GetKind ¶
func (d *Datasource) GetKind() string
func (*Datasource) GetMetadata ¶
func (d *Datasource) GetMetadata() modelAPI.Metadata
func (*Datasource) GetSpec ¶ added in v0.11.0
func (d *Datasource) GetSpec() any
func (*Datasource) UnmarshalJSON ¶
func (d *Datasource) UnmarshalJSON(data []byte) error
func (*Datasource) UnmarshalYAML ¶
func (d *Datasource) UnmarshalYAML(unmarshal func(any) error) error
type DatasourceInterface ¶ added in v0.11.0
type DatasourceInterface interface {
GetMetadata() modelAPI.Metadata
GetDatasourceSpec() DatasourceSpec
}
type DatasourceSpec ¶
type EphemeralDashboard ¶ added in v0.44.0
type EphemeralDashboard struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec EphemeralDashboardSpec `json:"spec" yaml:"spec"`
}
func (*EphemeralDashboard) GetKind ¶ added in v0.44.0
func (e *EphemeralDashboard) GetKind() string
func (*EphemeralDashboard) GetMetadata ¶ added in v0.44.0
func (e *EphemeralDashboard) GetMetadata() modelAPI.Metadata
func (*EphemeralDashboard) GetSpec ¶ added in v0.44.0
func (e *EphemeralDashboard) GetSpec() any
func (*EphemeralDashboard) UnmarshalJSON ¶ added in v0.44.0
func (e *EphemeralDashboard) UnmarshalJSON(data []byte) error
func (*EphemeralDashboard) UnmarshalYAML ¶ added in v0.44.0
func (e *EphemeralDashboard) UnmarshalYAML(unmarshal func(any) error) error
type EphemeralDashboardSpec ¶ added in v0.44.0
type EphemeralDashboardSpec struct {
EphemeralDashboardSpecBase `json:",inline" yaml:",inline"`
DashboardSpec `json:",inline" yaml:",inline"`
}
func (*EphemeralDashboardSpec) UnmarshalJSON ¶ added in v0.44.0
func (eds *EphemeralDashboardSpec) UnmarshalJSON(data []byte) error
func (*EphemeralDashboardSpec) UnmarshalYAML ¶ added in v0.44.0
func (eds *EphemeralDashboardSpec) UnmarshalYAML(unmarshal func(any) error) error
type EphemeralDashboardSpecBase ¶ added in v0.44.0
func (*EphemeralDashboardSpecBase) UnmarshalJSON ¶ added in v0.44.0
func (edsb *EphemeralDashboardSpecBase) UnmarshalJSON(data []byte) error
func (*EphemeralDashboardSpecBase) UnmarshalYAML ¶ added in v0.44.0
func (edsb *EphemeralDashboardSpecBase) UnmarshalYAML(unmarshal func(any) error) error
type Folder ¶
type Folder struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec []FolderSpec `json:"spec" yaml:"spec"`
}
func (*Folder) GetMetadata ¶
func (*Folder) UnmarshalJSON ¶
type FolderSpec ¶
type FolderSpec struct {
// Kind can only have two values: `Dashboard` or `Folder`
Kind Kind `json:"kind" yaml:"kind"`
// Name is the reference to the dashboard when `Kind` is equal to `Dashboard`.
// When `Kind` is equal to `Folder`, then it's just the name of the folder
Name string `json:"name" yaml:"name"`
// Spec must only be set when 'Kind' is equal to 'Folder'.
Spec []FolderSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
}
func (*FolderSpec) UnmarshalJSON ¶
func (f *FolderSpec) UnmarshalJSON(data []byte) error
func (*FolderSpec) UnmarshalYAML ¶
func (f *FolderSpec) UnmarshalYAML(unmarshal func(any) error) error
type GlobalDatasource ¶
type GlobalDatasource struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec DatasourceSpec `json:"spec" yaml:"spec"`
}
GlobalDatasource is the struct representing the datasource shared to everybody. Any Dashboard can reference it.
func (*GlobalDatasource) GetDatasourceSpec ¶ added in v0.41.1
func (d *GlobalDatasource) GetDatasourceSpec() DatasourceSpec
func (*GlobalDatasource) GetKind ¶
func (d *GlobalDatasource) GetKind() string
func (*GlobalDatasource) GetMetadata ¶
func (d *GlobalDatasource) GetMetadata() modelAPI.Metadata
func (*GlobalDatasource) GetSpec ¶ added in v0.11.0
func (d *GlobalDatasource) GetSpec() any
func (*GlobalDatasource) UnmarshalJSON ¶
func (d *GlobalDatasource) UnmarshalJSON(data []byte) error
func (*GlobalDatasource) UnmarshalYAML ¶
func (d *GlobalDatasource) UnmarshalYAML(unmarshal func(any) error) error
type GlobalRole ¶ added in v0.42.0
type GlobalRole struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec RoleSpec `json:"spec" yaml:"spec"`
}
GlobalRole is the struct representing the role shared to everybody.
func (*GlobalRole) GetKind ¶ added in v0.42.0
func (g *GlobalRole) GetKind() string
func (*GlobalRole) GetMetadata ¶ added in v0.42.0
func (g *GlobalRole) GetMetadata() modelAPI.Metadata
func (*GlobalRole) GetRoleSpec ¶ added in v0.42.0
func (g *GlobalRole) GetRoleSpec() RoleSpec
func (*GlobalRole) GetSpec ¶ added in v0.42.0
func (g *GlobalRole) GetSpec() any
func (*GlobalRole) UnmarshalJSON ¶ added in v0.42.0
func (g *GlobalRole) UnmarshalJSON(data []byte) error
func (*GlobalRole) UnmarshalYAML ¶ added in v0.42.0
func (g *GlobalRole) UnmarshalYAML(unmarshal func(any) error) error
type GlobalRoleBinding ¶ added in v0.42.0
type GlobalRoleBinding struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec RoleBindingSpec `json:"spec" yaml:"spec"`
}
GlobalRoleBinding is the struct representing the roleBinding shared to everybody.
func (*GlobalRoleBinding) GetKind ¶ added in v0.42.0
func (g *GlobalRoleBinding) GetKind() string
func (*GlobalRoleBinding) GetMetadata ¶ added in v0.42.0
func (g *GlobalRoleBinding) GetMetadata() modelAPI.Metadata
func (*GlobalRoleBinding) GetRoleBindingSpec ¶ added in v0.42.0
func (g *GlobalRoleBinding) GetRoleBindingSpec() RoleBindingSpec
func (*GlobalRoleBinding) GetSpec ¶ added in v0.42.0
func (g *GlobalRoleBinding) GetSpec() any
func (*GlobalRoleBinding) UnmarshalJSON ¶ added in v0.42.0
func (g *GlobalRoleBinding) UnmarshalJSON(data []byte) error
func (*GlobalRoleBinding) UnmarshalYAML ¶ added in v0.42.0
func (g *GlobalRoleBinding) UnmarshalYAML(unmarshal func(any) error) error
type GlobalSecret ¶ added in v0.40.0
type GlobalSecret struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec SecretSpec `json:"spec" yaml:"spec"`
}
func (*GlobalSecret) GetKind ¶ added in v0.40.0
func (g *GlobalSecret) GetKind() string
func (*GlobalSecret) GetMetadata ¶ added in v0.40.0
func (g *GlobalSecret) GetMetadata() modelAPI.Metadata
func (*GlobalSecret) GetSpec ¶ added in v0.40.0
func (g *GlobalSecret) GetSpec() any
type GlobalVariable ¶ added in v0.31.0
type GlobalVariable struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec VariableSpec `json:"spec" yaml:"spec"`
}
GlobalVariable is a global variable that be used everywhere regardless the project.
func (*GlobalVariable) GetKind ¶ added in v0.31.0
func (v *GlobalVariable) GetKind() string
func (*GlobalVariable) GetMetadata ¶ added in v0.31.0
func (v *GlobalVariable) GetMetadata() modelAPI.Metadata
func (*GlobalVariable) GetSpec ¶ added in v0.31.0
func (v *GlobalVariable) GetSpec() any
func (*GlobalVariable) GetVarSpec ¶ added in v0.40.0
func (v *GlobalVariable) GetVarSpec() VariableSpec
type Health ¶
type Health struct {
BuildTime string `json:"buildTime"`
Version string `json:"version"`
Commit string `json:"commit"`
Database bool `json:"database"`
}
Health is the struct that provides the health information of the API
type Kind ¶
type Kind string
const ( KindDashboard Kind = "Dashboard" KindDatasource Kind = "Datasource" KindEphemeralDashboard Kind = "EphemeralDashboard" KindFolder Kind = "Folder" KindGlobalDatasource Kind = "GlobalDatasource" KindGlobalRole Kind = "GlobalRole" KindGlobalRoleBinding Kind = "GlobalRoleBinding" KindGlobalVariable Kind = "GlobalVariable" KindGlobalSecret Kind = "GlobalSecret" KindProject Kind = "Project" KindRole Kind = "Role" KindRoleBinding Kind = "RoleBinding" KindSecret Kind = "Secret" KindUser Kind = "User" KindVariable Kind = "Variable" )
func (*Kind) UnmarshalJSON ¶
type Link ¶ added in v0.45.0
type Link struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
URL string `json:"url" yaml:"url"`
Tooltip string `json:"tooltip,omitempty" yaml:"tooltip,omitempty"`
RenderVariables bool `json:"renderVariables,omitempty" yaml:"renderVariables,omitempty"`
TargetBlank bool `json:"targetBlank,omitempty" yaml:"targetBlank,omitempty"`
}
type Metadata ¶
type Metadata struct {
Name string `json:"name" yaml:"name"`
// +kubebuilder:validation:Schemaless
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Format=date-time
// +kubebuilder:validation:Optional
CreatedAt time.Time `json:"createdAt" yaml:"createdAt"`
// +kubebuilder:validation:Schemaless
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Format=date-time
// +kubebuilder:validation:Optional
UpdatedAt time.Time `json:"updatedAt" yaml:"updatedAt"`
Version uint64 `json:"version" yaml:"version"`
}
func NewMetadata ¶ added in v0.23.0
func (*Metadata) UnmarshalJSON ¶ added in v0.44.0
func (*Metadata) UnmarshalYAML ¶ added in v0.44.0
type NativeProvider ¶ added in v0.43.0
type NativeProvider struct {
Password string `json:"password,omitempty" yaml:"password,omitempty"`
}
type OAuthProvider ¶ added in v0.43.0
type PanelDisplay ¶ added in v0.40.0
type PanelDisplay struct {
Name string `json:"name" yaml:"name"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
}
func (*PanelDisplay) UnmarshalJSON ¶ added in v0.40.0
func (p *PanelDisplay) UnmarshalJSON(data []byte) error
func (*PanelDisplay) UnmarshalYAML ¶ added in v0.40.0
func (p *PanelDisplay) UnmarshalYAML(unmarshal func(any) error) error
type PanelSpec ¶ added in v0.10.0
type PanelSpec struct {
Display PanelDisplay `json:"display" yaml:"display"`
Plugin common.Plugin `json:"plugin" yaml:"plugin"`
Queries []Query `json:"queries,omitempty" yaml:"queries,omitempty"`
Links []Link `json:"links,omitempty" yaml:"links,omitempty"`
}
type PartialEntity ¶ added in v0.46.0
type PartialEntity struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec struct{} `json:"spec,omitempty" yaml:"spec,omitempty"`
}
func (*PartialEntity) GetKind ¶ added in v0.46.0
func (p *PartialEntity) GetKind() string
func (*PartialEntity) GetMetadata ¶ added in v0.46.0
func (p *PartialEntity) GetMetadata() modelAPI.Metadata
func (*PartialEntity) GetSpec ¶ added in v0.46.0
func (p *PartialEntity) GetSpec() any
type PartialProjectEntity ¶ added in v0.46.0
type PartialProjectEntity struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec struct{} `json:"spec,omitempty" yaml:"spec,omitempty"`
}
func (*PartialProjectEntity) GetKind ¶ added in v0.46.0
func (p *PartialProjectEntity) GetKind() string
func (*PartialProjectEntity) GetMetadata ¶ added in v0.46.0
func (p *PartialProjectEntity) GetMetadata() modelAPI.Metadata
func (*PartialProjectEntity) GetSpec ¶ added in v0.46.0
func (p *PartialProjectEntity) GetSpec() any
type PluginInDevelopment ¶ added in v0.51.0
type PluginInDevelopment struct {
// The name of the plugin in development
Name string `json:"name" yaml:"name"`
// DisableSchema is used to disable the schema validation of the plugin.
// It is useful when the plugin is in development and the schema is not yet defined.
DisableSchema bool `json:"disable_schema,omitempty" yaml:"disable_schema,omitempty"`
// The URL of the development server hosting the plugin.
// It is usually created by the command `rsbuild dev`.
// If defined, it will override the URL defined in the `PluginDevEnvironment`.
URL *common.URL `json:"url,omitempty" yaml:"url,omitempty"`
// The absolute path to the plugin repository
AbsolutePath string `json:"absolute_path" yaml:"absolute_path"`
}
func (*PluginInDevelopment) UnmarshalJSON ¶ added in v0.51.0
func (p *PluginInDevelopment) UnmarshalJSON(data []byte) error
func (*PluginInDevelopment) UnmarshalYAML ¶ added in v0.51.0
func (p *PluginInDevelopment) UnmarshalYAML(unmarshal func(any) error) error
type PluginModule ¶ added in v0.51.0
type PluginModule struct {
Kind string `json:"kind" yaml:"kind"`
Metadata plugin.ModuleMetadata `json:"metadata" yaml:"metadata"`
Spec plugin.ModuleSpec `json:"spec" yaml:"spec"`
Status *plugin.ModuleStatus `json:"status,omitempty" yaml:"status,omitempty"`
}
type Project ¶
type Project struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec ProjectSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
}
func (*Project) GetMetadata ¶
func (*Project) UnmarshalJSON ¶
type ProjectMetadata ¶
type ProjectMetadata struct {
Metadata `json:",inline" yaml:",inline"`
ProjectMetadataWrapper `json:",inline" yaml:",inline"`
}
ProjectMetadata is the metadata struct for resources that belongs to a project.
func NewProjectMetadata ¶ added in v0.23.0
func NewProjectMetadata(project string, name string) *ProjectMetadata
func (*ProjectMetadata) Flatten ¶ added in v0.44.0
func (pm *ProjectMetadata) Flatten(sensitive bool)
func (*ProjectMetadata) GetName ¶
func (pm *ProjectMetadata) GetName() string
func (*ProjectMetadata) UnmarshalJSON ¶ added in v0.44.0
func (pm *ProjectMetadata) UnmarshalJSON(data []byte) error
This method is needed in the case of JSON otherwise parts of the fields are missed when unmarshalling
func (*ProjectMetadata) UnmarshalYAML ¶ added in v0.44.0
func (pm *ProjectMetadata) UnmarshalYAML(unmarshal func(any) error) error
This method is needed in the case of YAML otherwise the validation part is not triggered when unmarshalling
func (*ProjectMetadata) Update ¶ added in v0.5.0
func (pm *ProjectMetadata) Update(previous ProjectMetadata)
type ProjectMetadataWrapper ¶ added in v0.44.0
type ProjectMetadataWrapper struct {
Project string `json:"project" yaml:"project"`
}
This wrapping struct is required to allow defining a custom unmarshall on Metadata without breaking the Project attribute (the fact Metadata is injected line in ProjectMetadata caused Project string to be ignored when unmarshalling)
func (*ProjectMetadataWrapper) UnmarshalJSON ¶ added in v0.44.0
func (p *ProjectMetadataWrapper) UnmarshalJSON(data []byte) error
func (*ProjectMetadataWrapper) UnmarshalYAML ¶ added in v0.44.0
func (p *ProjectMetadataWrapper) UnmarshalYAML(unmarshal func(any) error) error
type ProjectSpec ¶ added in v0.12.0
type PublicGlobalSecret ¶ added in v0.40.0
type PublicGlobalSecret struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata Metadata `json:"metadata" yaml:"metadata"`
Spec PublicSecretSpec `json:"spec" yaml:"spec"`
}
func NewPublicGlobalSecret ¶ added in v0.40.0
func NewPublicGlobalSecret(s *GlobalSecret) *PublicGlobalSecret
func (*PublicGlobalSecret) GetKind ¶ added in v0.40.0
func (g *PublicGlobalSecret) GetKind() string
func (*PublicGlobalSecret) GetMetadata ¶ added in v0.40.0
func (g *PublicGlobalSecret) GetMetadata() modelAPI.Metadata
func (*PublicGlobalSecret) GetSpec ¶ added in v0.40.0
func (g *PublicGlobalSecret) GetSpec() any
type PublicNativeProvider ¶ added in v0.43.0
type PublicSecret ¶ added in v0.40.0
type PublicSecret struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec PublicSecretSpec `json:"spec" yaml:"spec"`
}
func NewPublicSecret ¶ added in v0.40.0
func NewPublicSecret(s *Secret) *PublicSecret
func (*PublicSecret) GetKind ¶ added in v0.40.0
func (s *PublicSecret) GetKind() string
func (*PublicSecret) GetMetadata ¶ added in v0.40.0
func (s *PublicSecret) GetMetadata() modelAPI.Metadata
func (*PublicSecret) GetSpec ¶ added in v0.40.0
func (s *PublicSecret) GetSpec() any
type PublicSecretSpec ¶ added in v0.40.0
type PublicSecretSpec struct {
BasicAuth *secret.PublicBasicAuth `json:"basicAuth,omitempty" yaml:"basicAuth,omitempty"`
// The HTTP authorization credentials for the targets.
Authorization *secret.PublicAuthorization `json:"authorization,omitempty" yaml:"authorization,omitempty"`
// The Oauth configuration for the targets.
OAuth *secret.PublicOAuth `json:"oauth,omitempty" yaml:"oauth,omitempty"`
// TLSConfig to use to connect to the targets.
TLSConfig *secret.PublicTLSConfig `json:"tlsConfig,omitempty" yaml:"tlsConfig,omitempty"`
}
func NewPublicSecretSpec ¶ added in v0.40.0
func NewPublicSecretSpec(s SecretSpec) PublicSecretSpec
type PublicUser ¶ added in v0.42.0
type PublicUser struct {
Kind Kind `json:"kind"`
Metadata Metadata `json:"metadata"`
Spec PublicUserSpec `json:"spec"`
}
func NewPublicUser ¶ added in v0.42.0
func NewPublicUser(u *User) *PublicUser
func (*PublicUser) GetKind ¶ added in v0.42.0
func (u *PublicUser) GetKind() string
func (*PublicUser) GetMetadata ¶ added in v0.42.0
func (u *PublicUser) GetMetadata() modelAPI.Metadata
func (*PublicUser) GetSpec ¶ added in v0.42.0
func (u *PublicUser) GetSpec() any
type PublicUserSpec ¶ added in v0.42.0
type PublicUserSpec struct {
FirstName string `json:"firstName,omitempty" yaml:"firstName,omitempty"`
LastName string `json:"lastName,omitempty" yaml:"lastName,omitempty"`
NativeProvider PublicNativeProvider `json:"nativeProvider,omitempty" yaml:"nativeProvider,omitempty"`
OauthProviders []OAuthProvider `json:"oauthProviders,omitempty" yaml:"oauthProviders,omitempty"`
}
func NewPublicUserSpec ¶ added in v0.42.0
func NewPublicUserSpec(u UserSpec) PublicUserSpec
type Role ¶ added in v0.42.0
type Role struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec RoleSpec `json:"spec" yaml:"spec"`
}
Role will be the role you can define in your project/namespace This is a resource that won't be shared across projects.
func (*Role) GetMetadata ¶ added in v0.42.0
func (*Role) UnmarshalJSON ¶ added in v0.42.0
type RoleBinding ¶ added in v0.42.0
type RoleBinding struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec RoleBindingSpec `json:"spec" yaml:"spec"`
}
RoleBinding will be the roleBinding you can define in your project/namespace This is a resource that won't be shared across projects.
func (*RoleBinding) GetKind ¶ added in v0.42.0
func (r *RoleBinding) GetKind() string
func (*RoleBinding) GetMetadata ¶ added in v0.42.0
func (r *RoleBinding) GetMetadata() modelAPI.Metadata
func (*RoleBinding) GetSpec ¶ added in v0.42.0
func (r *RoleBinding) GetSpec() any
func (*RoleBinding) UnmarshalJSON ¶ added in v0.42.0
func (r *RoleBinding) UnmarshalJSON(data []byte) error
func (*RoleBinding) UnmarshalYAML ¶ added in v0.42.0
func (r *RoleBinding) UnmarshalYAML(unmarshal func(any) error) error
type RoleBindingInterface ¶ added in v0.42.0
type RoleBindingSpec ¶ added in v0.42.0
type RoleBindingSpec struct {
// Name of the Role or GlobalRole concerned by the role binding (metadata.name)
Role string `json:"role" yaml:"role"`
// Subjects that will inherit permissions from the role
Subjects []Subject `json:"subjects" yaml:"subjects"`
}
func (*RoleBindingSpec) Has ¶ added in v0.42.0
func (r *RoleBindingSpec) Has(kind Kind, name string) bool
func (*RoleBindingSpec) UnmarshalJSON ¶ added in v0.42.0
func (r *RoleBindingSpec) UnmarshalJSON(data []byte) error
func (*RoleBindingSpec) UnmarshalYAML ¶ added in v0.42.0
func (r *RoleBindingSpec) UnmarshalYAML(unmarshal func(any) error) error
type RoleInterface ¶ added in v0.42.0
type RoleSpec ¶ added in v0.42.0
type RoleSpec struct {
// List of permissions owned by the role
Permissions []role.Permission `json:"permissions" yaml:"permissions"`
}
type Secret ¶ added in v0.40.0
type Secret struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec SecretSpec `json:"spec" yaml:"spec"`
}
func (*Secret) GetMetadata ¶ added in v0.40.0
type SecretSpec ¶ added in v0.40.0
type SecretSpec struct {
BasicAuth *secret.BasicAuth `json:"basicAuth,omitempty" yaml:"basicAuth,omitempty"`
// The HTTP authorization credentials for the targets.
Authorization *secret.Authorization `json:"authorization,omitempty" yaml:"authorization,omitempty"`
// Oauth configuration for the targets.
OAuth *secret.OAuth `json:"oauth,omitempty" yaml:"oauth,omitempty"`
// TLSConfig to use to connect to the targets.
TLSConfig *secret.TLSConfig `json:"tlsConfig,omitempty" yaml:"tlsConfig,omitempty"`
}
func (*SecretSpec) UnmarshalJSON ¶ added in v0.40.0
func (s *SecretSpec) UnmarshalJSON(data []byte) error
func (*SecretSpec) UnmarshalYAML ¶ added in v0.40.0
func (s *SecretSpec) UnmarshalYAML(unmarshal func(any) error) error
type Subject ¶ added in v0.42.0
func (*Subject) UnmarshalJSON ¶ added in v0.42.0
type User ¶
type User struct {
Kind Kind `json:"kind"`
Metadata Metadata `json:"metadata"`
Spec UserSpec `json:"spec"`
}
func (*User) GetMetadata ¶
func (*User) UnmarshalJSON ¶
type UserSpec ¶
type UserSpec struct {
FirstName string `json:"firstName,omitempty" yaml:"firstName,omitempty"`
LastName string `json:"lastName,omitempty" yaml:"lastName,omitempty"`
NativeProvider NativeProvider `json:"nativeProvider,omitempty" yaml:"nativeProvider,omitempty"`
OauthProviders []OAuthProvider `json:"oauthProviders,omitempty" yaml:"oauthProviders,omitempty"`
}
type Variable ¶ added in v0.31.0
type Variable struct {
Kind Kind `json:"kind" yaml:"kind"`
Metadata ProjectMetadata `json:"metadata" yaml:"metadata"`
Spec VariableSpec `json:"spec" yaml:"spec"`
}
Variable relates to variables defined at project level. If you are looking for variable defined at dashboard level, see dashboard.Variable
func (*Variable) GetMetadata ¶ added in v0.31.0
func (*Variable) GetVarSpec ¶ added in v0.40.0
func (v *Variable) GetVarSpec() VariableSpec
type VariableInterface ¶ added in v0.40.0
type VariableInterface interface {
GetMetadata() modelAPI.Metadata
GetVarSpec() VariableSpec
}
type VariableSpec ¶ added in v0.31.0
type VariableSpec struct {
// Kind is the type of the variable. Depending on the value of Kind, it will change the content of Spec.
Kind variable.Kind `json:"kind" yaml:"kind"`
Spec any `json:"spec" yaml:"spec"`
}
func (*VariableSpec) UnmarshalJSON ¶ added in v0.31.0
func (v *VariableSpec) UnmarshalJSON(data []byte) error
func (*VariableSpec) UnmarshalYAML ¶ added in v0.31.0
func (v *VariableSpec) UnmarshalYAML(unmarshal func(any) error) error
type View ¶ added in v0.45.0
type View struct {
// The resource being viewed.
Project string `json:"project" yaml:"project"`
Dashboard string `json:"dashboard" yaml:"dashboard"`
// Stats about the view.
RenderTimeSecs float64 `json:"render_time" yaml:"render_time"`
RenderErrors int `json:"render_errors" yaml:"render_errors"`
}