cdf.toml - Cognite Docs

Expected location: the current working directory (the directory where you run the Cognite Toolkit.) Use the cdf.toml to configure the Cognite Toolkit CLI. The file is created automatically when you run the cdf modules init command. The cdf.toml file is written in the TOML format and looks similar to this:

[cdf]
default_organization_dir = "my_organization"
default_env = "dev"
file_encoding = "utf-8"
file_upload_timeout_seconds = 120

[rules]
ignore = []
enforce = false

[plugins]
run = true
pull = true
dump = true
data = true

[alpha_flags]
alpha-rules = true
run-workflow = true

[modules]
version = "0.3.14"

The `cdf` section

The cdf section contains these keys:

default_organization_dir (string): specifies the default organization directory to use if the --organization-dir/-o flag isn’t specified. The key is used by all commands that require the organization directory.
default_env (string): specifies the default environment to use when the --env/-e flag isn’t specified. The key is used by all commands that require the environment.
file_encoding (string, available from version 0.5.14): specifies the encoding used by the Cognite Toolkit when reading configuration files from the /modules directory. If not specified, the default depends on the operating system, typically utf-8 on Linux and MacOS, and cp1252 on Windows. We recommend using utf-8 to avoid issues with special characters and ensure compatibility across different platforms.
file_upload_timeout_seconds (float, available from version 0.7.139): specifies the timeout in seconds for uploading function code when running the cdf upload command. To deploy a Cognite Function, the Cognite Toolkit first uploads a file with the function code and then references that file in the function configuration. If the upload exceeds the specified timeout, the deployment fails. The default value is 120 seconds.

The `rules` section

This section controls how cdf build reports insights. An insight is a finding in your configuration, such as a missing reference, a schema warning, or a recommendation. For example, referenced resources must be in the build or already exist in CDF.

ignore (list of strings): insight codes to skip in every file. cdf build leaves these codes out of the terminal output and still writes them to build/insights.csv.
enforce (boolean, default false): when true, cdf build raises an error if any insight remains after ignored codes are filtered out, including errors, warnings, and recommendations. Set enforce = true in CI/CD when the build must be clean. When false, cdf build logs the violations to build/insights.csv and prints them in the terminal output.

To skip a code in one file, add a comment on any line in that file. Write # rules: ignore[CODE] or # rule: ignore[CODE]. Separate multiple codes with commas.

# rules: ignore[UNGOVERNED-RESOURCE, MISSING-REFERENCED-RESOURCE]

Insight codes

The Cognite Toolkit version 0.9 reports these insight codes. Use a code in rules.ignore or in a file comment.

Code	Meaning
`EMPTY-FILE`	The file is empty.
`EXCEEDED-LIMIT`	Function CPU or memory is outside the project limits, or an agent has more tools than the project allows.
`INVALID-DIRECT-RELATION`	A container has a non-nullable direct relation. `cdf build` reports this code when `alpha-rules = true` is set under `[alpha_flags]`.
`INVALID-FIELD`	A field is missing, has the wrong type, or is not supported on this resource.
`INVALID-FILE-CONTENT`	The YAML body or a sidecar file has invalid content.
`INVALID-FILE-SUFFIX`	The resource type in the filename is unknown for that resource folder.
`INVALID-FUNCTION-REQUIREMENTS`	A function `requirements.txt` file fails validation.
`INVALID-REFERENCED-PROPERTY`	A reverse direct relation does not point at a direct relation.
`INVALID-REFERENCED-RESOURCE`	A referenced view is missing properties that the configuration requires.
`INVALID-RESOURCE-CHANGE`	A local container, view, or data model change cannot be applied to the resource already in CDF.
`INVALID-VALUE`	A function runtime, agent model, or agent runtime version is not available in the CDF project.
`INVALID-VARIABLE-PATH`	A variable path does not match the configuration structure.
`INVALID-VARIABLE-TYPE`	A variable in a list has an invalid type.
`MISSING-FILE-SUFFIX`	The filename has no resource-type suffix, so the Cognite Toolkit skips the file.
`MISSING-REFERENCED-DIRECTORY`	A referenced directory is missing.
`MISSING-REFERENCED-FILE`	A referenced file is missing.
`MISSING-REFERENCED-PROPERTY`	A referenced property or direct relation does not exist locally or in CDF.
`MISSING-REFERENCED-RESOURCE`	A referenced resource is not in the build and does not exist in CDF.
`UNGOVERNED-RESOURCE`	A resource is not assigned to a data set or a space.
`UNREADABLE-FILE`	The file cannot be read, or its identifier cannot be read after a validation error.
`UNRECOGNIZED-FIELD`	A field is not part of the schema. The Cognite Toolkit deploys the field unchanged.
`UNRECOGNIZED-VALUE`	A value is not a known option. The Cognite Toolkit deploys the value unchanged.
`UNRESOLVED-VARIABLE`	A variable placeholder is not set.
`UNSUPPORTED-RESOURCE-REMOVAL`	The local configuration omits a property or view that is already deployed in CDF.
`UNVERIFIED-REFERENCED-PROPERTY`	A referenced property or direct relation could not be confirmed in CDF.
`UNVERIFIED-REFERENCED-RESOURCE`	A referenced resource is not in the build, and CDF was not checked.

The `plugins` section

This section turns plugins on or off. See the Plugins for more information.

The `alpha_flags` section

This section enables alpha features. Alpha features are experimental and may change or be removed in future releases.

The `modules` section

This section specifies the version of the modules found in the modules/ directory. The Cognite Toolkit uses it to ensure that the CLI matches the modules. It’s automatically updated when you run the cdf modules upgrade command.

​The cdf section

​The rules section

​Insight codes

​The plugins section

​The alpha_flags section

​The modules section