Package v1aplha2 contains API Schema definitions for the policy v1aplha2 API group
ClusterPolicyReport is the Schema for the clusterpolicyreports API
Field | Description |
---|---|
apiVersion
string |
wgpolicyk8s.io/v1alpha2
|
kind
string
|
ClusterPolicyReport |
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
scope
Kubernetes core/v1.ObjectReference
|
(Optional) Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node) |
scopeSelector
Kubernetes meta/v1.LabelSelector
|
(Optional) 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
|
(Optional) PolicyReportSummary provides a summary of results |
results
[]*./api/v1alpha2.PolicyReportResult
|
(Optional) PolicyReportResult provides result details |
PolicyReport is the Schema for the policyreports API
Field | Description |
---|---|
apiVersion
string |
wgpolicyk8s.io/v1alpha2
|
kind
string
|
PolicyReport |
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
scope
Kubernetes core/v1.ObjectReference
|
(Optional) Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node) |
scopeSelector
Kubernetes meta/v1.LabelSelector
|
(Optional) 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
|
(Optional) PolicyReportSummary provides a summary of results |
results
[]*./api/v1alpha2.PolicyReportResult
|
(Optional) PolicyReportResult provides result details |
PolicyReportResult provides the result for an individual policy
Field | Description |
---|---|
policy
string
|
Policy is the name or identifier of the policy |
rule
string
|
(Optional) Rule is the name or identifier of the rule within the policy |
category
string
|
(Optional) Category indicates policy category |
severity
PolicyResultSeverity
|
(Optional) Severity indicates policy check result criticality |
timestamp
Kubernetes meta/v1.Timestamp
|
Timestamp indicates the time the result was found |
result
PolicyResult
|
Result indicates the outcome of the policy rule execution |
scored
bool
|
Scored indicates if this result is scored |
resources
[]*k8s.io/api/core/v1.ObjectReference
|
(Optional) Subjects is an optional reference to the checked Kubernetes resources |
resourceSelector
Kubernetes meta/v1.LabelSelector
|
(Optional) 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 |
properties
map[string]string
|
Properties provides additional information for the policy rule |
(Appears on: ClusterPolicyReport, PolicyReport)
PolicyReportSummary provides a status count summary
Field | Description |
---|---|
pass
int
|
(Optional) Pass provides the count of policies whose requirements were met |
fail
int
|
(Optional) Fail provides the count of policies whose requirements were not met |
warn
int
|
(Optional) Warn provides the count of non-scored policies whose requirements were not met |
error
int
|
(Optional) Error provides the count of policies that could not be evaluated |
skip
int
|
(Optional) Skip indicates the count of policies that were not selected for evaluation |
string
alias)(Appears on: PolicyReportResult)
PolicyResult has one of the following values: - pass: the policy requirements are met - fail: the policy requirements are not met - warn: the policy requirements are not met and the policy is not scored - error: the policy could not be evaluated - skip: the policy was not selected based on user inputs or applicability
string
alias)(Appears on: PolicyReportResult)
PolicyResultSeverity has one of the following values: - high - low - medium
Generated with gen-crd-api-reference-docs
.