Skip to content

Releases: cognitedata/toolkit

v0.3.8

12 Nov 08:45
a0b0299
Compare
Choose a tag to compare

cdf

Fixed

  • Running cdf run function local no longer defaults to IDP_CLIENT_SECRET as the environment variable
    for the client secret. Instead, it will use the name specified in the function schedule configuration.
  • cdf auth verify now asks the user to verify before updating the capabilities of the service principal.

templates

Added

  • The sourcesystem modules now has example data.

Fixed

  • Ensure uniqueness of joins in the transformations of the cdf_connection_sql module.

Changed

  • Extension of CogniteCore and CogniteProcessIndustries now includes containers.

Details

What's Changed

Full Changelog: v0.3.7...v0.3.8

v0.3.7

06 Nov 13:07
7687b81
Compare
Choose a tag to compare

cdf

Fixed

  • Deploying RAW Tables/Databases no longer raises a ToolkitRequiredValueError.
  • Deploying Asset given as .csv/.parquet is now supported again.
  • Running cdf deploy no longer complains about !keyvault syntax in ExtractionPipelineConfig resources.

Templates

No changes

Details

Full Changelog: v0.3.6...v0.3.7

v0.3.6

04 Nov 11:04
5c93784
Compare
Choose a tag to compare

cdf

Fixed

  • When running cdf modules add, the Toolkit removed trailing slash in the module path causing a
    build error. This is now fixed.
  • When running cdf build, the Toolkit now stops if an error is encountered.
  • Asset resources without metadata are no longer always redeployed when running cdf deploy,
    only if the local is different than the CDF configuration.
  • Asset centric LocationFilters are no longer always redeployed when running cdf deploy,
    only if the local is different than the CDF configuration.
  • When deleting a Function the file is also removed if it exists.
  • The parentExternalId in LocationFilter is now correctly replaced by parentId when running cdf deploy.

templates

Added

  • The modules init wizard provides an option for an empty, custom module scaffolding.

Fixed

  • Removed unused variables from default InRobot configuration.
  • Added missing transformation asset to asset in cdf_sap_asset module.

Details

Full Changelog: v0.3.5...v0.3.6

v0.3.5

24 Oct 09:31
85e09fa
Compare
Choose a tag to compare

cdf

No changes

Templates

  • Added new module cdf_sharepoint to the sourcesystem package.
  • Added new package industrial_tool for data exploration and analytics with modules
    • cdf_search for setting up location filters
  • Added new package contextualization with modules
    • cdf_p_and_id_parser
    • cdf_timeseries_equipment_sql

Details

Full Changelog: v0.3.4...v0.3.5

v0.3.4

18 Oct 06:10
b9dce1c
Compare
Choose a tag to compare

cdf

Fixed

  • Building a WorkflowTrigger will no longer complain that authentication is an unused variable.
  • In resource Group, the following lookups are now done when running cdf deploy/clean:
    • securityCategoriesAcl idscope Security Names are now replaced by IDs.
    • locationFiltersAcl idscope external LocationFilter Ids are now replaced by IDs.
    • timeSeriesAcl idscope external TimeSeries IDs are now replaced by internal IDs.
    • assetRootIdScope external Asset IDs are now replaced by internal IDs.
  • The resource ResourceScopedGroup is now correctly deployed after RAW Tables and Databases,
    LocationFilters, and SecurityCategories when running cdf deploy.

Templates

Added

  • Added new package sourcesystem with modules
    • sap_asset
    • sap_events
    • pi
  • Added new modules for extension of CogniteProcessIndustries model.
    Full and minimum extension templates in quickstart and example packages.

Details

Full Changelog: v0.3.3...v0.3.4

v0.3.3

15 Oct 09:25
57352a5
Compare
Choose a tag to compare

cdf

Fixed

  • Running cdf deploy --verbose will no longer raise a ToolkitRequiredValueError when creating a new
    FunctionSchedule.
  • If --verbose is set on any command and an error occurs, the Toolkit will now print a full traceback.

Templates

Changed

  • The cdf_location_filter_example has been split into two separate modules: cdf_location_asset_centric,
    and cdf_location_datamodel_based. This is to better demonstrate the different ways to filter locations in CDF.

Removed

  • Module bootcamp data_sets and raw modules removed from ice_cream_api and oee
  • Module bootcamp default config removed from ice_cream_api

Fixed

  • Added missing default variable scheduleHourly to InField module cdf_infield_common.
  • The property featureConfiguration is in the APM_Config is now correctly a blob and not a list of blobs. This
    impacted the InRobot and InField options in cdf modules init and cdf modules add.
  • Module bootcamp error in calculation of site names for ooe_timeseries
  • Module bootcamp comment for icapi_extractors_source_id incorrect.
  • Added missing dataset ds_asset_oid to cdf_data_pipeline_3d_valhall example.
  • Added missing RAW table asset_oid_workmate to cdf_data_pipeline_asset_valhall example.
  • Added missing RAW table files_oid_fileshare and dataset ds_asset_oid to cdf_data_pipeline_files_valhall example.
  • Added missing dataset ds_asset_oid to cdf_data_pipeline_timeseries_valhall example.

