text
stringlengths 1
1k
| id
int64 0
8.58k
|
---|---|
. You can fetch like this:
kubectl get --raw /debug/api_priority_and_fairness/dump_queues
The output will be in CSV and similar to this:
PriorityLevelName, Index, PendingRequests, ExecutingRequests, SeatsInUse,
NextDispatchR, InitialSeatsSum, MaxSeatsSum, TotalWorkSum
workload-low, 14, 27, 0, 0, 77.64342019ss, 270,
270, 0.81000000ss
workload-low, 74, 26, 0, 0, 76.95387841ss, 260,
260, 0.78000000ss
...
leader-election, 0, 0, 0, 0, 5088.87053833ss, 0, 0,
0.00000000ss
leader-election, 1, 0, 0, 0, 0.00000000ss, 0, 0,
0.00000000ss
...
workload-high, 0, 0, 0, 0, 0.00000000ss, 0, 0,
0.00000000ss
workload-high, 1, 0, | 7,400 |
0, 0, 1119.44936475ss, 0,
0, 0.00000000ss
Explanation for selected column names:
NextDispatchR : The R progress meter reading, in units of seat-seconds, at which
the next request will be dispatched.
InitialSeatsSum : The sum of InitialSeats associated with all requests in a given
queue.
MaxSeatsSum : The sum of MaxSeats associated with all requests in a given queue.
TotalWorkSum : The sum of total work, in units of seat-seconds, of all waiting
requests in a given queue.
Note: seat-second (abbreviate as ss) is a measure of work, in units of seat-seconds, in the
APF world.◦
•
◦
◦
◦
| 7,401 |
/debug/api_priority_and_fairness/dump_requests - a listing of all the requests including
requests waiting in a queue and requests being executing. You can fetch like this:
kubectl get --raw /debug/api_priority_and_fairness/dump_requests
The output will be in CSV and similar to this:
PriorityLevelName, FlowSchemaName, QueueIndex, RequestIndexInQueue,
FlowDistingsher, ArriveTime, InitialSeats, FinalSeats,
AdditionalLatency, StartTime
exempt, exempt, -1, -1, ,
2023-07-15T04:51:25.596404345Z, 1, 0, 0s,
2023-07-15T04:51:25.596404345Z
workload-low, service-accounts, 14, 0,
system:serviceaccount:default:loadtest, 2023-07-18T00:12:51.386556253Z, 10, 0,
0s, 0001-01-01T00:00:00Z
workload-low, service-accounts, 14, 1,
system:servicea | 7,402 |
ccount:default:loadtest, 2023-07-18T00:12:51.487092539Z, 10, 0,
0s, 0001-01-01T00:00:00Z
You can get a more detailed listing with a command like this:
kubectl get --raw '/debug/api_priority_and_fairness/dump_requests?
includeRequestDetails=1'
The output will be in CSV and similar to this:
PriorityLevelName, FlowSchemaName, QueueIndex, RequestIndexInQueue,
FlowDistingsher, ArriveTime, InitialSeats, FinalSeats,
AdditionalLatency, StartTime, UserName, Verb,
APIPath, Namespace, Name, APIVersion, Resource, SubResource
exempt, exempt, -1, -1, ,
2023-07-15T04:51:25.596404345Z, 1, 0, 0s,
2023-07-15T04:51:25.596404345Z, system:serviceaccount:system:admin, list, /api/v1/
namespaces/kube-stress/conf | 7,403 |
igmaps, kube-stress, , v1, configmaps,
workload-low, service-accounts, 14, 0,
system:serviceaccount:default:loadtest, 2023-07-18T00:13:08.986534842Z, 10, 0,
0s, 0001-01-01T00:00:00Z, system:serviceaccount:default:loadtest, list, /
api/v1/namespaces/kube-stress/configmaps, kube-stress, , v1, configmaps,
workload-low, service-accounts, 14, 1,
system:serviceaccount:default:loadtest, 2023-07-18T00:13:09.086476021Z, 10, 0,
0s, 0001-01-01T00:00:00Z, system:serviceaccount:default:loadtest, list, /
api/v1/namespaces/kube-stress/configmaps, kube-stress, , v1, configmaps,
Explanation for selected column names:
QueueIndex : The index of the queue. It will be -1 for priority levels without queues.
RequestIndexInQueue : The index in the queue for a given request. It will be -1 for
executing requests.
I | 7,404 |
nitialSeats : The number of seats will be occupied during the initial (normal) stage
of execution of the request.
FinalSeats : The number of seats will be occupied during the final stage of request
execution, accounting for the associated WATCH notifications.•
◦
◦
◦
| 7,405 |
AdditionalLatency : The extra time taken during the final stage of request execution.
FinalSeats will be occupied during this time period. It does not mean any latency
that a user will observe.
StartTime : The time a request starts to execute. It will be 0001-01-01T00:00:00Z for
queued requests.
Debug logging
At -v=3 or more verbosity, the API server outputs an httplog line for every request in the API
server log, and it includes the following attributes.
apf_fs : the name of the flow schema to which the request was classified.
apf_pl : the name of the priority level for that flow schema.
apf_iseats : the number of seats determined for the initial (normal) stage of execution of
the request.
apf_fseats : the number of seats determined for the final stage of execution (accounting for
the associated watch notifications) of the request.
apf_additionalLatency : the duration of the final stage of execution of the request.
At higher levels of verbosity there will be log lines exposing detail | 7,406 |
s of how APF handled the
request, primarily for debugging purposes.
Response headers
APF adds the following two headers to each HTTP response message. They won't appear in the
audit log. They can be viewed from the client side. For client using klog, use verbosity -v=8 or
higher to view these headers.
X-Kubernetes-PF-FlowSchema-UID holds the UID of the FlowSchema object to which the
corresponding request was classified.
X-Kubernetes-PF-PriorityLevel-UID holds the UID of the PriorityLevelConfiguration
object associated with that FlowSchema.
What's next
For background information on design details for API priority and fairness, see the
enhancement proposal .
Configuration APIs
Client Authentication (v1)
Client Authentication (v1beta1)
Event Rate Limit Configuration (v1alpha1)
Image Policy API (v1alpha1)◦
◦
•
•
•
•
•
•
| 7,407 |
kube-apiserver Admission (v1)
kube-apiserver Audit Configuration (v1)
kube-apiserver Configuration (v1)
kube-apiserver Configuration (v1alpha1)
kube-apiserver Configuration (v1beta1)
kube-apiserver Encryption Configuration (v1)
kube-controller-manager Configuration (v1alpha1)
kube-proxy Configuration (v1alpha1)
kube-scheduler Configuration (v1)
kubeadm Configuration (v1beta3)
kubeadm Configuration (v1beta4)
kubeconfig (v1)
Kubelet Configuration (v1)
Kubelet Configuration (v1alpha1)
Kubelet Configuration (v1beta1)
Kubelet CredentialProvider (v1)
WebhookAdmission Configuration (v1)
Client Authentication (v1)
Resource Types
ExecCredential
ExecCredential
ExecCredential is used by exec-based plugins to communicate credentials to HTTP transports.
Field Description
apiVersion
stringclient.authentication.k8s.io/v1
kind
stringExecCredential• | 7,408 |
Field Description
spec [Required]
ExecCredentialSpecSpec holds information passed to the plugin by the transport.
status
ExecCredentialStatusStatus is filled in by the plugin and holds the credentials that the
transport should use to contact the API.
Cluster
Appears in:
ExecCredentialSpec
Cluster contains information to allow an exec plugin to communicate with the kubernetes
cluster being authenticated to.
To ensure that this struct contains everything someone would need to communicate with a
kubernetes cluster (just like they would via a kubeconfig), the fields should shadow "k8s.io/
client-go/tools/clientcmd/api/v1".Cluster, with the exception of CertificateAuthority, since CA
data will always be passed to the plugin as bytes.
Field Description
server [Required]
stringServer is the address of the kubernetes cluster (https://
hostname:port).
tls-server-name
stringTLSServerName is passed to the server for SNI and is used in the
client to check server certificates against. If ServerNam | 7,409 |
e is empty, the
hostname used to contact the server is used.
insecure-skip-tls-verify
boolInsecureSkipTLSVerify skips the validity check for the server's
certificate. This will make your HTTPS connections insecure.
certificate-authority-
data
[]byteCAData contains PEM-encoded certificate authority certificates. If
empty, system roots should be used.
proxy-url
stringProxyURL is the URL to the proxy to be used for all requests to this
cluster.
disable-compression
boolDisableCompression allows client to opt-out of response compression
for all requests to the server. This is useful to speed up requests
(specifically lists) when client-server network bandwidth is ample, by
saving time on compression (server-side) and decompression (client-
side): https://github.com/kubernetes/kubernetes/issues/112296. | 7,410 |
Field Description
config
k8s.io/apimachinery/
pkg/
runtime.RawExtensionConfig holds additional config data that is specific to the exec plugin
with regards to the cluster being authenticated to.
This data is sourced from the clientcmd Cluster object's
extensions[client.authentication.k8s.io/exec] field:
clusters:
name: my-cluster cluster: ... extensions:
name: client.authentication.k8s.io/exec # reserved
extension name for per cluster exec config extension:
audience: 06e3fbd18de8 # arbitrary config
In some environments, the user config may be exactly the same
across many clusters (i.e. call this exec plugin) minus some details
that are specific to each cluster such as the audience. This field allows
the per cluster config to be directly specified with the cluster info.
Using this field to store secret data is not recommended as one of the
prime benefits of exec plugins is that no secrets need to be stored
directly in the kubeconfig.
ExecCredentialSpec
Appears in:
ExecCredential
ExecCre | 7,411 |
dentialSpec holds request and runtime specific information provided by the transport.
Field Description
cluster
ClusterCluster contains information to allow an exec plugin to communicate with the
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
when provideClusterInfo is set to true in the exec provider config (i.e.,
ExecConfig.ProvideClusterInfo).
interactive
[Required]
boolInteractive declares whether stdin has been passed to this exec plugin.
ExecCredentialStatus
Appears in:
ExecCredential
ExecCredentialStatus holds credentials for the transport to use.•
◦
•
| 7,412 |
Token and ClientKeyData are sensitive fields. This data should only be transmitted in-memory
between client and exec plugin process. Exec plugin itself should at least be protected via file
permissions.
Field Description
expirationTimestamp
meta/v1.TimeExpirationTimestamp indicates a time when the provided
credentials expire.
token [Required]
stringToken is a bearer token used by the client for request
authentication.
clientCertificateData
[Required]
stringPEM-encoded client TLS certificates (including intermediates, if
any).
clientKeyData [Required]
stringPEM-encoded private key for the above certificate.
Client Authentication (v1beta1)
Resource Types
ExecCredential
ExecCredential
ExecCredential is used by exec-based plugins to communicate credentials to HTTP transports.
Field Description
apiVersion
stringclient.authentication.k8s.io/v1beta1
kind
stringExecCredential
spec [Required]
ExecCredentialSpecSpec holds information passed to the plugin by the transport.
status
ExecCredenti | 7,413 |
alStatusStatus is filled in by the plugin and holds the credentials that the
transport should use to contact the API.
Cluster
Appears in:
ExecCredentialSpec•
| 7,414 |
Cluster contains information to allow an exec plugin to communicate with the kubernetes
cluster being authenticated to.
To ensure that this struct contains everything someone would need to communicate with a
kubernetes cluster (just like they would via a kubeconfig), the fields should shadow "k8s.io/
client-go/tools/clientcmd/api/v1".Cluster, with the exception of CertificateAuthority, since CA
data will always be passed to the plugin as bytes.
Field Description
server [Required]
stringServer is the address of the kubernetes cluster (https://
hostname:port).
tls-server-name
stringTLSServerName is passed to the server for SNI and is used in the
client to check server certificates against. If ServerName is empty, the
hostname used to contact the server is used.
insecure-skip-tls-verify
boolInsecureSkipTLSVerify skips the validity check for the server's
certificate. This will make your HTTPS connections insecure.
certificate-authority-
data
[]byteCAData contains PEM-encoded certificate a | 7,415 |
uthority certificates. If
empty, system roots should be used.
proxy-url
stringProxyURL is the URL to the proxy to be used for all requests to this
cluster.
disable-compression
boolDisableCompression allows client to opt-out of response compression
for all requests to the server. This is useful to speed up requests
(specifically lists) when client-server network bandwidth is ample, by
saving time on compression (server-side) and decompression (client-
side): https://github.com/kubernetes/kubernetes/issues/112296.
config
k8s.io/apimachinery/
pkg/
runtime.RawExtensionConfig holds additional config data that is specific to the exec plugin
with regards to the cluster being authenticated to.
This data is sourced from the clientcmd Cluster object's
extensions[client.authentication.k8s.io/exec] field:
clusters:
name: my-cluster cluster: ... extensions:
name: client.authentication.k8s.io/exec # reserved
extension name for per cluster exec config extension:
audience: 06e3fbd18de8 # arbitrary con | 7,416 |
fig
In some environments, the user config may be exactly the same
across many clusters (i.e. call this exec plugin) minus some details
that are specific to each cluster such as the audience. This field allows•
| 7,417 |
Field Description
the per cluster config to be directly specified with the cluster info.
Using this field to store secret data is not recommended as one of the
prime benefits of exec plugins is that no secrets need to be stored
directly in the kubeconfig.
ExecCredentialSpec
Appears in:
ExecCredential
ExecCredentialSpec holds request and runtime specific information provided by the transport.
Field Description
cluster
ClusterCluster contains information to allow an exec plugin to communicate with the
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
when provideClusterInfo is set to true in the exec provider config (i.e.,
ExecConfig.ProvideClusterInfo).
interactive
[Required]
boolInteractive declares whether stdin has been passed to this exec plugin.
ExecCredentialStatus
Appears in:
ExecCredential
ExecCredentialStatus holds credentials for the transport to use.
Token and ClientKeyData are sensitive fields. This data should only be transmitted in-memory
betwe | 7,418 |
en client and exec plugin process. Exec plugin itself should at least be protected via file
permissions.
Field Description
expirationTimestamp
meta/v1.TimeExpirationTimestamp indicates a time when the provided
credentials expire.
token [Required]
stringToken is a bearer token used by the client for request
authentication.
clientCertificateData
[Required]
stringPEM-encoded client TLS certificates (including intermediates, if
any).•
| 7,419 |
Field Description
clientKeyData [Required]
stringPEM-encoded private key for the above certificate.
Event Rate Limit Configuration (v1alpha1)
Resource Types
Configuration
Configuration
Configuration provides configuration for the EventRateLimit admission controller.
Field Description
apiVersion
stringeventratelimit.admission.k8s.io/v1alpha1
kind
stringConfiguration
limits
[Required]
[]Limitlimits are the limits to place on event queries received. Limits can be placed on
events received server-wide, per namespace, per user, and per source+object. At
least one limit is required.
Limit
Appears in:
Configuration
Limit is the configuration for a particular limit type
Field Description
type
[Required]
LimitTypetype is the type of limit to which this configuration applies
qps
[Required]
int32qps is the number of event queries per second that are allowed for this type of
limit. The qps and burst fields are used together to determine if a particular event
query is accepted. The qps determi | 7,420 |
nes how many queries are accepted once the
burst amount of queries has been exhausted.
burst
[Required]
int32burst is the burst number of event queries that are allowed for this type of limit.
The qps and burst fields are used together to determine if a particular event query
is accepted. The burst determines the maximum size of the allowance granted for
a particular bucket. For example, if the burst is 10 and the qps is 3, then the•
| 7,421 |
Field Description
admission control will accept 10 queries before blocking any queries. Every
second, 3 more queries will be allowed. If some of that allowance is not used, then
it will roll over to the next second, until the maximum allowance of 10 is reached.
cacheSize
int32cacheSize is the size of the LRU cache for this type of limit. If a bucket is evicted
from the cache, then the allowance for that bucket is reset. If more queries are
later received for an evicted bucket, then that bucket will re-enter the cache with
a clean slate, giving that bucket a full allowance of burst queries.
The default cache size is 4096.
If limitType is 'server', then cacheSize is ignored.
LimitType
(Alias of string )
Appears in:
Limit
LimitType is the type of the limit (e.g., per-namespace)
Image Policy API (v1alpha1)
Resource Types
ImageReview
ImageReview
ImageReview checks if the set of images in a pod are allowed.
Field Description
apiVersion
stringimagepolicy.k8s.io/v1alpha1
kind
stringImageReview | 7,422 |
metadata
meta/
v1.ObjectMetaStandard object's metadata. More info: https://git.k8s.io/community/
contributors/devel/sig-architecture/api-conventions.md#metadata
Refer to the Kubernetes API documentation for the fields of the metadata
field.
spec [Required]
ImageReviewSpecSpec holds information about the pod being evaluated•
| 7,423 |
Field Description
status
ImageReviewStatusStatus is filled in by the backend and indicates whether the pod should be
allowed.
ImageReviewContainerSpec
Appears in:
ImageReviewSpec
ImageReviewContainerSpec is a description of a container within the pod creation request.
Field Description
image
stringThis can be in the form image:tag or image@SHA:012345679abcdef.
ImageReviewSpec
Appears in:
ImageReview
ImageReviewSpec is a description of the pod creation request.
Field Description
containers
[]ImageReviewContainerSpecContainers is a list of a subset of the information in each
container of the Pod being created.
annotations
map[string]stringAnnotations is a list of key-value pairs extracted from the Pod's
annotations. It only includes keys which match the pattern
*.image-policy.k8s.io/* . It is up to each webhook backend to
determine how to interpret these annotations, if at all.
namespace
stringNamespace is the namespace the pod is being created in.
ImageReviewStatus
Appears in:
ImageRev | 7,424 |
iew
ImageReviewStatus is the result of the review for the pod creation request.•
•
| 7,425 |
Field Description
allowed
[Required]
boolAllowed indicates that all images were allowed to be run.
reason
stringReason should be empty unless Allowed is false in which case it may
contain a short description of what is wrong. Kubernetes may truncate
excessively long errors when displaying to the user.
auditAnnotations
map[string]stringAuditAnnotations will be added to the attributes object of the admission
controller request using 'AddAnnotation'. The keys should be prefix-less
(i.e., the admission controller will add an appropriate prefix).
kube-apiserver Admission (v1)
Resource Types
AdmissionReview
AdmissionReview
AdmissionReview describes an admission review request/response.
Field Description
apiVersion
stringadmission.k8s.io/v1
kind
stringAdmissionReview
request
AdmissionRequestRequest describes the attributes for the admission request.
response
AdmissionResponseResponse describes the attributes for the admission response.
AdmissionRequest
Appears in:
AdmissionReview
AdmissionR | 7,426 |
equest describes the admission.Attributes for the admission request.
Field Description
uid [Required]
k8s.io/apimachinery/pkg/
types.UIDUID is an identifier for the individual request/response. It allows us
to distinguish instances of requests which are otherwise identical•
| 7,427 |
Field Description
(parallel requests, requests when earlier requests did not modify
etc) The UID is meant to track the round trip (request/response)
between the KAS and the WebHook, not the user request. It is
suitable for correlating log entries between the webhook and
apiserver, for either auditing or debugging.
kind [Required]
meta/v1.GroupVersionKindKind is the fully-qualified type of object being submitted (for
example, v1.Pod or autoscaling.v1.Scale)
resource [Required]
meta/
v1.GroupVersionResourceResource is the fully-qualified resource being requested (for
example, v1.pods)
subResource
stringSubResource is the subresource being requested, if any (for
example, "status" or "scale")
requestKind
meta/v1.GroupVersionKindRequestKind is the fully-qualified type of the original API request
(for example, v1.Pod or autoscaling.v1.Scale). If this is specified and
differs from the value in "kind", an equivalent match and
conversion was performed.
For example, if deployments can be modifi | 7,428 |
ed via apps/v1 and apps/
v1beta1, and a webhook registered a rule of apiGroups:["apps"],
apiVersions:["v1"], resources: ["deployments"] and matchPolicy:
Equivalent , an API request to apps/v1beta1 deployments would be
converted and sent to the webhook with kind: {group:"apps",
version:"v1", kind:"Deployment"} (matching the rule the webhook
registered for), and requestKind: {group:"apps", version:"v1beta1",
kind:"Deployment"} (indicating the kind of the original API
request).
See documentation for the "matchPolicy" field in the webhook
configuration type for more details.
requestResource
meta/
v1.GroupVersionResourceRequestResource is the fully-qualified resource of the original API
request (for example, v1.pods). If this is specified and differs from
the value in "resource", an equivalent match and conversion was
performed.
For example, if deployments can be modified via apps/v1 and apps/
v1beta1, and a webhook registered a rule of apiGroups:["apps"],
apiVersions:["v1"], resour | 7,429 |
ces: ["deployments"] and matchPolicy:
Equivalent , an API request to apps/v1beta1 deployments would be
converted and sent to the webhook with resource: {group:"apps",
version:"v1", resource:"deployments"} (matching the resource the
webhook registered for), and requestResource: {group:"apps",
version:"v1beta1", resource:"deployments"} (indicating the resource
of the original API request) | 7,430 |
Field Description
See documentation for the "matchPolicy" field in the webhook
configuration type.
requestSubResource
stringRequestSubResource is the name of the subresource of the original
API request, if any (for example, "status" or "scale") If this is
specified and differs from the value in "subResource", an equivalent
match and conversion was performed. See documentation for the
"matchPolicy" field in the webhook configuration type.
name
stringName is the name of the object as presented in the request. On a
CREATE operation, the client may omit name and rely on the
server to generate the name. If that is the case, this field will
contain an empty string.
namespace
stringNamespace is the namespace associated with the request (if any).
operation [Required]
OperationOperation is the operation being performed. This may be different
than the operation requested. e.g. a patch can result in either a
CREATE or UPDATE Operation.
userInfo [Required]
authentication/v1.UserInfoUserInfo is i | 7,431 |
nformation about the requesting user
object
k8s.io/apimachinery/pkg/
runtime.RawExtensionObject is the object from the incoming request.
oldObject
k8s.io/apimachinery/pkg/
runtime.RawExtensionOldObject is the existing object. Only populated for DELETE and
UPDATE requests.
dryRun
boolDryRun indicates that modifications will definitely not be persisted
for this request. Defaults to false.
options
k8s.io/apimachinery/pkg/
runtime.RawExtensionOptions is the operation option structure of the operation being
performed. e.g. meta.k8s.io/v1.DeleteOptions or meta.k8s.io/
v1.CreateOptions . This may be different than the options the caller
provided. e.g. for a patch request the performed Operation might
be a CREATE, in which case the Options will a meta.k8s.io/
v1.CreateOptions even though the caller provided meta.k8s.io/
v1.PatchOptions | 7,432 |
AdmissionResponse
Appears in:
AdmissionReview
AdmissionResponse describes an admission response.
Field Description
uid [Required]
k8s.io/
apimachinery/pkg/
types.UIDUID is an identifier for the individual request/response. This must be
copied over from the corresponding AdmissionRequest.
allowed
[Required]
boolAllowed indicates whether or not the admission request was permitted.
status
meta/v1.StatusResult contains extra details into why an admission request was denied.
This field IS NOT consulted in any way if "Allowed" is "true".
patch
[]byteThe patch body. Currently we only support "JSONPatch" which
implements RFC 6902.
patchType
PatchTypeThe type of Patch. Currently we only allow "JSONPatch".
auditAnnotations
map[string]stringAuditAnnotations is an unstructured key value map set by remote
admission controller (e.g. error=image-blacklisted).
MutatingAdmissionWebhook and ValidatingAdmissionWebhook
admission controller will prefix the keys with admission webhook name
(e.g. imagepoli | 7,433 |
cy.example.com/error=image-blacklisted). AuditAnnotations
will be provided by the admission webhook to add additional context to
the audit log for this request.
warnings
[]stringwarnings is a list of warning messages to return to the requesting API
client. Warning messages describe a problem the client making the API
request should correct or be aware of. Limit warnings to 120 characters if
possible. Warnings over 256 characters and large numbers of warnings
may be truncated.
Operation
(Alias of string )
Appears in:
AdmissionRequest•
| 7,434 |
Operation is the type of resource operation being checked for admission control
PatchType
(Alias of string )
Appears in:
AdmissionResponse
PatchType is the type of patch being used to represent the mutated object
kube-apiserver Audit Configuration (v1)
Resource Types
Event
EventList
Policy
PolicyList
Event
Appears in:
EventList
Event captures all the information that can be included in an API audit log.
Field Description
apiVersion
stringaudit.k8s.io/v1
kind
stringEvent
level [Required]
LevelAuditLevel at which event was generated
auditID [Required]
k8s.io/apimachinery/pkg/
types.UIDUnique audit ID, generated for each request.
stage [Required]
StageStage of the request handling when this event instance was
generated.
requestURI [Required]
stringRequestURI is the request URI as sent by the client to a server.•
•
•
•
•
• | 7,435 |
Field Description
verb [Required]
stringVerb is the kubernetes verb associated with the request. For non-
resource requests, this is the lower-cased HTTP method.
user [Required]
authentication/v1.UserInfoAuthenticated user information.
impersonatedUser
authentication/v1.UserInfoImpersonated user information.
sourceIPs
[]stringSource IPs, from where the request originated and intermediate
proxies. The source IPs are listed from (in order):
X-Forwarded-For request header IPs
X-Real-Ip header, if not present in the X-Forwarded-For list
The remote address for the connection, if it doesn't match
the last IP in the list up to here (X-Forwarded-For or X-Real-
Ip). Note: All but the last IP can be arbitrarily set by the
client.
userAgent
stringUserAgent records the user agent string reported by the client.
Note that the UserAgent is provided by the client, and must not be
trusted.
objectRef
ObjectReferenceObject reference this request is targeted at. Does not apply for
List-type requests, or n | 7,436 |
on-resource requests.
responseStatus
meta/v1.StatusThe response status, populated even when the ResponseObject is
not a Status type. For successful responses, this will only include
the Code and StatusSuccess. For non-status type error responses,
this will be auto-populated with the error Message.
requestObject
k8s.io/apimachinery/pkg/
runtime.UnknownAPI object from the request, in JSON format. The RequestObject is
recorded as-is in the request (possibly re-encoded as JSON), prior
to version conversion, defaulting, admission or merging. It is an
external versioned object type, and may not be a valid object on
its own. Omitted for non-resource requests. Only logged at
Request Level and higher.
responseObject
k8s.io/apimachinery/pkg/
runtime.UnknownAPI object returned in the response, in JSON. The ResponseObject
is recorded after conversion to the external type, and serialized as
JSON. Omitted for non-resource requests. Only logged at
Response Level.
requestReceivedTimestamp
meta/v1.Micr | 7,437 |
oTimeTime the request reached the apiserver.1.
2.
3 | 7,438 |
Field Description
stageTimestamp
meta/v1.MicroTimeTime the request reached current audit stage.
annotations
map[string]stringAnnotations is an unstructured key value map stored with an
audit event that may be set by plugins invoked in the request
serving chain, including authentication, authorization and
admission plugins. Note that these annotations are for the audit
event, and do not correspond to the metadata.annotations of the
submitted object. Keys should uniquely identify the informing
component to avoid name collisions (e.g.
podsecuritypolicy.admission.k8s.io/policy). Values should be
short. Annotations are included in the Metadata level.
EventList
EventList is a list of audit Events.
Field Description
apiVersion
stringaudit.k8s.io/v1
kind
stringEventList
metadata
meta/v1.ListMetaNo description provided.
items [Required]
[]EventNo description provided.
Policy
Appears in:
PolicyList
Policy defines the configuration of audit logging, and the rules for how different request
catego | 7,439 |
ries are logged.
Field Description
apiVersion
stringaudit.k8s.io/v1
kind
stringPolicy
metadata
meta/
v1.ObjectMetaObjectMeta is included for interoperability with API infrastructure.
Refer to the Kubernetes API documentation for the fields of the metadata
field. | 7,440 |
Field Description
rules [Required]
[]PolicyRuleRules specify the audit Level a request should be recorded at. A request
may match multiple rules, in which case the FIRST matching rule is used.
The default audit level is None, but can be overridden by a catch-all rule at
the end of the list. PolicyRules are strictly ordered.
omitStages
[]StageOmitStages is a list of stages for which no events are created. Note that
this can also be specified per rule in which case the union of both are
omitted.
omitManagedFields
boolOmitManagedFields indicates whether to omit the managed fields of the
request and response bodies from being written to the API audit log. This
is used as a global default - a value of 'true' will omit the managed fileds,
otherwise the managed fields will be included in the API audit log. Note
that this can also be specified per rule in which case the value specified in
a rule will override the global default.
PolicyList
PolicyList is a list of audit Policies.
Field Descrip | 7,441 |
tion
apiVersion
stringaudit.k8s.io/v1
kind
stringPolicyList
metadata
meta/v1.ListMetaNo description provided.
items [Required]
[]PolicyNo description provided.
GroupResources
Appears in:
PolicyRule
GroupResources represents resource kinds in an API group.
Field Description
group
stringGroup is the name of the API group that contains the resources. The empty
string represents the core API group.
resources
[]stringResources is a list of resources this rule applies to. | 7,442 |
Field Description
For example:
pods matches pods.
pods/log matches the log subresource of pods.
* matches all resources and their subresources.
pods/* matches all subresources of pods.
*/scale matches all scale subresources.
If wildcard is present, the validation rule will ensure resources do not overlap
with each other.
An empty list implies all resources and subresources in this API groups apply.
resourceNames
[]stringResourceNames is a list of resource instance names that the policy matches.
Using this field requires Resources to be specified. An empty list implies that
every instance of the resource is matched.
Level
(Alias of string )
Appears in:
Event
PolicyRule
Level defines the amount of information logged during auditing
ObjectReference
Appears in:
Event
ObjectReference contains enough information to let you inspect or modify the referred object.
Field Description
resource
stringNo description provided.
namespace
stringNo description provided.
name
stringNo description pro | 7,443 |
vided.
uid
k8s.io/apimachinery/pkg/
types.UIDNo description provided.•
•
•
•
•
•
•
| 7,444 |
Field Description
apiGroup
stringAPIGroup is the name of the API group that contains the referred
object. The empty string represents the core API group.
apiVersion
stringAPIVersion is the version of the API group that contains the referred
object.
resourceVersion
stringNo description provided.
subresource
stringNo description provided.
PolicyRule
Appears in:
Policy
PolicyRule maps requests based off metadata to an audit Level. Requests must match the rules
of every field (an intersection of rules).
Field Description
level [Required]
LevelThe Level that requests matching this rule are recorded at.
users
[]stringThe users (by authenticated user name) this rule applies to. An empty list
implies every user.
userGroups
[]stringThe user groups this rule applies to. A user is considered matching if it is a
member of any of the UserGroups. An empty list implies every user group.
verbs
[]stringThe verbs that match this rule. An empty list implies every verb.
resources
[]GroupResourcesResource | 7,445 |
s that this rule matches. An empty list implies all kinds in all API
groups.
namespaces
[]stringNamespaces that this rule matches. The empty string "" matches non-
namespaced resources. An empty list implies every namespace.
nonResourceURLs
[]stringNonResourceURLs is a set of URL paths that should be audited. *s are
allowed, but only as the full, final step in the path. Examples:
/metrics - Log requests for apiserver metrics
/healthz* - Log all health checks•
•
| 7,446 |
Field Description
omitStages
[]StageOmitStages is a list of stages for which no events are created. Note that this
can also be specified policy wide in which case the union of both are
omitted. An empty list means no restrictions will apply.
omitManagedFields
boolOmitManagedFields indicates whether to omit the managed fields of the
request and response bodies from being written to the API audit log.
a value of 'true' will drop the managed fields from the API audit log
a value of 'false' indicates that the managed fileds should be included
in the API audit log Note that the value, if specified, in this rule will
override the global default If a value is not specified then the global
default specified in Policy.OmitManagedFields will stand.
Stage
(Alias of string )
Appears in:
Event
Policy
PolicyRule
Stage defines the stages in request handling that audit events may be generated.
kube-apiserver Configuration (v1)
Package v1 is the v1 version of the API.
Resource Types
AdmissionConfigurat | 7,447 |
ion
AdmissionConfiguration
AdmissionConfiguration provides versioned configuration for admission controllers.
Field Description
apiVersion
stringapiserver.config.k8s.io/v1
kind
stringAdmissionConfiguration
plugins
[]AdmissionPluginConfiguration•
•
•
•
•
| 7,448 |
Field Description
Plugins allows specifying a configuration per admission
control plugin.
AdmissionPluginConfiguration
Appears in:
AdmissionConfiguration
AdmissionPluginConfiguration provides the configuration for a single plug-in.
Field Description
name [Required]
stringName is the name of the admission controller. It must match the
registered admission plugin name.
path
stringPath is the path to a configuration file that contains the plugin's
configuration
configuration
k8s.io/apimachinery/pkg/
runtime.UnknownConfiguration is an embedded configuration object to be used as
the plugin's configuration. If present, it will be used instead of the
path to the configuration file.
kube-apiserver Configuration (v1alpha1)
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types
AdmissionConfiguration
AuthenticationConfiguration
AuthorizationConfiguration
EgressSelectorConfiguration
TracingConfiguration
TracingConfiguration
Appears in:
KubeletConfiguration
TracingConfiguration
Traci | 7,449 |
ngConfiguration provides versioned configuration for OpenTelemetry tracing clients.•
•
•
•
•
•
•
| 7,450 |
Field Description
endpoint
stringEndpoint of the collector this component will report traces to. The
connection is insecure, and does not currently support TLS.
Recommended is unset, and endpoint is the otlp grpc default,
localhost:4317.
samplingRatePerMillion
int32SamplingRatePerMillion is the number of samples to collect per
million spans. Recommended is unset. If unset, sampler respects its
parent span's sampling rate, but otherwise never samples.
AdmissionConfiguration
AdmissionConfiguration provides versioned configuration for admission controllers.
Field Description
apiVersion
stringapiserver.k8s.io/v1alpha1
kind
stringAdmissionConfiguration
plugins
[]AdmissionPluginConfigurationPlugins allows specifying a configuration per admission
control plugin.
AuthenticationConfiguration
AuthenticationConfiguration provides versioned configuration for authentication.
Field Description
apiVersion
stringapiserver.k8s.io/v1alpha1
kind
stringAuthenticationConfiguration
jwt [Required]
[]JWTAuthe | 7,451 |
nticatorjwt is a list of authenticator to authenticate Kubernetes users using JWT
compliant tokens. The authenticator will attempt to parse a raw ID token,
verify it's been signed by the configured issuer. The public key to verify
the signature is discovered from the issuer's public endpoint using OIDC
discovery. For an incoming token, each JWT authenticator will be
attempted in the order in which it is specified in this list. Note however
that other authenticators may run before or after the JWT authenticators.
The specific position of JWT authenticators in relation to other
authenticators is neither defined nor stable across releases. Since each
JWT authenticator must have a unique issuer URL, at most one JWT
authenticator will attempt to cryptographically validate the token | 7,452 |
AuthorizationConfiguration
Field Description
apiVersion
stringapiserver.k8s.io/v1alpha1
kind
stringAuthorizationConfiguration
authorizers [Required]
[]AuthorizerConfigurationAuthorizers is an ordered list of authorizers to authorize requests
against. This is similar to the --authorization-modes kube-apiserver
flag Must be at least one.
EgressSelectorConfiguration
EgressSelectorConfiguration provides versioned configuration for egress selector clients.
Field Description
apiVersion
stringapiserver.k8s.io/v1alpha1
kind
stringEgressSelectorConfiguration
egressSelections
[Required]
[]EgressSelectionconnectionServices contains a list of egress selection client
configurations
TracingConfiguration
TracingConfiguration provides versioned configuration for tracing clients.
Field Description
apiVersion
stringapiserver.k8s.io/v1alpha1
kind
stringTracingConfiguration
TracingConfiguration
[Required]
TracingConfiguration(Members of TracingConfiguration are embedded into this
type.)
Embed the co | 7,453 |
mponent config tracing configuration struct
AdmissionPluginConfiguration
Appears in:
AdmissionConfiguration
AdmissionPluginConfiguration provides the configuration for a single plug-in. | 7,454 |
Field Description
name [Required]
stringName is the name of the admission controller. It must match the
registered admission plugin name.
path
stringPath is the path to a configuration file that contains the plugin's
configuration
configuration
k8s.io/apimachinery/pkg/
runtime.UnknownConfiguration is an embedded configuration object to be used as
the plugin's configuration. If present, it will be used instead of the
path to the configuration file.
AuthorizerConfiguration
Appears in:
AuthorizationConfiguration
Field Description
type [Required]
stringType refers to the type of the authorizer "Webhook" is supported in the
generic API server Other API servers may support additional
authorizer types like Node, RBAC, ABAC, etc.
name [Required]
stringName used to describe the webhook This is explicitly used in
monitoring machinery for metrics Note: Names must be DNS1123
labels like myauthorizername or subdomains like
myauthorizer.example.domain Required, with no default
webhook [Require | 7,455 |
d]
WebhookConfigurationWebhook defines the configuration for a Webhook authorizer Must be
defined when Type=Webhook Must not be defined when Type!
=Webhook
ClaimMappings
Appears in:
JWTAuthenticator
ClaimMappings provides the configuration for claim mapping
Field Description
username [Required]
PrefixedClaimOrExpressionusername represents an option for the username attribute. The
claim's value must be a singular string. Same as the --oidc-
username-claim and --oidc-username-prefix flags. If•
| 7,456 |
Field Description
username.expression is set, the expression must produce a string
value.
In the flag based approach, the --oidc-username-claim and --oidc-
username-prefix are optional. If --oidc-username-claim is not set,
the default value is "sub". For the authentication config, there is no
defaulting for claim or prefix. The claim and prefix must be set
explicitly. For claim, if --oidc-username-claim was not set with
legacy flag approach, configure username.claim="sub" in the
authentication config. For prefix: (1) --oidc-username-prefix="-", no
prefix was added to the username. For the same behavior using
authentication config, set username.prefix="" (2) --oidc-username-
prefix="" and --oidc-username-claim != "email", prefix was "<value
of --oidc-issuer-url>#". For the same behavior using authentication
config, set username.prefix="#" (3) --oidc-username-prefix="". For
the same behavior using authentication config, set
username.prefix=""
groups
PrefixedClaimOrExpressiongroups repres | 7,457 |
ents an option for the groups attribute. The claim's
value must be a string or string array claim. If groups.claim is set,
the prefix must be specified (and can be the empty string). If
groups.expression is set, the expression must produce a string or
string array value. "", [], and null values are treated as the group
mapping not being present.
uid
ClaimOrExpressionuid represents an option for the uid attribute. Claim must be a
singular string claim. If uid.expression is set, the expression must
produce a string value.
extra
[]ExtraMappingextra represents an option for the extra attribute. expression must
produce a string or string array value. If the value is empty, the
extra mapping will not be present.
hard-coded extra key/value
key: "foo" valueExpression: "'bar'" This will result in an extra
attribute - foo: ["bar"]
hard-coded key, value copying claim value
key: "foo" valueExpression: "claims.some_claim" This will
result in an extra attribute - foo: [value of some_claim]
hard-code | 7,458 |
d key, value derived from claim value
key: "admin" valueExpression: '(has(claims.is_admin) &&
claims.is_admin) ? "true":""' This will result in:
if is_admin claim is present and true, extra attribute - admin:
["true"]•
•
•
| 7,459 |
Field Description
if is_admin claim is present and false or is_admin claim is
not present, no extra attribute will be added
ClaimOrExpression
Appears in:
ClaimMappings
ClaimOrExpression provides the configuration for a single claim or expression.
Field Description
claim
stringclaim is the JWT claim to use. Either claim or expression must be set. Mutually
exclusive with expression.
expression
stringexpression represents the expression which will be evaluated by CEL.
CEL expressions have access to the contents of the token claims, organized into
CEL variable:
'claims' is a map of claim names to claim values. For example, a variable
named 'sub' can be accessed as 'claims.sub'. Nested claims can be accessed
using dot notation, e.g. 'claims.email.verified'.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Mutually exclusive with claim.
ClaimValidationRule
Appears in:
JWTAuthenticator
ClaimValidationRule provides the configuration for a single claim validation rule.
| 7,460 |
Field Description
claim
stringclaim is the name of a required claim. Same as --oidc-required-claim flag. Only
string claim keys are supported. Mutually exclusive with expression and
message.•
•
•
| 7,461 |
Field Description
requiredValue
stringrequiredValue is the value of a required claim. Same as --oidc-required-claim
flag. Only string claim values are supported. If claim is set and requiredValue is
not set, the claim must be present with a value set to the empty string. Mutually
exclusive with expression and message.
expression
stringexpression represents the expression which will be evaluated by CEL. Must
produce a boolean.
CEL expressions have access to the contents of the token claims, organized into
CEL variable:
'claims' is a map of claim names to claim values. For example, a variable
named 'sub' can be accessed as 'claims.sub'. Nested claims can be accessed
using dot notation, e.g. 'claims.email.verified'. Must return true for the
validation to pass.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Mutually exclusive with claim and requiredValue.
message
stringmessage customizes the returned error message when expression returns false.
message is a liter | 7,462 |
al string. Mutually exclusive with claim and requiredValue.
Connection
Appears in:
EgressSelection
Connection provides the configuration for a single egress selection client.
Field Description
proxyProtocol
[Required]
ProtocolTypeProtocol is the protocol used to connect from client to the konnectivity
server.
transport
TransportTransport defines the transport configurations we use to dial to the
konnectivity server. This is required if ProxyProtocol is HTTPConnect or
GRPC.
EgressSelection
Appears in:
EgressSelectorConfiguration•
•
| 7,463 |
EgressSelection provides the configuration for a single egress selection client.
Field Description
name
[Required]
stringname is the name of the egress selection. Currently supported values are
"controlplane", "master", "etcd" and "cluster" The "master" egress selector is
deprecated in favor of "controlplane"
connection
[Required]
Connectionconnection is the exact information used to configure the egress selection
ExtraMapping
Appears in:
ClaimMappings
ExtraMapping provides the configuration for a single extra mapping.
Field Description
key [Required]
stringkey is a string to use as the extra attribute key. key must be a domain-prefix
path (e.g. example.org/foo). All characters before the first "/" must be a valid
subdomain as defined by RFC 1123. All characters trailing the first "/" must
be valid HTTP Path characters as defined by RFC 3986. key must be
lowercase.
valueExpression
[Required]
stringvalueExpression is a CEL expression to extract extra attribute value.
valueExpressi | 7,464 |
on must produce a string or string array value. "", [], and null
values are treated as the extra mapping not being present. Empty string
values contained within a string array are filtered out.
CEL expressions have access to the contents of the token claims, organized
into CEL variable:
'claims' is a map of claim names to claim values. For example, a
variable named 'sub' can be accessed as 'claims.sub'. Nested claims can
be accessed using dot notation, e.g. 'claims.email.verified'.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Issuer
Appears in:
JWTAuthenticator
Issuer provides the configuration for a external provider specific settings.•
•
| 7,465 |
Field Description
url [Required]
stringurl points to the issuer URL in a format https://url or https://url/path. This
must match the "iss" claim in the presented JWT, and the issuer returned
from discovery. Same value as the --oidc-issuer-url flag. Used to fetch
discovery information unless overridden by discoveryURL. Required to be
unique. Note that egress selection configuration is not used for this
network connection.
certificateAuthority
stringcertificateAuthority contains PEM-encoded certificate authority
certificates used to validate the connection when fetching discovery
information. If unset, the system verifier is used. Same value as the
content of the file referenced by the --oidc-ca-file flag.
audiences
[Required]
[]stringaudiences is the set of acceptable audiences the JWT must be issued to. At
least one of the entries must match the "aud" claim in presented JWTs.
Same value as the --oidc-client-id flag (though this field supports an
array). Required to be non-empty.
JWTA | 7,466 |
uthenticator
Appears in:
AuthenticationConfiguration
JWTAuthenticator provides the configuration for a single JWT authenticator.
Field Description
issuer [Required]
Issuerissuer contains the basic OIDC provider connection options.
claimValidationRules
[]ClaimValidationRuleclaimValidationRules are rules that are applied to validate token claims
to authenticate users.
claimMappings
[Required]
ClaimMappingsclaimMappings points claims of a token to be treated as user attributes.
userValidationRules
[]UserValidationRuleuserValidationRules are rules that are applied to final user before
completing authentication. These allow invariants to be applied to
incoming identities such as preventing the use of the system: prefix
that is commonly used by Kubernetes components. The validation rules
are logically ANDed together and must all return true for the validation
to pass. | 7,467 |
PrefixedClaimOrExpression
Appears in:
ClaimMappings
PrefixedClaimOrExpression provides the configuration for a single prefixed claim or expression.
Field Description
claim
stringclaim is the JWT claim to use. Mutually exclusive with expression.
prefix
stringprefix is prepended to claim's value to prevent clashes with existing names. prefix
needs to be set if claim is set and can be the empty string. Mutually exclusive with
expression.
expression
stringexpression represents the expression which will be evaluated by CEL.
CEL expressions have access to the contents of the token claims, organized into
CEL variable:
'claims' is a map of claim names to claim values. For example, a variable
named 'sub' can be accessed as 'claims.sub'. Nested claims can be accessed
using dot notation, e.g. 'claims.email.verified'.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Mutually exclusive with claim and prefix.
ProtocolType
(Alias of string )
Appears in:
Connection
ProtocolTyp | 7,468 |
e is a set of valid values for Connection.ProtocolType
TCPTransport
Appears in:
Transport
TCPTransport provides the information to connect to konnectivity server via TCP•
•
•
| 7,469 |
Field Description
url
[Required]
stringURL is the location of the konnectivity server to connect to. As an example it
might be "https://127.0.0.1:8131"
tlsConfig
TLSConfigTLSConfig is the config needed to use TLS when connecting to konnectivity
server
TLSConfig
Appears in:
TCPTransport
TLSConfig provides the authentication information to connect to konnectivity server Only used
with TCPTransport
Field Description
caBundle
stringcaBundle is the file location of the CA to be used to determine trust with the
konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed with
http:// If absent while TCPTransport.URL is prefixed with https://, default to system
trust roots.
clientKey
stringclientKey is the file location of the client key to be used in mtls handshakes with the
konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed with
http:// Must be configured if TCPTransport.URL is prefixed with https://
clientCert
stringclientCert is the file location of th | 7,470 |
e client certificate to be used in mtls handshakes
with the konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed
with http:// Must be configured if TCPTransport.URL is prefixed with https://
Transport
Appears in:
Connection
Transport defines the transport configurations we use to dial to the konnectivity server
Field Description
tcp
TCPTransportTCP is the TCP configuration for communicating with the konnectivity server
via TCP ProxyProtocol of GRPC is not supported with TCP transport at the
moment Requires at least one of TCP or UDS to be set•
| 7,471 |
Field Description
uds
UDSTransportUDS is the UDS configuration for communicating with the konnectivity server
via UDS Requires at least one of TCP or UDS to be set
UDSTransport
Appears in:
Transport
UDSTransport provides the information to connect to konnectivity server via UDS
Field Description
udsName
[Required]
stringUDSName is the name of the unix domain socket to connect to konnectivity
server This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-
server/konnectivity-server.socket)
UserValidationRule
Appears in:
JWTAuthenticator
UserValidationRule provides the configuration for a single user info validation rule.
Field Description
expression
[Required]
stringexpression represents the expression which will be evaluated by CEL. Must
return true for the validation to pass.
CEL expressions have access to the contents of UserInfo, organized into CEL
variable:
'user' - authentication.k8s.io/v1, Kind=UserInfo object Refer to https://
github.com/kubernetes/api/blob | 7,472 |
/release-1.28/authentication/v1/
types.go#L105-L122 for the definition. API documentation: https://
kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#userinfo-
v1-authentication-k8s-io
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
message
stringmessage customizes the returned error message when rule returns false.
message is a literal string.•
•
| 7,473 |
WebhookConfiguration
Appears in:
AuthorizerConfiguration
Field Description
authorizedTTL [Required]
meta/v1.DurationThe duration to cache 'authorized' responses
from the webhook authorizer. Same as setting --
authorization-webhook-cache-authorized-ttl flag
Default: 5m0s
unauthorizedTTL [Required]
meta/v1.DurationThe duration to cache 'unauthorized' responses
from the webhook authorizer. Same as setting --
authorization-webhook-cache-unauthorized-ttl
flag Default: 30s
timeout [Required]
meta/v1.DurationTimeout for the webhook request Maximum
allowed value is 30s. Required, no default value.
subjectAccessReviewVersion [Required]
stringThe API version of the authorization.k8s.io
SubjectAccessReview to send to and expect from
the webhook. Same as setting --authorization-
webhook-version flag Valid values: v1beta1, v1
Required, no default value
matchConditionSubjectAccessReviewVersion
[Required]
stringMatchConditionSubjectAccessReviewVersion
specifies the SubjectAccessReview version | 7,474 |
the
CEL expressions are evaluated against Valid
values: v1 Required, no default value
failurePolicy [Required]
stringControls the authorization decision when a
webhook request fails to complete or returns a
malformed response or errors evaluating
matchConditions. Valid values:
NoOpinion: continue to subsequent
authorizers to see if one of them allows the
request
Deny: reject the request without
consulting subsequent authorizers
Required, with no default.
connectionInfo [Required]
WebhookConnectionInfoConnectionInfo defines how we talk to the
webhook•
•
| 7,475 |
Field Description
matchConditions [Required]
[]WebhookMatchConditionmatchConditions is a list of conditions that must
be met for a request to be sent to this webhook.
An empty list of matchConditions matches all
requests. There are a maximum of 64 match
conditions allowed.
The exact matching logic is (in order):
If at least one matchCondition evaluates to
FALSE, then the webhook is skipped.
If ALL matchConditions evaluate to TRUE,
then the webhook is called.
If at least one matchCondition evaluates to
an error (but none are FALSE):
If failurePolicy=Deny, then the
webhook rejects the request
If failurePolicy=NoOpinion, then the
error is ignored and the webhook is
skipped
WebhookConnectionInfo
Appears in:
WebhookConfiguration
Field Description
type [Required]
stringControls how the webhook should communicate with the server. Valid
values:
KubeConfigFile: use the file specified in kubeConfigFile to locate the
server.
InClusterConfig: use the in-cluster configuration to call the
SubjectAc | 7,476 |
cessReview API hosted by kube-apiserver. This mode is not
allowed for kube-apiserver.
kubeConfigFile
[Required]
stringPath to KubeConfigFile for connection info Required, if
connectionInfo.Type is KubeConfig
WebhookMatchCondition
Appears in:
WebhookConfiguration1.
2.
3.
◦
◦
•
•
•
| 7,477 |
Field Description
expression
[Required]
stringexpression represents the expression which will be evaluated by CEL. Must
evaluate to bool. CEL expressions have access to the contents of the
SubjectAccessReview in v1 version. If version specified by
subjectAccessReviewVersion in the request variable is v1beta1, the contents
would be converted to the v1 version before evaluating the CEL expression.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
kube-apiserver Configuration (v1beta1)
Package v1beta1 is the v1beta1 version of the API.
Resource Types
EgressSelectorConfiguration
TracingConfiguration
TracingConfiguration
Appears in:
KubeletConfiguration
TracingConfiguration
TracingConfiguration
TracingConfiguration provides versioned configuration for OpenTelemetry tracing clients.
Field Description
endpoint
stringEndpoint of the collector this component will report traces to. The
connection is insecure, and does not currently support TLS.
Recommended is unset, and | 7,478 |
endpoint is the otlp grpc default,
localhost:4317.
samplingRatePerMillion
int32SamplingRatePerMillion is the number of samples to collect per
million spans. Recommended is unset. If unset, sampler respects its
parent span's sampling rate, but otherwise never samples.
EgressSelectorConfiguration
EgressSelectorConfiguration provides versioned configuration for egress selector clients.•
•
•
•
| 7,479 |
Field Description
apiVersion
stringapiserver.k8s.io/v1beta1
kind
stringEgressSelectorConfiguration
egressSelections
[Required]
[]EgressSelectionconnectionServices contains a list of egress selection client
configurations
TracingConfiguration
TracingConfiguration provides versioned configuration for tracing clients.
Field Description
apiVersion
stringapiserver.k8s.io/v1beta1
kind
stringTracingConfiguration
TracingConfiguration
[Required]
TracingConfiguration(Members of TracingConfiguration are embedded into this
type.)
Embed the component config tracing configuration struct
Connection
Appears in:
EgressSelection
Connection provides the configuration for a single egress selection client.
Field Description
proxyProtocol
[Required]
ProtocolTypeProtocol is the protocol used to connect from client to the konnectivity
server.
transport
TransportTransport defines the transport configurations we use to dial to the
konnectivity server. This is required if ProxyProtocol is HTTPConnect or
G | 7,480 |
RPC.
EgressSelection
Appears in:
EgressSelectorConfiguration
EgressSelection provides the configuration for a single egress selection client.•
| 7,481 |
Field Description
name
[Required]
stringname is the name of the egress selection. Currently supported values are
"controlplane", "master", "etcd" and "cluster" The "master" egress selector is
deprecated in favor of "controlplane"
connection
[Required]
Connectionconnection is the exact information used to configure the egress selection
ProtocolType
(Alias of string )
Appears in:
Connection
ProtocolType is a set of valid values for Connection.ProtocolType
TCPTransport
Appears in:
Transport
TCPTransport provides the information to connect to konnectivity server via TCP
Field Description
url
[Required]
stringURL is the location of the konnectivity server to connect to. As an example it
might be "https://127.0.0.1:8131"
tlsConfig
TLSConfigTLSConfig is the config needed to use TLS when connecting to konnectivity
server
TLSConfig
Appears in:
TCPTransport
TLSConfig provides the authentication information to connect to konnectivity server Only used
with TCPTransport
Field Description
caBun | 7,482 |
dle
stringcaBundle is the file location of the CA to be used to determine trust with the
konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed with•
•
| 7,483 |
Field Description
http:// If absent while TCPTransport.URL is prefixed with https://, default to system
trust roots.
clientKey
stringclientKey is the file location of the client key to be used in mtls handshakes with the
konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed with
http:// Must be configured if TCPTransport.URL is prefixed with https://
clientCert
stringclientCert is the file location of the client certificate to be used in mtls handshakes
with the konnectivity server. Must be absent/empty if TCPTransport.URL is prefixed
with http:// Must be configured if TCPTransport.URL is prefixed with https://
Transport
Appears in:
Connection
Transport defines the transport configurations we use to dial to the konnectivity server
Field Description
tcp
TCPTransportTCP is the TCP configuration for communicating with the konnectivity server
via TCP ProxyProtocol of GRPC is not supported with TCP transport at the
moment Requires at least one of TCP or UDS to be set
uds | 7,484 |
UDSTransportUDS is the UDS configuration for communicating with the konnectivity server
via UDS Requires at least one of TCP or UDS to be set
UDSTransport
Appears in:
Transport
UDSTransport provides the information to connect to konnectivity server via UDS
Field Description
udsName
[Required]
stringUDSName is the name of the unix domain socket to connect to konnectivity
server This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-
server/konnectivity-server.socket)•
| 7,485 |
kube-apiserver Encryption Configuration
(v1)
Package v1 is the v1 version of the API.
Resource Types
EncryptionConfiguration
EncryptionConfiguration
EncryptionConfiguration stores the complete configuration for encryption providers. It also
allows the use of wildcards to specify the resources that should be encrypted. Use ' .' to encrypt
all resources within a group or ' .' to encrypt all resources. ' .' can be used to encrypt all resource in
the core group. ' .' will encrypt all resources, even custom resources that are added after API
server start. Use of wildcards that overlap within the same resource list or across multiple
entries are not allowed since part of the configuration would be ineffective. Resource lists are
processed in order, with earlier lists taking precedence.
Example:
kind: EncryptionConfiguration
apiVersion: apiserver.config.k8s.io/v1
resources:
- resources:
- events
providers:
- identity: {} # do not encrypt events even though *.* is specified below
- reso | 7,486 |
urces:
- secrets
- configmaps
- pandas.awesome.bears.example
providers:
- aescbc:
keys:
- name: key1
secret: c2VjcmV0IGlzIHNlY3VyZQ==
- resources:
- '*.apps'
providers:
- aescbc:
keys:
- name: key2
secret: c2VjcmV0IGlzIHNlY3VyZSwgb3IgaXMgaXQ/Cg==
- resources:
- '*.*'
providers:
- aescbc:
keys: | 7,487 |
- name: key3
secret: c2VjcmV0IGlzIHNlY3VyZSwgSSB0aGluaw==
Field Description
apiVersion
stringapiserver.config.k8s.io/v1
kind
stringEncryptionConfiguration
resources [Required]
[]ResourceConfigurationresources is a list containing resources, and their corresponding
encryption providers.
AESConfiguration
Appears in:
ProviderConfiguration
AESConfiguration contains the API configuration for an AES transformer.
Field Description
keys
[Required]
[]Keykeys is a list of keys to be used for creating the AES transformer. Each key has
to be 32 bytes long for AES-CBC and 16, 24 or 32 bytes for AES-GCM.
IdentityConfiguration
Appears in:
ProviderConfiguration
IdentityConfiguration is an empty struct to allow identity transformer in provider
configuration.
KMSConfiguration
Appears in:
ProviderConfiguration
KMSConfiguration contains the name, cache size and path to configuration file for a KMS based
envelope transformer.
Field Description
apiVersion
stringapiVersion of KeyManagementService• | 7,488 |
•
| 7,489 |
Field Description
name
[Required]
stringname is the name of the KMS plugin to be used.
cachesize
int32cachesize is the maximum number of secrets which are cached in memory. The
default value is 1000. Set to a negative value to disable caching. This field is
only allowed for KMS v1 providers.
endpoint
[Required]
stringendpoint is the gRPC server listening address, for example "unix:///var/run/
kms-provider.sock".
timeout
meta/
v1.Durationtimeout for gRPC calls to kms-plugin (ex. 5s). The default is 3 seconds.
Key
Appears in:
AESConfiguration
SecretboxConfiguration
Key contains name and secret of the provided key for a transformer.
Field Description
name [Required]
stringname is the name of the key to be used while storing data to disk.
secret [Required]
stringsecret is the actual key, encoded in base64.
ProviderConfiguration
Appears in:
ResourceConfiguration
ProviderConfiguration stores the provided configuration for an encryption provider.
Field Description
aesgcm [Required]
AES | 7,490 |
Configurationaesgcm is the configuration for the AES-GCM transformer.
aescbc [Required]
AESConfigurationaescbc is the configuration for the AES-CBC transformer.•
•
| 7,491 |
Field Description
secretbox [Required]
SecretboxConfigurationsecretbox is the configuration for the Secretbox based transformer.
identity [Required]
IdentityConfigurationidentity is the (empty) configuration for the identity transformer.
kms [Required]
KMSConfigurationkms contains the name, cache size and path to configuration file for a
KMS based envelope transformer.
ResourceConfiguration
Appears in:
EncryptionConfiguration
ResourceConfiguration stores per resource configuration.
Field Description
resources [Required]
[]stringresources is a list of kubernetes resources which have to be encrypted.
The resource names are derived from resource or resource.group of
the group/version/resource. eg: pandas.awesome.bears.example is a
custom resource with 'group': awesome.bears.example, 'resource':
pandas. Use ' .' to encrypt all resources and ' .' to encrypt all resources in
a specific group. eg: ' .awesome.bears.example' will encrypt all
resources in the group 'awesome.bears.example'. | 7,492 |
eg: '*.' will encrypt all
resources in the core group (such as pods, configmaps, etc).
providers [Required]
[]ProviderConfigurationproviders is a list of transformers to be used for reading and writing
the resources to disk. eg: aesgcm, aescbc, secretbox, identity, kms.
SecretboxConfiguration
Appears in:
ProviderConfiguration
SecretboxConfiguration contains the API configuration for an Secretbox transformer.
Field Description
keys
[Required]
[]Keykeys is a list of keys to be used for creating the Secretbox transformer. Each
key has to be 32 bytes long.•
| 7,493 |
kube-controller-manager Configuration
(v1alpha1)
Resource Types
CloudControllerManagerConfiguration
LeaderMigrationConfiguration
KubeControllerManagerConfiguration
NodeControllerConfiguration
Appears in:
CloudControllerManagerConfiguration
NodeControllerConfiguration contains elements describing NodeController.
Field Description
ConcurrentNodeSyncs
[Required]
int32ConcurrentNodeSyncs is the number of workers concurrently
synchronizing nodes
ServiceControllerConfiguration
Appears in:
CloudControllerManagerConfiguration
KubeControllerManagerConfiguration
ServiceControllerConfiguration contains elements describing ServiceController.
Field Description
ConcurrentServiceSyncs
[Required]
int32concurrentServiceSyncs is the number of services that are allowed
to sync concurrently. Larger number = more responsive service
management, but more CPU (and network) load.
CloudControllerManagerConfiguration
CloudControllerManagerConfiguration contains elements describing cloud-controller manager.
F | 7,494 |
ield Description
apiVersion
stringcloudcontrollermanager.config.k8s.io/v1alpha1
CloudControllerManagerConfiguration•
•
•
•
•
| 7,495 |
Field Description
kind
string
Generic [Required]
GenericControllerManagerConfigurationGeneric holds configuration for a generic controller-
manager
KubeCloudShared [Required]
KubeCloudSharedConfigurationKubeCloudSharedConfiguration holds configuration
for shared related features both in cloud controller
manager and kube-controller manager.
NodeController [Required]
NodeControllerConfigurationNodeController holds configuration for node
controller related features.
ServiceController [Required]
ServiceControllerConfigurationServiceControllerConfiguration holds configuration
for ServiceController related features.
NodeStatusUpdateFrequency
[Required]
meta/v1.DurationNodeStatusUpdateFrequency is the frequency at
which the controller updates nodes' status
Webhook [Required]
WebhookConfigurationWebhook is the configuration for cloud-controller-
manager hosted webhooks
CloudProviderConfiguration
Appears in:
KubeCloudSharedConfiguration
CloudProviderConfiguration contains basically eleme | 7,496 |
nts about cloud provider.
Field Description
Name [Required]
stringName is the provider for cloud services.
CloudConfigFile
[Required]
stringcloudConfigFile is the path to the cloud provider configuration
file.
KubeCloudSharedConfiguration
Appears in:
CloudControllerManagerConfiguration•
| 7,497 |
KubeControllerManagerConfiguration
KubeCloudSharedConfiguration contains elements shared by both kube-controller manager and
cloud-controller manager, but not genericconfig.
Field Description
CloudProvider [Required]
CloudProviderConfigurationCloudProviderConfiguration holds configuration for
CloudProvider related features.
ExternalCloudVolumePlugin
[Required]
stringexternalCloudVolumePlugin specifies the plugin to use when
cloudProvider is "external". It is currently used by the in repo
cloud providers to handle node and volume control in the
KCM.
UseServiceAccountCredentials
[Required]
booluseServiceAccountCredentials indicates whether controllers
should be run with individual service account credentials.
AllowUntaggedCloud
[Required]
boolrun with untagged cloud instances
RouteReconciliationPeriod
[Required]
meta/v1.DurationrouteReconciliationPeriod is the period for reconciling routes
created for Nodes by cloud provider..
NodeMonitorPeriod [Required]
meta/v1.DurationnodeMo | 7,498 |
nitorPeriod is the period for syncing NodeStatus in
NodeController.
ClusterName [Required]
stringclusterName is the instance prefix for the cluster.
ClusterCIDR [Required]
stringclusterCIDR is CIDR Range for Pods in cluster.
AllocateNodeCIDRs [Required]
boolAllocateNodeCIDRs enables CIDRs for Pods to be allocated
and, if ConfigureCloudRoutes is true, to be set on the cloud
provider.
CIDRAllocatorType [Required]
stringCIDRAllocatorType determines what kind of pod CIDR
allocator will be used.
ConfigureCloudRoutes
[Required]
boolconfigureCloudRoutes enables CIDRs allocated with
allocateNodeCIDRs to be configured on the cloud provider.
NodeSyncPeriod [Required]
meta/v1.DurationnodeSyncPeriod is the period for syncing nodes from
cloudprovider. Longer periods will result in fewer calls to | 7,499 |