Versio.io Managed operation
Startup
If the installation is finished, the Docker images are available and your customizing is ready, the Versio.io instance can be started:
# Startup the Versio.io platform
bash startup.sh
Command: Start Versio.io instance
Enclosed is a sample output for starting a Versio.io instance:
Image: Versio.io Managed installer
Attention
After successful installation and first startup, we recommend that you perform the following activities as soon as possible:
- Login with the default user and password
- Configure SMTP server for e-mail notification (necessary for initial password set/reset!)
- Create new admin user (see
Environment settings - User & rights
) - Deactivate default admin user
- Change default password
- Remove from default environment (see
Environment settings - User & rights
)
- Create a new environment (see
Server settings - Environment settings
) - Invite new user to the new environment (see
Environment settings - User & rights
) - Install an OneImporter (see
Environment settings - OneImporter - Install
) - Configure OneImporter configuration (see
Environment settings - OneImporter - Configurations
)
Status
Get a detailed status of the operational environment and execution status of the Versio.io platform:
# Check operation state of the Versio.io platform
bash status.sh
Command: Status of the Versio.io platform
Then, for example, updates of Versio.io Docker images or other maintenance work can take place before Versio.io is started again.
Shutdown
To shut down a Versio.io instance the corresponding command must be executed:
# Shutdown the Versio.io platform
bash shutdown.sh
Command: Stop Versio.io instance
Then, for example, updates of Versio.io Docker images or other maintenance work can take place before Versio.io is started again.
Update
It is recommended to make a backup before each update!
To update a Versio.io Managd instance the corresponding commands should be executed in /opt/versio.io/install
folder as versio
user:
# Update the container images and the database schema
bash update.sh
Command: Update Versio.io Managed instance
If the application stack and the database of the Versio.io platform are operated on separate server instances, the update should be carried out as follows:
# LOGIN APP STACK HOST!
# Shutdown app stack
bash shutdown.sh
# SWITCH TO DATABSE HOST!
# Update database stack
bash update.sh
# SWITCH TO APP STACK HOST!
# Update app stack
bash update.sh
Command: Update Versio.io Managed instance with seperated app and database stack
Update AI content
Versio.io provides Artifical Intelligance (AI) content for the assessment of product lifecycle and vulnerabilities. These change daily and should therefore be updated daily. We recommend running the update as a cron job.
# Update the artificial intelligence content repositories (product, lifecycle, vulnerability etc.)
bash /opt/versio.io/install/utils/update-ai-rep.sh
Command: Update AI content on command line
# Cron job to update each day the artificial intelligence content repositories. Please configure it for user 'versio'!
0 6 * * * /bin/bash /opt/versio.io/install/utils/update-ai-rep.sh > /opt/versio.io/install/utils/update-ai-rep.log 2>&1
Command: Update AI content as cron job
Backup & restore
To backup a Versio.io server instance with all environment data the corresponding command must be executed (see environment varibale VERSIO_BACKUP_FOLDER):
# Backup all Versio.io content data
bash /opt/versio.io/install/utils/backup-database-content.sh
Command: Backup Versio.io instance includes all environment data
The backup script creates a physical backup with name versio.io-backup-<date>-<time>.tar.gz
. Physical backups are performed by copying the individual data files or directories (see logical versus physical backups).
To ensure data integrity, the Versio.io Server instance is stopped, the backup is performed and the Versio.io Server instance is restarted. This means that during this time the Versio.io Server is not available. The downtime depends on the data volume to be backed up and is displayed at the end of the backup execution.
It is recommended to run the backup continuously e.g. based on cron jobs:
# Crontab configuration for daily backup. Please configure it for user 'versio'!
40 0 * * * /opt/versio.io/install/utils/backup-database-content.sh
Configuration: Cronjob configuration for daily backup
To restore all Versio.io Managed data you can execute the follwoing script. Please note - All data of the current Versio.io Managed Instance will be overwritten!!!
# Restore all Versio.io content data
bash /opt/versio.io/install/utils/restore-database-content.sh <backup-date-time>
Configuration: Cronjob configuration for daily backup
Please note that a repocessing of the full-text search and topology detection reprocessing for each (!) environment must be performed when restoring backup data:
- see
Environment Settings - Full-text search - Reprocess environment
- see
Environment Settings - Topology detection - Reprocess environment