USP Manager

USP Manager is a configuration helper component for USP Server. It provides both a REST API and a web UI to manage the configuration of multiple USP Server instances. This component is used to push updated configurations to the servers and monitor their status.

Interactions

• USP Admin UI: USP Manager provides a user-friendly web interface for managing configurations.
• USP REST API: A RESTful API is exposed for programmatic configuration management.

Configuration Overview

The USP Manager requires a minimal set of configuration parameters to be operational. These values must be explicitly defined during installation, as they do not have default values.

• HCL Configuration File: Located at /opt/udmg/etc/usp-manager.hcl. This file defines the structured configuration using HCL (HashiCorp Configuration Language), where fields are written using dot notation to express the hierarchy of nested blocks.
• Environment Variable File: Environment variables are loaded from /opt/udmg/etc/usp-manager.env via the systemd unit.

info

Any configuration value defined via an environment variable will override the corresponding value in the HCL file.

Configuration File

You can specify the path to the configuration file using one of the following options (in order of precedence):

1. Environment Variable: USP_MANAGER_CONFIG
2. Command Line Flag: -c or --config
3. Default File: usp-manager.hcl (lowest precedence)

Commands Usage

To view the available commands and options, run:

usp-manager -h

To run a command, run:

usp-manager [command]

Available Commands

Command	Description
usp-manager [command] --help	Get more information about a command.
completion	Generate the autocompletion script.
help	Display help about any command.
migrate	Migrate to the latest version.
start	Start the USP Manager.
rotate	Rotate the Key Encryption Key (KEK). For more details, see Encryption Key Rotation.
reencrypt	Force all encrypted entities to be re-encrypted with the currently active DEK. For more details, see Encryption Key Rotation.
remove-ip-filter	Remove the USP Admin UI IP Filter assignment. For more details, see Lockout Recovery (CLI).

Available Flags

-h, --help      help for usp-manager
-v, --version   version for usp-manager

Start USP Manager

To start the USP Manager, use:

usp-manager start [flags]

Flags:

• -c, --config string: Path to the configuration file (default: usp-manager.hcl).
• -h, --help: Displays help information for the start command.

Migrate to the Latest Version

To migrate to the latest version, use:

usp-manager migrate [flags]

Flags:

• -c, --config string: Path to the configuration file (default: usp-manager.hcl).
• --dry-run: Prints the SQL statements to stdout without applying them.
• -h, --help: Displays help information for the migrate command.