Nucleus Tools#

Overview#

Nucleus Tools is a collection of utilities delivered via a Docker container providing advanced capabilities and functionality.

Nucleus Tools includes the following:

For additional Nucleus Tools documentation, use the following command to mount the container and display the in-container help on a Docker enabled server: (This can be run on your Enterprise Nucleus Server.)

export NUC_TOOLS=[PATH_TO_CONTAINER]
sudo docker run --rm -p 8888:80 -e "ACCEPT_EULA=Y" $NUC_TOOLS docs

Once the container is running, visit the IP Address or Hostname of the server in a web browser on TCP 8888.

Using Nucleus Tools#

To use one of the Nucleus Tools, use the following command to mount the container and execute the tool on a Docker enabled server: (This can be run on your Enterprise Nucleus Server.)

export NUC_TOOLS=[PATH_TO_CONTAINER]
sudo docker run --rm -e "ACCEPT_EULA=Y" $NUC_TOOLS (command)

For example, to run the ls tool, use the following command:

export NUC_TOOLS=[PATH_TO_CONTAINER]
sudo docker run --rm -e "ACCEPT_EULA=Y" $NUC_TOOLS ls

All included tools offer additional help and documentation by appending -h after the tool’s name.

Nucleus User Sanitization#

For the requirement of sanitizing a user’s personally identifiable information (PII) / user account from a Nucleus instance, the Nucleus Tool scrub_users is available.

The usage syntax for scrub_users is:

export NUC_TOOLS=[PATH_TO_CONTAINER]
sudo docker run --rm -e "ACCEPT_EULA=Y" $NUC_TOOLS scrub_users -u omniverse -p $omniverse_admin_password $server_hostname_or_ip $user_to_sanitize --do-it

For example, if your omniverse password is password1, your Enterprise Nucleus Server hostname is nucleus.example.com, and the user to sanitize is jdoe, the command to use is:

export NUC_TOOLS=[PATH_TO_CONTAINER]
sudo docker run --rm -e "ACCEPT_EULA=Y" $NUC_TOOLS scrub_users -u omniverse -p password1 nucleus.example.com jdoe --do-it

Once complete, logging into the Enterprise Nucleus Server will display the sanitized user. While the information generated is random, the sanitized user will resemble the following sample: