Provisioning: Add Standalone Job Controller Without Job Processing (#109610)
* Add standalone job controller * Add makefile * Add limit on the current implementation * Move job controllers to app package * Add TLS flags
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
package controller
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apiserver/pkg/endpoints/request"
|
||||
"k8s.io/client-go/tools/cache"
|
||||
|
||||
"github.com/grafana/grafana-app-sdk/logging"
|
||||
provisioning "github.com/grafana/grafana/apps/provisioning/pkg/apis/provisioning/v0alpha1"
|
||||
client "github.com/grafana/grafana/apps/provisioning/pkg/generated/clientset/versioned/typed/provisioning/v0alpha1"
|
||||
informer "github.com/grafana/grafana/apps/provisioning/pkg/generated/informers/externalversions/provisioning/v0alpha1"
|
||||
"github.com/grafana/grafana/pkg/apimachinery/identity"
|
||||
)
|
||||
|
||||
const (
|
||||
historyJobControllerLoggerName = "provisioning-historyjob-controller"
|
||||
)
|
||||
|
||||
// HistoryJobController manages the cleanup of old HistoryJob entries.
|
||||
type HistoryJobController struct {
|
||||
client client.ProvisioningV0alpha1Interface
|
||||
logger logging.Logger
|
||||
expirationTime time.Duration
|
||||
}
|
||||
|
||||
// NewHistoryJobController creates a new HistoryJobController.
|
||||
func NewHistoryJobController(
|
||||
provisioningClient client.ProvisioningV0alpha1Interface,
|
||||
historyJobInformer informer.HistoricJobInformer,
|
||||
expirationTime time.Duration,
|
||||
) (*HistoryJobController, error) {
|
||||
c := &HistoryJobController{
|
||||
client: provisioningClient,
|
||||
logger: logging.DefaultLogger.With("logger", historyJobControllerLoggerName),
|
||||
expirationTime: expirationTime,
|
||||
}
|
||||
|
||||
// Use the resync events from the shared informer to trigger cleanup for each job
|
||||
_, err := historyJobInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
|
||||
AddFunc: func(obj interface{}) {
|
||||
c.cleanupJob(obj)
|
||||
},
|
||||
UpdateFunc: func(oldObj, newObj interface{}) {
|
||||
c.cleanupJob(newObj)
|
||||
},
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return c, nil
|
||||
}
|
||||
|
||||
func (c *HistoryJobController) cleanupJob(obj interface{}) {
|
||||
job, ok := obj.(*provisioning.HistoricJob)
|
||||
if !ok {
|
||||
c.logger.Error("Expected HistoricJob but got", "type", obj)
|
||||
return
|
||||
}
|
||||
|
||||
age := time.Since(job.CreationTimestamp.Time)
|
||||
if age > c.expirationTime {
|
||||
namespace := job.Namespace
|
||||
ctx, _, err := identity.WithProvisioningIdentity(context.Background(), namespace)
|
||||
if err != nil {
|
||||
c.logger.Error("Failed to set provisioning identity for cleanup", "error", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx = request.WithNamespace(ctx, namespace)
|
||||
err = c.client.HistoricJobs(job.Namespace).Delete(ctx, job.Name, metav1.DeleteOptions{})
|
||||
if err != nil && !apierrors.IsNotFound(err) {
|
||||
c.logger.Error("Failed to delete expired HistoryJob",
|
||||
"namespace", job.Namespace,
|
||||
"name", job.Name,
|
||||
"age", age,
|
||||
"error", err)
|
||||
} else {
|
||||
c.logger.Info("Deleted expired HistoryJob",
|
||||
"namespace", job.Namespace,
|
||||
"name", job.Name,
|
||||
"age", age)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
package controller
|
||||
|
||||
import (
|
||||
"k8s.io/client-go/tools/cache"
|
||||
|
||||
"github.com/grafana/grafana-app-sdk/logging"
|
||||
informer "github.com/grafana/grafana/apps/provisioning/pkg/generated/informers/externalversions/provisioning/v0alpha1"
|
||||
)
|
||||
|
||||
const (
|
||||
jobControllerLoggerName = "provisioning-job-controller"
|
||||
)
|
||||
|
||||
// JobController manages job create notifications.
|
||||
type JobController struct {
|
||||
jobSynced cache.InformerSynced
|
||||
logger logging.Logger
|
||||
|
||||
// notification channel for job create events (replaces InsertNotifications)
|
||||
notifications chan struct{}
|
||||
}
|
||||
|
||||
// NewJobController creates a new JobController.
|
||||
func NewJobController(
|
||||
jobInformer informer.JobInformer,
|
||||
) (*JobController, error) {
|
||||
jc := &JobController{
|
||||
jobSynced: jobInformer.Informer().HasSynced,
|
||||
logger: logging.DefaultLogger.With("logger", jobControllerLoggerName),
|
||||
notifications: make(chan struct{}, 1),
|
||||
}
|
||||
|
||||
_, err := jobInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
|
||||
AddFunc: func(obj interface{}) {
|
||||
// Send notification for job create events (replaces InsertNotifications)
|
||||
jc.sendNotification()
|
||||
},
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return jc, nil
|
||||
}
|
||||
|
||||
// InsertNotifications returns a channel that receives notifications when jobs are created.
|
||||
// This replaces the InsertNotifications method from persistentstore.go.
|
||||
func (jc *JobController) InsertNotifications() chan struct{} {
|
||||
return jc.notifications
|
||||
}
|
||||
|
||||
func (jc *JobController) sendNotification() {
|
||||
select {
|
||||
case jc.notifications <- struct{}{}:
|
||||
default:
|
||||
// Don't block if there's already a notification waiting
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
package controller
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
|
||||
provisioning "github.com/grafana/grafana/apps/provisioning/pkg/apis/provisioning/v0alpha1"
|
||||
provisioningfake "github.com/grafana/grafana/apps/provisioning/pkg/generated/clientset/versioned/fake"
|
||||
provisioninginformers "github.com/grafana/grafana/apps/provisioning/pkg/generated/informers/externalversions"
|
||||
)
|
||||
|
||||
func TestJobController_New(t *testing.T) {
|
||||
client := provisioningfake.NewSimpleClientset()
|
||||
informerFactory := provisioninginformers.NewSharedInformerFactory(client, time.Second)
|
||||
jobInformer := informerFactory.Provisioning().V0alpha1().Jobs()
|
||||
|
||||
controller, err := NewJobController(jobInformer)
|
||||
|
||||
require.NoError(t, err)
|
||||
assert.NotNil(t, controller)
|
||||
assert.NotNil(t, controller.notifications)
|
||||
}
|
||||
|
||||
func TestJobController_InsertNotifications(t *testing.T) {
|
||||
client := provisioningfake.NewSimpleClientset()
|
||||
informerFactory := provisioninginformers.NewSharedInformerFactory(client, time.Second)
|
||||
jobInformer := informerFactory.Provisioning().V0alpha1().Jobs()
|
||||
|
||||
controller, err := NewJobController(jobInformer)
|
||||
require.NoError(t, err)
|
||||
|
||||
notifications := controller.InsertNotifications()
|
||||
assert.NotNil(t, notifications)
|
||||
|
||||
// Test that notification is sent
|
||||
controller.sendNotification()
|
||||
|
||||
select {
|
||||
case <-notifications:
|
||||
// Success - notification received
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("Expected notification but didn't receive one")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobController_NotificationOnJobCreate(t *testing.T) {
|
||||
client := provisioningfake.NewSimpleClientset()
|
||||
informerFactory := provisioninginformers.NewSharedInformerFactory(client, time.Second)
|
||||
jobInformer := informerFactory.Provisioning().V0alpha1().Jobs()
|
||||
|
||||
controller, err := NewJobController(jobInformer)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Start informer and wait for cache sync
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
||||
defer cancel()
|
||||
|
||||
informerFactory.Start(ctx.Done())
|
||||
informerFactory.WaitForCacheSync(ctx.Done())
|
||||
|
||||
// Get notifications channel
|
||||
notifications := controller.InsertNotifications()
|
||||
|
||||
// Create a job - this should trigger a notification
|
||||
_, err = client.ProvisioningV0alpha1().Jobs("default").Create(ctx, &provisioning.Job{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "test-job",
|
||||
Namespace: "default",
|
||||
},
|
||||
}, metav1.CreateOptions{})
|
||||
require.NoError(t, err)
|
||||
|
||||
// Wait for notification
|
||||
select {
|
||||
case <-notifications:
|
||||
// Success - notification received
|
||||
case <-time.After(time.Second * 2):
|
||||
t.Fatal("Expected notification but didn't receive one")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user