Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for deployments #324

Merged
merged 1 commit into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/administration_of_deployments/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Configuration
===========================================

Athena can serve requests from multiple LM systems. It uses a custom HTTP header ``X-Server-URL`` to identify the origin of each request. To prevent unauthorized use of resources, the admin must whitelist all supported deployments. This configuration is done in the ``assessment_module_manager/deployments.ini`` file or the corresponding Docker analog for server deployments using Docker images.

For each listed deployment, the admin must define a corresponding secret in the environment variable ``LMS_DEPLOYMENT_NAME_SECRET`` (replace DEPLOYMENT_NAME with the name from the .ini file) of the ``assessment_module_manager``.
Please note: Playground counts as an LMS and needs its own record.

This configuration does not exclude or replace inter-module authentication; Athena still requires keys between modules and the assessment module manager.
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,10 @@ Athena will use the information it is given and provide the automatic suggestion

athena_package/storage
athena_package/helpers

.. toctree::
:caption: Administration of Deployments
:includehidden:
:maxdepth: 1

administration_of_deployments/configuration
3 changes: 1 addition & 2 deletions env_example/assessment_module_manager.env
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
PRODUCTION=1
SECRET=abcdef12345

# module secrets, same as in the module env files
MODULE_EXAMPLE_SECRET=12345abcdef
Expand All @@ -9,7 +8,7 @@ MODULE_TEXT_COFEE_SECRET=12345abcdef
MODULE_PROGRAMMING_THEMISML_SECRET=12345abcdef

################################################################
# LMS Deployments #
# LMS Deployments #
################################################################
# the deployment name should correspond to the name in deployments.ini
LMS_DEPLOYMENT_NAME_SECRET=12345abcdef
Loading