Skip to content

Commit 68c45ac

Browse files
DOCSP-34752 Add Dataset retention as a sub-menu (#296)
* DOCSP-34752 Add Dataset retention as a sub-menu * Apply suggestions from code review Co-authored-by: corryroot <72401712+corryroot@users.noreply.github.com> * DOCSP-34752 updates for CR feedback --------- Co-authored-by: corryroot <72401712+corryroot@users.noreply.github.com>
1 parent 5bbc80f commit 68c45ac

File tree

4 files changed

+64
-12
lines changed

4 files changed

+64
-12
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
.. _config-dataset-retention:
2+
3+
==================================
4+
Configure Dataset Retention Policy
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. default-domain:: mongodb
16+
17+
A dataset retention policy can help manage your {+dl+} storage by
18+
automatically deleting old datasets after a duration you specify. You
19+
can configure a retention polity for your {+dl+} dataset through the
20+
|service| |ui|.
21+
22+
Procedure
23+
---------
24+
25+
To configure a dataset retention policy for a pipeline, you must do the
26+
following:
27+
28+
.. procedure::
29+
:style: normal
30+
31+
.. step:: Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
32+
33+
.. step:: Select :guilabel:`Data Lake` from the :guilabel:`Deployment` section in the left-hand navigation.
34+
35+
.. step:: Click the :guilabel:`Edit` :icon-fa5:`pencil-alt` icon in the :guilabel:`Actions` column for the pipeline that you want to modify.
36+
37+
.. step:: Configure a :guilabel:`Dataset Retention Policy`.
38+
39+
a. Toggle :guilabel:`Dataset Retention Policy` to ``ON``.
40+
#. Enter a time value, in days, weeks, or months.
41+
42+
.. step:: Apply the changes.
43+
44+
a. Click :guilabel:`Continue`.
45+
#. Click :guilabel:`Review Changes` to review the changes.
46+
#. Click :guilabel:`Apply Changes` for the changes to take effect.
47+
48+
.. include:: /includes/fact-dataset-retention-policy.rst

source/administration/edit-data-pipeline.txt

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,15 @@ Procedure
6868

6969
.. step:: (Optional) Configure a :guilabel:`Dataset Retention Policy`.
7070

71-
A dataset retention policy can help manage your {+dl+} storage
72-
by automatically deleting old datasets after a duration you specify.
73-
74-
To configure a dataset retention policy for a pipeline, toggle
75-
:guilabel:`Dataset Retention Policy` to ``ON`` and enter a time value,
76-
in days, weeks, or months.
77-
78-
.. important::
79-
80-
Changes to your pipeline's dataset retention policy take effect immediately.
81-
If you lower the retention duration for a pipeline with existing datasets,
82-
then datasets that are beyond the new duration expire immediately.
71+
A dataset retention policy can help manage your {+dl+}
72+
storage by automatically deleting old datasets after a
73+
duration you specify.
74+
75+
To configure a dataset retention policy for a pipeline,
76+
toggle :guilabel:`Dataset Retention Policy` to ``ON`` and
77+
enter a time value, in days, weeks, or months.
78+
79+
.. include:: /includes/fact-dataset-retention-policy.rst
8380

8481
.. step:: (Optional) Make changes to your data extraction schedule.
8582

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. important::
2+
3+
Changes to your pipeline's dataset retention policy take effect
4+
immediately. If you lower the retention duration for a pipeline with
5+
existing datasets, then datasets that are beyond the new duration
6+
expire immediately.

source/manage-adl-dataset-pipeline.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ You can perform the following actions on your {+dl+} pipeline:
3131
Ingest Data On Demand </administration/ingest-data-on-demand>
3232
Pause and Resume Data Ingestion </administration/pause-resume-data-extraction>
3333
Delete Data Lake Pipeline </administration/delete-datalake-pipeline>
34+
Configure Dataset Retention </administration/config-dataset-retention>

0 commit comments

Comments
 (0)