Releases: cognitedata/toolkit
Releases · cognitedata/toolkit
v0.3.8
cdf
Fixed
- Running
cdf run function local
no longer defaults toIDP_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
andCogniteProcessIndustries
now includes containers.
Details
What's Changed
- [CDF-23132, CDF-23133] 🕵Better error messages on ill defined dependencies by @doctrino in #1172
- [CDF-23166] ADO pipelines to use containers containers by @ronpal in #1174
- [CDF-23175] 🚊 Verify question before updating by @doctrino in #1176
- [CDF-23100] ➡ Run workflow Part 1 by @doctrino in #1173
- [CDF-23100] ➡ Run workflow Part 2 by @doctrino in #1177
- [CDF-23097] 👻 Example data by @doctrino in #1179
- [CDF-23189] 🕵 Verify quickstart package by @doctrino in #1180
- [CDF-23210] 🤕 Filtering on space by @doctrino in #1186
- [CDF-23209] 🤵 Linting contextualization functions by @doctrino in #1182
- [CDF-23223] 🐋 Extension containers by @doctrino in #1187
- [CDF-22845] 🥺 Support streamlit by @doctrino in #1181
- Prepare 0.3.8 by @doctrino in #1188
Full Changelog: v0.3.7...v0.3.8
v0.3.7
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 inExtractionPipelineConfig
resources.
Templates
No changes
Details
- Bootcamp updates by @petreeb in #1160
- [CDF-21838] S🪓 plit utils.py into a submodule by @doctrino in #1167
- [CDF-23093] 🥬Load Table Formats by @doctrino in #1152
- [CDF-23154] Distinguish between DataBase and Table by @doctrino in #1168
- [CDF-22997] 🛡️ limit env replacement to loaders with auth/credentials by @ronpal in #1155
- [CDF-23157] No more complains by @doctrino in #1169
- Prepare 0.3.7 by @doctrino in #1170
Full Changelog: v0.3.6...v0.3.7
v0.3.6
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 withoutmetadata
are no longer always redeployed when runningcdf deploy
,
only if the local is different than the CDF configuration.- Asset centric
LocationFilter
s are no longer always redeployed when runningcdf 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
inLocationFilter
is now correctly replaced byparentId
when runningcdf 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
incdf_sap_asset
module.
Details
- docs; poste fix by @doctrino in #1132
- 🐛Fix P&ID Annotation by @doctrino in #1134
- residue variables by @ronpal in #1133
- [CDF-23033] 🦈DML valid Extension Models by @doctrino in #1137
- [CDF-22975] 🧑
✈️ Warning on deploying to prod by @doctrino in #1138 - Typo in connection transformation by @doctrino in #1139
- [CDF-22808] Custom module creation by @ronpal in #1144
- [CDF-23045] Preserving trailing slash on 'modules/' by @ronpal in #1145
- [CDF-22891] cdf_connection_sql by @doctrino in #1143
- Revert full extionsion by @doctrino in #1146
- [CDF-23032] 🛑 Build stop on error by @doctrino in #1148
- [CDF-22957] 🐘 Remove redundant warning in CICD by @doctrino in #1153
- [CDF-23039] 🏃♂️ Finish Quickstart by @doctrino in #1147
- [CDF-23073] 🪱 Fix LocationFilter by @doctrino in #1156
- [CDF-22720] Support parent external id in location filter by @doctrino in #1162
- [CDF-23090, CDF-23107] 🦍Create RAW Database before Table by @doctrino in #1158
- [CDF-23012] Delete file ID when function is deleted. by @doctrino in #1157
- Move location filter examples by @doctrino in #1163
- Prepare 0.3.6 by @doctrino in #1164
Full Changelog: v0.3.5...v0.3.6
v0.3.5
cdf
No changes
Templates
- Added new module
cdf_sharepoint
to thesourcesystem
package. - Added new package
industrial_tool
for data exploration and analytics with modulescdf_search
for setting up location filters
- Added new package
contextualization
with modulescdf_p_and_id_parser
cdf_timeseries_equipment_sql
Details
- small fix to avoid mixup between environments by @ronpal in #1110
- [CDF-22886] File datasource module by @ronpal in #1105
- Fix source system modules by @doctrino in #1111
- [CDF-22892] 📍Module search location by @ronpal in #1112
- [CDF-22809] 🔓Dev auth write all by @doctrino in #1122
- Fix all groups by @doctrino in #1123
- Remove userProfilesAcl by @doctrino in #1125
- [CDF-22890] 😈Diagram Parser Module by @doctrino in #1113
- [CDF-22888] connect CogniteAssets and CogniteTimeSeries by @ronpal in #1114
- [CDF-23000] 🧑🔧Cleanup naming by @doctrino in #1127
- [CDF-22841] 🧐 Require Kind by @doctrino in #1126
- build: fix changelog by @doctrino in #1129
- Prepare 0.3.5 by @doctrino in #1130
Full Changelog: v0.3.4...v0.3.5
v0.3.4
cdf
Fixed
- Building a
WorkflowTrigger
will no longer complain thatauthentication
is an unused variable. - In resource
Group
, the following lookups are now done when runningcdf 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 afterRAW
Tables
andDatabases
,
LocationFilters
, andSecurityCategories
when runningcdf deploy
.
Templates
Added
- Added new package
sourcesystem
with modulessap_asset
sap_events
pi
- Added new modules for extension of
CogniteProcessIndustries
model.
Full and minimum extension templates inquickstart
andexample
packages.
Details
- [CDF-22879] Lower bound cognite-sdk >=7.63.5 by @doctrino in #1097
- 💀Skeleton for SourceSystem package by @doctrino in #1098
- [CDF-22884] 👨🔧SAP Module Template by @doctrino in #1099
- [CDF-22934] 🧑🏭IDM Model extension by @doctrino in #1102
- [CDF-22933] 🦏 SAP round2 events by @doctrino in #1103
- [CDF-22885] 🥧 AVEVA PI source module by @ronpal in #1101
- [CDF-22938] 🦡 Pretty badges by @doctrino in #1106
- [CDF-22936] 🐧 Lookup Security Cagetgories in Groups by @doctrino in #1104
- Removing invalid volumes mount in the default github workflow by @ddonukis in #1107
- Prepare 0.3.4 by @doctrino in #1108
Full Changelog: v0.3.3...v0.3.4
v0.3.3
cdf
Fixed
- Running
cdf deploy --verbose
will no longer raise aToolkitRequiredValueError
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
,
andcdf_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 fromice_cream_api
andoee
- Module
bootcamp
default config removed fromice_cream_api
Fixed
- Added missing default variable
scheduleHourly
toInField
modulecdf_infield_common
. - The property
featureConfiguration
is in theAPM_Config
is now correctly a blob and not a list of blobs. This
impacted the InRobot and InField options incdf modules init
andcdf modules add
. - Module
bootcamp
error in calculation of site names forooe_timeseries
- Module
bootcamp
comment foricapi_extractors_source_id
incorrect. - Added missing dataset
ds_asset_oid
tocdf_data_pipeline_3d_valhall
example. - Added missing RAW table
asset_oid_workmate
tocdf_data_pipeline_asset_valhall
example. - Added missing RAW table
files_oid_fileshare
and datasetds_asset_oid
tocdf_data_pipeline_files_valhall
example. - Added missing dataset
ds_asset_oid
tocdf_data_pipeline_timeseries_valhall
example.
Details
- [CDF-22868] 🐋Fix APMConfig container by @doctrino in #1084
- [CDF-22859] ☕ Create boilerplate Azure Devops pipelines with repo init command by @ronpal in #1075
- Bootcamp config update by @petreeb in #1086
- [CDF-22820] 😋Bump to stable by @doctrino in #1089
- [CDF-22819]🔥 Raise if error in Build by @doctrino in #1090
- [CDF-22867] 😵💫 Function Schedule bug by @doctrino in #1085
- [CDF-22863] 😯 Build packages without warnings Part 1 by @doctrino in #1087
- [CDF-22863] 😯 Build packages without warnings Part 3 by @doctrino in #1092
- [CDF-22882] ⚾ Remove catching broad exceptions by @doctrino in #1093
- [CDF-22895] Update location filters by @doctrino in #1094
- Prepare 0.3.3 by @doctrino in #1095
Full Changelog: v0.3.2...v0.3.3
v0.3.2
cdf
Fixed
- Deploying
Robotics
resourceMap
now accounts for the dependencies onFrame
andLocation
. - The Hosted Extractor Resources now respects the dependencies between the resources. For example, if a
Job
is referencing aDestination
, theDestination
will be deployed before theJob
. - Deploying a view-based
LocationFilter
no longer raises a400
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 thehosted_extractors
folder, the Toolkit will now give a warning if aDestination
is referring toa non-existing dataset. - Running
cdf modules upgrade
from version0.3.0
and earlier will no longer fail if you
have a view basedLocationFilter
in thelocations
folder.
templates
Fixed
- Added missing views, containers, and spaces to the
cdf_apm_base
module.
Details
- [CDF-22840] 🌍Integration test of Complete Org by @doctrino in #1074
- [CDF-22860] 🤖⛓️💥Robot test by @doctrino in #1078
- [CDF-22839] 🛞 Change for view bug by @doctrino in #1076
- [CDF-22854] 🤨Robotics Dependency by @doctrino in #1077
- [CDF-22861] 🫤Required is always selected by @doctrino in #1079
- 🧑🔧Update SDK by @doctrino in #1080
- [CDF-22862] 👷 Missing views apm model by @doctrino in #1081
- Prepare 0.3.2 by @doctrino in #1082
Full Changelog: v0.3.1...v0.3.2
v0.3.1
cdf
Fixed
- Views based location filters no longer raises a TypeError when running
cdf clean
orcdf deploy
. - CogniteFiles are not recognized by
CogniteFile
and not.CogniteFile
suffix in thefiles
resource folder.
templates
No changes to templates.
Details
- 🤦Typo in Changelog by @doctrino in #1068
- [CDF-22837] 😱 Bug in Location Filter by @doctrino in #1071
- [CDF-22832] 🤗 Recognize cognite files by
CogniteFile
and not.CogniteFile
by @doctrino in #1069 - Prepare 0.3.1 by @doctrino in #1072
Full Changelog: v0.3.0...v0.3.1
v0.3.0
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_principal
s, thecdf auth verify
will offer to delete duplicates. - Dump for
Assets
andTimeSeries
withcdf dump asset
andcdf 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 theclassic
folder. - Made the
config.[env].yaml
optional when running the `cdf build command. - Loaders for resource types
Assets
,3DModel
, andRobotic
(Map
,DataPostProcessing
,RobotCapability
,
Frame
, andLocation
). These loaders were earlier available as feature preview. - Support for
LocationFilter
in thelocations
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 previouscdf-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 bycdf run function local
. - [BREAKING] The resource folder
timeseries_datapoints
is removed andcsv
andparquet
files with
datapoints are now expected to be in thetimeseries
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 thecdf build
command. - The
cdf build
command no longer requiresconfig.[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 intocdf auth init
andcdf auth verify
. Theinit
command
is used to initialize the auth parameters, and theverify
command is used to verify that required privileges are
set. Theinit
command will by default run theverify
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 supportsobject
(dict
) as a valid type for the
data
field. This will automatically be converted to ajson
string when deploying the trigger. - In the commands
build
andpull
,modules upgrade
andmodules 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 byname
instead ofcronExpression
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 folderclassic
and not in thelabels
folder.
Fixed
- Uploading a file will no longer overwrite the
FileMetadata
. - Running
cdf auth verify
now prompts the user to create thecognite_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 aDataModel
or aView
the version is
now always read as a string. Before if it was for example,3_0_0
it would be read as300
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 aExtractionPipelineConfig
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 thecdf.toml
file. This is now fixed. - If the version of a
DataModel
orView
was set to1_0_0
in the resource file, Toolkit would send
it as100
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 stringtimeshift_
in the index will no longer
be timeshifted to today when runningcdf build
- FileMetadata pattern
$FILENAME
is no longer supports prefix and suffix in thename
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 thecdf deploy
andcdf 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 writecdf --verbose build --env dev
, now you should write
cdf build --env dev --verbose
. - [BREAKING] The command
cdf-tk init
it now replaced bycdf repo init
andcdf modules init
.
Templates
Added
- CogniteCore full and minimum extension templates in
quickstart
andexample
packages. - Added
bootcamp
modulesice_cream_api
andoee
. - 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
withcdf-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...
v0.3.0b5
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
- [CDF-22718] 🌳 When running
deploy --dry-run
, the Toolkit will not require write access to the CDF project. by @ronpal in #1031 - [CDF-22685] 😼 Builder Concept Part 1 by @doctrino in #1017
- [CDF-22685] 😼 Builder Concept Part 2 by @doctrino in #1032
- [CDF-22685] 😼 Builder Concept Part 3 by @doctrino in #1033
- Add authlib dependency and configure OAuth2 authentication by @gregertw in #846
- [CDF-22685] 😼 Builder Concept Part 4 by @doctrino in #1034
- [CDF-22745] 📦 feat: Upload Cognite Files by @doctrino in #1036
- [CDF-22354] 🐋 Docker image by @doctrino in #1035
- fix by @doctrino in #1043
- Prepare 0.3.0b5 by @doctrino in #1044
Full Changelog: v0.3.0b4...v0.3.0b5