Tutor plugin: installation and modes
Install and enable
Install the plugin into your Tutor environment and enable it:
pip install tutor-contrib-panorama
tutor plugins enable panorama
Then rebuild the openedx and mfe images (the plugin adds the backend to the
openedx image and the MFE to the mfe image) and restart:
tutor images build openedx
tutor images build mfe
tutor {local|k8s} restart
Confirm the plugin is enabled with:
tutor plugins list
Choosing a mode
The plugin exposes Panorama’s four modes through the
PANORAMA_MODE variable. The default is DEMO.
Mode |
What it gives you |
Data handling |
|---|---|---|
|
The standard Panorama SaaS dashboards, populated with anonymized demo data, so you can try Panorama as if it were your own. This is the default. |
No data is extracted from your server. Nothing to configure. |
|
A basic but useful set of hosted dashboards, free of charge, as part of Aulasneo’s SaaS offering. |
Only relational and courseware data is extracted; tracking logs are not processed, so event-based analytics are unavailable. Your instance data is uploaded to Aulasneo’s servers. |
|
The full set of out-of-the-box dashboards, hosted and managed by Aulasneo (paid). |
Full extraction, including tracking logs. Your instance data is uploaded to Aulasneo’s servers. |
|
The full power of Panorama on your own data infrastructure (self-hosted data lake and QuickSight, or your own SaaS arrangement). |
You own the data lake; nothing is sent to Aulasneo. Requires the most setup. |
Mode quick starts
DEMO (default). Install, enable, rebuild images, and restart. No configuration is needed:
pip install tutor-contrib-panorama
tutor plugins enable panorama
tutor images build openedx
tutor images build mfe
tutor {local|k8s} restart
Note
DEMO mode shows the production Panorama SaaS dashboards with anonymized data and does not touch your data. It is the fastest way to see what Panorama looks like.
FREE and SAAS. Install and enable exactly as for DEMO, then set PANORAMA_MODE and
apply the additional settings Aulasneo provides. To get FREE credentials, register at the
Panorama site and email info@aulasneo.com; for SAAS,
contact info@aulasneo.com for setup instructions.
Warning
In FREE and SAAS modes, data from your instance is uploaded to Aulasneo’s servers. Make sure this is compatible with your data-handling requirements.
CUSTOM. Deploy your own AWS data lake first (see Tutor plugin: configuration for the plugin
variables and the IAM permissions, and Extract and Load: setting up the data lake for the underlying resources), set
PANORAMA_MODE: CUSTOM and the AWS/bucket variables, then rebuild and restart. In CUSTOM
mode the plugin creates the data lake tables and views for you during initialization (see
Tutor plugin: what it deploys and operations).
Applying configuration
Set variables with tutor config save, for example:
tutor config save \
--set PANORAMA_MODE=CUSTOM \
--set PANORAMA_BUCKET=my-panorama-data \
--set PANORAMA_AWS_ACCOUNT_ID=123456789012
Then rebuild the affected images if required and restart. The full list of variables is in Tutor plugin: configuration.