On This Page

Home / Edge/ Reference/Configuration Files

Configuration Files ​

Configuration files store the configuration changes locally on your system. They reflect the changes you make to configuration settings in the UI.

You can preview how settings are translated into configuration changes in the Git Changes modal whenever you commit your changes via the Version Control option.

Modifications to configuration files presented as Git changes
Git Changes screen showing Git diff with changes to configuration files.

Typically, you do not modify configuration files manually. If you need to edit the configuration outside the UI, Cribl recommends using the API. However, if your particular use case requires it, in an on-prem deployment the files are open for editing.

The Version Control view can also contain entries with configuration files for other Cribl products. See Cribl Search Configuration Files and Cribl Lake Configuration Files for details.

Configuration File Locations ​

In an on-prem deployment, configuration files are stored in the $CRIBL_HOME/local/cribl directory (where $CRIBL_HOME is your installation directory, for example, /opt/cribl/). Configuration for specific Fleets is located $CRIBL_HOME/groups/<fleet-name>/local/cribl.

You can view the default configurations by taking a look in the default directory, instead of local.

Pack configuration resides within a separate subdirectory for each Pack: $CRIBL_HOME/default/<pack_name>.

General-Purpose ​

Configuration file/folderDescription
app-limits.ymlInternal limit configuration.
appscope.ymlDeprecated legacy instrumentation configuration file.
breakers.ymlEvent Breakers configuration.
certificates.ymlTLS/SSL certificates.
conditionsDirectory storing configurations for Notification conditions.
cribl.ymlGeneral system configuration.
email-templates.ymlTemplates for Email Notifications.
executorsExecutor job configurations.
functionsDirectory storing individual Function configurations.
grok-patternsDirectory storing individual Grok Pattern configurations.
inputs.ymlSources configuration.
instance.ymlConfiguration for the current instance. Located in local/_system/instance.yml.
job-limits.ymlParameters for Collection jobs and system tasks.
kms.ymlKMS provider configuration.
licenses.ymlLicenses.
limits.ymlLimit configuration.
logger.ymlLogging levels and redactions.
notifications.ymlNotifications and Notification targets.
notification-templates.ymlTemplates for email Notifications.
outputs.ymlDestinations configuration.
parquet-schemas.ymlParquet Schemas.
parquet-schemasDirectory storing individual Parquet Schema configurations.
parsers.ymlParsers Library.
pipelinesDirectory storing individual Pipeline configurations.
protobuf-libraries.ymlConfiguration for Protobuf libraries.
redis-cache-limits.ymlRedis cache settings.
redis-limits.ymlRedis connection settings.
regexes.ymlRegex Library.
route.ymlRoute configuration. Located in local/cribl/pipelines/route.yml.
samples.ymlMetadata about about stored sample data files.
schemas.ymlSchema Library.
schemasDirectory storing individual schema configurations.
scripts.ymlScripts configured at Settings > Global > Scripts.
secrets.ymlSecrets.
vars.ymlVariables Library.

Leader-Specific ​

Configuration file/folderDescription
ai.ymlCribl AI settings.
fleet-mappings.ymlMapping rulesets for Edge Nodes.
groups.ymlWorker Group and Edge Fleet settings.
leader.ymlSecondary Leader configuration.
messages.ymlMessages displayed in the UI’s Messages fly-out.
perms.ymlPermission configuration. Located in users/<id>/perms.yml / teams/<id>/perms.yml.
policies.ymlRBAC Policies.
roles.ymlRBAC Roles.
secret-folders/<folder-id>/global-secrets.ymlGlobal secrets metadata for a specific secret folder.
secret-folders.ymlDeclarations for secret folders that contain global secrets, including backing store and sharing.
secret-stores.ymlDeclarations for secret stores for global secrets.
service.ymlService processes.

Cribl Outpost-Specific ​

Configuration file/folderDescription
outpost.ymlConfiguration for Cribl Outpost.