Skip to content

Commit 576b7e2

Browse files
carriecwkcarriecwk
authored
(DOCSP-30038) adding new atlascli datalake pipeline commands (#283)
* (DOCSP-30038) adding new atlascli datalake pipeline commands * (DOCSP-30038) adding create command to datalake docs create page * (DOCSP-30038) adding source constants * (DOCSP-30038) troubleshooting * (DOCSP-30038) troubleshooting * (DOCSP-30038) adding list command to datalake docs * (DOCSP-30038) adding update command to datalake docs * (DOCSP-30038) fixing a typo * (DOCSP-30038) fixed more typos, modified descriptions * (DOCSP-30038) small copy change * (DOCSP-30038) addressed copy feedback * (DOCSP-30038) addressed copy feedback * (DOCSP-30038) addressed copy feedback * (DOCSP-30038) addressing copy feedback
1 parent a08bc9d commit 576b7e2

13 files changed

+1024
-368
lines changed

‎assets.toml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,28 @@ repository_path = "source/includes"
33

44
[[assets.sources.repository]]
55
repo = "mongodb/mongodb-atlas-cli"
6-
version = "atlascli/v1.6.0"
6+
version = "mongocli/v1.30.0"
77

88
[[assets.sources.repository.targets]]
99
source = "docs/atlascli/command/atlas-accessLists-create.txt"
1010
output = "command/atlas-accessLists-create.txt"
11+
12+
[[assets.sources.repository.targets]]
13+
source = "docs/atlascli/command/atlas-dataLakePipelines-create.txt"
14+
output = "command/atlas-dataLakePipelines-create.txt"
15+
16+
[[assets.sources.repository.targets]]
17+
source = "docs/atlascli/command/atlas-dataLakePipelines-delete.txt"
18+
output = "command/atlas-dataLakePipelines-delete.txt"
19+
20+
[[assets.sources.repository.targets]]
21+
source = "docs/atlascli/command/atlas-dataLakePipelines-describe.txt"
22+
output = "command/atlas-dataLakePipelines-describe.txt"
23+
24+
[[assets.sources.repository.targets]]
25+
source = "docs/atlascli/command/atlas-dataLakePipelines-list.txt"
26+
output = "command/atlas-dataLakePipelines-list.txt"
27+
28+
[[assets.sources.repository.targets]]
29+
source = "docs/atlascli/command/atlas-dataLakePipelines-update.txt"
30+
output = "command/atlas-dataLakePipelines-update.txt"

‎snooty.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ toc_landing_pages = ["/get-started"]
88
[constants]
99
adl = "Atlas Data Lake"
1010
adf = "Atlas Data Federation"
11+
atlas-admin-api = "Atlas Administration API"
1112
atlas-cli = "Atlas CLI"
13+
atlas-ui = "Atlas UI"
1214
aws-pl = "AWS PrivateLink"
1315
df = "Data Federation"
1416
dl = "Data Lake"

‎source/administration/delete-datalake-pipeline.txt

Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,52 @@ Delete {+adl+} Pipeline
66

77
.. default-domain:: mongodb
88

9-
You can delete your {+dl+} pipeline at any time from the |service| |ui|
10-
and {+dl+} Pipelines |api|. When you delete your {+dl+} pipeline,
11-
|service| deletes all underlying datasets, including the data, and
12-
removes the {+dl+} datasets from your federated database instances
13-
where it's referenced. You can't undo this operation.
9+
You can delete your {+dl+} pipeline at any time from
10+
the |service| |ui|, {+dl+} Pipelines |api|, and the {+atlas-cli+}.
11+
When you delete your {+dl+} pipeline, |service| deletes all underlying
12+
datasets, including the data, and removes the {+dl+} datasets from your
13+
federated database instances where it's referenced.
14+
You can't undo this operation.
1415

15-
.. _delete-pipeline-ui:
16+
Procedure
17+
---------
1618

17-
Delete a Pipeline from the |service| UI
18-
---------------------------------------
19+
.. tabs::
1920

20-
To delete a {+dl+} pipeline:
21+
.. tab:: {+atlas-cli+}
22+
:tabid: atlascli
2123

22-
.. procedure::
24+
.. include:: /includes/extracts/atlas-dataLakePipelines-delete.rst
2325

24-
.. step:: Navigate to {+adl+} in the |service| |ui|.
26+
.. tab:: {+atlas-admin-api+}
27+
:tabid: api
2528

26-
To navigate to the {+adl+} page:
29+
.. _delete-pipeline-api:
2730

28-
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
29-
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
30-
on the left-hand navigation.
31+
To delete a pipeline through the |api|, send a ``DELETE`` request to
32+
the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pipelines``
33+
endpoint with the name of the pipeline that you want to delete. To
34+
learn more about the ``pipelines`` endpoint syntax and parameters for
35+
deleting a pipeline, see :oas-atlas-op:`Remove One Data Lake Pipeline
36+
</removeOneDataLakePipeline>`.
3137

32-
.. step:: Click :icon:`trash` in the :guilabel:`Actions` column for the pipeline that you wish to delete.
38+
.. tab:: {+atlas-ui+}
39+
:tabid: ui
3340

34-
.. step:: Click :guilabel:`Delete` in the confirmation window.
41+
.. _delete-pipeline-ui:
3542

36-
.. _delete-pipeline-api:
43+
To delete a {+dl+} pipeline:
3744

38-
Delete a Pipeline from the API
39-
------------------------------
45+
.. procedure::
4046

41-
To delete a pipeline through the |api|, send a ``DELETE`` request to
42-
the :oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pipelines``
43-
endpoint with the name of the pipeline that you want to delete. To
44-
learn more about the ``pipelines`` endpoint syntax and parameters for
45-
deleting a pipeline, see :oas-atlas-op:`Remove One Data Lake Pipeline
46-
</removeOneDataLakePipeline>`.
47+
.. step:: Navigate to {+adl+} in the |service| |ui|.
48+
49+
To navigate to the {+adl+} page:
50+
51+
1. Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
52+
#. Select :guilabel:`Data Lake` under :guilabel:`Deployment`
53+
on the left-hand navigation.
54+
55+
.. step:: Click :icon:`trash` in the :guilabel:`Actions` column for the pipeline that you wish to delete.
56+
57+
.. step:: Click :guilabel:`Delete` in the confirmation window.

‎source/administration/edit-data-pipeline.txt

Lines changed: 61 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -15,81 +15,91 @@ Edit an {+adl+} Pipeline
1515
.. default-domain:: mongodb
1616

1717
You can make changes to your {+dl+} pipelines through the |service|
18-
|ui| and {+dl+} Pipelines |api|, including:
18+
|ui|, {+dl+} Pipelines |api|, and the {+atlas-cli+}, including:
1919

2020
- Edit the data extraction schedule
2121
- Edit the data storage region
2222
- Change the fields to exclude from your {+dl+} datasets
2323

24-
.. _adl-edit-dataset-pipeline-ui:
24+
Procedure
25+
---------
2526

26-
Edit a Pipeline from the |service| UI
27-
-------------------------------------
27+
.. tabs::
2828

29-
.. procedure::
30-
:style: normal
29+
.. tab:: {+atlas-cli+}
30+
:tabid: atlascli
3131

32-
.. step:: Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
32+
.. include:: /includes/extracts/atlas-dataLakePipelines-update.rst
33+
34+
.. tab:: {+atlas-admin-api+}
35+
:tabid: api
3336

34-
.. step:: Select :guilabel:`Data Lake` under :guilabel:`Deployment` on the left-hand navigation.
37+
.. _adl-edit-dataset-pipeline-api:
3538

36-
.. step:: Click :icon-fa5:`pencil-alt` in the :guilabel:`Actions` column for the pipeline that you wish to modify.
39+
To edit a pipeline through the |api|, send a ``PATCH`` request to the
40+
:oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pipelines`` endpoint
41+
with the name of the pipeline that you want to edit. To learn more
42+
about the ``pipelines`` endpoint syntax and parameters for updating a
43+
pipeline, see :oas-atlas-op:`Update One Data Lake Pipeline
44+
</updateOneDataLakePipeline>`.
3745

38-
.. step:: (Optional) Make changes to your data extraction schedule.
46+
.. tip::
3947

40-
Before making changes to your :guilabel:`Basic Schedule`, ensure
41-
that your desired data extraction frequency is similar to your
42-
current backup schedule. For example, if you wish to switch to
43-
``Daily``, you must have a ``Daily`` backup schedule configured
44-
in your policy. Or, if you want to switch to a schedule of once a
45-
week, you must have a ``Weekly`` backup schedule configured in
46-
your policy. To learn more, see :atlas:`Backup Scheduling
47-
</backup/cloud-backup/overview/#backup-scheduling--retention--and-on-demand-backup-snapshots>`.
48-
You can also send a ``GET`` request to the {+dl+}
49-
:oas-atlas-op:`availableSchedules
50-
</returnAvailableSchedulesForPipeline>` endpoint to retrieve the
51-
list of backup schedule policy items that you can use to change
52-
the schedule of your {+dl+} pipeline.
48+
You can send a ``GET`` request to the
49+
:oas-atlas-op:`availableSchedules
50+
</returnAvailableSchedulesForPipeline>` endpoint to retrieve the
51+
list of backup schedule policy items that you can use to change the
52+
schedule of your {+dl+} pipelines of type ``PERIODIC_DPS``.
53+
54+
.. tab:: {+atlas-ui+}
55+
:tabid: ui
5356

54-
.. step:: (Optional) Make changes to your data storage region.
57+
.. _adl-edit-dataset-pipeline-ui:
5558

56-
{+adl+} provides optimized storage in the following |aws| regions:
59+
.. procedure::
60+
:style: normal
5761

58-
.. include:: /includes/list-table-supported-aws-regions.rst
62+
.. step:: Log in to `MongoDB Atlas <https://cloud.mongodb.com>`__.
5963

60-
.. step:: Click :guilabel:`Continue`.
64+
.. step:: Select :guilabel:`Data Lake` under :guilabel:`Deployment` on the left-hand navigation.
6165

62-
.. step:: (Optional) Make changes to the fields excluded from your {+dl+} datasets.
66+
.. step:: Click :icon-fa5:`pencil-alt` in the :guilabel:`Actions` column for the pipeline that you wish to modify.
6367

64-
- Click :guilabel:`Add Field` and specify :guilabel:`Field Name`
65-
to add fields to the excluded fields list.
68+
.. step:: (Optional) Make changes to your data extraction schedule.
6669

67-
- Click :guilabel:`Delete All` to remove all the fields from the
68-
excluded fields list.
70+
Before making changes to your :guilabel:`Basic Schedule`, ensure
71+
that your desired data extraction frequency is similar to your
72+
current backup schedule. For example, if you wish to switch to
73+
``Daily``, you must have a ``Daily`` backup schedule configured
74+
in your policy. Or, if you want to switch to a schedule of once a
75+
week, you must have a ``Weekly`` backup schedule configured in
76+
your policy. To learn more, see :atlas:`Backup Scheduling
77+
</backup/cloud-backup/overview/#backup-scheduling--retention--and-on-demand-backup-snapshots>`.
78+
You can also send a ``GET`` request to the {+dl+}
79+
:oas-atlas-op:`availableSchedules
80+
</returnAvailableSchedulesForPipeline>` endpoint to retrieve the
81+
list of backup schedule policy items that you can use to change
82+
the schedule of your {+dl+} pipeline.
6983

70-
- Click :icon:`trash-alt` next to a field to remove that
71-
field from the excluded fields list.
84+
.. step:: (Optional) Make changes to your data storage region.
7285

73-
.. step:: Click :guilabel:`Review Changes` to review the changes to your pipeline.
86+
{+adl+} provides optimized storage in the following |aws| regions:
7487

75-
.. step:: Click :guilabel:`Apply Changes` for the changes to take effect.
88+
.. include:: /includes/list-table-supported-aws-regions.rst
7689

77-
.. _adl-edit-dataset-pipeline-api:
90+
.. step:: Click :guilabel:`Continue`.
7891

79-
Edit a Pipeline from the API
80-
----------------------------
92+
.. step:: (Optional) Make changes to the fields excluded from your {+dl+} datasets.
8193

82-
To edit a pipeline through the |api|, send a ``PATCH`` request to the
83-
:oas-atlas-tag:`{+dl+} </Data-Lake-Pipelines>` ``pipelines`` endpoint
84-
with the name of the pipeline that you want to edit. To learn more
85-
about the ``pipelines`` endpoint syntax and parameters for updating a
86-
pipeline, see :oas-atlas-op:`Update One Data Lake Pipeline
87-
</updateOneDataLakePipeline>`.
94+
- Click :guilabel:`Add Field` and specify :guilabel:`Field Name`
95+
to add fields to the excluded fields list.
8896

89-
.. tip::
97+
- Click :guilabel:`Delete All` to remove all the fields from the
98+
excluded fields list.
9099

91-
You can send a ``GET`` request to the
92-
:oas-atlas-op:`availableSchedules
93-
</returnAvailableSchedulesForPipeline>` endpoint to retrieve the
94-
list of backup schedule policy items that you can use to change the
95-
schedule of your {+dl+} pipelines of type ``PERIODIC_DPS``.
100+
- Click :icon:`trash-alt` next to a field to remove that
101+
field from the excluded fields list.
102+
103+
.. step:: Click :guilabel:`Review Changes` to review the changes to your pipeline.
104+
105+
.. step:: Click :guilabel:`Apply Changes` for the changes to take effect.

0 commit comments

Comments
 (0)