Details

Full Changelog: v0.3.2...v0.3.3

v0.3.2

11 Oct 08:32
c8747dc
Compare
Choose a tag to compare

cdf

Fixed

  • Deploying Robotics resource Map now accounts for the dependencies on Frame and Location.
  • The Hosted Extractor Resources now respects the dependencies between the resources. For example, if a Job
    is referencing a Destination, the Destination will be deployed before the Job.
  • Deploying a view-based LocationFilter no longer raises a 400 error.
  • When running cdf modules init required modules are now created. Before, the Toolkit would skip creating
    the required modules.
  • When running cdf build, in the hosted_extractors folder, the Toolkit will now give a warning if a Destination
    is referring toa non-existing dataset.
  • Running cdf modules upgrade from version 0.3.0 and earlier will no longer fail if you
    have a view based LocationFilter in the locations folder.

templates

Fixed

  • Added missing views, containers, and spaces to the cdf_apm_base module.

Details

Full Changelog: v0.3.1...v0.3.2

v0.3.1

09 Oct 08:09
6e1aef9
Compare
Choose a tag to compare

cdf

Fixed

  • Views based location filters no longer raises a TypeError when running cdf clean or cdf deploy.
  • CogniteFiles are not recognized by CogniteFile and not .CogniteFile suffix in the files resource folder.

templates

No changes to templates.

Details

Full Changelog: v0.3.0...v0.3.1

v0.3.0

08 Oct 10:14
4c108bd
Compare
Choose a tag to compare

cdf

