3.12.0 Migration Guide

This release includes several API cleanups, refactorings and changes which will be addressed in the following. This document includes general information about the changes necessary for the migration and a detailed list of API changes.

Changed Security Defaults

This release enables stricter permission settings for running containers by default. You will have issues upgrading to this release if your environment previously ran containers without a set security context. To resolve this, you may restore the more lax behavior by explicitly disabling the security context in your values.yaml as shown below.

securityContext:
  enabled: false

We recommend enabling the security context and adjusting your environment to adhere to the stricter security settings. You may need to clear previously used persistent volumes to resolve permission issues if the previous installation did not use a security context.

3D Space API (Experimental)

This release changes the experimental 3D Space API based on further development on the product story behind collaborative 3D spaces. The deprecated base path /space has been removed. The API no longer provides the capability to freely choose the space ID or namespace. Previously, it was possible to call add or setProperty on a chosen space and the space would be created implicitly. It is now required to create a space before add and setProperty calls are made, otherwise the operation will be rejected.

Body Nodes, Construction Geometry and Invisible Geometry

Starting with this release, Body Nodes are enabled by default. The system now loads the internal body structure of a part, providing a more detailed and accurate part hierarchy. In addition, two new geometry types can be configured in your values.yaml under the experimental section:

  • Construction geometry — Auxiliary and reference geometry.

  • Invisible geometry — Geometry belonging to the structure but set to hidden in the authoring CAD environment.

For each of these types a new instant3Dhub layer will be created. Note that these are disabled by default.

Note

Enabling these options will only apply to newly transcoded data. Previously transcoded data will not be affected. Be aware that enabling these options may lead to an increased number of nodes in the part hierarchy, which can impact cache size and transcoding time.

To ensure these changes take effect — especially for content originating from Catia or NX — you must clear your cache and retranscode the affected data. Only then will the updated geometry settings and the newly loaded body structures be applied correctly.

  • POST /space
  • POST /space/{namespace}
  • POST /space/{namespace}/{id}
  • GET /space/{namespace}/{id}
  • POST /space/{namespace}/{id}/add
  • POST /space/{namespace}/{id}/setProperty
  • POST /api/space/v1/{namespace}
  • POST /api/space/v1/{namespace}/{id}
  • POST /api/space/v1/{namespace}/{id}/add
  • POST /api/space/v1/{namespace}/{id}/setProperty

API Changes

The following list contain API additions, changes and removals which might be subject for migration efforts. Most alterations were performed to provide a more streamlined experience when working with the API and come only with minimal need for manual intervention from application developers.

ContextAPI

ViewerAPI

Events

Types

Enums

EventType

Property

SettingStrings

  • USAGE_GROUP
  • INITIAL_STATE_ACTIVATION
  • MAX_CONCURRENT_DOWNLOADS
  • MEASUREMENT_MATERIAL_DENSITIES

ViewerSettingStrings

  • SHOW_AUX_ON_NAVIGATION


Was this page helpful? Please leave a thumbs up or down.