FAQ#

The app build command seems to be stuck?#

  • If the app uses services whose Helm charts are remotely hosted (e.g., NGC Helm registry), it takes longer to fetch the Helm charts compared to when the Helm charts are on the local filesystem.

Failed to load/export parameters of a graph#

  • Save the graph before loading or exporting parameters.

Unable to delete a backdrop#

  • Delete the nodes inside the backdrop first or move the nodes out of the backdrop before deleting it.

Graph is broken after sync up from the registry#

  • Close the graph before syncing.

Application builder CLI hangs#

  • Make sure UCS Studio is not running on the same system. UCS Studio holds registry cache DB lock which prevents CLI tool from accessing registry. Close UCS Studio as a workaround.

Unable to run WebSocket streaming with UCS Studio#

  • WebSocket Streaming is no longer supported.

Can I change the default paths for registry and config?#

Yes, you can change the paths.

export UCF_REGISTRY_ROOT=/your/desired/registry/path
export UCF_CONFIG_ROOT=/your/desired/config/path
# set api key again for this to take effect
ucf_ms_builder_cli registry repo set-api-key -a <YOUR_NGC_API_KEY>

Ensure the directories exist and you have sufficient permissions.

CLI service list operations do not seem to do anything#

This can happen if the local repository does not have any microservices and NGC repositories have not been added using the registry repo set-api-key command.

Once either of the two happens, the service list command will list all available microservices from local and/or NGC repositories.

CLI service sync command fails with error “An unhandled error occurred!”#

Use one of these alternatives:

  • Use the service versions command to get a list of available versions for the microservice. Use ucf_app_builder_cli service sync -n <name> -v <version> to sync a specific version of the microservice.

  • Use the repo sync command to sync the latest versions of all microservices.

  • Use the Repo Sync functionality of UCS Studio.

repo sync operation fails for local repository#

This is expected since the repo sync operation is not supported for local repository.

Parameters file exported from UCS Studio does not work#

If parameters for multiple microservices are exported using UCS Studio, you cannot load them again in UCS Studio or with UCS AppBuilder CLI. To make the file work, remove the --- YAML doc separators from the file.

Uninstall UCS Tools#

To uninstall UCS Tools, run:

sudo apt remove ucf-tools # if version < 2.5
sudo apt remove ucs-tools # if version >= 2.5

Note

DO NOT run sudo apt remove ucf. ucf is a Linux utility to update configuration file to incorporate user’s changes. Removing this will break your system.