mirror of
https://github.com/kyverno/kyverno.git
synced 2025-03-06 07:57:07 +00:00
331 lines
9.6 KiB
Go
331 lines
9.6 KiB
Go
package background
|
|
|
|
import (
|
|
"reflect"
|
|
"time"
|
|
|
|
"github.com/go-logr/logr"
|
|
kyverno "github.com/kyverno/kyverno/api/kyverno/v1"
|
|
"github.com/kyverno/kyverno/pkg/autogen"
|
|
common "github.com/kyverno/kyverno/pkg/background/common"
|
|
kyvernoclient "github.com/kyverno/kyverno/pkg/client/clientset/versioned"
|
|
kyvernoinformer "github.com/kyverno/kyverno/pkg/client/informers/externalversions/kyverno/v1"
|
|
kyvernolister "github.com/kyverno/kyverno/pkg/client/listers/kyverno/v1"
|
|
"github.com/kyverno/kyverno/pkg/config"
|
|
dclient "github.com/kyverno/kyverno/pkg/dclient"
|
|
"github.com/kyverno/kyverno/pkg/event"
|
|
admissionv1 "k8s.io/api/admission/v1"
|
|
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
|
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
|
|
"k8s.io/apimachinery/pkg/util/wait"
|
|
coreinformers "k8s.io/client-go/informers/core/v1"
|
|
"k8s.io/client-go/kubernetes"
|
|
corelister "k8s.io/client-go/listers/core/v1"
|
|
"k8s.io/client-go/tools/cache"
|
|
"k8s.io/client-go/util/workqueue"
|
|
)
|
|
|
|
const (
|
|
maxRetries = 10
|
|
)
|
|
|
|
// Controller manages the life-cycle for Generate-Requests and applies generate rule
|
|
type Controller struct {
|
|
// dynamic client implementation
|
|
client *dclient.Client
|
|
|
|
// typed client for Kyverno CRDs
|
|
kyvernoClient *kyvernoclient.Clientset
|
|
|
|
policyInformer kyvernoinformer.ClusterPolicyInformer
|
|
|
|
// event generator interface
|
|
eventGen event.Interface
|
|
|
|
// grStatusControl is used to update GR status
|
|
statusControl common.StatusControlInterface
|
|
|
|
// GR that need to be synced
|
|
queue workqueue.RateLimitingInterface
|
|
|
|
// policyLister can list/get cluster policy from the shared informer's store
|
|
policyLister kyvernolister.ClusterPolicyLister
|
|
|
|
// policyLister can list/get Namespace policy from the shared informer's store
|
|
npolicyLister kyvernolister.PolicyLister
|
|
|
|
// grLister can list/get generate request from the shared informer's store
|
|
grLister kyvernolister.GenerateRequestNamespaceLister
|
|
|
|
// nsLister can list/get namespaces from the shared informer's store
|
|
nsLister corelister.NamespaceLister
|
|
|
|
// policySynced returns true if the Cluster policy store has been synced at least once
|
|
policySynced cache.InformerSynced
|
|
|
|
// policySynced returns true if the Namespace policy store has been synced at least once
|
|
npolicySynced cache.InformerSynced
|
|
|
|
// grSynced returns true if the Generate Request store has been synced at least once
|
|
grSynced cache.InformerSynced
|
|
|
|
// namespaceInformer for re-evaluation on namespace updates
|
|
namespaceInformer coreinformers.NamespaceInformer
|
|
|
|
log logr.Logger
|
|
|
|
Config config.Interface
|
|
}
|
|
|
|
//NewController returns an instance of the Generate-Request Controller
|
|
func NewController(
|
|
kubeClient kubernetes.Interface,
|
|
kyvernoClient *kyvernoclient.Clientset,
|
|
client *dclient.Client,
|
|
policyInformer kyvernoinformer.ClusterPolicyInformer,
|
|
npolicyInformer kyvernoinformer.PolicyInformer,
|
|
grInformer kyvernoinformer.GenerateRequestInformer,
|
|
eventGen event.Interface,
|
|
namespaceInformer coreinformers.NamespaceInformer,
|
|
log logr.Logger,
|
|
dynamicConfig config.Interface,
|
|
) (*Controller, error) {
|
|
|
|
c := Controller{
|
|
client: client,
|
|
kyvernoClient: kyvernoClient,
|
|
policyInformer: policyInformer,
|
|
eventGen: eventGen,
|
|
queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "generate-request"),
|
|
namespaceInformer: namespaceInformer,
|
|
log: log,
|
|
Config: dynamicConfig,
|
|
}
|
|
|
|
c.statusControl = common.StatusControl{Client: kyvernoClient}
|
|
|
|
c.policySynced = policyInformer.Informer().HasSynced
|
|
|
|
c.npolicySynced = npolicyInformer.Informer().HasSynced
|
|
|
|
c.grSynced = grInformer.Informer().HasSynced
|
|
|
|
grInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
|
|
AddFunc: c.addGR,
|
|
UpdateFunc: c.updateGR,
|
|
DeleteFunc: c.deleteGR,
|
|
})
|
|
|
|
c.policyLister = policyInformer.Lister()
|
|
c.npolicyLister = npolicyInformer.Lister()
|
|
c.grLister = grInformer.Lister().GenerateRequests(config.KyvernoNamespace)
|
|
c.nsLister = namespaceInformer.Lister()
|
|
|
|
return &c, nil
|
|
}
|
|
|
|
// Run starts workers
|
|
func (c *Controller) Run(workers int, stopCh <-chan struct{}) {
|
|
defer utilruntime.HandleCrash()
|
|
defer c.queue.ShutDown()
|
|
defer c.log.Info("shutting down")
|
|
|
|
if !cache.WaitForCacheSync(stopCh, c.policySynced, c.grSynced, c.npolicySynced) {
|
|
c.log.Info("failed to sync informer cache")
|
|
return
|
|
}
|
|
|
|
c.policyInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
|
|
UpdateFunc: c.updatePolicy, // We only handle updates to policy
|
|
// Deletion of policy will be handled by cleanup controller
|
|
})
|
|
|
|
for i := 0; i < workers; i++ {
|
|
go wait.Until(c.worker, time.Second, stopCh)
|
|
}
|
|
|
|
<-stopCh
|
|
}
|
|
|
|
// worker runs a worker thread that just dequeues items, processes them, and marks them done.
|
|
// It enforces that the syncHandler is never invoked concurrently with the same key.
|
|
func (c *Controller) worker() {
|
|
for c.processNextWorkItem() {
|
|
}
|
|
}
|
|
|
|
func (c *Controller) processNextWorkItem() bool {
|
|
key, quit := c.queue.Get()
|
|
if quit {
|
|
return false
|
|
}
|
|
|
|
defer c.queue.Done(key)
|
|
err := c.syncGenerateRequest(key.(string))
|
|
c.handleErr(err, key)
|
|
return true
|
|
}
|
|
|
|
func (c *Controller) handleErr(err error, key interface{}) {
|
|
logger := c.log
|
|
if err == nil {
|
|
c.queue.Forget(key)
|
|
return
|
|
}
|
|
|
|
if apierrors.IsNotFound(err) {
|
|
c.queue.Forget(key)
|
|
logger.V(4).Info("Dropping generate request from the queue", "key", key, "error", err.Error())
|
|
return
|
|
}
|
|
|
|
if c.queue.NumRequeues(key) < maxRetries {
|
|
logger.V(3).Info("retrying generate request", "key", key, "error", err.Error())
|
|
c.queue.AddRateLimited(key)
|
|
return
|
|
}
|
|
|
|
logger.Error(err, "failed to process generate request", "key", key)
|
|
c.queue.Forget(key)
|
|
}
|
|
|
|
func (c *Controller) syncGenerateRequest(key string) error {
|
|
logger := c.log
|
|
var err error
|
|
startTime := time.Now()
|
|
logger.V(4).Info("started sync", "key", key, "startTime", startTime)
|
|
defer func() {
|
|
logger.V(4).Info("completed sync generate request", "key", key, "processingTime", time.Since(startTime).String())
|
|
}()
|
|
|
|
_, grName, err := cache.SplitMetaNamespaceKey(key)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
gr, err := c.grLister.Get(grName)
|
|
if err != nil {
|
|
if apierrors.IsNotFound(err) {
|
|
return nil
|
|
}
|
|
|
|
logger.Error(err, "failed to fetch generate request", "key", key)
|
|
return err
|
|
}
|
|
|
|
return c.ProcessGR(gr)
|
|
}
|
|
|
|
// EnqueueGenerateRequestFromWebhook - enqueueing generate requests from webhook
|
|
func (c *Controller) EnqueueGenerateRequestFromWebhook(gr *kyverno.GenerateRequest) {
|
|
c.enqueueGenerateRequest(gr)
|
|
}
|
|
|
|
func (c *Controller) enqueueGenerateRequest(gr *kyverno.GenerateRequest) {
|
|
c.log.V(5).Info("enqueuing generate request", "gr", gr.Name)
|
|
key, err := cache.MetaNamespaceKeyFunc(gr)
|
|
if err != nil {
|
|
c.log.Error(err, "failed to extract name")
|
|
return
|
|
}
|
|
|
|
c.queue.Add(key)
|
|
}
|
|
|
|
func (c *Controller) updatePolicy(old, cur interface{}) {
|
|
logger := c.log
|
|
oldP := old.(*kyverno.ClusterPolicy)
|
|
curP := cur.(*kyverno.ClusterPolicy)
|
|
if oldP.ResourceVersion == curP.ResourceVersion {
|
|
// Periodic resync will send update events for all known Namespace.
|
|
// Two different versions of the same replica set will always have different RVs.
|
|
return
|
|
}
|
|
|
|
var policyHasGenerate bool
|
|
for _, rule := range autogen.ComputeRules(curP) {
|
|
if rule.HasGenerate() {
|
|
policyHasGenerate = true
|
|
}
|
|
}
|
|
|
|
if reflect.DeepEqual(curP.Spec, oldP.Spec) {
|
|
policyHasGenerate = false
|
|
}
|
|
|
|
if !policyHasGenerate {
|
|
return
|
|
}
|
|
|
|
logger.V(4).Info("updating policy", "name", oldP.Name)
|
|
|
|
// get the list of GR for the current Policy version
|
|
grs, err := c.grLister.GetGenerateRequestsForClusterPolicy(curP.Name)
|
|
if err != nil {
|
|
logger.Error(err, "failed to generate request for policy", "name", curP.Name)
|
|
return
|
|
}
|
|
|
|
// re-evaluate the GR as the policy was updated
|
|
for _, gr := range grs {
|
|
gr.Spec.Context.AdmissionRequestInfo.Operation = admissionv1.Update
|
|
c.enqueueGenerateRequest(gr)
|
|
}
|
|
}
|
|
|
|
func (c *Controller) addGR(obj interface{}) {
|
|
gr := obj.(*kyverno.GenerateRequest)
|
|
c.enqueueGenerateRequest(gr)
|
|
}
|
|
|
|
func (c *Controller) updateGR(old, cur interface{}) {
|
|
oldGr := old.(*kyverno.GenerateRequest)
|
|
curGr := cur.(*kyverno.GenerateRequest)
|
|
if oldGr.ResourceVersion == curGr.ResourceVersion {
|
|
// Periodic resync will send update events for all known Namespace.
|
|
// Two different versions of the same replica set will always have different RVs.
|
|
return
|
|
}
|
|
// only process the ones that are in "Pending"/"Completed" state
|
|
// if the Generate Request fails due to incorrect policy, it will be requeued during policy update
|
|
if curGr.Status.State == kyverno.Failed {
|
|
return
|
|
}
|
|
c.enqueueGenerateRequest(curGr)
|
|
}
|
|
|
|
func (c *Controller) deleteGR(obj interface{}) {
|
|
logger := c.log
|
|
gr, ok := obj.(*kyverno.GenerateRequest)
|
|
if !ok {
|
|
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
|
|
if !ok {
|
|
logger.Info("Couldn't get object from tombstone", "obj", obj)
|
|
return
|
|
}
|
|
_, ok = tombstone.Obj.(*kyverno.GenerateRequest)
|
|
if !ok {
|
|
logger.Info("tombstone contained object that is not a Generate Request CR", "obj", obj)
|
|
return
|
|
}
|
|
}
|
|
|
|
for _, resource := range gr.Status.GeneratedResources {
|
|
r, err := c.client.GetResource(resource.APIVersion, resource.Kind, resource.Namespace, resource.Name)
|
|
if err != nil && !apierrors.IsNotFound(err) {
|
|
logger.Error(err, "Generated resource is not deleted", "Resource", resource.Name)
|
|
continue
|
|
}
|
|
|
|
if r != nil && r.GetLabels()["policy.kyverno.io/synchronize"] == "enable" {
|
|
if err := c.client.DeleteResource(r.GetAPIVersion(), r.GetKind(), r.GetNamespace(), r.GetName(), false); err != nil && !apierrors.IsNotFound(err) {
|
|
logger.Error(err, "Generated resource is not deleted", "Resource", r.GetName())
|
|
}
|
|
}
|
|
}
|
|
|
|
logger.V(3).Info("deleting generate request", "name", gr.Name)
|
|
|
|
// sync Handler will remove it from the queue
|
|
c.enqueueGenerateRequest(gr)
|
|
}
|