Skip to content

Commit d441e59

Browse files
authored
(DOCSP-29724) adding 7 new atlascli commands to the datalakes docs (#285)
* (DOCSP-29724) adding 7 new atlascli commands to the datalakes docs * (DOCSP-29724) adding atlascli commands to datalakes docs * (DOCSP-29724) deleting a redundant command * (DOCSP-29724) pushing to master * (DOCSP-29724) title change
1 parent f62d1ca commit d441e59

13 files changed

+836
-94
lines changed

assets.toml

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,22 @@ version = "mongocli/v1.30.0"
99
source = "docs/atlascli/command/atlas-accessLists-create.txt"
1010
output = "command/atlas-accessLists-create.txt"
1111

12+
[[assets.sources.repository.targets]]
13+
source = "docs/atlascli/command/atlas-dataLakePipelines-availableSchedules-list.txt"
14+
output = "command/atlas-dataLakePipelines-availableSchedules-list.txt"
15+
16+
[[assets.sources.repository.targets]]
17+
source = "docs/atlascli/command/atlas-dataLakePipelines-availableSnapshots-list.txt"
18+
output = "command/atlas-dataLakePipelines-availableSnapshots-list.txt"
19+
1220
[[assets.sources.repository.targets]]
1321
source = "docs/atlascli/command/atlas-dataLakePipelines-create.txt"
1422
output = "command/atlas-dataLakePipelines-create.txt"
1523

24+
[[assets.sources.repository.targets]]
25+
source = "docs/atlascli/command/atlas-dataLakePipelines-datasets-delete.txt"
26+
output = "command/atlas-dataLakePipelines-datasets-delete.txt"
27+
1628
[[assets.sources.repository.targets]]
1729
source = "docs/atlascli/command/atlas-dataLakePipelines-delete.txt"
1830
output = "command/atlas-dataLakePipelines-delete.txt"
@@ -25,15 +37,25 @@ output = "command/atlas-dataLakePipelines-describe.txt"
2537
source = "docs/atlascli/command/atlas-dataLakePipelines-list.txt"
2638
output = "command/atlas-dataLakePipelines-list.txt"
2739

40+
[[assets.sources.repository.targets]]
41+
source = "docs/atlascli/command/atlas-dataLakePipelines-pause.txt"
42+
output = "command/atlas-dataLakePipelines-pause.txt"
43+
2844
[[assets.sources.repository.targets]]
2945
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-watch.txt"
3046
output = "command/atlas-dataLakePipelines-runs-watch.txt"
3147

48+
[[assets.sources.repository.targets]]
49+
source = "docs/atlascli/command/atlas-dataLakePipelines-start.txt"
50+
output = "command/atlas-dataLakePipelines-start.txt"
51+
52+
[[assets.sources.repository.targets]]
53+
source = "docs/atlascli/command/atlas-dataLakePipelines-trigger.txt"
54+
output = "command/atlas-dataLakePipelines-trigger.txt"
55+
3256
[[assets.sources.repository.targets]]
3357
source = "docs/atlascli/command/atlas-dataLakePipelines-update.txt"
3458
output = "command/atlas-dataLakePipelines-update.txt"
35-
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-watch.txt"
36-
output = "command/atlas-dataLakePipelines-runs-watch.txt"
3759

3860
[[assets.sources.repository.targets]]
3961
source = "docs/atlascli/command/atlas-dataLakePipelines-watch.txt"

source/administration/delete-datalake-pipeline.txt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ datasets, including the data, and removes the {+dl+} datasets from your
1313
federated database instances where it's referenced.
1414
You can't undo this operation.
1515

16+
You can also delete a dataset from your {+dl+} pipeline at any time from
17+
the {+atlas-cli+}. When you delete a dataset from your {+dl+} pipeline,
18+
|service| removes the {+dl+} dataset from your federated database instances
19+
where it's referenced. You can't undo this operation.
20+
1621
Procedure
1722
---------
1823

@@ -23,6 +28,11 @@ Procedure
2328

2429
.. include:: /includes/extracts/atlas-dataLakePipelines-delete.rst
2530

31+
Delete a Pipeline Dataset
32+
`````````````````````````
33+
34+
.. include:: /includes/extracts/atlas-dataLakePipelines-datasets-delete.rst
35+
2636
.. tab:: {+atlas-admin-api+}
2737
:tabid: api
2838

@@ -54,4 +64,4 @@ Procedure
5464

5565
.. step:: Click :icon:`trash` in the :guilabel:`Actions` column for the pipeline that you wish to delete.
5666

57-
.. step:: Click :guilabel:`Delete` in the confirmation window.
67+
.. step:: Click :guilabel:`Delete` in the confirmation window.

source/administration/ingest-data-on-demand.txt

Lines changed: 52 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,61 +9,70 @@ Trigger Data Ingestion On Demand
99
You can manually trigger an ingestion of snapshot data from the
1010
|service| cluster to {+adl+} datasets if you configured :guilabel:`On
1111
Demand` extraction in your {+dl+} pipeline. You can trigger data
12-
ingestion from the |service| |ui| and {+dl+} Pipelines |api|.
12+
ingestion from the |service| |ui|, the {+dl+} Pipelines |api|, or the
13+
{+atlas-cli+}.
1314

14-
Trigger Data Ingestion from the |service| UI
15-
--------------------------------------------
15+
.. tabs::
1616

17-
.. procedure::
18-
:style: normal
17+
.. tab:: {+atlas-cli+}
18+
:tabid: atlascli
1919

20-
.. step:: Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
20+
.. include:: /includes/extracts/atlas-dataLakePipelines-trigger.rst
2121

22-
.. step:: Select :guilabel:`Data Lake` under :guilabel:`Deployment` on the left-hand navigation.
22+
Watch for a Pipeline Run to Complete
23+
````````````````````````````````````````````````````
2324

24-
.. step:: Click the vertical ellipsis (:icon-fa4:`ellipsis-v`) for the {+dl+} for which you configured :guilabel:`On Demand` ingestion and select :guilabel:`Trigger an On Demand Pipeline Run`.
25+
.. include:: /includes/extracts/atlas-dataLakePipelines-runs-watch.rst
2526

26-
.. step:: Select the snapshot, from which to ingest data, from the dropdown.
27+
.. tab:: {+atlas-admin-api+}
28+
:tabid: api
2729

28-
The dropdown shows a list of all the snapshots on your |service|
29-
cluster. However, you can select only the snapshots from which
30-
{+dl+} hasn't yet ingested data; the grayed-out snapshots are
31-
snapshots from which your {+dl+} has already ingested data.
30+
To trigger data ingestion through the |api|, send a ``POST`` request
31+
to the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``trigger``
32+
endpoint with the name of the pipeline for which you want to trigger
33+
data ingestion. To learn more about the |api| syntax and parameters for
34+
the ``trigger`` endpoint, see :oas-atlas-op:`Trigger On-Demand Snapshot
35+
Ingestion </triggerOneOnDemandSnapshotIngestion>`.
3236

33-
You can also send a ``GET`` request to the :oas-atlas-tag:`{+dl+}
34-
</Data-Lake-Pipelines>` ``availableSnapshots`` endpoint to
35-
retrieve the list of backup snapshots that you can use to trigger
36-
an on-demand pipeline run. To learn more about the |api| syntax
37-
and options for the ``availableSnapshots`` endpoint, see
38-
:oas-atlas-op:`Return Available Backup Snapshots for One Data
39-
Lake Pipeline </returnAvailableSnapshotsForPipeline>`.
40-
41-
.. step:: Click :guilabel:`Confirm`.
37+
.. tip::
4238

43-
|service| displays a blue banner at the top of the page that
44-
shows the data ingestion status.
39+
You can send a ``GET`` request to the :oas-atlas-tag:`{+dl+}
40+
</Data-Lake-Pipelines>` ``availableSnapshots`` endpoint to retrieve
41+
the list of backup snapshots that you can use to trigger an
42+
on-demand pipeline run. To learn more about the |api| syntax and
43+
options for the ``availableSnapshots`` endpoint, see
44+
:oas-atlas-op:`Return Available Backup Snapshots for One Data Lake
45+
Pipeline </returnAvailableSnapshotsForPipeline>`.
4546

46-
Trigger Data Ingestion from the API
47-
-----------------------------------
47+
.. tab:: {+atlas-ui+}
48+
:tabid: ui
4849

49-
To trigger data ingestion through the |api|, send a ``POST`` request
50-
to the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``trigger``
51-
endpoint with the name of the pipeline for which you want to trigger
52-
data ingestion. To learn more about the |api| syntax and parameters for
53-
the ``trigger`` endpoint, see :oas-atlas-op:`Trigger On-Demand Snapshot
54-
Ingestion </triggerOneOnDemandSnapshotIngestion>`.
50+
.. procedure::
51+
:style: normal
5552

56-
.. tip::
53+
.. step:: Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
5754

58-
You can send a ``GET`` request to the :oas-atlas-tag:`{+dl+}
59-
</Data-Lake-Pipelines>` ``availableSnapshots`` endpoint to retrieve
60-
the list of backup snapshots that you can use to trigger an
61-
on-demand pipeline run. To learn more about the |api| syntax and
62-
options for the ``availableSnapshots`` endpoint, see
63-
:oas-atlas-op:`Return Available Backup Snapshots for One Data Lake
64-
Pipeline </returnAvailableSnapshotsForPipeline>`.
55+
.. step:: Select :guilabel:`Data Lake` under :guilabel:`Deployment` on the left-hand navigation.
6556

66-
Watch for a Pipeline Run to Complete from the {+atlas-cli+}
67-
-----------------------------------------------------------
57+
.. step:: Click the vertical ellipsis (:icon-fa4:`ellipsis-v`) for the {+dl+} for which you configured :guilabel:`On Demand` ingestion and select :guilabel:`Trigger an On Demand Pipeline Run`.
58+
59+
.. step:: Select the snapshot, from which to ingest data, from the dropdown.
60+
61+
The dropdown shows a list of all the snapshots on your |service|
62+
cluster. However, you can select only the snapshots from which
63+
{+dl+} hasn't yet ingested data; the grayed-out snapshots are
64+
snapshots from which your {+dl+} has already ingested data.
65+
66+
You can also send a ``GET`` request to the :oas-atlas-tag:`{+dl+}
67+
</Data-Lake-Pipelines>` ``availableSnapshots`` endpoint to
68+
retrieve the list of backup snapshots that you can use to trigger
69+
an on-demand pipeline run. To learn more about the |api| syntax
70+
and options for the ``availableSnapshots`` endpoint, see
71+
:oas-atlas-op:`Return Available Backup Snapshots for One Data
72+
Lake Pipeline </returnAvailableSnapshotsForPipeline>`.
73+
74+
.. step:: Click :guilabel:`Confirm`.
75+
76+
|service| displays a blue banner at the top of the page that
77+
shows the data ingestion status.
6878

69-
.. include:: /includes/extracts/atlas-dataLakePipelines-runs-watch.rst

source/administration/pause-resume-data-extraction.txt

Lines changed: 60 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -21,40 +21,47 @@ Pause Data Ingestion for Your {+dl+} Pipeline
2121

2222
When you pause your {+dl+} pipeline, |service| doesn't ingest new
2323
datasets. You can continue to query previous snapshots from which data
24-
has been ingested.
24+
has been ingested.
2525

26-
Pause Data Ingestion from the |service| UI
27-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26+
.. tabs::
2827

29-
To pause a pipeline from the |service| |ui|:
28+
.. tab:: {+atlas-cli+}
29+
:tabid: atlascli
3030

31-
.. procedure::
31+
.. include:: /includes/extracts/atlas-dataLakePipelines-pause.rst
3232

33-
.. step:: Navigate to {+adl+} in the |service| UI.
33+
.. tab:: {+atlas-admin-api+}
34+
:tabid: api
3435

35-
To navigate to the {+adl+} page:
36+
To pause a pipeline through the |api|, send a ``POST`` request to the
37+
:oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pause`` endpoint
38+
with the name of the pipeline for which you want to pause the ingestion
39+
schedule. To learn more about the |api| syntax and parameters for the
40+
``pause`` endpoint, see :oas-atlas-op:`Pause One Data Lake Pipeline
41+
</pauseOnePipelineInOneProject>`.
42+
43+
.. tab:: {+atlas-ui+}
44+
:tabid: ui
3645

37-
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
38-
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
39-
on the left-hand navigation.
46+
To pause a pipeline from the |service| |ui|:
4047

41-
.. step:: Click the pause button for the pipeline that you wish to pause.
48+
.. procedure::
4249

43-
.. step:: Click :guilabel:`Confirm` in the :guilabel:`Pause Ingestion` confirmation window.
50+
.. step:: Navigate to {+adl+} in the |service| UI.
4451

45-
When you pause your {+dl+} pipeline, the :guilabel:`Last Updated`
46-
column for the pipeline in the |service| UI shows the status
47-
for the pipeline as :guilabel:`Paused`.
52+
To navigate to the {+adl+} page:
4853

49-
Pause Data Ingestion from the API
50-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
55+
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
56+
on the left-hand navigation.
5157

52-
To pause a pipeline through the |api|, send a ``POST`` request to the
53-
:oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pause`` endpoint
54-
with the name of the pipeline for which you want to pause the ingestion
55-
schedule. To learn more about the |api| syntax and parameters for the
56-
``pause`` endpoint, see :oas-atlas-op:`Pause One Data Lake Pipeline
57-
</pauseOnePipelineInOneProject>`.
58+
.. step:: Click the pause button for the pipeline that you wish to pause.
59+
60+
.. step:: Click :guilabel:`Confirm` in the :guilabel:`Pause Ingestion` confirmation window.
61+
62+
When you pause your {+dl+} pipeline, the :guilabel:`Last Updated`
63+
column for the pipeline in the |service| UI shows the status
64+
for the pipeline as :guilabel:`Paused`.
5865

5966
Resume Data Ingestion for Your {+dl+} Pipeline
6067
-------------------------------------------------
@@ -63,36 +70,43 @@ When you resume data ingestion for a paused {+adl+} pipeline,
6370
|service| begins to take snapshots, which are then ingested in to your
6471
{+dl+} datasets.
6572

66-
Resume Data Ingestion from the |service| UI
67-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73+
.. tabs::
74+
75+
.. tab:: {+atlas-cli+}
76+
:tabid: atlascli
77+
78+
.. include:: /includes/extracts/atlas-dataLakePipelines-start.rst
79+
80+
.. tab:: {+atlas-admin-api+}
81+
:tabid: api
6882

69-
To resume data ingestion from the |service| |ui|:
83+
To resume data ingestion for a pipeline from the |api|, send a ``POST``
84+
request to the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>`
85+
``resume`` endpoint with the name of the pipeline for which you want to
86+
resume the data ingestion. To learn more about the |api| syntax and
87+
parameters for the ``resume`` endpoint, see :oas-atlas-op:`Resume One
88+
Data Lake Pipeline </resumeOnePipelineInOneProject>`.
7089

71-
.. procedure::
90+
.. tab:: {+atlas-ui+}
91+
:tabid: ui
7292

73-
.. step:: Navigate to {+adl+} in the |service| UI.
93+
To resume data ingestion from the |service| |ui|:
7494

75-
To navigate to the {+adl+} page:
95+
.. procedure::
7696

77-
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
78-
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
79-
on the left-hand navigation.
97+
.. step:: Navigate to {+adl+} in the |service| UI.
8098

81-
.. step:: Click :icon-fa4:`ellipsis-v` in the :guilabel:`Actions` column for the pipeline that you wish to resume and select :guilabel:`Resume Ingestion`.
99+
To navigate to the {+adl+} page:
82100

83-
.. step:: Click :guilabel:`Confirm` in the :guilabel:`Resume Ingestion` confirmation window.
101+
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
102+
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
103+
on the left-hand navigation.
84104

85-
When you resume data ingestion for a paused {+adl+} pipeline,
86-
the :guilabel:`Last Run Time` column for the pipeline in the
87-
|service| UI shows the date and time when data ingestion for
88-
the pipeline resumed.
105+
.. step:: Click :icon-fa4:`ellipsis-v` in the :guilabel:`Actions` column for the pipeline that you wish to resume and select :guilabel:`Resume Ingestion`.
89106

90-
Resume Data Ingestion from the API
91-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107+
.. step:: Click :guilabel:`Confirm` in the :guilabel:`Resume Ingestion` confirmation window.
92108

93-
To resume data ingestion for a pipeline from the |api|, send a ``POST``
94-
request to the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>`
95-
``resume`` endpoint with the name of the pipeline for which you want to
96-
resume the data ingestion. To learn more about the |api| syntax and
97-
parameters for the ``resume`` endpoint, see :oas-atlas-op:`Resume One
98-
Data Lake Pipeline </resumeOnePipelineInOneProject>`.
109+
When you resume data ingestion for a paused {+adl+} pipeline,
110+
the :guilabel:`Last Run Time` column for the pipeline in the
111+
|service| UI shows the date and time when data ingestion for
112+
the pipeline resumed.

source/administration/view-datalake-pipelines.txt

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@ View {+adl+} Pipelines
2525
`````````````````````````````````````````````````````````
2626

2727
.. include:: /includes/extracts/atlas-dataLakePipelines-describe.rst
28-
28+
29+
View All Available Schedules for {+adl+} Pipelines
30+
````````````````````````````````````````````````````````````````````````
31+
32+
.. include:: /includes/extracts/atlas-dataLakePipelines-availableSchedules-list.rst
33+
34+
View All Available Backup Snapshots for {+adl+} Pipelines
35+
``````````````````````````````````````````````````````````````````````````````````
36+
37+
.. include:: /includes/extracts/atlas-dataLakePipelines-availableSnapshots-list.rst
38+
2939
.. tab:: {+atlas-admin-api+}
3040
:tabid: api
3141

@@ -130,4 +140,4 @@ View {+adl+} Pipelines
130140
dataset inside a pipeline, {+adl+} removes the dataset
131141
from the {+fdi+} storage configuration where the
132142
dataset is referenced.
133-
- Trigger an on-demand pipeline run.
143+
- Trigger an on-demand pipeline run.

0 commit comments

Comments
 (0)