|
This is unreleased documentation for Runtime Enforcer 0.11-dev. |
CRD API Reference
This page lists the Custom Resource Definitions (CRDs) of Kubewarden Runtime Enforcer.
API Reference
runtimeenforcer.kubewarden.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the runtimeenforcer v1alpha1 API group.
AcknowledgedViolationRecord
| Field | Description | Default | Validation |
|---|---|---|---|
|
violation is the violation record acknowledged by users |
||
|
reason is an optional field to indicate the reason this violation is acknowledged. |
||
|
acknowledgedAt is the time when the violation was acknowledged |
Phase
Underlying type: string
Phase represents the current phase of the workload policy. Possible values are: - "Transitioning": the policy is in the process of changing its enforcement mode. - "Failed": the policy deployment has failed. - "Ready": the policy is ready and actively enforced.
PolicyNodeStatus
| Field | Description | Default | Validation |
|---|---|---|---|
|
code is the policy code. |
||
|
message is a human-readable description. |
||
|
since is the time at which the node entered its current status. |
||
|
PolicyStatus
PolicyStatus represents information about a policy status on a node.
| Field | Description | Default | Validation |
|---|---|---|---|
|
code is the policy code. |
||
|
message is a human-readable description. |
||
|
since is the time at which the node entered its current status. |
ViolationRecord
ViolationRecord holds the details of a single policy violation.
| Field | Description | Default | Validation |
|---|---|---|---|
|
id is a per-policy unique identifier allocated by the controller Stored as int64 (not uint64) for compatibility with the Kubernetes |
||
|
lastObservedTimestamp is when the violation was last observed. |
||
|
occurrences is the number of times this violation (identified by |
1 |
|
|
firstObservedTimestamp is when the violation was first observed. It |
||
|
podName is the name of the pod where the violation occurred. |
||
|
containerName is the container where the unauthorized executable ran. |
||
|
executablePath is the path of the unauthorized executable. |
||
|
nodeName is the node where the violation occurred. |
||
|
action is the enforcement action taken (monitor or protect). |
||
|
workloadName is the name of the workload that owns the pod, taken |
||
|
workloadKind is the kind of the workload that owns the pod, taken |
WorkloadPolicy
WorkloadPolicy is the Schema for the workloadpolicies API.
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
|||
|
WorkloadPolicyExecutables
| Field | Description | Default | Validation |
|---|---|---|---|
|
allowed defines a list of executables that are allowed to run |
items:Pattern: ^/.*$ |
WorkloadPolicyList
WorkloadPolicyList contains a list of WorkloadPolicy.
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
WorkloadPolicyProposal
WorkloadPolicyProposal is the Schema for the workloadpolicyproposals API.
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
WorkloadPolicyProposalList
WorkloadPolicyProposalList contains a list of WorkloadPolicyProposal.
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
WorkloadPolicyProposalSpec
WorkloadPolicyProposalSpec defines the desired state of WorkloadPolicyProposal.
| Field | Description | Default | Validation |
|---|---|---|---|
|
rulesByContainer specifies for each container the list of rules to apply. |
WorkloadPolicyRules
| Field | Description | Default | Validation |
|---|---|---|---|
|
executables defines a security policy for executables. |
WorkloadPolicySpec
| Field | Description | Default | Validation |
|---|---|---|---|
|
mode defines the execution mode of this policy. Can be set to |
Enum: [monitor protect] |
|
|
rulesByContainer specifies for each container the list of rules to apply. |
WorkloadPolicyStatus
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
nodesWithIssues contains the status of each node with issues. |
||
|
totalNodes is the total number of nodes the policy is applied to. |
||
|
successfulNodes is the number of nodes where the policy is successfully enforced. |
||
|
failedNodes is the number of nodes where the policy enforcement failed. |
||
|
transitioningNodes is the number of nodes where the policy is transitioning mode. |
||
|
nodesTransitioning contains the nodes that are transitioning, including |
||
|
phase indicates the current phase of the workload policy. |
||
|
violationCount is the total number of unique violation records |
0 |
|
|
activeViolationCount is the number of currently active (non-cleared) |
0 |
|
|
violations is the list of the most recent violation records (max maxViolationRecords). |
||
|
acknowledgedViolations is the list of the most recent violation records that are acknowledged |