Package: wgpolicyk8s.io/v1alpha2

Resource Types:

ClusterPolicyReport

ClusterPolicyReport is the Schema for the clusterpolicyreports API

Field Description
apiVersion
string
wgpolicyk8s.io/v1alpha2
kind
string
ClusterPolicyReport
metadata *
meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
scope
core/v1.ObjectReference

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

scopeSelector
meta/v1.LabelSelector

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

summary
PolicyReportSummary

PolicyReportSummary provides a summary of results

results
[]PolicyReportResult

PolicyReportResult provides result details

PolicyReport

PolicyReport is the Schema for the policyreports API

Field Description
apiVersion
string
wgpolicyk8s.io/v1alpha2
kind
string
PolicyReport
metadata *
meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
scope
core/v1.ObjectReference

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

scopeSelector
meta/v1.LabelSelector

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

summary
PolicyReportSummary

PolicyReportSummary provides a summary of results

results
[]PolicyReportResult

PolicyReportResult provides result details

PolicyReportResult

(Appears in: ClusterPolicyReport, PolicyReport)

PolicyReportResult provides the result for an individual policy

Field Description
source
string

Source is an identifier for the policy engine that manages this report

policy *
string

Policy is the name or identifier of the policy

rule
string

Rule is the name or identifier of the rule within the policy

resources
[]core/v1.ObjectReference

Subjects is an optional reference to the checked Kubernetes resources

resourceSelector
meta/v1.LabelSelector

SubjectSelector is an optional label selector for checked Kubernetes resources. For example, a policy result may apply to all pods that match a label. Either a Subject or a SubjectSelector can be specified. If neither are provided, the result is assumed to be for the policy report scope.

message *
string

Description is a short user friendly message for the policy rule

result *
PolicyResult

Result indicates the outcome of the policy rule execution

scored *
bool

Scored indicates if this result is scored

properties *
map[string]string

Properties provides additional information for the policy rule

timestamp *
meta/v1.Timestamp

Timestamp indicates the time the result was found

category
string

Category indicates policy category

severity
PolicySeverity

Severity indicates policy check result criticality

PolicyReportSummary

(Appears in: ClusterPolicyReport, PolicyReport)

PolicyReportSummary provides a status count summary

Field Description
pass
int

Pass provides the count of policies whose requirements were met

fail
int

Fail provides the count of policies whose requirements were not met

warn
int

Warn provides the count of non-scored policies whose requirements were not met

error
int

Error provides the count of policies that could not be evaluated

skip
int

Skip indicates the count of policies that were not selected for evaluation

PolicyResult (string alias)

(Appears in: PolicyReportResult)

PolicyResult has one of the following values:

PolicySeverity (string alias)

(Appears in: PolicyReportResult)

PolicySeverity has one of the following values: