description:ClusterPolicy declares validation, mutation, and generation behaviors
for matching resources.
properties:
apiVersion:
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
metadata:
type:object
spec:
description:Spec declares policy behaviors.
properties:
background:
description:Background controls if rules are applied to existing
resources during a background scan. Optional. Default value is "true".
The value must be set to "false" if the policy rule uses variables
that are only available in the admission review request (e.g. user
name).
type:boolean
rules:
description:Rules is a list of Rule instances
items:
description:Rule defines a validation, mutation, or generation
control for matching resources.
properties:
context:
description:Context defines data sources and variables that
can be used during rule execution.
items:
description:ContextEntry adds variables and data sources
to a rule Context
properties:
configMap:
description:ConfigMapReference refers to a ConfigMap
properties:
name:
type:string
namespace:
type:string
type:object
name:
type:string
type:object
type:array
exclude:
description:ExcludeResources selects resources to which the
policy rule should not be applied.
properties:
clusterRoles:
description:ClusterRoles is the list of cluster-wide role
names for the user.
items:
type:string
type:array
resources:
description:ResourceDescription contains information about
the resource being created or modified.
properties:
annotations:
additionalProperties:
type:string
description:Annotations is a map of annotations (string
description:ClusterPolicyReport is the Schema for the clusterpolicyreports
API
properties:
apiVersion:
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
metadata:
type:object
results:
description:PolicyReportResult provides result details
items:
description:PolicyReportResult provides the result for an individual
policy
properties:
category:
description:Category indicates policy category
type:string
data:
additionalProperties:
type:string
description:Data provides additional information for the policy
rule
type:object
message:
description:Message is a short user friendly description of the
policy rule
type:string
policy:
description:Policy is the name of the policy
type:string
resourceSelector:
description:ResourceSelector is an optional selector for policy
results that apply to multiple resources. For example, a policy
result may apply to all pods that match a label. Either a Resource
or a ResourceSelector can be specified. If neither are provided,
the result is assumed to be for the policy report scope.
properties:
matchExpressions:
description:matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description:A label selector requirement is a selector that
contains values, a key, and an operator that relates the
key and values.
properties:
key:
description:key is the label key that the selector applies
to.
type:string
operator:
description:operator represents a key's relationship
to a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type:string
values:
description:values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a
strategic merge patch.
items:
type:string
type:array
required:
- key
- operator
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type:object
type:object
resources:
description:Resources is an optional reference to the resource
checked by the policy and rule
items:
description:'ObjectReference contains enough information to let
you inspect or modify the referred object. --- New uses of this
type are discouraged because of difficulty describing its usage
when embedded in APIs. 1. Ignored fields. It includes many
fields which are not generally honored. For instance, ResourceVersion
and FieldPath are both very rarely valid in actual usage. 2.
Invalid usage help. It is impossible to add specific help for
individual usage. In most embedded usages, there are particular restrictions
like, "must refer only to types A and B" or "UID not honored"
or "name must be restricted". Those cannot be well described
when embedded. 3. Inconsistent validation. Because the usages
are different, the validation rules are different by usage,
which makes it hard for users to predict what will happen. 4.
The fields are both imprecise and overly precise. Kind is not
a precise mapping to a URL. This can produce ambiguity during
interpretation and require a REST mapping. In most cases, the
dependency is on the group,resource tuple and the version
of the actual struct is irrelevant. 5. We cannot easily change
it. Because this type is embedded in many locations, updates
to this type will affect numerous schemas. Don''t make
new APIs embed an underspecified API type they do not control.
Instead of using this type, create a locally provided and used
type that is well-focused on your reference. For example, ServiceReferences
for admission registration:https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
.'
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead
of an entire object, this string should contain a valid
JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part
of an object. TODO:this design is not final and this field
is subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
type:array
rule:
description:Rule is the name of the policy rule
type:string
scored:
description:Scored indicates if this policy rule is scored
type:boolean
severity:
description:Severity indicates policy severity
enum:
- high
- low
- medium
type:string
status:
description:Status indicates the result of the policy rule check
enum:
- pass
- fail
- warn
- error
- skip
type:string
required:
- policy
type:object
type:array
scope:
description:Scope is an optional reference to the report scope (e.g.
a Deployment, Namespace, or Node)
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of an entire
object, this string should contain a valid JSON/Go field access
statement, such as desiredState.manifest.containers[2]. For example,
if the object reference is to a container within a pod, this would
take on a value like:"spec.containers{name}"(where "name" refers
to the name of the container that triggered the event) or if no
container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined
way of referencing a part of an object. TODO:this design is not
final and this field is subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference is
made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
scopeSelector:
description: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.
properties:
matchExpressions:
description:matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description:A label selector requirement is a selector that contains
values, a key, and an operator that relates the key and values.
properties:
key:
description:key is the label key that the selector applies
to.
type:string
operator:
description:operator represents a key's relationship to a set
of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type:string
values:
description:values is an array of string values. If the operator
is In or NotIn, the values array must be non-empty. If the
operator is Exists or DoesNotExist, the values array must
be empty. This array is replaced during a strategic merge
patch.
items:
type:string
type:array
required:
- key
- operator
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:matchLabels is a map of {key,value} pairs. A single {key,value}
in the matchLabels map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In", and the values array
contains only "value". The requirements are ANDed.
type:object
type:object
summary:
description:PolicyReportSummary provides a summary of results
properties:
error:
description:Error provides the count of policies that could not be
evaluated
type:integer
fail:
description:Fail provides the count of policies whose requirements
were not met
type:integer
pass:
description:Pass provides the count of policies whose requirements
were met
type:integer
skip:
description:Skip indicates the count of policies that were not selected
for evaluation
type:integer
warn:
description:Warn provides the count of unscored policies whose requirements
description:ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests
API
properties:
apiVersion:
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
metadata:
type:object
results:
description:PolicyReportResult provides result details
items:
description:PolicyReportResult provides the result for an individual
policy
properties:
category:
description:Category indicates policy category
type:string
data:
additionalProperties:
type:string
description:Data provides additional information for the policy
rule
type:object
message:
description:Message is a short user friendly description of the
policy rule
type:string
policy:
description:Policy is the name of the policy
type:string
resourceSelector:
description:ResourceSelector is an optional selector for policy
results that apply to multiple resources. For example, a policy
result may apply to all pods that match a label. Either a Resource
or a ResourceSelector can be specified. If neither are provided,
the result is assumed to be for the policy report scope.
properties:
matchExpressions:
description:matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description:A label selector requirement is a selector that
contains values, a key, and an operator that relates the
key and values.
properties:
key:
description:key is the label key that the selector applies
to.
type:string
operator:
description:operator represents a key's relationship
to a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type:string
values:
description:values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a
strategic merge patch.
items:
type:string
type:array
required:
- key
- operator
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type:object
type:object
resources:
description:Resources is an optional reference to the resource
checked by the policy and rule
items:
description:'ObjectReference contains enough information to let
you inspect or modify the referred object. --- New uses of this
type are discouraged because of difficulty describing its usage
when embedded in APIs. 1. Ignored fields. It includes many
fields which are not generally honored. For instance, ResourceVersion
and FieldPath are both very rarely valid in actual usage. 2.
Invalid usage help. It is impossible to add specific help for
individual usage. In most embedded usages, there are particular restrictions
like, "must refer only to types A and B" or "UID not honored"
or "name must be restricted". Those cannot be well described
when embedded. 3. Inconsistent validation. Because the usages
are different, the validation rules are different by usage,
which makes it hard for users to predict what will happen. 4.
The fields are both imprecise and overly precise. Kind is not
a precise mapping to a URL. This can produce ambiguity during
interpretation and require a REST mapping. In most cases, the
dependency is on the group,resource tuple and the version
of the actual struct is irrelevant. 5. We cannot easily change
it. Because this type is embedded in many locations, updates
to this type will affect numerous schemas. Don''t make
new APIs embed an underspecified API type they do not control.
Instead of using this type, create a locally provided and used
type that is well-focused on your reference. For example, ServiceReferences
for admission registration:https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
.'
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead
of an entire object, this string should contain a valid
JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part
of an object. TODO:this design is not final and this field
is subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
type:array
rule:
description:Rule is the name of the policy rule
type:string
scored:
description:Scored indicates if this policy rule is scored
type:boolean
severity:
description:Severity indicates policy severity
enum:
- high
- low
- medium
type:string
status:
description:Status indicates the result of the policy rule check
enum:
- pass
- fail
- warn
- error
- skip
type:string
required:
- policy
type:object
type:array
scope:
description:Scope is an optional reference to the report scope (e.g.
a Deployment, Namespace, or Node)
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of an entire
object, this string should contain a valid JSON/Go field access
statement, such as desiredState.manifest.containers[2]. For example,
if the object reference is to a container within a pod, this would
take on a value like:"spec.containers{name}"(where "name" refers
to the name of the container that triggered the event) or if no
container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined
way of referencing a part of an object. TODO:this design is not
final and this field is subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference is
made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
scopeSelector:
description: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.
properties:
matchExpressions:
description:matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description:A label selector requirement is a selector that contains
values, a key, and an operator that relates the key and values.
properties:
key:
description:key is the label key that the selector applies
to.
type:string
operator:
description:operator represents a key's relationship to a set
of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type:string
values:
description:values is an array of string values. If the operator
is In or NotIn, the values array must be non-empty. If the
operator is Exists or DoesNotExist, the values array must
be empty. This array is replaced during a strategic merge
patch.
items:
type:string
type:array
required:
- key
- operator
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:matchLabels is a map of {key,value} pairs. A single {key,value}
in the matchLabels map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In", and the values array
contains only "value". The requirements are ANDed.
type:object
type:object
summary:
description:PolicyReportSummary provides a summary of results
properties:
error:
description:Error provides the count of policies that could not be
evaluated
type:integer
fail:
description:Fail provides the count of policies whose requirements
were not met
type:integer
pass:
description:Pass provides the count of policies whose requirements
were met
type:integer
skip:
description:Skip indicates the count of policies that were not selected
for evaluation
type:integer
warn:
description:Warn provides the count of unscored policies whose requirements
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
description:Key is the context entry (using JMESPath)
for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields:true
operator:
description:Operator is the operation to perform.
type:string
value:
description:Value is the conditional value, or
set of values. The values can be fixed set or
can be variables declared using using JMESPath.
x-kubernetes-preserve-unknown-fields:true
type:object
type:array
type:object
message:
description:Message specifies a custom message to be displayed
onfailure.
type:string
pattern:
description:Pattern specifies an overlay-style pattern
used to check resources.
x-kubernetes-preserve-unknown-fields:true
type:object
type:object
type:array
validationFailureAction:
description:ValidationFailureAction controls if a validation policy
rule failure should disallow the admission review request (enforce),
or allow (audit) the admission review request and report an error
in a policy report. Optional. The default value is "audit".
type:string
type:object
status:
description:Status contains policy runtime data.
properties:
averageExecutionTime:
description:AvgExecutionTime is the average time taken to process
the policy rules on a resource.
type:string
resourcesBlockedCount:
description:ResourcesBlockedCount is the total count of admission
review requests that were blocked by this policy.
type:integer
resourcesGeneratedCount:
description:ResourcesGeneratedCount is the total count of resources
that were generated by this policy.
type:integer
resourcesMutatedCount:
description:ResourcesMutatedCount is the total count of resources
that were mutated by this policy.
type:integer
ruleStatus:
description:Rules provides per rule statistics
items:
description:RuleStats provides statistics for an individual rule
within a policy.
properties:
appliedCount:
description:AppliedCount is the total number of times this
rule was applied.
type:integer
averageExecutionTime:
description:ExecutionTime is the average time taken to execute
this rule.
type:string
failedCount:
description:FailedCount is the total count of policy error
results for this rule.
type:integer
resourcesBlockedCount:
description:ResourcesBlockedCount is the total count of admission
review requests that were blocked by this rule.
type:integer
resourcesGeneratedCount:
description:ResourcesGeneratedCount is the total count of resources
that were generated by this rule.
type:integer
resourcesMutatedCount:
description:ResourcesMutatedCount is the total count of resources
that were mutated by this rule.
type:integer
ruleName:
description:Name is the rule name.
type:string
violationCount:
description:ViolationCount is the total count of policy failure
results for this rule.
type:integer
required:
- ruleName
type:object
type:array
rulesAppliedCount:
description:RulesAppliedCount is the total number of times this policy
was applied.
type:integer
rulesFailedCount:
description:RulesFailedCount is the total count of policy execution
errors for this policy.
type:integer
violationCount:
description:ViolationCount is the total count of policy failure results
for this policy.
type:integer
type:object
required:
- spec
type:object
served:true
storage:true
subresources:
status:{}
status:
acceptedNames:
kind:""
plural:""
conditions:[]
storedVersions:[]
---
apiVersion:apiextensions.k8s.io/v1
kind:CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version:v0.4.0
creationTimestamp:null
name:policyreports.wgpolicyk8s.io
spec:
group:wgpolicyk8s.io
names:
kind:PolicyReport
listKind:PolicyReportList
plural:policyreports
shortNames:
- polr
singular:policyreport
scope:Namespaced
versions:
- additionalPrinterColumns:
- jsonPath:.scope.kind
name:Kind
priority:1
type:string
- jsonPath:.scope.name
name:Name
priority:1
type:string
- jsonPath:.summary.pass
name:Pass
type:integer
- jsonPath:.summary.fail
name:Fail
type:integer
- jsonPath:.summary.warn
name:Warn
type:integer
- jsonPath:.summary.error
name:Error
type:integer
- jsonPath:.summary.skip
name:Skip
type:integer
- jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1alpha1
schema:
openAPIV3Schema:
description:PolicyReport is the Schema for the policyreports API
properties:
apiVersion:
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
metadata:
type:object
results:
description:PolicyReportResult provides result details
items:
description:PolicyReportResult provides the result for an individual
policy
properties:
category:
description:Category indicates policy category
type:string
data:
additionalProperties:
type:string
description:Data provides additional information for the policy
rule
type:object
message:
description:Message is a short user friendly description of the
description:ReportChangeRequest is the Schema for the ReportChangeRequests
API
properties:
apiVersion:
description:'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type:string
kind:
description:'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
metadata:
type:object
results:
description:PolicyReportResult provides result details
items:
description:PolicyReportResult provides the result for an individual
