1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-31 03:45:17 +00:00

variable substitution on copy and retry generate resource creation

This commit is contained in:
shivkumar dudhani 2020-02-04 12:13:41 -08:00
parent a1b49f72a3
commit f608d4db18
7 changed files with 157 additions and 61 deletions

View file

@ -35,9 +35,10 @@ func filterRule(rule kyverno.Rule, resource unstructured.Unstructured, admission
if !MatchesResourceDescription(resource, rule) { if !MatchesResourceDescription(resource, rule) {
return nil return nil
} }
// operate on the copy of the conditions, as we perform variable substitution
copyConditions := copyConditions(rule.Conditions)
// evaluate pre-conditions // evaluate pre-conditions
if !variables.EvaluateConditions(ctx, rule.Conditions) { if !variables.EvaluateConditions(ctx, copyConditions) {
glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName()) glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName())
return nil return nil
} }

View file

@ -73,8 +73,10 @@ func Mutate(policyContext PolicyContext) (resp response.EngineResponse) {
continue continue
} }
// operate on the copy of the conditions, as we perform variable substitution
copyConditions := copyConditions(rule.Conditions)
// evaluate pre-conditions // evaluate pre-conditions
if !variables.EvaluateConditions(ctx, rule.Conditions) { if !variables.EvaluateConditions(ctx, copyConditions) {
glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName()) glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName())
continue continue
} }

View file

@ -257,3 +257,13 @@ func newPathNotPresentRuleResponse(rname, rtype, msg string) response.RuleRespon
PathNotPresent: true, PathNotPresent: true,
} }
} }
func copyConditions(original []kyverno.Condition) []kyverno.Condition {
var copy []kyverno.Condition
for _, condition := range original {
copyCondition := kyverno.Condition{}
condition.DeepCopyInto(&copyCondition)
copy = append(copy, copyCondition)
}
return copy
}

View file

@ -13,6 +13,8 @@ const (
PathNotPresent ValidationFailureReason = iota PathNotPresent ValidationFailureReason = iota
// Rulefailure if the rule failed // Rulefailure if the rule failed
Rulefailure Rulefailure
// OtherError if there is any other type of error
OtherError
) )
// convertToString converts value to string // convertToString converts value to string

View file

@ -1,6 +1,7 @@
package validate package validate
import ( import (
"encoding/json"
"errors" "errors"
"fmt" "fmt"
"path/filepath" "path/filepath"
@ -23,11 +24,16 @@ func ValidateResourceWithPattern(ctx context.EvalInterface, resource, pattern in
return "", newValidatePatternError(PathNotPresent, invalidPaths) return "", newValidatePatternError(PathNotPresent, invalidPaths)
} }
// Operate on copy of the value for variable substitution
patternCopy, err := copyInterface(pattern)
if err != nil {
return "", newValidatePatternError(OtherError, err.Error())
}
// first pass we substitute all the JMESPATH substitution for the variable // first pass we substitute all the JMESPATH substitution for the variable
// variable: {{<JMESPATH>}} // variable: {{<JMESPATH>}}
// if a JMESPATH fails, we dont return error but variable is substitured with nil and error log // if a JMESPATH fails, we dont return error but variable is substitured with nil and error log
pattern = variables.SubstituteVariables(ctx, pattern) pattern = variables.SubstituteVariables(ctx, patternCopy)
path, err := validateResourceElement(resource, pattern, pattern, "/") path, err := validateResourceElement(resource, patternCopy, patternCopy, "/")
if err != nil { if err != nil {
return path, newValidatePatternError(Rulefailure, err.Error()) return path, newValidatePatternError(Rulefailure, err.Error())
} }
@ -35,6 +41,20 @@ func ValidateResourceWithPattern(ctx context.EvalInterface, resource, pattern in
return "", ValidationError{} return "", ValidationError{}
} }
func copyInterface(original interface{}) (interface{}, error) {
tempData, err := json.Marshal(original)
if err != nil {
return nil, err
}
fmt.Println(string(tempData))
var temp interface{}
err = json.Unmarshal(tempData, &temp)
if err != nil {
return nil, err
}
return temp, nil
}
// validateResourceElement detects the element type (map, array, nil, string, int, bool, float) // validateResourceElement detects the element type (map, array, nil, string, int, bool, float)
// and calls corresponding handler // and calls corresponding handler
// Pattern tree and resource tree can have different structure. In this case validation fails // Pattern tree and resource tree can have different structure. In this case validation fails

