Base Nucleus Stack

Base Nucleus Stack stands up all of its components with their basic, default, configuration.

It’s the main building block of your installation - with extra features added on top of it. This stack is also sufficient for basic evaluation.

Please re-visit the installation methodology prior to proceeding with installation.

Stack Notes

Scaling LFT

Large File Transfer (LFT) service can be scaled beyond default one instance to support increased throughput demands. We recommend one LFT per 10 concurrent up/downloads.

Scaling is achieved by spinning up more instances of nucleus-lft container of the Base Stack, using docker-compose .... up --scale nucleus-lft=<no> command.

Errors on Startup

If you see errors in the log spew on startup of a stack, your first reaction should be giving it time. If you see crashing and restarting containers, you should do the same.

These errors happen because Docker launches everything at the same time, and some services in a stack depend on other services. So, for example, if Authentication Service happens to come up before its dependency - Discovery Service - it will fail, crash (and be happily restarted by Docker).

Only after you’ve given it enough time (a good 2-3 minutes), and your state is somewhat of a “stable crashloop” of some services, investigation is warranted.

Data Upgrades

One reason for stable crashloops is an attempt to run a newer version of Nucleus on top of old data. Some versions of Nucleus require upgrade of the DBs along with software.

Data upgrade tools are included in your base stack, and documented there. Also, make sure to review Migration and Upgrades section of our documentation.

Verifying Base Nucleus is Up

When everything “settles in” and is running stable (containers not restarting), first thing you should do is direct your web browser to the IP address or hostname of a machine you have deployed it to, and attempt to log into the Navigator (Web UI). If you see that Web UI, you can be 99.9% certain that everything is perfectly fine.

Additionally, you can do the following checks in the Navigator:

  • Upload a >256KB file, and immediately download it - this validates the LFT Service

  • Upload an image and make sure that a thumbnail got created - this validates the Thumbnail service

  • Search for something - this validates the Search Service (note that building an index takes some time after start if your file tree is large - watch the log output of the Search Service)

  • Tag a file and see if that was successful and if the tag is properly read - this validates the Tagging service

Note to Workstation users: we have had confusions in the field with folks used to Nucleus Workstation, and switching to Enterprise Nucleus Server, not realizing a few things:

  • Omniverse Navigator runs on port 80 by default (so no need to do when accessing it with a browser).

  • There is no System Monitor - which is purely a Workstation entity to manage your services. With Enterprise Nucleus, you have the full power of Docker to do the same thing.

Open Ports

All ports that will be opened are configurable (and suggested defaults provided) in the .env files. Don’t forget about client assumptions when considering changing default values.