Added

  • Added support for device code login flow.
  • Support for CogniteFiles.
  • Docker release of the Toolkit.
  • Support for Hosted Extractors.
  • If there are multiple cognite_toolkit_service_principals, the cdf auth verify will offer to delete duplicates.
  • Dump for Assets and TimeSeries with cdf dump asset and cdf dump timeseries commands.
  • The new cdf modules add subcommand lets users add modules to an existing modules directory.
  • Added support for resource type Sequence in the classic folder.
  • Made the config.[env].yaml optional when running the `cdf build command.
  • Loaders for resource types Assets, 3DModel, and Robotic (Map, DataPostProcessing, RobotCapability,
    Frame, and Location). These loaders were earlier available as feature preview.
  • Support for LocationFilter in the locations folder.
  • Command cdf repo init to initialize the repository with .gitignore, .env, and if the user is on GitHub, creates default workflows for running Toolkit in CI/CD.
  • Command cdf modules list to list all modules.
  • Command cdf modules init to setup modules. This is interactive and will guide you through selecting the
    modules you want to use. You can bypass the interactive mode by using the --all flag. which
    will select all modules, similar to the previous cdf-tk init command.
  • Command cdf modules upgrade to upgrade all modules automatically.

Changed

  • Running cdf dump datamodels now dumps containers and views into separate folders.
  • When running deploy --dry-run, the Toolkit will not require write access to the CDF project.
  • The Toolkit no longer gives a warning if it cannot import Cognite Function code when executing the cdf build
    command. This is to separate the build and deploying of artifacts from validating/debugging the function code.
    Validation of the function code is expected to be handled by cdf run function local.
  • [BREAKING] The resource folder timeseries_datapoints is removed and csv and parquet files with
    datapoints are now expected to be in the timeseries folder.
  • The dump of data models has changed interface, now the data model id is optionally given as positional instead
    of flags. If now data model is given, the user will be prompted to select one.
  • Added flag --modules/-m to select which modules to build in the cdf build command.
  • The cdf build command no longer requires config.[env].yaml to be present. If it is not present, the Toolkit
    will use the default values for the environment.
  • [BREAKING] The command cdf auth verify has been split into cdf auth init and cdf auth verify. The init command
    is used to initialize the auth parameters, and the verify command is used to verify that required privileges are
    set. The init command will by default run the verify command after the initialization unless a --no-verify
    flag is set. In addition, the two commands have been reworked to be more user-friendly. They are now interactive
    (no longer requires a --interactive flag) and have no longer supports passing in a custom Group file. Instead,
    they are intended to only set up and verify a service principal for the Toolkit.
  • The WorkflowTrigger config files now supports object (dict) as a valid type for the
    data field. This will automatically be converted to a json string when deploying the trigger.
  • In the commands build and pull, modules upgrade and modules list, organization-dir is now an
    optional argument --organization-dir and -o instead of positional argument. This is to have consistent
    behavior with other commands.
  • The resource FunctionSchedule is not uniquely identified by name instead of cronExpression by the Toolkit.
    This enables multiple schedules with the same cron expression for the same function.
  • The Toolkit no longer gives warnings for naming conventions that are not followed.
  • [BREAKING] The resource Label is now in the resource folder classic and not in the labels folder.

Fixed

  • Uploading a file will no longer overwrite the FileMetadata.
  • Running cdf auth verify now prompts the user to create the cognite_toolkit_service_principal group if it does not exist.
  • In the cdf build command, version variables (DataModel, View, Transformations) are now always read as
    string and not integer. This ensures no false positive warnings for missing dependencies.
  • In the cdf deploy/clean command, if a transformation is writing to a DataModel or a View the version is
    now always read as a string. Before if it was for example, 3_0_0 it would be read as 300 and cause
    the deployment of the transformation to fail.
  • If you removed metadata in any resource file, the Toolkit would not update this change in CDF. This is now fixed.
  • The config value of a ExtractionPipelineConfig is now correctly parsed as a string. Before it was parsed as YAML,
    typically an object/dict, which caused loss of information. This is because
    yaml.safe_dump(yaml.safe_load(config)) != config as, for example, special YAML tags are lost.
  • The field default_organization_dir was not read in the cdf.toml file. This is now fixed.
  • If the version of a DataModel or View was set to 1_0_0 in the resource file, Toolkit would send
    it as 100 to the API. This is now fixed.
  • Groups without metadata no longer triggers redeploy when running cdf deploy
  • When running any command, the terminal would print warnings from the cognite-sdk. This is now fixed.

Removed

  • CSV files in the timeseries_datapoins folder with the string timeshift_ in the index will no longer
    be timeshifted to today when running cdf build
  • FileMetadata pattern $FILENAME is no longer supports prefix and suffix in the name parameter. This is to
    simplify the pattern.
  • [BREAKING] The command cdf describe is removed. This functionality was not used and thus removing it to simplify
    the Toolkit and to focus on the core functionality.
  • [BREAKING] Support for api parameters in Node resource is removed.
  • Toolkit no longer support Python 3.9.
  • The --interactive flag from the cdf deploy and cdf clean commands.
  • The shared flags --verbose. This has been deprecated and has been replaced by --verbose on each individual
    command. For example, before you could write cdf --verbose build --env dev, now you should write
    cdf build --env dev --verbose.
  • [BREAKING] The command cdf-tk init it now replaced by cdf repo init and cdf modules init.

Templates

Added

  • CogniteCore full and minimum extension templates in quickstart and example packages.
  • Added bootcamp modules ice_cream_api and oee.
  • New modules cognite_modules/inrobot.

Details

What's Changed

  • Fix locale for git in devcontainer by @gregertw in #852
  • [CDF-22327] ⚙ Move asset, robotics and 3D loaders by @doctrino in #853
  • [CDF-22333]🔩Replace CogniteClient with ToolkitClient by @doctrino in #854
  • [CDF-22338] 🍃 Int versioned Views and Data Models always redeploy by @doctrino in #861
  • [CDF-22328] 💣Replace cdf-tk init with cdf-tk modules init by @doctrino in #855
  • [CDF-22329] ☢Delete manuel migration by @doctrino in #856
  • [CDF-22336] 🧬 Function identifier by @doctrino in #857
  • [CDF-22335] 🤐 Remove naming checks by @doctrino in #858
  • [CDF-22337] 🏹 Tracking modules command by @doctrino in #859
  • [CDF-22349] 🦮 Introduce Config by @doctrino in #865
  • Location filter support by @ronpal in #833
  • include common folder for inrobot functions by @ana-gheorghe in #868
  • [CDF-22374] 🦈Move Feature Flag into cdf.toml by @doctrino in #872
  • [CDF-22348] 🫣GraphQL Support by @doctrino in #864
  • [CDF-22378] 🐠 Modules list command by @doctrino in #874
  • [CDF-22356] 🐡 Rework run function part 1 by @doctrino in #866
  • New dataclass for packages by @ronpal in #869
  • [CDF-22421] 🏢 Introduce Organization Directory by @doctrino in #877
  • Reference templates by @ronpal in #824
  • Default cdf.toml values by @ronpal in #890
  • ci: fix try ignore by @doctrino in #891
  • [CDF-22207, CDF-22356] 🐋 Running Functions Locally by @doctrino in #878
  • [CDF-22356] 😌Remove old function app by @doctrino in #879
  • 🛑 Not check test directory for dependencies. by @doctrino in #905
  • [CDF-22448] 😎 Build errors by @doctrino in #906
  • [CDF-22441] 🧱 Robustify reading feature flags by @doctrino in #908
  • [CDF-22474] 🐻‍❄️ Classic Resource Folder by @doctrino in #907
  • [CDF-22341] 🪦Rip cognite modules by @ronpal in #896
  • [CDF-22341] 🏗️ modules init --all (--clean) copies all files from _builtin_modules to org_dir/modules by @ronpal in...
Read more

v0.3.0b5

03 Oct 15:15
5bef5e1
Compare
Choose a tag to compare
v0.3.0b5 Pre-release
Pre-release

cdf

Added

  • Added support for device code login flow.
  • Support for uploading CogniteFiles.
  • Docker release of the Toolkit.

Changed

  • When running deploy --dry-run, the Toolkit will not require write access to the CDF project.

Fixed

  • Uploading a file will no longer overwrite the FileMetadata.

Templates

No changes to templates.

Details

Full Changelog: v0.3.0b4...v0.3.0b5