docs: Add Production Configuration doc #220
Merged
Conversation
This file contains 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
bmtcril
force-pushed
the
bmtcril/production_configuration
branch
from
69acdb0 to
e0f54a3
Compare
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
| Setting up Ralph | ||
| ################ | ||
|
|
||
| You can deploy `Ralph via Helm chart`_. If you are using a pipeline that involves the Ralph learning record store (Celery or an event bus), you will want to run at least two Ralph servers for fault tolerance. Generally it consumes few resources and is quite stable. If you find that response times from Ralph are high it is usually because there are too many small ClickHouse inserts and you should turn on batching or increase your batch size. |
There was a problem hiding this comment.
Once this PR is released, we can implement the HPA strategy with a single filter. The values can be used similarly to what the official helmChart recommends: https://github.com/openfun/ralph/blob/main/src/helm/ralph/values.yaml#L76-L81
Ian2012
reviewed
May 10, 2024
|
|
||
| By default Superset is set to share the Open edX MySQL database and redis servers to save resources. Traditionally services like Aspects are fairly low traffic and this may be acceptable for a production environment, but you may wish to consider setting up separate instances for separation of resources and performance... especially for large sites. | ||
|
|
||
| Superset is a Flask application and can be load balanced if need be. Superset also uses Celery workers for asynchronous tasks. You may wish to run more than one of these, though Aspects does not currently make heavy use of them. |
There was a problem hiding this comment.
We will add autoscaling here too, in Superset and Superset workers
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
reviewed
May 10, 2024
Ian2012
approved these changes
May 10, 2024
bmtcril
force-pushed
the
bmtcril/production_configuration
branch
from
1d23d83 to
2749044
Compare
pomegranited
approved these changes
Jun 4, 2024
There was a problem hiding this comment.
👍 This reads well, and covers sufficient info for now. Thanks @bmtcril !
I put some formatting recommendations and fixes for reference links in #223 , feel free to merge if you're happy with them.
- I tested this by reading the rendered docs.
- I read through the code and text
-
I checked for accessibility issuesN/A - Includes documentation
-
User-facing strings are extracted for translationN/A
…ation docs: formatting fixes for Production Deployments
Co-authored-by: Cristhian Garcia <[email protected]>
Co-authored-by: Jillian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds some information about the choices and configuration options for Aspects