Transition from admin-docker-agent to Docker Compose

R2026b

Docker Compose is the recommended method for installing Polyspace® Access™. If you currently use admin-docker-agent to manage your installation, follow these steps to transition to Docker Compose while preserving your existing data and configuration.

Back Up Database and Prepare Configuration Files

  1. Back up your database. The database volume path is shown in the Cluster Admin under the Data volume field of the Polyspace Access Database service settings. For more information, see Back Up Polyspace Access Database.

  2. Download and extract the Docker Compose installation package from the MathWorks® Download page. For more information about extracting the installation package, see Install Polyspace Access using Docker Compose.

  3. Use the settings in the Cluster Admin to configure your new Polyspace Access installation. Copy the setting values to the corresponding variables in the .env file:

    Cluster Admin Setting.env Variable
    Gateway portGATEWAY_PORT
    HTTPS certificateGATEWAY_SSL_CERT_FILE
    HTTPS private keyGATEWAY_SSL_KEY_FILE
    Database volume pathPSACCESS_DB_VOLUME
    ETL directoriesPSACCESS_ETL_BASEDIR
    LDAP settingsVariables with LDAP prefix
    SAML settingsVariables with SAML prefix
    Administrator IDsUSERMANAGER_ADMIN_IDS

For more information about how to configure your .env file, see:

Transition to Docker Compose

  1. Stop the admin-docker-agent services. In the Cluster Admin interface, click Stop Apps. Then stop the admin-docker-agent binary by pressing Ctrl+C at the command line.

  2. Set the PSACCESS_DB_VOLUME variable in the .env file to your existing database volume path to preserve your uploaded results and user data without requiring a database migration.

  3. Copy the um-key.pem authentication private key to the folder specified by CERT_DIR in the .env file. If you do not have the original key file, generate a new one. Existing users need to log in again after the transition.

  4. Copy your license file to the folder specified by INSTALL_DIR in the .env file. Verify that LICENSE_FILE in the .env file is set to a path to your license file.

  5. Start the Docker Compose services:

    docker compose up -d

  6. Verify that all services are running and that your data is accessible. See Verify Your Installation.

Clean Up the Previous Installation

After you verify that Docker Compose is running correctly with your data:

  1. Remove the admin-docker-agent containers that are no longer in use:

    docker rm admin

  2. Optionally, remove the admin-docker-agent binary and installation files that you no longer need.

See Also

Topics