2020-01-07 10:33:28 -08:00
package generate
import (
2020-11-09 11:26:12 -08:00
contextdefault "context"
2020-02-04 12:13:41 -08:00
"encoding/json"
2020-12-22 11:07:31 -08:00
"errors"
2020-01-07 10:33:28 -08:00
"fmt"
2020-10-07 11:12:31 -07:00
"reflect"
2021-10-11 14:40:45 +05:30
"strconv"
2020-12-08 01:34:46 +05:30
"strings"
2020-10-07 11:12:31 -07:00
"time"
2022-04-25 20:20:40 +08:00
"github.com/go-logr/logr"
2022-05-17 13:12:43 +02:00
kyvernov1 "github.com/kyverno/kyverno/api/kyverno/v1"
kyvernov1beta1 "github.com/kyverno/kyverno/api/kyverno/v1beta1"
2022-03-28 16:01:27 +02:00
"github.com/kyverno/kyverno/pkg/autogen"
2022-04-13 18:15:04 +05:30
"github.com/kyverno/kyverno/pkg/background/common"
kyvernoclient "github.com/kyverno/kyverno/pkg/client/clientset/versioned"
2022-05-18 06:02:31 +02:00
kyvernov1listers "github.com/kyverno/kyverno/pkg/client/listers/kyverno/v1"
kyvernov1beta1listers "github.com/kyverno/kyverno/pkg/client/listers/kyverno/v1beta1"
2021-02-04 02:39:42 +05:30
pkgcommon "github.com/kyverno/kyverno/pkg/common"
2020-10-07 11:12:31 -07:00
"github.com/kyverno/kyverno/pkg/config"
2022-05-18 06:02:31 +02:00
"github.com/kyverno/kyverno/pkg/dclient"
2020-10-07 11:12:31 -07:00
"github.com/kyverno/kyverno/pkg/engine"
"github.com/kyverno/kyverno/pkg/engine/context"
2022-04-25 20:20:40 +08:00
"github.com/kyverno/kyverno/pkg/engine/response"
2020-12-04 10:04:46 -08:00
"github.com/kyverno/kyverno/pkg/engine/utils"
2020-10-07 11:12:31 -07:00
"github.com/kyverno/kyverno/pkg/engine/variables"
2022-04-25 20:20:40 +08:00
"github.com/kyverno/kyverno/pkg/event"
2020-12-15 15:21:39 -08:00
kyvernoutils "github.com/kyverno/kyverno/pkg/utils"
2020-01-09 17:53:27 -08:00
apierrors "k8s.io/apimachinery/pkg/api/errors"
2020-08-31 23:55:13 +05:30
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2020-01-07 10:33:28 -08:00
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
2020-12-15 04:22:13 +05:30
"k8s.io/apimachinery/pkg/labels"
2022-05-17 17:51:03 +02:00
corev1listers "k8s.io/client-go/listers/core/v1"
2022-03-29 18:34:33 +05:30
"k8s.io/client-go/tools/cache"
2020-01-07 10:33:28 -08:00
)
2022-04-13 18:15:04 +05:30
type GenerateController struct {
// GenerateController updaterequest.GenerateController
2022-05-03 07:30:04 +02:00
client dclient . Interface
2022-04-13 18:15:04 +05:30
// typed client for Kyverno CRDs
2022-05-02 22:30:07 +02:00
kyvernoClient kyvernoclient . Interface
2022-04-13 18:15:04 +05:30
2022-04-29 19:05:49 +08:00
// urStatusControl is used to update UR status
2022-04-13 18:15:04 +05:30
statusControl common . StatusControlInterface
// event generator interface
eventGen event . Interface
log logr . Logger
2022-04-27 03:18:24 +08:00
// urLister can list/get update request from the shared informer's store
2022-05-18 06:02:31 +02:00
urLister kyvernov1beta1listers . UpdateRequestNamespaceLister
2022-04-27 03:18:24 +08:00
2022-04-21 11:42:34 +05:30
// nsLister can list/get namespaces from the shared informer's store
2022-05-17 17:51:03 +02:00
nsLister corev1listers . NamespaceLister
2022-04-13 18:15:04 +05:30
// policyLister can list/get cluster policy from the shared informer's store
2022-05-18 06:02:31 +02:00
policyLister kyvernov1listers . ClusterPolicyLister
2022-04-13 18:15:04 +05:30
// policyLister can list/get Namespace policy from the shared informer's store
2022-05-18 06:02:31 +02:00
npolicyLister kyvernov1listers . PolicyLister
2022-04-13 18:15:04 +05:30
2022-05-04 18:05:03 +02:00
Config config . Configuration
2022-04-13 18:15:04 +05:30
}
2022-05-17 08:19:03 +02:00
// NewGenerateController returns an instance of the Generate-Request Controller
2022-04-13 18:15:04 +05:30
func NewGenerateController (
2022-05-02 22:30:07 +02:00
kyvernoClient kyvernoclient . Interface ,
2022-05-03 07:30:04 +02:00
client dclient . Interface ,
2022-05-18 06:02:31 +02:00
policyLister kyvernov1listers . ClusterPolicyLister ,
npolicyLister kyvernov1listers . PolicyLister ,
urLister kyvernov1beta1listers . UpdateRequestNamespaceLister ,
2022-04-13 18:15:04 +05:30
eventGen event . Interface ,
2022-05-17 17:51:03 +02:00
nsLister corev1listers . NamespaceLister ,
2022-04-13 18:15:04 +05:30
log logr . Logger ,
2022-05-04 18:05:03 +02:00
dynamicConfig config . Configuration ,
2022-04-13 18:15:04 +05:30
) ( * GenerateController , error ) {
c := GenerateController {
client : client ,
kyvernoClient : kyvernoClient ,
eventGen : eventGen ,
log : log ,
Config : dynamicConfig ,
policyLister : policyLister ,
npolicyLister : npolicyLister ,
2022-04-27 03:18:24 +08:00
urLister : urLister ,
2022-04-13 18:15:04 +05:30
}
c . statusControl = common . StatusControl { Client : kyvernoClient }
2022-04-25 20:20:40 +08:00
c . nsLister = nsLister
2022-04-14 17:02:30 +05:30
2022-04-13 18:15:04 +05:30
return & c , nil
}
2022-05-17 13:12:43 +02:00
func ( c * GenerateController ) ProcessUR ( ur * kyvernov1beta1 . UpdateRequest ) error {
2022-04-29 19:05:49 +08:00
logger := c . log . WithValues ( "name" , ur . Name , "policy" , ur . Spec . Policy , "kind" , ur . Spec . Resource . Kind , "apiVersion" , ur . Spec . Resource . APIVersion , "namespace" , ur . Spec . Resource . Namespace , "name" , ur . Spec . Resource . Name )
2020-01-07 15:13:57 -08:00
var err error
var resource * unstructured . Unstructured
2022-05-17 13:12:43 +02:00
var genResources [ ] kyvernov1 . ResourceSpec
2021-11-09 09:41:29 +05:30
var precreatedResource bool
2022-05-17 12:26:12 +05:30
logger . Info ( "start processing UR" , "ur" , ur . Name , "resourceVersion" , ur . GetResourceVersion ( ) )
2020-07-20 08:00:02 -07:00
2022-05-18 00:10:47 +08:00
// 1 - Check if the trigger exists
2022-04-29 19:05:49 +08:00
resource , err = common . GetResource ( c . client , ur . Spec , c . log )
2020-01-07 10:33:28 -08:00
if err != nil {
2020-12-21 11:04:19 -08:00
// Don't update status
2022-04-29 19:05:49 +08:00
// re-queueing the UR by updating the annotation
2021-10-11 14:40:45 +05:30
// retry - 5 times
logger . V ( 3 ) . Info ( "resource does not exist or is pending creation, re-queueing" , "details" , err . Error ( ) , "retry" )
2022-04-29 19:05:49 +08:00
urAnnotations := ur . Annotations
2021-10-11 14:40:45 +05:30
2022-04-29 19:05:49 +08:00
if len ( urAnnotations ) == 0 {
urAnnotations = make ( map [ string ] string )
urAnnotations [ "generate.kyverno.io/retry-count" ] = "1"
2021-10-11 14:40:45 +05:30
} else {
2022-04-29 19:05:49 +08:00
if val , ok := urAnnotations [ "generate.kyverno.io/retry-count" ] ; ok {
2021-10-11 14:40:45 +05:30
sleepCountInt64 , err := strconv . ParseUint ( val , 10 , 32 )
if err != nil {
logger . Error ( err , "unable to convert retry-count" )
return err
}
sleepCountInt := int ( sleepCountInt64 ) + 1
if sleepCountInt > 5 {
2022-05-18 00:10:47 +08:00
if err := deleteGeneratedResources ( logger , c . client , * ur ) ; err != nil {
return err
}
// - trigger-resource is deleted
// - generated-resources are deleted
// - > Now delete the UpdateRequest CR
return c . kyvernoClient . KyvernoV1beta1 ( ) . UpdateRequests ( config . KyvernoNamespace ( ) ) . Delete ( contextdefault . TODO ( ) , ur . Name , metav1 . DeleteOptions { } )
2021-10-11 14:40:45 +05:30
} else {
time . Sleep ( time . Second * time . Duration ( sleepCountInt ) )
incrementedCountString := strconv . Itoa ( sleepCountInt )
2022-04-29 19:05:49 +08:00
urAnnotations [ "generate.kyverno.io/retry-count" ] = incrementedCountString
2021-10-11 14:40:45 +05:30
}
} else {
time . Sleep ( time . Second * 1 )
2022-04-29 19:05:49 +08:00
urAnnotations [ "generate.kyverno.io/retry-count" ] = "1"
2021-10-11 14:40:45 +05:30
}
}
2022-05-18 00:10:47 +08:00
ur . SetAnnotations ( urAnnotations )
_ , err := c . kyvernoClient . KyvernoV1beta1 ( ) . UpdateRequests ( config . KyvernoNamespace ( ) ) . Update ( contextdefault . TODO ( ) , ur , metav1 . UpdateOptions { } )
if err != nil {
logger . Error ( err , "failed to update annotation in update request for the resource" , "update request" , ur . Name , "resourceVersion" , ur . GetResourceVersion ( ) )
return err
2021-10-11 14:40:45 +05:30
}
2020-01-07 10:33:28 -08:00
return err
}
2020-07-20 08:00:02 -07:00
2020-11-20 14:14:59 -08:00
// trigger resource is being terminated
if resource == nil {
return nil
}
2020-01-07 10:33:28 -08:00
// 2 - Apply the generate policy on the resource
2022-04-21 11:42:34 +05:30
namespaceLabels := pkgcommon . GetNamespaceSelectorsFromNamespaceLister ( resource . GetKind ( ) , resource . GetNamespace ( ) , c . nsLister , logger )
2022-04-29 19:05:49 +08:00
genResources , precreatedResource , err = c . applyGenerate ( * resource , * ur , namespaceLabels )
2020-07-20 08:00:02 -07:00
2020-12-22 11:07:31 -08:00
if err != nil {
2022-04-29 19:05:49 +08:00
// Need not update the status when policy doesn't apply on resource, because all the update requests are removed by the cleanup controller
2020-12-22 11:07:31 -08:00
if strings . Contains ( err . Error ( ) , doesNotApply ) {
2022-04-29 19:05:49 +08:00
logger . V ( 4 ) . Info ( "skipping updating status of update request" )
2020-12-22 11:07:31 -08:00
return nil
}
2020-07-20 08:00:02 -07:00
2020-12-22 11:07:31 -08:00
// 3 - Report failure Events
2022-05-01 22:14:32 -07:00
events := event . NewBackgroundFailedEvent ( err , ur . Spec . Policy , "" , event . GeneratePolicyController , resource )
2020-12-22 11:07:31 -08:00
c . eventGen . Add ( events ... )
2020-12-08 01:34:46 +05:30
}
2020-01-07 10:33:28 -08:00
// 4 - Update Status
2022-04-29 19:05:49 +08:00
return updateStatus ( c . statusControl , * ur , err , genResources , precreatedResource )
2020-01-07 10:33:28 -08:00
}
2020-12-22 11:07:31 -08:00
const doesNotApply = "policy does not apply to resource"
2022-05-17 13:12:43 +02:00
func ( c * GenerateController ) applyGenerate ( resource unstructured . Unstructured , ur kyvernov1beta1 . UpdateRequest , namespaceLabels map [ string ] string ) ( [ ] kyvernov1 . ResourceSpec , bool , error ) {
2022-05-05 18:56:27 +08:00
logger := c . log . WithValues ( "name" , ur . GetName ( ) , "policy" , ur . Spec . Policy , "kind" , ur . Spec . Resource . Kind , "apiVersion" , ur . Spec . Resource . APIVersion , "namespace" , ur . Spec . Resource . Namespace , "name" , ur . Spec . Resource . Name )
2020-12-01 12:30:08 -08:00
logger . V ( 3 ) . Info ( "applying generate policy rule" )
2022-04-29 19:05:49 +08:00
policy , err := c . getPolicySpec ( ur )
2020-01-07 10:33:28 -08:00
if err != nil {
2020-07-08 08:01:47 -07:00
if apierrors . IsNotFound ( err ) {
2022-04-29 19:05:49 +08:00
for _ , e := range ur . Status . GeneratedResources {
2022-05-05 18:56:27 +08:00
if err := c . cleanupClonedResource ( e ) ; err != nil {
logger . Error ( err , "failed to clean up cloned resource on policy deletion" )
2020-07-10 17:06:16 -07:00
}
2020-07-08 14:22:32 -07:00
}
2021-11-09 09:41:29 +05:30
return nil , false , nil
2020-07-08 08:01:47 -07:00
}
2020-11-12 16:44:57 -08:00
logger . Error ( err , "error in fetching policy" )
2021-11-09 09:41:29 +05:30
return nil , false , err
2020-01-07 10:33:28 -08:00
}
2020-07-08 14:22:32 -07:00
2022-04-29 19:05:49 +08:00
policyContext , precreatedResource , err := common . NewBackgroundContext ( c . client , & ur , & policy , & resource , c . Config , namespaceLabels , logger )
2020-01-24 09:37:12 -08:00
if err != nil {
2022-04-25 20:20:40 +08:00
return nil , precreatedResource , err
2020-01-07 10:33:28 -08:00
}
// check if the policy still applies to the resource
2022-04-29 19:05:49 +08:00
engineResponse := engine . GenerateResponse ( policyContext , ur )
2020-01-07 10:33:28 -08:00
if len ( engineResponse . PolicyResponse . Rules ) == 0 {
2020-12-22 11:07:31 -08:00
logger . V ( 4 ) . Info ( doesNotApply )
2021-11-09 09:41:29 +05:30
return nil , false , errors . New ( doesNotApply )
2020-01-07 10:33:28 -08:00
}
2020-09-19 01:04:43 +05:30
2020-12-15 15:21:39 -08:00
var applicableRules [ ] string
2022-04-29 19:05:49 +08:00
// Removing UR if rule is failed. Used when the generate condition failed but ur exist
2020-09-04 03:04:23 +05:30
for _ , r := range engineResponse . PolicyResponse . Rules {
2021-09-26 02:12:31 -07:00
if r . Status != response . RuleStatusPass {
2022-04-29 19:05:49 +08:00
logger . V ( 4 ) . Info ( "querying all update requests" )
2020-12-15 04:22:13 +05:30
selector := labels . SelectorFromSet ( labels . Set ( map [ string ] string {
2022-05-17 13:12:43 +02:00
kyvernov1beta1 . URGeneratePolicyLabel : engineResponse . PolicyResponse . Policy . Name ,
2020-12-23 12:20:29 +05:30
"generate.kyverno.io/resource-name" : engineResponse . PolicyResponse . Resource . Name ,
"generate.kyverno.io/resource-kind" : engineResponse . PolicyResponse . Resource . Kind ,
"generate.kyverno.io/resource-namespace" : engineResponse . PolicyResponse . Resource . Namespace ,
2020-12-15 04:22:13 +05:30
} ) )
2022-04-29 19:05:49 +08:00
urList , err := c . urLister . List ( selector )
2020-08-31 23:55:13 +05:30
if err != nil {
2022-04-29 19:05:49 +08:00
logger . Error ( err , "failed to get update request for the resource" , "kind" , engineResponse . PolicyResponse . Resource . Kind , "name" , engineResponse . PolicyResponse . Resource . Name , "namespace" , engineResponse . PolicyResponse . Resource . Namespace )
2020-08-31 23:55:13 +05:30
continue
}
2020-11-12 16:44:57 -08:00
2022-04-29 19:05:49 +08:00
for _ , v := range urList {
2022-05-11 08:14:30 +02:00
err := c . kyvernoClient . KyvernoV1beta1 ( ) . UpdateRequests ( config . KyvernoNamespace ( ) ) . Delete ( contextdefault . TODO ( ) , v . GetName ( ) , metav1 . DeleteOptions { } )
2020-12-15 15:21:39 -08:00
if err != nil {
2022-04-29 19:05:49 +08:00
logger . Error ( err , "failed to delete update request" )
2020-08-31 23:55:13 +05:30
}
}
2020-12-15 15:21:39 -08:00
} else {
applicableRules = append ( applicableRules , r . Name )
2020-08-31 23:55:13 +05:30
}
}
2020-09-04 03:04:23 +05:30
2020-01-07 10:33:28 -08:00
// Apply the generate rule on resource
2022-04-29 19:05:49 +08:00
return c . applyGeneratePolicy ( logger , policyContext , ur , applicableRules )
2020-01-07 10:33:28 -08:00
}
2022-05-05 18:56:27 +08:00
// cleanupClonedResource deletes cloned resource if sync is not enabled for the clone policy
2022-05-17 13:12:43 +02:00
func ( c * GenerateController ) cleanupClonedResource ( targetSpec kyvernov1 . ResourceSpec ) error {
2022-05-05 18:56:27 +08:00
target , err := c . client . GetResource ( targetSpec . APIVersion , targetSpec . Kind , targetSpec . Namespace , targetSpec . Name )
if err != nil {
if ! apierrors . IsNotFound ( err ) {
return fmt . Errorf ( "failed to find generated resource %s/%s: %v" , targetSpec . Namespace , targetSpec . Name , err )
}
}
if target == nil {
return nil
}
labels := target . GetLabels ( )
syncEnabled := labels [ "policy.kyverno.io/synchronize" ] == "enable"
clone := labels [ "generate.kyverno.io/clone-policy-name" ] != ""
if syncEnabled && ! clone {
if err := c . client . DeleteResource ( target . GetAPIVersion ( ) , target . GetKind ( ) , target . GetNamespace ( ) , target . GetName ( ) , false ) ; err != nil {
return fmt . Errorf ( "cloned resource is not deleted %s/%s: %v" , targetSpec . Namespace , targetSpec . Name , err )
}
}
return nil
}
2022-03-29 18:34:33 +05:30
// getPolicySpec gets the policy spec from the ClusterPolicy/Policy
2022-05-17 13:12:43 +02:00
func ( c * GenerateController ) getPolicySpec ( ur kyvernov1beta1 . UpdateRequest ) ( kyvernov1 . ClusterPolicy , error ) {
var policy kyvernov1 . ClusterPolicy
2022-03-29 18:34:33 +05:30
2022-04-29 19:05:49 +08:00
pNamespace , pName , err := cache . SplitMetaNamespaceKey ( ur . Spec . Policy )
2022-03-29 18:34:33 +05:30
if err != nil {
2022-04-14 17:02:30 +05:30
return policy , err
2022-03-29 18:34:33 +05:30
}
if pNamespace == "" {
policyObj , err := c . policyLister . Get ( pName )
if err != nil {
2022-04-14 17:02:30 +05:30
return policy , err
2022-03-29 18:34:33 +05:30
}
2022-04-14 17:02:30 +05:30
return * policyObj , err
2022-03-29 18:34:33 +05:30
} else {
npolicyObj , err := c . npolicyLister . Policies ( pNamespace ) . Get ( pName )
if err != nil {
2022-04-14 17:02:30 +05:30
return policy , err
2022-03-29 18:34:33 +05:30
}
2022-05-17 13:12:43 +02:00
return kyvernov1 . ClusterPolicy {
2022-04-14 17:02:30 +05:30
ObjectMeta : metav1 . ObjectMeta {
Name : pName ,
} ,
Spec : npolicyObj . Spec ,
} , nil
2022-03-29 18:34:33 +05:30
}
}
2022-05-17 13:12:43 +02:00
func updateStatus ( statusControl common . StatusControlInterface , ur kyvernov1beta1 . UpdateRequest , err error , genResources [ ] kyvernov1 . ResourceSpec , precreatedResource bool ) error {
2020-01-07 10:33:28 -08:00
if err != nil {
2022-04-29 19:05:49 +08:00
return statusControl . Failed ( ur , err . Error ( ) , genResources )
2021-11-09 09:41:29 +05:30
} else if precreatedResource {
2022-04-29 19:05:49 +08:00
return statusControl . Skip ( ur , genResources )
2020-01-07 10:33:28 -08:00
}
2022-04-29 19:05:49 +08:00
return statusControl . Success ( ur , genResources )
2020-01-07 10:33:28 -08:00
}
2022-05-17 13:12:43 +02:00
func ( c * GenerateController ) applyGeneratePolicy ( log logr . Logger , policyContext * engine . PolicyContext , ur kyvernov1beta1 . UpdateRequest , applicableRules [ ] string ) ( genResources [ ] kyvernov1 . ResourceSpec , processExisting bool , err error ) {
2020-01-07 10:33:28 -08:00
// Get the response as the actions to be performed on the resource
// - - substitute values
policy := policyContext . Policy
resource := policyContext . NewResource
2020-09-23 02:41:49 +05:30
jsonContext := policyContext . JSONContext
2020-08-31 23:55:13 +05:30
// To manage existing resources, we compare the creation time for the default resource to be generated and policy creation time
2020-01-07 10:33:28 -08:00
2020-03-04 13:11:48 +05:30
ruleNameToProcessingTime := make ( map [ string ] time . Duration )
2022-03-30 15:04:30 +02:00
for _ , rule := range autogen . ComputeRules ( policy ) {
2021-04-13 21:44:43 +03:00
var err error
2020-01-07 10:33:28 -08:00
if ! rule . HasGenerate ( ) {
continue
}
2020-09-04 03:04:23 +05:30
2020-12-15 15:21:39 -08:00
if ! kyvernoutils . ContainsString ( applicableRules , rule . Name ) {
continue
}
2020-11-12 16:44:57 -08:00
startTime := time . Now ( )
2021-11-09 09:41:29 +05:30
processExisting = false
2022-05-17 13:12:43 +02:00
var genResource kyvernov1 . ResourceSpec
2020-09-04 03:04:23 +05:30
2020-09-19 01:04:43 +05:30
if len ( rule . MatchResources . Kinds ) > 0 {
if len ( rule . MatchResources . Annotations ) == 0 && rule . MatchResources . Selector == nil {
2020-12-16 19:44:28 +05:30
rcreationTime := resource . GetCreationTimestamp ( )
pcreationTime := policy . GetCreationTimestamp ( )
processExisting = rcreationTime . Before ( & pcreationTime )
2020-09-04 03:04:23 +05:30
}
}
2020-09-23 02:41:49 +05:30
// add configmap json data to context
2022-01-18 20:59:35 +08:00
if err := engine . LoadContext ( log , rule . Context , policyContext , rule . Name ) ; err != nil {
2021-04-13 21:44:43 +03:00
log . Error ( err , "cannot add configmaps to context" )
2021-11-09 09:41:29 +05:30
return nil , processExisting , err
2021-04-13 21:44:43 +03:00
}
if rule , err = variables . SubstituteAllInRule ( log , policyContext . JSONContext , rule ) ; err != nil {
log . Error ( err , "variable substitution failed for rule %s" , rule . Name )
2021-11-09 09:41:29 +05:30
return nil , processExisting , err
2020-09-23 02:41:49 +05:30
}
2022-05-09 12:43:11 +05:30
if policy . GetSpec ( ) . IsGenerateExistingOnPolicyUpdate ( ) || ! processExisting {
genResource , err = applyRule ( log , c . client , rule , resource , jsonContext , policy , ur )
2020-12-16 19:44:28 +05:30
if err != nil {
2022-03-30 15:04:30 +02:00
log . Error ( err , "failed to apply generate rule" , "policy" , policy . GetName ( ) ,
2021-06-11 01:18:26 +05:30
"rule" , rule . Name , "resource" , resource . GetName ( ) , "suggestion" , "users need to grant Kyverno's service account additional privileges" )
2021-11-09 09:41:29 +05:30
return nil , processExisting , err
2020-12-16 19:44:28 +05:30
}
ruleNameToProcessingTime [ rule . Name ] = time . Since ( startTime )
genResources = append ( genResources , genResource )
2020-01-07 10:33:28 -08:00
}
2022-05-09 12:43:11 +05:30
if policy . GetSpec ( ) . IsGenerateExistingOnPolicyUpdate ( ) {
processExisting = false
}
2020-01-07 10:33:28 -08:00
}
2021-11-09 09:41:29 +05:30
return genResources , processExisting , nil
2020-01-07 10:33:28 -08:00
}
2020-12-04 10:04:46 -08:00
func getResourceInfo ( object map [ string ] interface { } ) ( kind , name , namespace , apiversion string , err error ) {
if kind , _ , err = unstructured . NestedString ( object , "kind" ) ; err != nil {
return "" , "" , "" , "" , err
}
if name , _ , err = unstructured . NestedString ( object , "name" ) ; err != nil {
return "" , "" , "" , "" , err
}
if namespace , _ , err = unstructured . NestedString ( object , "namespace" ) ; err != nil {
return "" , "" , "" , "" , err
}
if apiversion , _ , err = unstructured . NestedString ( object , "apiVersion" ) ; err != nil {
return "" , "" , "" , "" , err
}
return
}
2022-05-17 13:12:43 +02:00
func applyRule ( log logr . Logger , client dclient . Interface , rule kyvernov1 . Rule , resource unstructured . Unstructured , ctx context . EvalInterface , policy kyvernov1 . PolicyInterface , ur kyvernov1beta1 . UpdateRequest ) ( kyvernov1 . ResourceSpec , error ) {
2020-01-07 10:33:28 -08:00
var rdata map [ string ] interface { }
var err error
2020-02-04 12:13:41 -08:00
var mode ResourceMode
2022-05-17 13:12:43 +02:00
var noGenResource kyvernov1 . ResourceSpec
2020-02-13 13:57:48 -08:00
genUnst , err := getUnstrRule ( rule . Generation . DeepCopy ( ) )
if err != nil {
return noGenResource , err
}
2020-12-14 02:43:16 -08:00
2020-12-04 10:04:46 -08:00
genKind , genName , genNamespace , genAPIVersion , err := getResourceInfo ( genUnst . Object )
2020-02-13 13:57:48 -08:00
if err != nil {
return noGenResource , err
2020-01-10 11:59:05 -08:00
}
2020-12-14 02:43:16 -08:00
logger := log . WithValues ( "genKind" , genKind , "genAPIVersion" , genAPIVersion , "genNamespace" , genNamespace , "genName" , genName )
2020-01-07 15:13:57 -08:00
// Resource to be generated
2022-05-17 13:12:43 +02:00
newGenResource := kyvernov1 . ResourceSpec {
2020-08-07 09:47:33 +05:30
APIVersion : genAPIVersion ,
Kind : genKind ,
Namespace : genNamespace ,
Name : genName ,
2020-01-07 10:33:28 -08:00
}
2020-12-04 10:04:46 -08:00
2020-12-14 02:43:16 -08:00
genData , _ , err := unstructured . NestedMap ( genUnst . Object , "data" )
2020-02-13 13:57:48 -08:00
if err != nil {
2020-12-14 02:43:16 -08:00
return noGenResource , fmt . Errorf ( "failed to read `data`: %v" , err . Error ( ) )
2020-02-13 13:57:48 -08:00
}
2020-12-04 10:04:46 -08:00
2020-12-12 21:19:37 -08:00
genClone , _ , err := unstructured . NestedMap ( genUnst . Object , "clone" )
2020-02-13 13:57:48 -08:00
if err != nil {
2020-12-14 02:43:16 -08:00
return noGenResource , fmt . Errorf ( "failed to read `clone`: %v" , err . Error ( ) )
2020-02-13 13:57:48 -08:00
}
2020-12-04 10:04:46 -08:00
2022-05-05 18:56:27 +08:00
if len ( genClone ) != 0 {
2022-05-09 12:43:11 +05:30
rdata , mode , err = manageClone ( logger , genAPIVersion , genKind , genNamespace , genName , policy . GetName ( ) , genClone , client )
2020-02-13 13:57:48 -08:00
} else {
2020-12-14 02:43:16 -08:00
rdata , mode , err = manageData ( logger , genAPIVersion , genKind , genNamespace , genName , genData , client )
2020-02-13 13:57:48 -08:00
}
2020-08-31 23:55:13 +05:30
2020-12-14 02:43:16 -08:00
if err != nil {
2021-01-04 12:33:00 +05:30
logger . Error ( err , "failed to generate resource" , "mode" , mode )
2020-12-14 02:43:16 -08:00
return newGenResource , err
}
2020-09-19 01:04:43 +05:30
2021-02-07 20:26:56 -08:00
logger . V ( 3 ) . Info ( "applying generate rule" , "mode" , mode )
2020-12-14 02:43:16 -08:00
if rdata == nil && mode == Update {
2021-07-09 18:01:46 -07:00
logger . V ( 4 ) . Info ( "no changes required for generate target resource" )
2020-02-13 13:57:48 -08:00
return newGenResource , nil
2020-01-07 10:33:28 -08:00
}
2020-12-14 02:43:16 -08:00
2020-02-04 12:13:41 -08:00
// build the resource template
2020-01-07 10:33:28 -08:00
newResource := & unstructured . Unstructured { }
newResource . SetUnstructuredContent ( rdata )
2020-02-13 13:57:48 -08:00
newResource . SetName ( genName )
newResource . SetNamespace ( genNamespace )
2020-05-16 21:29:23 -07:00
if newResource . GetKind ( ) == "" {
newResource . SetKind ( genKind )
}
2020-09-04 03:04:23 +05:30
2020-08-07 09:47:33 +05:30
newResource . SetAPIVersion ( genAPIVersion )
2020-02-10 12:44:20 -08:00
// manage labels
// - app.kubernetes.io/managed-by: kyverno
2021-04-27 01:28:34 +05:30
// "kyverno.io/generated-by-kind": kind (trigger resource)
// "kyverno.io/generated-by-namespace": namespace (trigger resource)
// "kyverno.io/generated-by-name": name (trigger resource)
2022-04-13 18:15:04 +05:30
common . ManageLabels ( newResource , resource )
2020-07-10 15:23:07 -07:00
// Add Synchronize label
label := newResource . GetLabels ( )
2022-05-09 12:43:11 +05:30
// Add background gen-rule label if generate rule applied on existing resource
if policy . GetSpec ( ) . IsGenerateExistingOnPolicyUpdate ( ) {
label [ "kyverno.io/background-gen-rule" ] = rule . Name
}
label [ "policy.kyverno.io/policy-name" ] = policy . GetName ( )
2022-04-29 19:05:49 +08:00
label [ "policy.kyverno.io/gr-name" ] = ur . Name
2020-07-10 15:23:07 -07:00
if mode == Create {
2020-09-04 03:04:23 +05:30
if rule . Generation . Synchronize {
2020-12-29 00:05:29 +05:30
label [ "policy.kyverno.io/synchronize" ] = "enable"
2020-09-04 03:04:23 +05:30
} else {
2020-12-29 00:05:29 +05:30
label [ "policy.kyverno.io/synchronize" ] = "disable"
2020-09-04 03:04:23 +05:30
}
2020-12-14 02:43:16 -08:00
2020-02-04 12:13:41 -08:00
// Reset resource version
newResource . SetResourceVersion ( "" )
2020-12-16 19:44:28 +05:30
newResource . SetLabels ( label )
2020-02-04 12:13:41 -08:00
// Create the resource
2020-08-07 09:47:33 +05:30
_ , err = client . CreateResource ( genAPIVersion , genKind , genNamespace , newResource , false )
2020-02-04 12:13:41 -08:00
if err != nil {
return noGenResource , err
}
2020-12-01 12:30:08 -08:00
2021-07-09 18:01:46 -07:00
logger . V ( 2 ) . Info ( "created generate target resource" )
2020-02-04 12:13:41 -08:00
} else if mode == Update {
2021-10-26 04:58:11 +05:30
generatedObj , err := client . GetResource ( genAPIVersion , genKind , genNamespace , genName )
if err != nil {
logger . Error ( err , fmt . Sprintf ( "generated resource not found name:%v namespace:%v kind:%v" , genName , genNamespace , genKind ) )
logger . V ( 2 ) . Info ( fmt . Sprintf ( "creating generate resource name:name:%v namespace:%v kind:%v" , genName , genNamespace , genKind ) )
_ , err = client . CreateResource ( genAPIVersion , genKind , genNamespace , newResource , false )
2021-08-09 21:10:47 +05:30
if err != nil {
return noGenResource , err
}
2020-09-04 03:04:23 +05:30
} else {
2021-10-26 04:58:11 +05:30
// if synchronize is true - update the label and generated resource with generate policy data
if rule . Generation . Synchronize {
logger . V ( 4 ) . Info ( "updating existing resource" )
label [ "policy.kyverno.io/synchronize" ] = "enable"
newResource . SetLabels ( label )
2021-10-29 14:54:39 +05:30
if genAPIVersion == "" {
generatedResourceAPIVersion := generatedObj . GetAPIVersion ( )
newResource . SetAPIVersion ( generatedResourceAPIVersion )
}
if genNamespace == "" {
newResource . SetNamespace ( "default" )
}
if _ , err := ValidateResourceWithPattern ( logger , generatedObj . Object , newResource . Object ) ; err != nil {
2021-10-26 04:58:11 +05:30
_ , err = client . UpdateResource ( genAPIVersion , genKind , genNamespace , newResource , false )
if err != nil {
logger . Error ( err , "failed to update resource" )
return noGenResource , err
}
}
} else {
currentGeneratedResourcelabel := generatedObj . GetLabels ( )
currentSynclabel := currentGeneratedResourcelabel [ "policy.kyverno.io/synchronize" ]
// update only if the labels mismatches
if ( ! rule . Generation . Synchronize && currentSynclabel == "enable" ) ||
( rule . Generation . Synchronize && currentSynclabel == "disable" ) {
logger . V ( 4 ) . Info ( "updating label in existing resource" )
currentGeneratedResourcelabel [ "policy.kyverno.io/synchronize" ] = "disable"
generatedObj . SetLabels ( currentGeneratedResourcelabel )
_ , err = client . UpdateResource ( genAPIVersion , genKind , genNamespace , generatedObj , false )
if err != nil {
logger . Error ( err , "failed to update label in existing resource" )
return noGenResource , err
}
2021-08-13 17:23:39 +05:30
}
}
2020-02-04 12:13:41 -08:00
}
2022-04-21 11:42:34 +05:30
logger . V ( 3 ) . Info ( "updated generate target resource" )
2020-01-07 10:33:28 -08:00
}
2020-12-14 02:43:16 -08:00
2020-01-07 15:13:57 -08:00
return newGenResource , nil
2020-01-07 10:33:28 -08:00
}
2022-05-03 07:30:04 +02:00
func manageData ( log logr . Logger , apiVersion , kind , namespace , name string , data map [ string ] interface { } , client dclient . Interface ) ( map [ string ] interface { } , ResourceMode , error ) {
2020-08-07 09:47:33 +05:30
obj , err := client . GetResource ( apiVersion , kind , namespace , name )
2020-01-07 10:33:28 -08:00
if err != nil {
2020-09-04 03:04:23 +05:30
if apierrors . IsNotFound ( err ) {
return data , Create , nil
}
2020-12-12 21:19:37 -08:00
2020-12-14 02:43:16 -08:00
log . Error ( err , "failed to get resource" )
2020-02-04 12:13:41 -08:00
return nil , Skip , err
2020-01-07 10:33:28 -08:00
}
2020-12-12 21:19:37 -08:00
2021-01-04 12:33:00 +05:30
log . V ( 3 ) . Info ( "found target resource" , "resource" , obj )
2020-12-14 02:43:16 -08:00
if data == nil {
2021-01-04 12:33:00 +05:30
log . V ( 3 ) . Info ( "data is nil - skipping update" , "resource" , obj )
2020-12-14 02:43:16 -08:00
return nil , Skip , nil
}
2020-09-04 03:04:23 +05:30
updateObj := & unstructured . Unstructured { }
updateObj . SetUnstructuredContent ( data )
updateObj . SetResourceVersion ( obj . GetResourceVersion ( ) )
return updateObj . UnstructuredContent ( ) , Update , nil
2020-01-07 10:33:28 -08:00
}
2022-05-03 07:30:04 +02:00
func manageClone ( log logr . Logger , apiVersion , kind , namespace , name , policy string , clone map [ string ] interface { } , client dclient . Interface ) ( map [ string ] interface { } , ResourceMode , error ) {
2020-12-14 02:43:16 -08:00
rNamespace , _ , err := unstructured . NestedString ( clone , "namespace" )
2020-02-13 13:57:48 -08:00
if err != nil {
2020-12-14 02:43:16 -08:00
return nil , Skip , fmt . Errorf ( "failed to find source namespace: %v" , err )
2020-01-07 10:33:28 -08:00
}
2020-12-14 02:43:16 -08:00
rName , _ , err := unstructured . NestedString ( clone , "name" )
2020-02-13 13:57:48 -08:00
if err != nil {
2020-12-14 02:43:16 -08:00
return nil , Skip , fmt . Errorf ( "failed to find source name: %v" , err )
2020-02-13 13:57:48 -08:00
}
2020-08-07 09:47:33 +05:30
2020-12-14 02:43:16 -08:00
if rNamespace == namespace && rName == name {
log . V ( 4 ) . Info ( "skip resource self-clone" )
2020-02-13 13:57:48 -08:00
return nil , Skip , nil
}
2020-06-22 18:49:43 -07:00
2020-02-13 13:57:48 -08:00
// check if the resource as reference in clone exists?
2020-12-14 02:43:16 -08:00
obj , err := client . GetResource ( apiVersion , kind , rNamespace , rName )
2020-01-07 10:33:28 -08:00
if err != nil {
2020-12-14 02:43:16 -08:00
return nil , Skip , fmt . Errorf ( "source resource %s %s/%s/%s not found. %v" , apiVersion , kind , rNamespace , rName , err )
2020-01-07 10:33:28 -08:00
}
2021-08-24 16:02:12 +02:00
// remove ownerReferences when cloning resources to other namespace
if rNamespace != namespace && obj . GetOwnerReferences ( ) != nil {
obj . SetOwnerReferences ( nil )
}
2020-06-22 18:49:43 -07:00
// check if resource to be generated exists
2020-08-07 09:47:33 +05:30
newResource , err := client . GetResource ( apiVersion , kind , namespace , name )
2020-06-22 18:49:43 -07:00
if err == nil {
obj . SetUID ( newResource . GetUID ( ) )
obj . SetSelfLink ( newResource . GetSelfLink ( ) )
obj . SetCreationTimestamp ( newResource . GetCreationTimestamp ( ) )
obj . SetManagedFields ( newResource . GetManagedFields ( ) )
obj . SetResourceVersion ( newResource . GetResourceVersion ( ) )
if reflect . DeepEqual ( obj , newResource ) {
return nil , Skip , nil
}
return obj . UnstructuredContent ( ) , Update , nil
}
2020-02-04 12:13:41 -08:00
// create the resource based on the reference clone
return obj . UnstructuredContent ( ) , Create , nil
2020-01-07 10:33:28 -08:00
}
2020-02-13 13:57:48 -08:00
// ResourceMode defines the mode for generated resource
type ResourceMode string
const (
2022-05-17 08:19:03 +02:00
// Skip : failed to process rule, will not update the resource
2020-02-13 13:57:48 -08:00
Skip ResourceMode = "SKIP"
2022-05-17 08:19:03 +02:00
// Create : create a new resource
2020-02-13 13:57:48 -08:00
Create = "CREATE"
2022-05-17 08:19:03 +02:00
// Update : update/overwrite the new resource
2020-02-13 13:57:48 -08:00
Update = "UPDATE"
)
2022-05-17 13:12:43 +02:00
func getUnstrRule ( rule * kyvernov1 . Generation ) ( * unstructured . Unstructured , error ) {
2020-02-13 13:57:48 -08:00
ruleData , err := json . Marshal ( rule )
if err != nil {
return nil , err
}
2020-12-04 10:04:46 -08:00
return utils . ConvertToUnstructured ( ruleData )
2020-01-07 10:33:28 -08:00
}
2022-05-18 00:10:47 +08:00
func deleteGeneratedResources ( log logr . Logger , client dclient . Interface , ur kyvernov1beta1 . UpdateRequest ) error {
for _ , genResource := range ur . Status . GeneratedResources {
err := client . DeleteResource ( "" , genResource . Kind , genResource . Namespace , genResource . Name , false )
if err != nil && ! apierrors . IsNotFound ( err ) {
return err
}
log . V ( 3 ) . Info ( "generated resource deleted" , "genKind" , ur . Spec . Resource . Kind , "genNamespace" , ur . Spec . Resource . Namespace , "genName" , ur . Spec . Resource . Name )
}
return nil
}