LDAPAuthEngineConfig
redhatcop.redhat.io / v1alpha1
apiVersion: redhatcop.redhat.io/v1alpha1
kind: LDAPAuthEngineConfig
metadata:
name: example
apiVersion
string
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
kind
string
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
metadata
object
spec object
LDAPAuthEngineConfigSpec defines the desired state of LDAPAuthEngineConfig
TLSMaxVersion
string
TLSMaxVersion Maximum TLS version to use. Accepted values are tls10, tls11, tls12 or tls13
TLSMinVersion
string
TLSMinVersion Minimum TLS version to use. Accepted values are tls10, tls11, tls12 or tls13
UPNDomain
string
UPNDomain The userPrincipalDomain used to construct the UPN string for the authenticating user.
The constructed UPN will appear as [username]@UPNDomain. Example: example.com, which will cause vault to bind as username@example.com
anonymousGroupSearch
boolean
AnonymousGroupSearch Use anonymous binds when performing LDAP group searches (note: even when true, the initial credentials will still be used for the initial connection test).
authentication object
namespace
string
Namespace is the Vault namespace to be used in all the operations withing this connection/authentication. Only available in Vault Enterprise.
path
string
Path is the path of the role used for this kube auth authentication. The operator will try to authenticate at {[namespace/]}auth/{spec.path}
pattern:
^(?:/?[\w;:@&=\$-\.\+]*)+/?
role
string
Role the role to be used during authentication
serviceAccount object
ServiceAccount is the service account used for the kube auth authentication
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
bindCredentials object
BindCredentials is used to connect to the LDAP service on the specified LDAP Server.
BindCredentials consists in bindDN and bindPass, which can be created as Kubernetes Secret, VaultSecret or RandomSecret.
passwordKey
string
PasswordKey key to be used when retrieving the password, required with VaultSecrets and Kubernetes secrets, ignored with RandomSecret
randomSecret object
RandomSecret retrieves the credentials from the Vault secret corresponding to this RandomSecret. This will map the "username" and "password" keys of the secret to the username and password of this config. All other keys will be ignored. If the RandomSecret is refreshed the operator retrieves the new secret from Vault and updates this configuration. Only one of RootCredentialsFromVaultSecret or RootCredentialsFromSecret or RootCredentialsFromRandomSecret can be specified.
When using randomSecret a username must be specified in the spec.username
password: Specifies the password to use when connecting with the username. This value will not be returned by Vault when performing a read upon the configuration. This is typically used in the connection_url field via the templating directive "{{"password"}}"".
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
secret object
Secret retrieves the credentials from a Kubernetes secret. The secret must be of basicauth type (https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret). This will map the "username" and "password" keys of the secret to the username and password of this config. If the kubernetes secret is updated, this configuration will also be updated. All other keys will be ignored. Only one of RootCredentialsFromVaultSecret or RootCredentialsFromSecret or RootCredentialsFromRandomSecret can be specified.
username: Specifies the name of the user to use as the "root" user when connecting to the database. This "root" user is used to create/update/delete users managed by these plugins, so you will need to ensure that this user has permissions to manipulate users appropriate to the database. This is typically used in the connection_url field via the templating directive "{{"username"}}" or "{{"name"}}".
password: Specifies the password to use when connecting with the username. This value will not be returned by Vault when performing a read upon the configuration. This is typically used in the connection_url field via the templating directive "{{"password"}}".
If username is provided as spec.username, it takes precedence over the username retrieved from the referenced secret
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
usernameKey
string
UsernameKey key to be used when retrieving the username, optional with VaultSecrets and Kubernetes secrets, ignored with RandomSecret
vaultSecret object
VaultSecret retrieves the credentials from a Vault secret. This will map the "username" and "password" keys of the secret to the username and password of this config. All other keys will be ignored. Only one of RootCredentialsFromVaultSecret or RootCredentialsFromSecret or RootCredentialsFromRandomSecret can be specified.
username: Specifies the name of the user to use as the "root" user when connecting to the database. This "root" user is used to create/update/delete users managed by these plugins, so you will need to ensure that this user has permissions to manipulate users appropriate to the database. This is typically used in the connection_url field via the templating directive "{{"username"}}" or "{{"name"}}".
password: Specifies the password to use when connecting with the username. This value will not be returned by Vault when performing a read upon the configuration. This is typically used in the connection_url field via the templating directive "{{"password"}}".
If username is provided as spec.username, it takes precedence over the username retrieved from the referenced secret
path
string
Path is the path to the secret
bindDN
string
BindDN - Username used to connect to the LDAP service on the specified LDAP Server.
If in the form accountname@domain.com, the username is transformed into a proper LDAP bind DN, for example, CN=accountname,CN=users,DC=domain,DC=com, when accessing the LDAP server.
If username is provided it takes precedence over the username retrieved from the referenced secrets
caseSensitiveNames
boolean required
CaseSensitiveNames If set, user and group names assigned to policies within the backend will be case sensitive.
Otherwise, names will be normalized to lower case. Case will still be preserved when sending the username to the LDAP server at login time; this is only for matching local user/group definitions.
certificate
string
Certificate CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.
clientTLSCert
string
ClientTLSCert Client certificate to provide to the LDAP server, must be x509 PEM encoded
clientTLSKey
string
ClientTLSKey Client certificate key to provide to the LDAP server, must be x509 PEM encoded
connection object
Connection represents the information needed to connect to Vault. This operator uses the standard Vault environment variables to connect to Vault. If you need to override those settings and for example connect to a different Vault instance, you can do with this section of the CR.
address
string
Address Address of the Vault server expressed as a URL and port, for example: https://127.0.0.1:8200/
maxRetries
integer
MaxRetries Maximum number of retries when certain error codes are encountered. The default is 2, for three total attempts. Set this to 0 or less to disable retrying. Error codes that are retried are 412 (client consistency requirement not satisfied) and all 5xx except for 501 (not implemented).
tLSConfig object
cacert
string
Cacert Path to a PEM-encoded CA certificate file on the local disk. This file is used to verify the Vault server's SSL certificate. This environment variable takes precedence over a cert passed via the secret.
skipVerify
boolean
SkipVerify Do not verify Vault's presented certificate before communicating with it. Setting this variable is not recommended and voids Vault's security model.
tlsSecret object
TLSSecret namespace-local secret containing the tls material for the connection. the expected keys for the secret are: ca bundle -> "ca.crt", certificate -> "tls.crt", key -> "tls.key"
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
tlsServerName
string
TLSServerName Name to use as the SNI host when connecting via TLS.
timeOut
string
Timeout Timeout variable. The default value is 60s.
denyNullBind
boolean
DenyNullBind This option prevents users from bypassing authentication when providing an empty password
discoverDN
boolean
DiscoverDN Use anonymous bind to discover the bind DN of a user.
groupAttr
string
GroupAttr LDAP attribute to follow on objects returned by groupfilter in order to enumerate user group membership.
Examples: for groupfilter queries returning group objects, use: cn. For queries returning user objects, use: memberOf. The default is cn.
groupDN
string
GroupDN LDAP search base to use for group membership search. This can be the root containing either groups or users. Example: ou=Groups,dc=example,dc=com
groupFilter
string
GroupFilter Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username].
The default is (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})), which is compatible with several common directory schemas.
To support nested group resolution for Active Directory, instead use the following query: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))
insecureTLS
boolean
InsecureTLS If true, skips LDAP server SSL certificate verification - insecure, use with caution!
path
string
Path at which to make the configuration.
The final path in Vault will be {[spec.authentication.namespace]}/auth/{spec.path}/config/{metadata.name}.
The authentication role must have the following capabilities = [ "create", "read", "update", "delete"] on that path.
pattern:
^(?:/?[\w;:@&=\$-\.\+]*)+/?
requestTimeout
string
RequestTimeout Timeout, in seconds, for the connection when making requests against the server before returning back an error.
startTLS
boolean
StartTLS If true, issues a StartTLS command after establishing an unencrypted connection.
tLSConfig object
CertificateConfig represents the LDAP service certificate configuration.
CertificateConfig consists in certificate, clientTLSCert and clientTLSKey which can be consumed from an Kubernetes Secret.
cacert
string
Cacert Path to a PEM-encoded CA certificate file on the local disk. This file is used to verify the Vault server's SSL certificate. This environment variable takes precedence over a cert passed via the secret.
skipVerify
boolean
SkipVerify Do not verify Vault's presented certificate before communicating with it. Setting this variable is not recommended and voids Vault's security model.
tlsSecret object
TLSSecret namespace-local secret containing the tls material for the connection. the expected keys for the secret are: ca bundle -> "ca.crt", certificate -> "tls.crt", key -> "tls.key"
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
tlsServerName
string
TLSServerName Name to use as the SNI host when connecting via TLS.
tokenBoundCIDRs
string
TokenBoundCIDRs List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
tokenExplicitMaxTTL
string
TonenExplicitMaxTTL If set, will encode an explicit max TTL onto the token. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.
tokenMaxTTL
string
TokenMaxTTL The maximum lifetime for generated tokens. This current value of this will be referenced at renewal time
tokenNoDefaultPolicy
boolean
TokenNoDefaultPolicy If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
tokenNumUses
integer
TokenNumUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
If you require the token to have the ability to create child tokens, you will need to set this value to 0.
format:
int64
tokenPeriod
integer
TokenPeriod The period, if any, to set on the token
format:
int64
tokenPolicies
string
TokenPolicies List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
tokenTTL
string
TokenTTL The incremental lifetime for generated tokens. This current value of this will be referenced at renewal time.
tokenType
string
The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens).
For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.
url
string required
URL The LDAP server to connect to. Examples: ldap://ldap.myorg.com, ldaps://ldap.myorg.com:636.
Multiple URLs can be specified with commas, e.g. ldap://ldap.myorg.com,ldap://ldap2.myorg.com; these will be tried in-order.
userAttr
string
UserAttr Attribute on user attribute object matching the username passed when authenticating. Examples: sAMAccountName, cn, uid
userDN
string
UserDN Base DN under which to perform user search. Example: ou=Users,dc=example,dc=com
userFilter
string
UserFilter An optional LDAP user search filter. The template can access the following context variables: UserAttr, Username.
The default is ({{.UserAttr}}={{.Username}}), or ({{.UserAttr}}={{.Username@.upndomain}}) if upndomain is set.
usernameAsAlias
boolean
UsernameAsAlias If set to true, forces the auth method to use the username passed by the user as the alias name.
status object
LDAPAuthEngineConfigStatus defines the observed state of LDAPAuthEngineConfig
conditions []object
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316No matches. Try .spec.TLSMaxVersion for an exact path