ScaiPlatform installation environment in the cloud
ScaiPlatform on AWS
After starting a new instance with the ScaiPlatform on AWS, you will be able to access its web interface following the instructions here. This section contains information about how to manage the ScaiPlatform installation after it is up and running.
Logging into the instance
After the AWS ScaiPlatform instance is up and running you can use your ssh client to log into the machine as you would normally do with any other AWS (linux) instance. Identify the public dns name for the ScaiPlatform instance (available in the description section in the ec2 console), make sure that you have made the port 22 (SSH) open to connections from your machine (e.g. laptop) and identify which SSH key you have used when starting the AWS ScaiPlatform instance. Then you can ssh into the machine. Use the ec2-user to connect. Example:
ssh -i ~/aws/eu-west-3-scai.pem ec2-user@ec2-35-180-42-61.eu-west-3.compute.amazonaws.com
ScaiPlatform installation files
A usual ScaiPlatform installation will have the following file structure:
| path | description |
|---|---|
| /opt/scai | Base path for the ScaiPlatform installation |
| /opt/scai/data | Data directory for the ScaiPlatform. This directory will be mounted on the separate device you have configured when launching the ScaiPlatform instance and will contain all the metadata (users, dashboards, etc.). Backup this device regularly. |
| /opt/scai/data/scai.mv.db | The main metadata file (H2 database file) |
| /opt/scai/scainotebook.conf | The main configuration file. Modify this file to change the default configuration parameters |
| /opt/scai/data/logback.xml | The main logging configuration file. Modify this file to increase the verbosity of the ScaiPlatform logs |
| /opt/scai/3rd-party-license | The license text files for all the third party software that is included in this ScaiPlatform installation. Together with the /opt/scai/NOTICE, these files contain all the information about the third party software that comes installed with the ScaiPlatform. |
| /opt/scai/bin | Binary helper scripts for starting the ScaiPlatform |
| /opt/scai/conf | Default configuration files for the ScaiPlatform. These files contain the default configuration parameters for your version of ScaiPlatform and should not be modified. These files can and will be overwritten by any update of the ScaiPlatform. |
| /opt/scai/lib | The libraries used by The ScaiPlatform |
| /opt/scai/logs | Path to store the application logs if enabled in the logging configuration file. See /opt/scai/data/logback.xml for an example. |
Accessing the logs
ScaiPlatform relies on systemd to start/stop the platform and for logging. Viewing the log files, for example, for the ScaiPlatform can be achieved by running:
sudo journalctl -xefu scai
To view the ScaiPlatform logs for today, one could run:
sudo journalctl -S today -u scai
To view the ScaiPlatform logs for a range of days, one could run:
sudo journalctl -S 2019-01-01 -U 2019-02-01 -u scai
View the journalctl manual page for more options: man journalctl.
Alternatively, if logging to a file has been configured in the logging configuration file, you can access the logs in the file specified (e.g. /opt/scai/logs/application.log).
Restarting the ScaiPlatform
To restart the ScaiPlatform, simply run:
sudo systemctl restart scai
ScaiPlatform on GCP
After starting a new instance with the ScaiPlatform on GCP, you will be able to access its web interface following the instructions here.
Logging into the instance
After successfully deploying the ScaiPlatform instance on GCP, next to the Log into the admin panel you will have multiple options to ssh into the instance. Choose one of them or use your preferred ssh client to log into the instance, e.g.:
ssh <public ip address>
The rest of the instructions about the installation file structure, accessing the logs, starting and restarting the ScaiPlatform are exactly the same as those described in the ScaiPlatform on AWS section.
ScaiPlatform on Azure
After starting a new instance with the ScaiPlatform on Microsoft Azure, you will be able to access its web interface following the instructions here.
Logging into the instance
After successfully deploying the ScaiPlatform instance on Microsoft azure, use your preferred ssh client to log into the instance, e.g.:
ssh <public ip address>
Make sure to use the SSH private key corresponding to the public key you introduced while configuring the ScaiPlatform instance deployment.
The rest of the instructions about the installation file structure, accessing the logs, starting and restarting the ScaiPlatform are exactly the same as those described in the ScaiPlatform on AWS section.