response

Documentation

Index

• type EngineResponse
  • func (er EngineResponse) GetFailedRules() []string
  • func (er EngineResponse) GetPatches() [][]byte
  • func (er EngineResponse) GetResourceSpec() ResourceSpec
  • func (er EngineResponse) GetSuccessRules() []string
  • func (er EngineResponse) IsSuccessful() 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) GetResourceSpec

func (er EngineResponse) GetResourceSpec() ResourceSpec

GetResourceSpec returns resourceSpec of er

func (EngineResponse) GetSuccessRules

func (er EngineResponse) GetSuccessRules() []string

GetSuccessRules returns success rules

func (EngineResponse) IsSuccessful

func (er EngineResponse) IsSuccessful() bool

IsSuccessful 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 successfully
	RulesAppliedCount int `json:"rulesAppliedCount"`
	// Timestamp of the instant the Policy was triggered
	PolicyExecutionTimestamp int64 `json:"policyExecutionTimestamp"`
}

PolicyStats stores statistics for the single policy application

type ResourceSpec

type ResourceSpec struct {
	Kind       string `json:"kind"`
	APIVersion string `json:"apiVersion"`
	Namespace  string `json:"namespace"`
	Name       string `json:"name"`

	// UID is not used to build the unique identifier
	// optional
	UID string `json:"uid"`
}

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"`
}

RuleResponse details for each rule application

func (RuleResponse) ToString

func (rr RuleResponse) ToString() string

ToString ...

type RuleStats

type RuleStats struct {
	// time required to apply the rule on the resource
	ProcessingTime time.Duration `json:"processingTime"`
	// Timestamp of the instant the rule got triggered
	RuleExecutionTimestamp int64 `json:"ruleExecutionTimestamp"`
}

RuleStats stores the statistics for the single rule application