docs: First pass at docs, mostly around config and deployment #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add deployment and configuration docs (and move some of that info out of the README) - Add `prod_requirements` target to make deployment instructions easier - Remove feature toggles docs, since we don't use Waffle - Removes Concepts, Getting Started, Internationalization, Quickstart, References, and How-Tos docs until we have something to put in there - Remove some make targets from Testing that don't actually exist - Remove auto-documentation of "API" (don't need doc pages for all of the Python modules, since this is an IDA, not a library)
robrap
reviewed
Mar 11, 2025
Comment on lines
23
to
27
| This is intended to be run as a fully internal service with no database or admin frontend, with the LMS and CMS making calls to it unauthenticated. **It should not be callable directly from the internet.** | ||
|
|
||
| While the service uses AppArmor as a first (and really, only) line of defense, it should also be deployed in a way that does not allow direct connections to other IDAs or internal services within the Open edX deployment. In the ideal situation, networking would be set up to only allow outbound connections to a predetermined set of IPs or domains. | ||
|
|
||
| After any significant change to security settings, consider running the tests in ``./api_tests/``. These are run manually against a deployed service and can check for various sandbox weaknesses. |
Contributor
There was a problem hiding this comment.
I'd note here something about the important of properly securing this service, and sending people to the deployment doc for details.
|
|
||
| def on_init(app): # pylint: disable=unused-argument | ||
| """ | ||
| Run sphinx-apidoc after Sphinx initialization. |
Contributor
There was a problem hiding this comment.
- Are swagger docs completely separate from all this?
- How does the LMS generate these docs? https://docs.openedx.org/projects/edx-platform/en/latest/references/lms_apis.html. Wouldn't we want something similar for this service?
Contributor
Author
There was a problem hiding this comment.
Swagger is separate, yeah. I'll add that to #3 for future work.
docs/deployment.rst
Outdated
|
|
||
| The host or Docker image must be set up with a sandbox user, sandbox virtualenv, and sudoers file according to the documentation of the `codejail library <https://github.com/openedx/codejail>`__. This forms the foundation of the sandboxing, but does not provide much security by itself. | ||
|
|
||
| See `2U's Dockerfile <https://github.com/edx/public-dockerfiles/blob/main/dockerfiles/codejail-service.Dockerfile>`__ for an example of how you could set up your host or container. (There is not yet a Tutor plugin.) |
Contributor
There was a problem hiding this comment.
I like including a date for notes that you know will soon be outdated:
Suggested change
| See `2U's Dockerfile <https://github.com/edx/public-dockerfiles/blob/main/dockerfiles/codejail-service.Dockerfile>`__ for an example of how you could set up your host or container. (There is not yet a Tutor plugin.) | |
| See `2U's Dockerfile <https://github.com/edx/public-dockerfiles/blob/main/dockerfiles/codejail-service.Dockerfile>`__ for an example of how you could set up your host or container. (As of March 2025, there is not yet a Tutor plugin.) |
Consider adding an issue/ticket to codejail-service for replacing references to 2U once the Tutor plugin exists. I'm not sure if it makes sense to make it a ticket for the Tutor plugin itself or not, but you can decide.
Contributor
Author
There was a problem hiding this comment.
Good idea, created #26 and will add a date here.
docs/deployment.rst
Outdated
|
|
||
| Again following the codejail library's instructions, create an AppArmor profile and load it into the host. | ||
|
|
||
| This profile will need to be customized according to your service's app user, sandbox setup, and other details. It will also look different if you are using Docker or running the service dierctly on the host. For reference, here is `2U's AppArmor profile <https://github.com/edx/public-dockerfiles/blob/main/apparmor/openedx_codejail_service.profile>`__; note that the inner profile is the one that actually applies the sandboxing. |
Contributor
There was a problem hiding this comment.
Suggested change
| This profile will need to be customized according to your service's app user, sandbox setup, and other details. It will also look different if you are using Docker or running the service dierctly on the host. For reference, here is `2U's AppArmor profile <https://github.com/edx/public-dockerfiles/blob/main/apparmor/openedx_codejail_service.profile>`__; note that the inner profile is the one that actually applies the sandboxing. | |
| This profile will need to be customized according to your service's app user, sandbox setup, and other details. It will also look different if you are using Docker or running the service directly on the host. For reference, here is `2U's AppArmor profile <https://github.com/edx/public-dockerfiles/blob/main/apparmor/openedx_codejail_service.profile>`__; note that the inner profile is the one that actually applies the sandboxing. |
robrap
approved these changes
Mar 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
prod_requirementstarget to make deployment instructions easierRun
make docsto preview.Merge checklist:
Check off if complete or not applicable: