- kube-apiserver Configuration (v1alpha1)
- Resource Types
TracingConfiguration
AdmissionConfiguration
AuthenticationConfiguration
AuthorizationConfiguration
EgressSelectorConfiguration
TracingConfiguration
AdmissionPluginConfiguration
AuthorizerConfiguration
ClaimMappings
ClaimOrExpression
ClaimValidationRule
Connection
EgressSelection
ExtraMapping
Issuer
JWTAuthenticator
PrefixedClaimOrExpression
ProtocolType
TCPTransport
TLSConfig
Transport
UDSTransport
UserValidationRule
WebhookConfiguration
WebhookConnectionInfo
WebhookMatchCondition
kube-apiserver Configuration (v1alpha1)
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types
- AdmissionConfiguration
- AuthenticationConfiguration
- AuthorizationConfiguration
- EgressSelectorConfiguration
- TracingConfiguration
TracingConfiguration
Appears in:
TracingConfiguration provides versioned configuration for OpenTelemetry tracing clients.
Field | Description |
---|---|
endpoint string | Endpoint 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 int32 | SamplingRatePerMillion 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 string | apiserver.k8s.io/v1alpha1 |
kind string | AdmissionConfiguration |
plugins []AdmissionPluginConfiguration | Plugins allows specifying a configuration per admission control plugin. |
AuthenticationConfiguration
AuthenticationConfiguration provides versioned configuration for authentication.
Field | Description |
---|---|
apiVersion string | apiserver.k8s.io/v1alpha1 |
kind string | AuthenticationConfiguration |
jwt [Required][]JWTAuthenticator | jwt 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. |
AuthorizationConfiguration
Field | Description |
---|---|
apiVersion string | apiserver.k8s.io/v1alpha1 |
kind string | AuthorizationConfiguration |
authorizers [Required][]AuthorizerConfiguration | Authorizers 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 string | apiserver.k8s.io/v1alpha1 |
kind string | EgressSelectorConfiguration |
egressSelections [Required][]EgressSelection | connectionServices contains a list of egress selection client configurations |
TracingConfiguration
TracingConfiguration provides versioned configuration for tracing clients.
Field | Description |
---|---|
apiVersion string | apiserver.k8s.io/v1alpha1 |
kind string | TracingConfiguration |
TracingConfiguration [Required]TracingConfiguration | (Members of TracingConfiguration are embedded into this type.)Embed the component config tracing configuration struct |
AdmissionPluginConfiguration
Appears in:
AdmissionPluginConfiguration provides the configuration for a single plug-in.
Field | Description |
---|---|
name [Required]string | Name is the name of the admission controller. It must match the registered admission plugin name. |
path string | Path is the path to a configuration file that contains the plugin’s configuration |
configuration k8s.io/apimachinery/pkg/runtime.Unknown | Configuration 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:
Field | Description |
---|---|
type [Required]string | Type 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]string | Name used to describe the webhook This is explicitly used in monitoring machinery for metrics Note: Names must be DNS1123 labels like |
webhook [Required]WebhookConfiguration | Webhook defines the configuration for a Webhook authorizer Must be defined when Type=Webhook Must not be defined when Type!=Webhook |
ClaimMappings
Appears in:
ClaimMappings provides the configuration for claim mapping
Field | Description |
---|---|
username [Required]PrefixedClaimOrExpression | username 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 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 PrefixedClaimOrExpression | groups represents 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 ClaimOrExpression | uid 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 []ExtraMapping | extra 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
hard-coded key, value copying claim value
hard-coded key, value derived from claim value
|
ClaimOrExpression
Appears in:
ClaimOrExpression provides the configuration for a single claim or expression.
Field | Description |
---|---|
claim string | claim is the JWT claim to use. Either claim or expression must be set. Mutually exclusive with expression. |
expression string | expression represents the expression which will be evaluated by CEL. CEL expressions have access to the contents of the token claims, organized into CEL variable:
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Mutually exclusive with claim. |
ClaimValidationRule
Appears in:
ClaimValidationRule provides the configuration for a single claim validation rule.
Field | Description |
---|---|
claim string | claim 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. |
requiredValue string | requiredValue 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 string | expression 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:
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Mutually exclusive with claim and requiredValue. |
message string | message customizes the returned error message when expression returns false. message is a literal string. Mutually exclusive with claim and requiredValue. |
Connection
Appears in:
Connection provides the configuration for a single egress selection client.
Field | Description |
---|---|
proxyProtocol [Required]ProtocolType | Protocol is the protocol used to connect from client to the konnectivity server. |
transport Transport | Transport defines the transport configurations we use to dial to the konnectivity server. This is required if ProxyProtocol is HTTPConnect or GRPC. |
EgressSelection
Appears in:
EgressSelection provides the configuration for a single egress selection client.
Field | Description |
---|---|
name [Required]string | name 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]Connection | connection is the exact information used to configure the egress selection |
ExtraMapping
Appears in:
ExtraMapping provides the configuration for a single extra mapping.
Field | Description |
---|---|
key [Required]string | key 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]string | valueExpression is a CEL expression to extract extra attribute value. valueExpression 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:
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ |
Issuer
Appears in:
Issuer provides the configuration for a external provider specific settings.
Field | Description |
---|---|
url [Required]string | url 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 string | certificateAuthority 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][]string | audiences 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. |
JWTAuthenticator
Appears in:
JWTAuthenticator provides the configuration for a single JWT authenticator.
Field | Description |
---|---|
issuer [Required]Issuer | issuer contains the basic OIDC provider connection options. |
claimValidationRules []ClaimValidationRule | claimValidationRules are rules that are applied to validate token claims to authenticate users. |
claimMappings [Required]ClaimMappings | claimMappings points claims of a token to be treated as user attributes. |
userValidationRules []UserValidationRule | userValidationRules 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. |
PrefixedClaimOrExpression
Appears in:
PrefixedClaimOrExpression provides the configuration for a single prefixed claim or expression.
Field | Description |
---|---|
claim string | claim is the JWT claim to use. Mutually exclusive with expression. |
prefix string | prefix 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 string | expression represents the expression which will be evaluated by CEL. CEL expressions have access to the contents of the token claims, organized into CEL variable:
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Mutually exclusive with claim and prefix. |
ProtocolType
(Alias of string
)
Appears in:
ProtocolType is a set of valid values for Connection.ProtocolType
TCPTransport
Appears in:
TCPTransport provides the information to connect to konnectivity server via TCP
Field | Description |
---|---|
url [Required]string | URL is the location of the konnectivity server to connect to. As an example it might be “https://127.0.0.1:8131“ |
tlsConfig TLSConfig | TLSConfig is the config needed to use TLS when connecting to konnectivity server |
TLSConfig
Appears in:
TLSConfig provides the authentication information to connect to konnectivity server Only used with TCPTransport
Field | Description |
---|---|
caBundle string | caBundle 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 string | clientKey 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 string | clientCert 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:
Transport defines the transport configurations we use to dial to the konnectivity server
Field | Description |
---|---|
tcp TCPTransport | TCP 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 UDSTransport | UDS 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:
UDSTransport provides the information to connect to konnectivity server via UDS
Field | Description |
---|---|
udsName [Required]string | UDSName 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:
UserValidationRule provides the configuration for a single user info validation rule.
Field | Description |
---|---|
expression [Required]string | expression 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:
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ |
message string | message customizes the returned error message when rule returns false. message is a literal string. |
WebhookConfiguration
Appears in:
Field | Description |
---|---|
authorizedTTL [Required]meta/v1.Duration | The duration to cache ‘authorized’ responses from the webhook authorizer. Same as setting |
unauthorizedTTL [Required]meta/v1.Duration | The duration to cache ‘unauthorized’ responses from the webhook authorizer. Same as setting |
timeout [Required]meta/v1.Duration | Timeout for the webhook request Maximum allowed value is 30s. Required, no default value. |
subjectAccessReviewVersion [Required]string | The API version of the authorization.k8s.io SubjectAccessReview to send to and expect from the webhook. Same as setting |
matchConditionSubjectAccessReviewVersion [Required]string | MatchConditionSubjectAccessReviewVersion specifies the SubjectAccessReview version the CEL expressions are evaluated against Valid values: v1 Required, no default value |
failurePolicy [Required]string | Controls the authorization decision when a webhook request fails to complete or returns a malformed response or errors evaluating matchConditions. Valid values:
|
connectionInfo [Required]WebhookConnectionInfo | ConnectionInfo defines how we talk to the webhook |
matchConditions [Required][]WebhookMatchCondition | matchConditions 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):
|
WebhookConnectionInfo
Appears in:
Field | Description |
---|---|
type [Required]string | Controls how the webhook should communicate with the server. Valid values:
|
kubeConfigFile [Required]string | Path to KubeConfigFile for connection info Required, if connectionInfo.Type is KubeConfig |
WebhookMatchCondition
Appears in:
Field | Description |
---|---|
expression [Required]string | expression 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/ |