response

Documentation

Index

• type EngineResponse
  • func (er EngineResponse) GetFailedRules() []string
  • func (er EngineResponse) GetPatches() [][]byte
  • func (er EngineResponse) GetSuccessRules() []string
  • func (er EngineResponse) IsPathNotPresent() bool
  • func (er EngineResponse) IsSuccesful() bool
• type PolicyResponse
• type PolicyStats
• type ResourceSpec
  • func (rs ResourceSpec) GetKey() string
• type RuleResponse
  • func (rr RuleResponse) ToString() string
• type RuleStats

Types

type EngineResponse

type EngineResponse struct {
	// Resource patched with the engine action changes
	PatchedResource unstructured.Unstructured
	// Policy Response
	PolicyResponse PolicyResponse
}

EngineResponse engine response to the action

func (EngineResponse) GetFailedRules

func (er EngineResponse) GetFailedRules() []string

GetFailedRules returns failed rules

func (EngineResponse) GetPatches

func (er EngineResponse) GetPatches() [][]byte

GetPatches returns all the patches joined

func (EngineResponse) GetSuccessRules

func (er EngineResponse) GetSuccessRules() []string

GetSuccessRules returns success rules

func (EngineResponse) IsPathNotPresent

func (er EngineResponse) IsPathNotPresent() bool

IsPathNotPresent checks if the referenced path(in variable substitution) exist

func (EngineResponse) IsSuccesful

func (er EngineResponse) IsSuccesful() bool

IsSuccesful checks if any rule has failed or not

type PolicyResponse

type PolicyResponse struct {
	// policy name
	Policy string `json:"policy"`
	// resource details
	Resource ResourceSpec `json:"resource"`
	// policy statistics
	PolicyStats `json:",inline"`
	// rule response
	Rules []RuleResponse `json:"rules"`
	// ValidationFailureAction: audit(default if not set),enforce
	ValidationFailureAction string
}

PolicyResponse policy application response

type PolicyStats

type PolicyStats struct {
	// time required to process the policy rules on a resource
	ProcessingTime time.Duration `json:"processingTime"`
	// Count of rules that were applied succesfully
	RulesAppliedCount int `json:"rulesAppliedCount"`
}

PolicyStats stores statistics for the single policy application

type ResourceSpec

type ResourceSpec struct {
	//TODO: support ApiVersion
	Kind       string `json:"kind"`
	APIVersion string `json:"apiVersion"`
	Namespace  string `json:"namespace"`
	Name       string `json:"name"`
}

ResourceSpec resource action applied on

func (ResourceSpec) GetKey

func (rs ResourceSpec) GetKey() string

GetKey returns the key

type RuleResponse

type RuleResponse struct {
	// rule name specified in policy
	Name string `json:"name"`
	// rule type (Mutation,Generation,Validation) for Kyverno Policy
	Type string `json:"type"`
	// message response from the rule application
	Message string `json:"message"`
	// JSON patches, for mutation rules
	Patches [][]byte `json:"patches,omitempty"`
	// success/fail
	Success bool `json:"success"`
	// statistics
	RuleStats `json:",inline"`
	// PathNotPresent indicates whether referenced path in variable substitution exist
	PathNotPresent bool `json:"pathNotPresent"`
}

RuleResponse details for each rule applicatino

func (RuleResponse) ToString

func (rr RuleResponse) ToString() string

ToString ...

type RuleStats

type RuleStats struct {
	// time required to appliy the rule on the resource
	ProcessingTime time.Duration `json:"processingTime"`
}

RuleStats stores the statisctis for the single rule application