uiplugin

package

v1.5.0 Latest Latest Go to latest Published: Jun 5, 2026 License: Apache-2.0 Imports: 58 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rhobs/observability-operator

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ConsoleNameForType(pluginType uiv1alpha1.UIPluginType) string
func IsVersionAheadOrEqual(currentVersion, version string) bool
func RegisterWithManager(mgr ctrl.Manager, opts Options) error
type CompatibilityEntry
type ListFunction
type Options
type PluginProxy
type SupportLevel
type UIPluginInfo
- func PluginInfoBuilder(ctx context.Context, k client.Client, dk dynamic.Interface, ...) (*UIPluginInfo, error)
type UIPluginsConfiguration

Constants ¶

View Source

const (
	Korrel8rConfigFileName = "korrel8r.yaml"
	Korrel8rConfigMountDir = "/config/"
	OpenshiftLoggingNs     = "openshift-logging"
	OpenshiftNetobservNs   = "netobserv"
	OpenshiftTracingNs     = "openshift-tracing"
)

View Source

const (
	AvailableReason         = "UIPluginAvailable"
	ReconciledReason        = "UIPluginReconciled"
	FailedToReconcileReason = "UIPluginFailedToReconcile"
	ReconciledMessage       = "Plugin reconciled successfully"
	NoReason                = "None"
)

View Source

const (
	PersesUserFSGroupID = int64(65534)
)

Variables ¶

This section is empty.

Functions ¶

func ConsoleNameForType ¶ added in v1.5.0

func ConsoleNameForType(pluginType uiv1alpha1.UIPluginType) string

func IsVersionAheadOrEqual ¶ added in v1.5.0

func IsVersionAheadOrEqual(currentVersion, version string) bool

func RegisterWithManager ¶

func RegisterWithManager(mgr ctrl.Manager, opts Options) error

RegisterWithManager registers the controller with Manager

Types ¶

type CompatibilityEntry ¶

type CompatibilityEntry struct {
	PluginType uiv1alpha1.UIPluginType
	// Minimal OpenShift version supporting this plugin (inclusive).
	MinClusterVersion string
	// Maximal OpenShift version supporting this plugin (exclusive).
	MaxClusterVersion string
	ImageKey          string
	SupportLevel      SupportLevel
	Features          []string
}

type ListFunction ¶

type ListFunction func(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error

type Options ¶

type Options struct {
	PluginsConf    UIPluginsConfiguration
	ClusterVersion string
}

type PluginProxy ¶ added in v1.5.0

type PluginProxy struct {
	Alias            string
	ServiceName      string
	ServiceNamespace string
	ServicePort      int32
	Authorize        bool
}

func (PluginProxy) ToRhobsV1 ¶ added in v1.5.0

func (p PluginProxy) ToRhobsV1() osRhobsv1.ConsolePluginProxy

Used for OCP 4.17-18 (No CSP Field)

func (PluginProxy) ToUpstreamV1 ¶ added in v1.5.0

func (p PluginProxy) ToUpstreamV1() osv1.ConsolePluginProxy

Used for OCP 4.19+

func (PluginProxy) ToV1Alpha1 ¶ added in v1.5.0

func (p PluginProxy) ToV1Alpha1() osv1alpha1.ConsolePluginProxy

Used for OCP 4.16 and earlier.

type SupportLevel ¶

type SupportLevel string

var (
	DevPreview          SupportLevel = "DevPreview"
	TechPreview         SupportLevel = "TechPreview"
	GeneralAvailability SupportLevel = "GeneralAvailability"
	Experimental_SSA    SupportLevel = "Experimental-SSA"
)

type UIPluginInfo ¶

type UIPluginInfo struct {
	Image                      string
	Korrel8rImage              string
	HealthAnalyzerImage        string
	LokiServiceNames           map[string]string
	TempoServiceNames          map[string]string
	Name                       string
	ConsoleName                string
	DisplayName                string
	ExtraArgs                  []string
	Proxies                    []PluginProxy
	Role                       *rbacv1.Role
	RoleBinding                *rbacv1.RoleBinding
	ClusterRoles               []*rbacv1.ClusterRole
	ClusterRoleBindings        []*rbacv1.ClusterRoleBinding
	ConfigMap                  *corev1.ConfigMap
	ResourceNamespace          string
	PersesImage                string
	AreMonitoringFeatsDisabled bool
	TLSMinVersion              string
	TLSCiphers                 []string
}

func PluginInfoBuilder ¶

func PluginInfoBuilder(ctx context.Context, k client.Client, dk dynamic.Interface, plugin *uiv1alpha1.UIPlugin, pluginConf UIPluginsConfiguration, compatibilityInfo CompatibilityEntry, clusterVersion string, logger logr.Logger) (*UIPluginInfo, error)

type UIPluginsConfiguration ¶

type UIPluginsConfiguration struct {
	Images             map[string]string
	ResourcesNamespace string
	TLSProfile         configv1.TLSProfileSpec
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL