Loft Configuration

Config Reference for the Loft config that can be found in the Loft UI at Admin > Config.

auth required object

Authentication holds the information for authentication

password required object

Password holds password authentication relevant information

disabled required boolean true

If true login via password is disabled

oidc required object

OIDC holds oidc authentication configuration

issuerUrl required string

IssuerURL is the URL the provider signs ID Tokens as. This will be the "iss" field of all tokens produced by the provider and is used for configuration discovery.

The URL is usually the provider's URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com".

The provider must implement configuration discovery. See: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig

clientId required string

ClientID the JWT must be issued for, the "sub" field. This plugin only trusts a single client to ensure the plugin can be used with public providers.

The plugin supports the "authorized party" OpenID Connect claim, which allows specialized providers to issue tokens to a client for a different client. See: https://openid.net/specs/openid-connect-core-1_0.html#IDToken

clientSecret required string

ClientSecret to issue tokens from the OIDC provider

redirectURI required string

loft redirect uri. E.g. https://loft.my.domain/auth/oidc/callback

caFile required string

Path to a PEM encoded root certificate of the provider. Optional

insecureCa required boolean false

Specify whether to communicate without validating SSL certificates

usernameClaim required string

UsernameClaim is the JWT field to use as the user's username.

usernamePrefix required string

UsernamePrefix, if specified, causes claims mapping to username to be prefix with the provided value. A value "oidc:" would result in usernames like "oidc:john".

groupsClaim required string

GroupsClaim, if specified, causes the OIDCAuthenticator to try to populate the user's groups with an ID Token field. If the GroupsClaim field is present in an ID Token the value must be a string or list of strings.

groups required string[]

If required groups is non empty, access is denied if the user is not part of at least one of the specified groups.

getUserInfo required boolean false

GetUserInfo, if specified, tells the OIDCAuthenticator to try to populate the user's information from the UserInfo.

groupsPrefix required string

GroupsPrefix, if specified, causes claims mapping to group names to be prefixed with the value. A value "oidc:" would result in groups like "oidc:engineering" and "oidc:marketing".

type required string

Type of the OIDC to show in the UI. Only for displaying purposes

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

name required string

Name of the cluster account template to apply

sync required boolean false

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

accountName required string

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

groupClusterAccountTemplates required object[]

A mapping between groups and cluster account templates. If the user has a certain group, the cluster account template will be added during creation

group required string

Group is the name of the group that should be matched

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

####### name required string {#status-auth-oidc-groupClusterAccountTemplates-clusterAccountTemplates-name}

Name of the cluster account template to apply

####### sync required boolean false {#status-auth-oidc-groupClusterAccountTemplates-clusterAccountTemplates-sync}

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

####### accountName required string {#status-auth-oidc-groupClusterAccountTemplates-clusterAccountTemplates-accountName}

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

github required object

Github holds github authentication configuration

clientId required string

ClientID holds the github client id

clientSecret required string

ClientID holds the github client secret

redirectURI required string

RedirectURI holds the redirect URI. Should be https://loft.domain.tld/auth/github/callback

orgs required object[]

Loft queries the following organizations for group information. Group claims are formatted as "(org):(team)". For example if a user is part of the "engineering" team of the "coreos" org, the group claim would include "coreos:engineering".

If orgs are specified in the config then user MUST be a member of at least one of the specified orgs to authenticate with loft.

name required string

Organization name in github (not slug, full name). Only users in this github organization can authenticate.

teams required string[]

Names of teams in a github organization. A user will be able to authenticate if they are members of at least one of these teams. Users in the organization can authenticate if this field is omitted from the config file.

hostName required string

Required ONLY for GitHub Enterprise. This is the Hostname of the GitHub Enterprise account listed on the management console. Ensure this domain is routable on your network.

rootCA required string

ONLY for GitHub Enterprise. Optional field. Used to support self-signed or untrusted CA root certificates.

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

name required string

Name of the cluster account template to apply

sync required boolean false

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

accountName required string

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

groupClusterAccountTemplates required object[]

A mapping between groups and cluster account templates. If the user has a certain group, the cluster account template will be added during creation

group required string

Group is the name of the group that should be matched

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

####### name required string {#status-auth-github-groupClusterAccountTemplates-clusterAccountTemplates-name}

Name of the cluster account template to apply

####### sync required boolean false {#status-auth-github-groupClusterAccountTemplates-clusterAccountTemplates-sync}

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

####### accountName required string {#status-auth-github-groupClusterAccountTemplates-clusterAccountTemplates-accountName}

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

gitlab required object

Gitlab holds gitlab authentication configuration

clientId required string

Gitlab client id

clientSecret required string

Gitlab client secret

redirectURI required string

Redirect URI

baseURL required string

BaseURL is optional, default = https://gitlab.com

groups required string[]

Optional groups whitelist, communicated through the "groups" scope. If groups is omitted, all of the user's GitLab groups are returned. If groups is provided, this acts as a whitelist - only the user's GitLab groups that are in the configured groups below will go into the groups claim. Conversely, if the user is not in any of the configured groups, the user will not be authenticated.

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

name required string

Name of the cluster account template to apply

sync required boolean false

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

accountName required string

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

groupClusterAccountTemplates required object[]

A mapping between groups and cluster account templates. If the user has a certain group, the cluster account template will be added during creation

group required string

Group is the name of the group that should be matched

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

####### name required string {#status-auth-gitlab-groupClusterAccountTemplates-clusterAccountTemplates-name}

Name of the cluster account template to apply

####### sync required boolean false {#status-auth-gitlab-groupClusterAccountTemplates-clusterAccountTemplates-sync}

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

####### accountName required string {#status-auth-gitlab-groupClusterAccountTemplates-clusterAccountTemplates-accountName}

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

google required object

Google holds google authentication configuration

clientId required string

Google client id

clientSecret required string

Google client secret

redirectURI required string

loft redirect uri. E.g. https://loft.my.domain/auth/google/callback

scopes required string[]

defaults to "profile" and "email"

hostedDomains required string[]

Optional list of whitelisted domains If this field is nonempty, only users from a listed domain will be allowed to log in

groups required string[]

Optional list of whitelisted groups If this field is nonempty, only users from a listed group will be allowed to log in

serviceAccountFilePath required string

Optional path to service account json If nonempty, and groups claim is made, will use authentication from file to check groups with the admin directory api

adminEmail required string

Required if ServiceAccountFilePath The email of a GSuite super user which the service account will impersonate when listing groups

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

name required string

Name of the cluster account template to apply

sync required boolean false

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

accountName required string

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

groupClusterAccountTemplates required object[]

A mapping between groups and cluster account templates. If the user has a certain group, the cluster account template will be added during creation

group required string

Group is the name of the group that should be matched

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

####### name required string {#status-auth-google-groupClusterAccountTemplates-clusterAccountTemplates-name}

Name of the cluster account template to apply

####### sync required boolean false {#status-auth-google-groupClusterAccountTemplates-clusterAccountTemplates-sync}

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

####### accountName required string {#status-auth-google-groupClusterAccountTemplates-clusterAccountTemplates-accountName}

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

microsoft required object

Microsoft holds microsoft authentication configuration

clientId required string

Microsoft client id

clientSecret required string

Microsoft client secret

redirectURI required string

loft redirect uri. Usually https://loft.my.domain/auth/microsoft/callback

tenant required string

tenant configuration parameter controls what kinds of accounts may be authenticated in loft. By default, all types of Microsoft accounts (consumers and organizations) can authenticate in loft via Microsoft. To change this, set the tenant parameter to one of the following:

common - both personal and business/school accounts can authenticate in loft via Microsoft (default) consumers - only personal accounts can authenticate in loft organizations - only business/school accounts can authenticate in loft tenant uuid or tenant name - only accounts belonging to specific tenant identified by either tenant uuid or tenant name can authenticate in loft

groups required string[]

It is possible to require a user to be a member of a particular group in order to be successfully authenticated in loft.

onlySecurityGroups required boolean false

configuration option restricts the list to include only security groups. By default all groups (security, Office 365, mailing lists) are included.

useGroupsAsWhitelist required boolean false

Restrict the groups claims to include only the user’s groups that are in the configured groups

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

name required string

Name of the cluster account template to apply

sync required boolean false

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

accountName required string

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

groupClusterAccountTemplates required object[]

A mapping between groups and cluster account templates. If the user has a certain group, the cluster account template will be added during creation

group required string

Group is the name of the group that should be matched

clusterAccountTemplates required object[]

Cluster Account Templates that will be applied for users logging in through this authentication

####### name required string {#status-auth-microsoft-groupClusterAccountTemplates-clusterAccountTemplates-name}

Name of the cluster account template to apply

####### sync required boolean false {#status-auth-microsoft-groupClusterAccountTemplates-clusterAccountTemplates-sync}

Sync defines if Loft should sync changes to the cluster account template to the cluster accounts and create new accounts if new clusters match the templates.

####### accountName required string {#status-auth-microsoft-groupClusterAccountTemplates-clusterAccountTemplates-accountName}

AccountName is the name of the account that should be created. Defaults to the user or team kubernetes name.

saml required object

SAML holds saml authentication configuration

redirectURI required string

If the response assertion status value contains a Destination element, it must match this value exactly. Usually looks like https://your-loft-domain/auth/saml/callback

ssoURL required string

SSO URL used for POST value.

caData required string

CAData is a base64 encoded string that holds the ca certificate for validating the signature of the SAML response. Either CAData, CA or InsecureSkipSignatureValidation needs to be defined.

usernameAttr required string

Name of attribute in the returned assertions to map to username

emailAttr required string

Name of attribute in the returned assertions to map to email

groupsAttr required string

Name of attribute in the returned assertions to map to groups

ca required string

CA to use when validating the signature of the SAML response.

insecureSkipSignatureValidation required boolean false

Ignore the ca cert

entityIssuer required string

When provided Loft will include this as the Issuer value during AuthnRequest. It will also override the redirectURI as the required audience when evaluating AudienceRestriction elements in the response.