View file

@ -118,8 +118,10 @@ func validateResource(ctx context.EvalInterface, policy kyverno.ClusterPolicy, r
continue continue
} }
// operate on the copy of the conditions, as we perform variable substitution
copyConditions := copyConditions(rule.Conditions)
// evaluate pre-conditions // evaluate pre-conditions
if !variables.EvaluateConditions(ctx, rule.Conditions) { if !variables.EvaluateConditions(ctx, copyConditions) {
glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName()) glog.V(4).Infof("resource %s/%s does not satisfy the conditions for the rule ", resource.GetNamespace(), resource.GetName())
continue continue
} }
@ -199,6 +201,12 @@ func validatePatterns(ctx context.EvalInterface, resource unstructured.Unstructu
resp.Success = false resp.Success = false
resp.Message = fmt.Sprintf("Validation error: %s; Validation rule '%s' failed at path '%s'", resp.Message = fmt.Sprintf("Validation error: %s; Validation rule '%s' failed at path '%s'",
rule.Validation.Message, rule.Name, path) rule.Validation.Message, rule.Name, path)
case validate.OtherError:
// other error
glog.V(4).Infof("Validation rule '%s' failed at '%s' for resource %s/%s/%s. %s: %v", rule.Name, path, resource.GetKind(), resource.GetNamespace(), resource.GetName(), rule.Validation.Message, err)
resp.Success = false
resp.Message = fmt.Sprintf("Validation error: %s; Validation rule '%s' failed at path '%s'",
rule.Validation.Message, rule.Name, path)
} }
return resp return resp
} }

View file

