Skip to content

Commit 2681b69

Browse files
carriecwkcarriecwk
authored
(DOCSP-29592) added 2 new datalakepipeline commands (#286)
* (DOCSP-29592) added 2 new datalakepipeline commands * (DOCSP-29592) added a source constant * (DOCSP-29592) pushing to master * (DOCSP-29592) pushing to master * (DOCSP-29592) deleted a duplicate source constant * (DOCSP-29592) title change
1 parent d441e59 commit 2681b69

File tree

7 files changed

+225
-6
lines changed

7 files changed

+225
-6
lines changed

‎assets.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ output = "command/atlas-dataLakePipelines-list.txt"
4141
source = "docs/atlascli/command/atlas-dataLakePipelines-pause.txt"
4242
output = "command/atlas-dataLakePipelines-pause.txt"
4343

44+
[[assets.sources.repository.targets]]
45+
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-describe.txt"
46+
output = "command/atlas-dataLakePipelines-runs-describe.txt"
47+
48+
[[assets.sources.repository.targets]]
49+
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-list.txt"
50+
output = "command/atlas-dataLakePipelines-runs-list.txt"
51+
4452
[[assets.sources.repository.targets]]
4553
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-watch.txt"
4654
output = "command/atlas-dataLakePipelines-runs-watch.txt"

‎snooty.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv","https://www.mo
66
toc_landing_pages = ["/get-started"]
77

88
[constants]
9+
atlas-admin-api = "Atlas Administration API"
910
adl = "Atlas Data Lake"
1011
adf = "Atlas Data Federation"
11-
atlas-admin-api = "Atlas Administration API"
1212
atlas-cli = "Atlas CLI"
1313
atlas-ui = "Atlas UI"
1414
aws-pl = "AWS PrivateLink"

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Demand` extraction in your {+dl+} pipeline. You can trigger data
1212
ingestion from the |service| |ui|, the {+dl+} Pipelines |api|, or the
1313
{+atlas-cli+}.
1414

15+
Procedure
16+
---------
17+
1518
.. tabs::
1619

1720
.. tab:: {+atlas-cli+}
@@ -20,7 +23,7 @@ ingestion from the |service| |ui|, the {+dl+} Pipelines |api|, or the
2023
.. include:: /includes/extracts/atlas-dataLakePipelines-trigger.rst
2124

2225
Watch for a Pipeline Run to Complete
23-
````````````````````````````````````````````````````
26+
````````````````````````````````````
2427

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

‎source/administration/view-datalake-pipelines.txt‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ You can view all of your {+dl+} pipelines and view the details of a specified
1111
and the {+atlas-cli+}. You can also retrieve all of your completed {+dl+} pipeline
1212
data ingestion jobs from the |api| and the {+atlas-cli+}.
1313

14-
View {+adl+} Pipelines
15-
----------------------------------
14+
Procedure
15+
---------
1616

1717
.. tabs::
1818

@@ -26,16 +26,26 @@ View {+adl+} Pipelines
2626

2727
.. include:: /includes/extracts/atlas-dataLakePipelines-describe.rst
2828

29-
View All Available Schedules for {+adl+} Pipelines
29+
View All Available Schedules for an {+adl+} Pipeline
3030
````````````````````````````````````````````````````````````````````````
3131

3232
.. include:: /includes/extracts/atlas-dataLakePipelines-availableSchedules-list.rst
3333

34-
View All Available Backup Snapshots for {+adl+} Pipelines
34+
View All Available Backup Snapshots for an {+adl+} Pipeline
3535
``````````````````````````````````````````````````````````````````````````````````
3636

3737
.. include:: /includes/extracts/atlas-dataLakePipelines-availableSnapshots-list.rst
3838

39+
View {+adl+} Pipeline Runs
40+
`````````````````````````````````````````````````````
41+
42+
.. include:: /includes/extracts/atlas-dataLakePipelines-runs-list.rst
43+
44+
View Details of an {+adl+} Pipeline Run
45+
```````````````````````````````````````````````````````````````
46+
47+
.. include:: /includes/extracts/atlas-dataLakePipelines-runs-describe.rst
48+
3949
.. tab:: {+atlas-admin-api+}
4050
:tabid: api
4151

‎source/includes/command/atlas-dataLakePipelines-runs-describe.txt‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
.. _atlas-dataLakePipelines-runs-describe:
2+
3+
=====================================
4+
atlas dataLakePipelines runs describe
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+
Return the details for the specified data lake pipeline run for your project.
16+
17+
To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas dataLakePipelines runs describe <pipelineRunId> [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Arguments
30+
---------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - pipelineRunId
41+
- string
42+
- true
43+
- Unique identifier for the data lake pipeline run
44+
45+
Options
46+
-------
47+
48+
.. list-table::
49+
:header-rows: 1
50+
:widths: 20 10 10 60
51+
52+
* - Name
53+
- Type
54+
- Required
55+
- Description
56+
* - -h, --help
57+
-
58+
- false
59+
- help for describe
60+
* - -o, --output
61+
- string
62+
- false
63+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
64+
* - --pipeline
65+
- string
66+
- true
67+
- Name of the Data lake pipeline.
68+
* - --projectId
69+
- string
70+
- false
71+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
72+
73+
Inherited Options
74+
-----------------
75+
76+
.. list-table::
77+
:header-rows: 1
78+
:widths: 20 10 10 60
79+
80+
* - Name
81+
- Type
82+
- Required
83+
- Description
84+
* - -P, --profile
85+
- string
86+
- false
87+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
88+
89+
Examples
90+
--------
91+
92+
.. code-block::
93+
94+
# retrieves pipeline run '507f1f77bcf86cd799439011':
95+
atlas dataLakePipelines runs describe 507f1f77bcf86cd799439011
96+

‎source/includes/command/atlas-dataLakePipelines-runs-list.txt‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
.. _atlas-dataLakePipelines-runs-list:
2+
3+
=================================
4+
atlas dataLakePipelines runs list
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+
Returns all data lake pipeline runs for your project.
16+
17+
To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas dataLakePipelines runs list [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Options
30+
-------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - -h, --help
41+
-
42+
- false
43+
- help for list
44+
* - -o, --output
45+
- string
46+
- false
47+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
48+
* - --pipeline
49+
- string
50+
- true
51+
- Name of the Data lake pipeline.
52+
* - --projectId
53+
- string
54+
- false
55+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
56+
57+
Inherited Options
58+
-----------------
59+
60+
.. list-table::
61+
:header-rows: 1
62+
:widths: 20 10 10 60
63+
64+
* - Name
65+
- Type
66+
- Required
67+
- Description
68+
* - -P, --profile
69+
- string
70+
- false
71+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
72+
73+
Examples
74+
--------
75+
76+
.. code-block::
77+
78+
# list all pipeline runs:
79+
atlas dataLakePipelines runs list
80+

‎source/includes/extracts-atlas-cli-commands.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,26 @@ replacement:
9797
commandWithDashes: "atlas-dataLakePipelines-runs-watch"
9898
commandWithoutDashes: "atlas dataLakePipelines runs watch"
9999

100+
---
101+
ref: atlas-dataLakePipelines-runs-describe
102+
inherit:
103+
ref: atlas-cli-source-tabs
104+
file: extracts-atlas-cli-source-tabs.yaml
105+
replacement:
106+
task: "return the details for the specified data lake pipeline run for your project"
107+
commandWithDashes: "atlas-dataLakePipelines-runs-describe"
108+
commandWithoutDashes: "atlas dataLakePipelines runs describe"
109+
110+
---
111+
ref: atlas-dataLakePipelines-runs-list
112+
inherit:
113+
ref: atlas-cli-source-tabs
114+
file: extracts-atlas-cli-source-tabs.yaml
115+
replacement:
116+
task: "returns all data lake pipeline runs for your project"
117+
commandWithDashes: "atlas-dataLakePipelines-runs-list"
118+
commandWithoutDashes: "atlas dataLakePipelines runs list"
119+
100120
---
101121
ref: atlas-dataLakePipelines-start
102122
inherit:
@@ -148,3 +168,5 @@ replacement:
148168
commandWithoutDashes: "atlas kubernetes operator install"
149169

150170
...
171+
172+

0 commit comments

Comments
 (0)