Enterprise Nucleus Server Release Notes

2023.1.0

  • Released 06/13/2023

  • Primary focus of this release is updates to base components in the containers, bugfixes, and similar.

  • IMPORTANT:

    • This stack requires Docker 20. Docker 23 has not been tested by us and will likely not work.

    • This stack will not work with configuration from previous versions, requiring the following:

    • .env file for the Base Stack now needs LFT_SALT, which is a secret value used to sign LFT links. If you are upgrading, make sure that you do not destroy already existing keys, or you will break your existing installation.

  • Manual data upgrade is no longer required; Nucleus will do the following steps automatically:

    • Upgrade the DB (if required)

    • Verify the DB

    • If any errors are detected, attempt to repair them

    • Verify the DB post-repair, and not start in case any errors are still present.

    All of the above steps preserve logs and DB snapshots in case support personnel will require them.

    Progress can be observed in STDERR of nucleus-api container.

  • Included Jinja templates for stack and env files

  • Note that with this release, Core versioning scheme was brought up in line with SemVer. Practically, this results in an extra “dot” between hundredths and tens of the version number, ie, 114.0 -> 1.14.0, etc.

  • LFT Compression now disabled by default

  • Resolver Cache is now based on NGINX

  • SSO Gateway is now renamed to Nucleus Auth Router. For now, keeping the external facing names the same not to cause confusion

  • generate-sample-insecure-secrets.sh now has a mode to add missing secrets to the existing set

  • Components updates:

    • Core 1.14.17

    • Discovery Service 1.4.9

    • Authentication Service 1.4.9

    • Search Service 3.2.5

    • Tagging Service 3.1.6

    • Thumbnail Service 1.5.6

    • Nucleus Navigator 3.3.2

    • Auth Router (former SSO Gateway) 1.3.0

    • Detailed components’ notes

2022.4.0

  • Released 11/29/2022

  • This release primarily makes Atomic Checkpoints available as a feature, and fixes some bugs and issues.

  • Some users reported issues with generate-sample-insecure-secrets.sh script on some Linuxii, where OpenSSL does not accept double-dashes in front of arguments. The script now uses a single dash in arguments to openssl.

  • Components updates:

2022.3.0

2022.2.0

  • Released 09/06/2022

  • IMPORTANT: if using SSL and upgrading from previous versions, please make sure to update your Web endpoints from /omni/web2 to /omni/web3 throughout.

  • Fixed internal services’ registrations with Discovery to use server’s hostname throughout.

  • Ingress config sample:

    • Added /omni/ngsearch2 endpoint for NGSearch

    • Updated Navigator endpoint to /omni/web3

    • Fixed a typo exposing Canonical Name endpoint on canon-name instead of canonical-name path

  • Added standalone Navigator stack

  • Components updates:

    • Core 113.29

    • Discovery Service 1.4.4

    • Authentication Service 1.4.4. (not a typo)

    • Search Service 3.2.2

    • Thumbnail Service 1.5.1

    • Tagging Service 3.1.1

    • Nucleus Navigator 3.1.1

    • SSO Gateway 1.2.5

    • Detailed components’ notes

2022.1.0

  • Released 02/17/2022

  • IMPORTANT

    • This stack will not work with configuration from previous versions, requiring the following:

      • .env file for the Base Stack now needs AUTH_ROOT_OF_TRUST_LONG_TERM_PUB and AUTH_ROOT_OF_TRUST_LONG_TERM_PRI keypair specified in addition to other keys. This keypair is now used to signed long-lived authentication and refresh tokens. If you are upgrading, make sure that you do not destroy already existing keys, or you will lose your authentication service’s database

      • If using SSL, update your Search and Tagging endpoint routes from /omni/search2 to /omni/search3, and from /omni/tagging2 to /omni/tagging3. You can reuse your existing Ingress Router configuration in other respects

  • LFT service now supports scaling to multiple instances. Use --scale nucleus-lft=<no> argument to docker-compose up. We recommend one LFT per 10 concurrent up/downloads

  • More user friendly handling of unset but required settings’ variables

  • generate_sample_insecure_secrets.sh: added new secrets’ generation, added a safety block to prevent accidental keys’ deletion

  • Sample NGINX ingress router config: replaced 301s with 302s, updated endpoints due to services’ upgrades

  • Components updates:

    • Core 113.6

    • Navigator 2.4.4

    • Discovery Service 1.4.2

    • Authentication Service 1.4.0

    • Search Service 3.0.0

    • Thumbnail Service 1.4.4

    • Tagging Service 3.0.1

    • SSO Gateway 1.2.3

    • Detailed components’ notes