@ -1,6 +1,7 @@
package generate package generate
import ( import (
"encoding/json"
"errors" "errors"
"fmt" "fmt"
"reflect" "reflect"
@ -104,7 +105,7 @@ func (c *Controller) applyGenerate(resource unstructured.Unstructured, gr kyvern
} }
// Apply the generate rule on resource // Apply the generate rule on resource
return applyGeneratePolicy(c.client, policyContext, gr.Status.State) return applyGeneratePolicy(c.client, policyContext)
} }
func updateStatus(statusControl StatusControlInterface, gr kyverno.GenerateRequest, err error, genResources []kyverno.ResourceSpec) error { func updateStatus(statusControl StatusControlInterface, gr kyverno.GenerateRequest, err error, genResources []kyverno.ResourceSpec) error {
@ -116,7 +117,7 @@ func updateStatus(statusControl StatusControlInterface, gr kyverno.GenerateReque
return statusControl.Success(gr, genResources) return statusControl.Success(gr, genResources)
} }
func applyGeneratePolicy(client *dclient.Client, policyContext engine.PolicyContext, state kyverno.GenerateRequestState) ([]kyverno.ResourceSpec, error) { func applyGeneratePolicy(client *dclient.Client, policyContext engine.PolicyContext) ([]kyverno.ResourceSpec, error) {
// List of generatedResources // List of generatedResources
var genResources []kyverno.ResourceSpec var genResources []kyverno.ResourceSpec
// Get the response as the actions to be performed on the resource // Get the response as the actions to be performed on the resource
@ -135,7 +136,7 @@ func applyGeneratePolicy(client *dclient.Client, policyContext engine.PolicyCont
if !rule.HasGenerate() { if !rule.HasGenerate() {
continue continue
} }
genResource, err := applyRule(client, rule, resource, ctx, state, processExisting) genResource, err := applyRule(client, rule, resource, ctx, processExisting)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -145,9 +146,10 @@ func applyGeneratePolicy(client *dclient.Client, policyContext engine.PolicyCont
return genResources, nil return genResources, nil
} }
func applyRule(client *dclient.Client, rule kyverno.Rule, resource unstructured.Unstructured, ctx context.EvalInterface, state kyverno.GenerateRequestState, processExisting bool) (kyverno.ResourceSpec, error) { func applyRule(client *dclient.Client, rule kyverno.Rule, resource unstructured.Unstructured, ctx context.EvalInterface, processExisting bool) (kyverno.ResourceSpec, error) {
var rdata map[string]interface{} var rdata map[string]interface{}
var err error var err error
var mode ResourceMode
var noGenResource kyverno.ResourceSpec var noGenResource kyverno.ResourceSpec
if invalidPaths := variables.ValidateVariables(ctx, rule.Generation.ResourceSpec); len(invalidPaths) != 0 { if invalidPaths := variables.ValidateVariables(ctx, rule.Generation.ResourceSpec); len(invalidPaths) != 0 {
@ -169,11 +171,12 @@ func applyRule(client *dclient.Client, rule kyverno.Rule, resource unstructured.
// DATA // DATA
if gen.Data != nil { if gen.Data != nil {
if rdata, err = handleData(rule.Name, gen, client, resource, ctx, state); err != nil { if rdata, mode, err = handleData(rule.Name, gen, client, resource, ctx); err != nil {
glog.V(4).Info(err) glog.V(4).Info(err)
switch e := err.(type) { switch e := err.(type) {
case *ParseFailed, *NotFound, *ConfigNotFound: case *ParseFailed, *NotFound, *ConfigNotFound:
// handled errors // handled errors
return noGenResource, e
case *Violation: case *Violation:
// create policy violation // create policy violation
return noGenResource, e return noGenResource, e
@ -189,7 +192,7 @@ func applyRule(client *dclient.Client, rule kyverno.Rule, resource unstructured.
} }
// CLONE // CLONE
if gen.Clone != (kyverno.CloneFrom{}) { if gen.Clone != (kyverno.CloneFrom{}) {
if rdata, err = handleClone(rule.Name, gen, client, resource, ctx, state); err != nil { if rdata, mode, err = handleClone(rule.Name, gen, client, resource, ctx); err != nil {
glog.V(4).Info(err) glog.V(4).Info(err)
switch e := err.(type) { switch e := err.(type) {
case *NotFound: case *NotFound:
@ -211,21 +214,36 @@ func applyRule(client *dclient.Client, rule kyverno.Rule, resource unstructured.
// we do not create new resource // we do not create new resource
return noGenResource, err return noGenResource, err
} }
// Create the generate resource
// build the resource template
newResource := &unstructured.Unstructured{} newResource := &unstructured.Unstructured{}
newResource.SetUnstructuredContent(rdata) newResource.SetUnstructuredContent(rdata)
newResource.SetName(gen.Name) newResource.SetName(gen.Name)
newResource.SetNamespace(gen.Namespace) newResource.SetNamespace(gen.Namespace)
// Reset resource version
newResource.SetResourceVersion("")
glog.V(4).Infof("creating resource %v", newResource) if mode == Create {
_, err = client.CreateResource(gen.Kind, gen.Namespace, newResource, false) // Reset resource version
if err != nil { newResource.SetResourceVersion("")
glog.Info(err) // Create the resource
return noGenResource, err glog.V(4).Infof("Creating new resource %s/%s/%s", gen.Kind, gen.Namespace, gen.Name)
_, err = client.CreateResource(gen.Kind, gen.Namespace, newResource, false)
if err != nil {
// Failed to create resource
return noGenResource, err
}
glog.V(4).Infof("Created new resource %s/%s/%s", gen.Kind, gen.Namespace, gen.Name)
} else if mode == Update {
glog.V(4).Infof("Updating existing resource %s/%s/%s", gen.Kind, gen.Namespace, gen.Name)
// Update the resource
_, err := client.UpdateResource(gen.Kind, gen.Namespace, newResource, false)
if err != nil {
// Failed to update resource
return noGenResource, err
}
glog.V(4).Infof("Updated existing resource %s/%s/%s", gen.Kind, gen.Namespace, gen.Name)
} }
glog.V(4).Infof("created new resource %s %s %s ", gen.Kind, gen.Namespace, gen.Name)
return newGenResource, nil return newGenResource, nil
} }
@ -261,81 +279,116 @@ func variableSubsitutionForAttributes(gen kyverno.Generation, ctx context.EvalIn
return gen return gen
} }
func handleData(ruleName string, generateRule kyverno.Generation, client *dclient.Client, resource unstructured.Unstructured, ctx context.EvalInterface, state kyverno.GenerateRequestState) (map[string]interface{}, error) { // ResourceMode defines the mode for generated resource
if invalidPaths := variables.ValidateVariables(ctx, generateRule.Data); len(invalidPaths) != 0 { type ResourceMode string
return nil, NewViolation(ruleName, fmt.Errorf("path not present in generate data: %s", invalidPaths))
}
//work on copy const (
copyDataTemp := reflect.Indirect(reflect.ValueOf(generateRule.Data)) //Skip : failed to process rule, will not update the resource
copyData := copyDataTemp.Interface() Skip ResourceMode = "SKIP"
newData := variables.SubstituteVariables(ctx, copyData) //Create : create a new resource
Create = "CREATE"
//Update : update/override the new resource
Update = "UPDATE"
)
func copyInterface(original interface{}) (interface{}, error) {
tempData, err := json.Marshal(original)
if err != nil {
return nil, err
}
fmt.Println(string(tempData))
var temp interface{}
err = json.Unmarshal(tempData, &temp)
if err != nil {
return nil, err
}
return temp, nil
}
// manage the creation/update of resource to be generated using the spec defined in the policy
func handleData(ruleName string, generateRule kyverno.Generation, client *dclient.Client, resource unstructured.Unstructured, ctx context.EvalInterface) (map[string]interface{}, ResourceMode, error) {
//work on copy of the data
// as the type of data stoed in interface is not know,
// we marshall the data and unmarshal it into a new resource to create a copy
dataCopy, err := copyInterface(generateRule.Data)
if err != nil {
glog.V(4).Infof("failed to create a copy of the interface %v", generateRule.Data)
return nil, Skip, err
}
// replace variables with the corresponding values
newData := variables.SubstituteVariables(ctx, dataCopy)
// if any variable defined in the data is not avaialbe in the context
if invalidPaths := variables.ValidateVariables(ctx, newData); len(invalidPaths) != 0 {
return nil, Skip, NewViolation(ruleName, fmt.Errorf("path not present in generate data: %s", invalidPaths))
}
// check if resource exists // check if resource exists
obj, err := client.GetResource(generateRule.Kind, generateRule.Namespace, generateRule.Name) obj, err := client.GetResource(generateRule.Kind, generateRule.Namespace, generateRule.Name)
glog.V(4).Info(err)
if apierrors.IsNotFound(err) { if apierrors.IsNotFound(err) {
glog.V(4).Info(string(state))
// Resource does not exist // Resource does not exist
if state == "" { // Processing the request first time
// Processing the request first time rdata, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&newData)
rdata, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&newData) if err != nil {
glog.V(4).Info(err) return nil, Skip, NewParseFailed(newData, err)
if err != nil {
return nil, NewParseFailed(newData, err)
}
return rdata, nil
} }
glog.V(4).Info("Creating violation") glog.V(4).Infof("Resource %s/%s/%s does not exists, will try to create", generateRule.Kind, generateRule.Namespace, generateRule.Name)
// State : Failed,Completed return rdata, Create, nil
// request has been processed before, so dont create the resource
// report Violation to notify the error
return nil, NewViolation(ruleName, NewNotFound(generateRule.Kind, generateRule.Namespace, generateRule.Name))
} }
if err != nil { if err != nil {
//something wrong while fetching resource //something wrong while fetching resource
return nil, err return nil, Skip, err
} }
// Resource exists; verfiy the content of the resource // Resource exists; verfiy the content of the resource
ok, err := checkResource(ctx, newData, obj) ok, err := checkResource(ctx, newData, obj)
if err != nil { if err != nil {
//something wrong with configuration // error while evaluating if the existing resource contains the required information
glog.V(4).Info(err) return nil, Skip, err
return nil, err
} }
if !ok { if !ok {
return nil, NewConfigNotFound(newData, generateRule.Kind, generateRule.Namespace, generateRule.Name) // existing resource does not contain the configuration mentioned in spec, will try to update
rdata, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&newData)
if err != nil {
return nil, Skip, NewParseFailed(newData, err)
}
glog.V(4).Infof("Resource %s/%s/%s exists but missing required configuration, will try to update", generateRule.Kind, generateRule.Namespace, generateRule.Name)
return rdata, Update, nil
} }
// Existing resource does contain the required // Existing resource does contain the mentioned configuration in spec, skip processing the resource as it is already in expected state
return nil, nil return nil, Skip, nil
} }
func handleClone(ruleName string, generateRule kyverno.Generation, client *dclient.Client, resource unstructured.Unstructured, ctx context.EvalInterface, state kyverno.GenerateRequestState) (map[string]interface{}, error) { // manage the creation/update based on the reference clone resource
func handleClone(ruleName string, generateRule kyverno.Generation, client *dclient.Client, resource unstructured.Unstructured, ctx context.EvalInterface) (map[string]interface{}, ResourceMode, error) {
// if any variable defined in the data is not avaialbe in the context
if invalidPaths := variables.ValidateVariables(ctx, generateRule.Clone); len(invalidPaths) != 0 { if invalidPaths := variables.ValidateVariables(ctx, generateRule.Clone); len(invalidPaths) != 0 {
return nil, NewViolation(ruleName, fmt.Errorf("path not present in generate clone: %s", invalidPaths)) return nil, Skip, NewViolation(ruleName, fmt.Errorf("path not present in generate clone: %s", invalidPaths))
} }
// check if resource exists // check if resource to be generated exists
_, err := client.GetResource(generateRule.Kind, generateRule.Namespace, generateRule.Name) _, err := client.GetResource(generateRule.Kind, generateRule.Namespace, generateRule.Name)
if err == nil { if err == nil {
// resource exists // resource does exists, not need to process further as it is already in expected state
return nil, nil return nil, Skip, nil
} }
if !apierrors.IsNotFound(err) { if !apierrors.IsNotFound(err) {
//something wrong while fetching resource //something wrong while fetching resource
return nil, err return nil, Skip, err
} }
// get reference clone resource // get clone resource reference in the rule
obj, err := client.GetResource(generateRule.Kind, generateRule.Clone.Namespace, generateRule.Clone.Name) obj, err := client.GetResource(generateRule.Kind, generateRule.Clone.Namespace, generateRule.Clone.Name)
if apierrors.IsNotFound(err) { if apierrors.IsNotFound(err) {
return nil, NewNotFound(generateRule.Kind, generateRule.Clone.Namespace, generateRule.Clone.Name) // reference resource does not exist, cant generate the resources
return nil, Skip, NewNotFound(generateRule.Kind, generateRule.Clone.Namespace, generateRule.Clone.Name)
} }
if err != nil { if err != nil {
//something wrong while fetching resource //something wrong while fetching resource
return nil, err return nil, Skip, err
} }
return obj.UnstructuredContent(), nil // create the resource based on the reference clone
return obj.UnstructuredContent(), Create, nil
} }
func checkResource(ctx context.EvalInterface, newResourceSpec interface{}, resource *unstructured.Unstructured) (bool, error) { func checkResource(ctx context.EvalInterface, newResourceSpec interface{}, resource *unstructured.Unstructured) (bool, error) {