ssoIssuer required string

Issuer value expected in the SAML response. Optional.

groupsDelim required string

If GroupsDelim is supplied the connector assumes groups are returned as a single string instead of multiple attribute values. This delimiter will be used split the groups string.

allowedGroups required string[]

List of groups to filter access based on membership

filterGroups required boolean false

If used with allowed groups, only forwards the allowed groups and not all groups specified.

nameIDPolicyFormat required string

Requested format of the NameID. The NameID value is is mapped to the ID Token 'sub' claim.

This can be an abbreviated form of the full URI with just the last component. For example, if this value is set to "emailAddress" the format will resolve to:

    urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

If no value is specified, this value defaults to:

    urn:oasis:names:tc:SAML:2.0:nameid-format:persistent

disableTeamCreation required boolean false

Prevents from team creation for the new groups associated with the user at the time of logging in through sso, Default behaviour is false, this means that teams will be created for new groups.

oidc required object

OIDC holds oidc provider relevant information

enabled required boolean true

If true indicates that loft will act as an OIDC server

clients required object[]

The clients that are allowed to request loft tokens

name required string

The client name

clientId required string

The client id of the client

clientSecret required string

The client secret of the client

redirectURIs required string[]

A registered set of redirect URIs. When redirecting from dex to the client, the URI requested to redirect to MUST match one of these values, unless the client is "public".

apps required object

Apps holds configuration around apps

noDefault required boolean false

If this option is true, loft will not try to parse the default apps

repositories required object[]

These are additional repositories that are parsed by loft

name required string

Name is the name of the repository

url required string

URL is the repository url

username required string

Username of the repository

password required string

Password of the repository

insecure required boolean false

Insecure specifies if the chart should be retrieved without TLS verification

predefinedApps required object[]

Predefined apps that can be selected in the Spaces > Space menu

chart required string

Chart holds the repo/chart name of the predefined app

initialVersion required string

InitialVersion holds the initial version of this app. This version will be selected automatically.

initialValues required string

InitialValues holds the initial values for this app. The values will be prefilled automatically. There are certain placeholders that can be used within the values that are replaced by the loft UI automatically.

clusters required string[]

Holds the cluster names where to display this app

title required string

Title is the name that should be displayed for the predefined app. If empty the chart name is used.

iconUrl required string

IconURL specifies an url to the icon that should be displayed for this app. If none is specified the icon from the chart metadata is used.

readmeUrl required string

ReadmeURL specifies an url to the readme page of this predefined app. If empty an url will be constructed to artifact hub.

audit required object

Audit holds audit configuration

enabled required boolean false

If audit is enabled and incoming api requests will be logged based on the supplied policy.

level required integer

Level is an optional log level for audit logs. Cannot be used together with policy

policy required object

The audit policy to use and log requests. By default loft will not log anything

rules required object[]

Rules 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.

level required string

The Level that requests matching this rule are recorded at.

users required string[]

The users (by authenticated user name) this rule applies to. An empty list implies every user.

userGroups required string[]

The 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 required string[]

The verbs that match this rule. An empty list implies every verb.

resources required object[]

Resources that this rule matches. An empty list implies all kinds in all API groups.

####### group required string {#status-audit-policy-rules-resources-group}

Group is the name of the API group that contains the resources. The empty string represents the core API group.

####### resources required string[] {#status-audit-policy-rules-resources-resources}

Resources is a list of resources this rule applies to.

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 required string[] {#status-audit-policy-rules-resources-resourceNames}

ResourceNames 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.

namespaces required string[]

Namespaces that this rule matches. The empty string "" matches non-namespaced resources. An empty list implies every namespace.

nonResourceURLs required string[]

NonResourceURLs 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

omitStages required string[]

OmitStages 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.

requestTargets required string[]

RequestTargets is a list of request targets for which events are created. An empty list implies every request.

clusters required string[]

Clusters that this rule matches. Only applies to cluster requests. If this is set, no events for non cluster requests will be created. An empty list means no restrictions will apply.

omitStages required string[]

OmitStages 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.

dataStoreEndpoint required string

DataStoreEndpoint is an endpoint to store events in.

dataStoreTTL required integer

DataStoreMaxAge is the maximum number of hours to retain old log events in the datastore

path required string

The path where to save the audit log files. This is required if audit is enabled. Backup log files will be retained in the same directory.

maxAge required integer

MaxAge is the maximum number of days to retain old log files based on the timestamp encoded in their filename. Note that a day is defined as 24 hours and may not exactly correspond to calendar days due to daylight savings, leap seconds, etc. The default is not to remove old log files based on age.

maxBackups required integer

MaxBackups is the maximum number of old log files to retain. The default is to retain all old log files (though MaxAge may still cause them to get deleted.)

maxSize required integer

MaxSize is the maximum size in megabytes of the log file before it gets rotated. It defaults to 100 megabytes.

compress required boolean false

Compress determines if the rotated log files should be compressed using gzip. The default is not to perform compression.

loftHost required string

LoftHost holds the domain where the loft instance is hosted