2021.3.2

  • Released 01/23/2022

  • A hotfix release, focused on fixing TLS/SSL connectivity issues from newer Clients (Apps and Connectors)

  • Components updates:

2021.3.1

  • Released 11/22/2021

  • Added SAML_SSO_MAX_BOUNCEBACK_URL_LENGTH variable to enable controlling max lengths of URLs passed back into the Authentication Service

  • Components updates:

2021.3.0

2021.2.3

  • Released 10/29/2021

  • Base Stack: added SECURITY_REVIEWED env var that is now required to be set to indicate that security posture was reviewed

  • Component updates:

2021.2.2

  • Released 10/13/2021

  • Base Stack SSL: fixed a typo in Login URL in auth service registration (this would cause the SSL stack to not work with Omniverse Apps)

  • Components updates:

2021.2.1

  • Released 10/04/2021

  • Patch release for 2021.2.0

  • Added a number of additional configuration parameters for SAML SSO to stack’s .env file

  • Data upgrade required!

    • Tooling included in the package in the base stack, notes added to README, .env files.

  • Components updates:

2021.2.0

  • Released 09/16/2021

  • Clarifications and rework in the .env and the .yml stack files

  • Re-structured distribution to include multiple stacks and artifacts, added README

  • Added Azure AD SSO support

  • Added support for SSL

  • Added support for backup/restore via nucleus-tools

  • Components updates:

    • Core 111.2

    • Navigator 2.3.0

    • Discovery Service 1.3.0

    • Authentication Service 1.1.0

    • Search Service 2.1.0

    • Thumbnail Service 1.4.1

    • Tagging Service 2.1.1

    • Snapshot Service: removed (features replaced with Checkpoints in Core Nucleus)

    • Detailed components’ notes

Warning

Upgrades from older versions than 2021.2.0 are not officially supported. Performing such an upgrade may result in loss of data. Contact your technical support representative if you wish to upgrade from a version older than 2021.2.0

2021.1.0 (abandoned)

  • Clarified documentation in the .env file

  • Nucleus Core 110.2

  • Omniverse Navigator (previously Web) 2.2.11

  • Discovery Service 1.0.5

  • Authentication Service 1.0.2

  • Search Service 2.1.0

  • Snapshot Service 2.0.3

  • Thumbnail Service 1.3.0

  • Tagging Service 2.0.7

2020.3.0

  • Nucleus Core 109.9

  • Omniverse Navigator (previously Web) 2.2.8

  • Discovery Service 1.0.5

  • Authentication Service 1.0.2

  • Search Service 2.0.3

  • Snapshot Service 2.0.3

  • Thumbnail Service 1.3.0

  • Tagging Service 2.0.7 added

2020.2

  • Nucleus Core 109.5

  • Web 2.2.1

  • Discovery Service 1.0.0 added

  • Authentication Service 1.0.1 added

  • Search (previously Index) Service 2.0.2

  • Snapshot Service 2.0.2

  • Thumbnail Service 1.2.5

  • Tagging Service 2.0.4 added

  • Required configuration amended and documented

2020.1

Initial release.

  • Nucleus Core 107.6

  • Web 2.1.0

  • Search 1.2.0

  • Snapshot Service 1.0.1

  • Thumbnail Service 1.2.3

  • Cache 1.3.1

  • Includes Compose files for Nucleus Stack and Nucleus Cache, and docs