Documentation
¶
Overview ¶
Package console provides reconciliation logic for the OpenShift Console UI plugin that integrates OpenShift Lightspeed into the OpenShift web console.
This package manages:
- ConsolePlugin custom resource for UI integration
- Console UI deployment and pod lifecycle
- Service configuration for plugin serving
- ConfigMap for Nginx configuration
- TLS certificate management for secure connections
- Network policies for console security
- Integration with OpenShift Console operator
The console plugin provides users with a chat interface directly in the OpenShift web console to interact with the Lightspeed AI assistant. The main entry points are ReconcileConsoleUI for setup and RemoveConsoleUI for cleanup.
Index ¶
- func GenerateConsoleUIConfigMap(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*corev1.ConfigMap, error)
- func GenerateConsoleUIDeployment(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*appsv1.Deployment, error)
- func GenerateConsoleUILabels() map[string]string
- func GenerateConsoleUINetworkPolicy(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*networkingv1.NetworkPolicy, error)
- func GenerateConsoleUIPlugin(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*consolev1.ConsolePlugin, error)
- func GenerateConsoleUIService(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*corev1.Service, error)
- func ReconcileConsoleUI(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
- func ReconcileConsoleUIDeployment(r reconciler.Reconciler, ctx context.Context, cr *olsv1alpha1.OLSConfig) error
- func ReconcileConsoleUIDeploymentAndPlugin(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
- func ReconcileConsoleUIResources(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
- func RemoveConsoleUI(r reconciler.Reconciler, ctx context.Context) error
- func RestartConsoleUI(r reconciler.Reconciler, ctx context.Context, deployment ...*appsv1.Deployment) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateConsoleUIConfigMap ¶
func GenerateConsoleUIConfigMap(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*corev1.ConfigMap, error)
func GenerateConsoleUIDeployment ¶
func GenerateConsoleUIDeployment(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*appsv1.Deployment, error)
GenerateConsoleUIDeployment generates the Console UI deployment object.
func GenerateConsoleUILabels ¶
func GenerateConsoleUINetworkPolicy ¶
func GenerateConsoleUINetworkPolicy(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*networkingv1.NetworkPolicy, error)
func GenerateConsoleUIPlugin ¶
func GenerateConsoleUIPlugin(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*consolev1.ConsolePlugin, error)
func GenerateConsoleUIService ¶
func GenerateConsoleUIService(r reconciler.Reconciler, cr *olsv1alpha1.OLSConfig) (*corev1.Service, error)
func ReconcileConsoleUI ¶
func ReconcileConsoleUI(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
ReconcileConsoleUI reconciles all Console UI resources in the original order. This function is maintained for backward compatibility with existing tests. New code should call ReconcileConsoleUIResources and ReconcileConsoleUIDeploymentAndPlugin separately.
func ReconcileConsoleUIDeployment ¶
func ReconcileConsoleUIDeployment(r reconciler.Reconciler, ctx context.Context, cr *olsv1alpha1.OLSConfig) error
func ReconcileConsoleUIDeploymentAndPlugin ¶
func ReconcileConsoleUIDeploymentAndPlugin(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
ReconcileConsoleUIDeploymentAndPlugin reconciles the deployment and related resources (Phase 2)
func ReconcileConsoleUIResources ¶
func ReconcileConsoleUIResources(r reconciler.Reconciler, ctx context.Context, olsconfig *olsv1alpha1.OLSConfig) error
ReconcileConsoleUIResources reconciles all resources except the deployment (Phase 1) Uses continue-on-error pattern since these resources are independent
func RemoveConsoleUI ¶
func RemoveConsoleUI(r reconciler.Reconciler, ctx context.Context) error
func RestartConsoleUI ¶
func RestartConsoleUI(r reconciler.Reconciler, ctx context.Context, deployment ...*appsv1.Deployment) error
RestartConsoleUI triggers a rolling restart of the Console UI deployment by updating its pod template annotation. This is useful when configuration changes require a pod restart (e.g., ConfigMap or Secret updates).
Types ¶
This section is empty.
Source Files