Merge pull request #220 from openedx/bmtcril/production_configuration

docs: Add Production Configuration doc
openedx · Jun 4, 2024 · 8287d69 · 8287d69
2 parents 20570b6 + bd2b529
commit 8287d69
Show file tree

Hide file tree

Showing 5 changed files with 393 additions and 2 deletions.
diff --git a/docs/concepts/data_lifecycle_policy.rst b/docs/concepts/data_lifecycle_policy.rst
@@ -11,4 +11,4 @@ However, the data is not stored indefinitely by default. The data is keep for 1
 
 The setting value is a ClickHouse expression that defines the time-to-live policy (TTL) for the data. The expression is evaluated for each row in the table and should return a date. Rows with a date in the past are deleted. You can read more about the TTL policy in the ClickHouse documentation: https://clickhouse.tech/docs/en/engines/table-engines/mergetree-family/mergetree/#ttl
 
-The data is partioned by month this way the TLL policy is applied per partition. Make sure to set the TTL policy to a date that is compatible with the partitioning policy. e.g. `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 MONTH` or `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 YEAR`.
+The data is partioned by month so that the TLL policy is applied per partition. Make sure to set the TTL policy to a date that is compatible with the partitioning policy. e.g. `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 MONTH` or `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 24 MONTH` should work fine, but `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 90 DAY` may cause performance issues as the whole data partition cannot be dropped and needs to be periodically rebuilt.
diff --git a/docs/how-tos/clickhouse_cluster.rst b/docs/how-tos/clickhouse_cluster.rst
@@ -1,4 +1,4 @@
-.. clickhouse-cluster:
+.. _clickhouse-cluster:
 
 How To Run Aspects With ClickHouse Cluster
 ******************************************

diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst
@@ -6,6 +6,7 @@ How-Tos
    :caption: Content:
 
    Upgrade Aspects <upgrade>
+   Configure Aspects for Production <production_configuration>
    Changing the xAPI actor identifier <changing_actor_identifier>
    Backfill old or missing data <backfill>
    Superset extra assets <superset_extra_assets>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,4 +11,4 @@ However, the data is not stored indefinitely by default. The data is keep for 1

		The setting value is a ClickHouse expression that defines the time-to-live policy (TTL) for the data. The expression is evaluated for each row in the table and should return a date. Rows with a date in the past are deleted. You can read more about the TTL policy in the ClickHouse documentation: https://clickhouse.tech/docs/en/engines/table-engines/mergetree-family/mergetree/#ttl

		The data is partioned by month this way the TLL policy is applied per partition. Make sure to set the TTL policy to a date that is compatible with the partitioning policy. e.g. `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 MONTH` or `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 YEAR`.
		The data is partioned by month so that the TLL policy is applied per partition. Make sure to set the TTL policy to a date that is compatible with the partitioning policy. e.g. `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 2 MONTH` or `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 24 MONTH` should work fine, but `ASPECTS_DATA_TTL_EXPRESSION: toDateTime(emission_time) + INTERVAL 90 DAY` may cause performance issues as the whole data partition cannot be dropped and needs to be periodically rebuilt.