From 7f431bcd0060e11966786afd167b8470291c43c3 Mon Sep 17 00:00:00 2001 From: Dmytro Polityka Date: Thu, 1 Aug 2024 12:32:12 +0200 Subject: [PATCH] update documentation for deployments --- docs/administration_of_deployments/configuration.rst | 9 +++++++++ docs/index.rst | 7 +++++++ env_example/assessment_module_manager.env | 3 +-- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/administration_of_deployments/configuration.rst diff --git a/docs/administration_of_deployments/configuration.rst b/docs/administration_of_deployments/configuration.rst new file mode 100644 index 00000000..e2d8b5e1 --- /dev/null +++ b/docs/administration_of_deployments/configuration.rst @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 0b1a3aeb..908ecef7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 \ No newline at end of file diff --git a/env_example/assessment_module_manager.env b/env_example/assessment_module_manager.env index 6182d37b..2dc42f12 100644 --- a/env_example/assessment_module_manager.env +++ b/env_example/assessment_module_manager.env @@ -1,5 +1,4 @@ PRODUCTION=1 -SECRET=abcdef12345 # module secrets, same as in the module env files MODULE_EXAMPLE_SECRET=12345abcdef @@ -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