Articles in this section

See more

System Maintenance

Avatar
Jason Stevens
  • Updated
Follow

System Restart

Shut Down the Servers

Once you've entered annotations and selected annotate, the data is saved in the system. If you bring down the servers while models are being trained, the models will be recreated and retrained upon restart.

Shut down the servers in the following order:

  1. Rosette Adaptation Studio

    stop-standalone.sh

  2. REX Training Server

    docker-compose down

  3. Rosette Server

    docker-compose down

Start the Servers

Once installed, start the servers in the following order:

Run Rosette Server (RS)

  1. Navigate to the installation directory containing the Docker Compose files. The default is:

    /basis/rs/rs-docker

  2. Run the service in detached mode.

    docker-compose up -d

  3. To check that the service has started, check the logs. This will display the last few lines of the logs from the service.

    tail /basis/rs/logs/wrapper.log

  4. The service can be tested by using a browser and navigating to http:<host>:<port>/rest/v1/info. This will display information about the version of RS.

    Example:

    http://localhost:8181/rest/v1/info

This instance of Rosette Server is shipped with two custom profiles, ad-base-linguistics and ad-suggestions. The are stored in /rosette/server/launcher/config/custom-profiles/ in the image. See Custom Profiles for instructions on setting up and using custom profiles.

Run the REX Training Server (RTS)

  1. Navigate to the installation directory containing the Docker Compose files. The default is:

    /basis/rts/rts-docker

  2. Run the service in detached mode.

    docker-compose up -d

  3. To check that the service has started, check the logs. This will display the last few lines of the logs from the service.

    tail /basis/rts/logs/messages.log

  4. The service can be tested by using a browser and navigating to http://<host>:<port> . This will list the endpoints to be used for health checks, API documentation, and metrics.

    Example:

    http://localhost:9080
Run Rosette Adaptation Studio (RAS)

Rosette Server and REX Training Server must be running.

  1. Navigate to the installation directory (default /basis/ras).

  2. Execute the script ./scripts/start-standalone.sh. This script starts the services in detached mode and prints the logs. CTRL-C to disconnect from the logs.

  3. Using a browser, navigate to http(s)://<host>:<port>/ to display the RAS landing page.

Export or Backup a Project

Note

You must be registered as a manager for the project.

You can backup an individual project to save a snapshot whenever necessary, for example at project milestones or before making major changes to the project.

  1. In the project menu, select Export Project.

  2. Add a descriptive name to the export. The studio will generate an ID for the download; the name you provide will be listed as the version.

  3. Confirm when prompted.

To view the exported versions:

  1. Select Manage from the navigation menu.

  2. Scroll down to the Exported Versions table.

  3. From here, you can download or delete the file. The downloaded file name will concatenate the project id and backup timestamp.

Import a Project

Note

You must be registered as a manager for the project.

To import a project, you must have an exported project file.

  1. Open a command window on the Rosette Adaptation Studio server.

  2. Run the import_project.sh command.

Tip

To convert an old NER project to the NER-Rosette template, use the --template rex option.

Usage: ./import_project.sh [options] export_file
Available options:
  --server <server>       Server to use (default: localhost)
  --https                 Contact server with https (default is http)
  --name <name>           Set the name of the project being imported
  --template <template>   Set the template of the project being imported, e.g. --template rex
                          (must be compatible with existing template)
  --async                 Upload asynchronously (may be required for large projects) [EXPERIMENTAL]
  --max-wait <secs>       Maximum amount of time to wait for project to be ready
                          (only effective when --async is set)

Upgrade to a New Release

At this time, all components must be upgraded when installing a new release.

  1. From Rosette Adaptation Studio backup all projects you want to move to the new release.

  2. Shut down the servers in the following order:

    1. Rosette Adaptation Studio

      stop-standalone.sh

    2. REX Training Server

      docker-compose down

    3. Rosette Server

      docker-compose down

  3. Install the new releases on a different server or virtual machine.

    1. Install Rosette Server (RS)

    2. Install REX Training Server (RTS)

    3. Install Rosette Adaptation Studio (RAS)

  4. Start the Servers.

  5. Import the projects into the new version of Rosette Adaptation Studio.

    Tip

    You can change the project template when importing the project during the upgrade. The templates must be compatible.

Migrate to a New Template

Note

You must be registered as a manager for the project.

There may be times when you want to migrate a project from one template to another. New templates may be added, or you may realize a different template will work better for your project.

Tip

The templates must be compatible.

These procedures can be used to move projects created with the NER template to the NER-Rosette template.

On the Same Server

This option copies a project created with the NER template to the NER-Rosette Template. The new copy is on the same server.

  1. Open the project.

  2. From the project menu in the upper right-hand corner of the project dashboard, select Clone.

  3. Enter the name of the new project.

  4. Check the box: Switch to NER-Rosette Template?.

  5. OK.

To a Different Server

This option creates a copy of the project on a new server. A different template can be specified.

  1. Export the project from the original server:

  2. Import the project onto the new server.

Backup the Server

Note

Rosette Adaptation Studio does not automatically backup the database. You must create a cron job or other process to create regular server backups.

The server uses a mongo database to store the projects.

The studio ships with a script file, backup_mongo.sh. This script creates a timestamped snapshot of the entire mongo database in the mongo_data_dump subdirectory.

The script can be run manually at any time.

We recommend setting up a cron job to backup the server automatically. For example, do crontab -e and add the following line to run the script weekly (replacing MYDIR with your installation directory):

0 0 * * 0 <MYDIR>/backup_mongo.sh > <MYDIR>/backup.log 2> <MYDIR>/backup.err

Restore

To restore the entire database from a backup use the mongorestore command. This restores all projects in the database. To save and restore an individual project, export and then import the project.

  1. Get the container id of the mongo docker server by querying the docker containers on the Rosette Adaptation Studio (RAS) server.

    docker ps

  2. Get a list of all the backups available. From the machine where the backup is run, the RAS directory will have a subdirectory named mongo_data_dump. The backups will be in the format DD-Mon-YYYY, e.g. 18-Oct-2020.

    ls

  3. Select the backup to restore and issue the following command:

    docker exec -i <container-id> mongorestore /data/dump/<backup_version>

    where <backup_version> is the backup name, 18-Oct-2020.

Related articles

Comments

0 comments

Article is closed for comments.





Powered by Zendesk