Skip to content

Commit f62d1ca

Browse files
carriecwkcarriecwk
authored
(DOCSP-30088) adding new atlascli datalakepipeline and kubernetes operator commands (#284)
* (DOCSP-30088) adding new atlascli datalakepipeline and kubernetes operator commands * (DOCSP-30088) add datalake watch and runs watch commands to the datalake docs * (DOCSP-30088) merged and rebased from another PR * (DOCSP-30088) making a small change * (DOCSP-30088) adding a command
1 parent 576b7e2 commit f62d1ca

8 files changed

+378
-4
lines changed

‎assets.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,21 @@ output = "command/atlas-dataLakePipelines-describe.txt"
2525
source = "docs/atlascli/command/atlas-dataLakePipelines-list.txt"
2626
output = "command/atlas-dataLakePipelines-list.txt"
2727

28+
[[assets.sources.repository.targets]]
29+
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-watch.txt"
30+
output = "command/atlas-dataLakePipelines-runs-watch.txt"
31+
2832
[[assets.sources.repository.targets]]
2933
source = "docs/atlascli/command/atlas-dataLakePipelines-update.txt"
3034
output = "command/atlas-dataLakePipelines-update.txt"
35+
source = "docs/atlascli/command/atlas-dataLakePipelines-runs-watch.txt"
36+
output = "command/atlas-dataLakePipelines-runs-watch.txt"
37+
38+
[[assets.sources.repository.targets]]
39+
source = "docs/atlascli/command/atlas-dataLakePipelines-watch.txt"
40+
output = "command/atlas-dataLakePipelines-watch.txt"
41+
42+
[[assets.sources.repository.targets]]
43+
source = "docs/atlascli/command/atlas-kubernetes-operator-install.txt"
44+
output = "command/atlas-kubernetes-operator-install.txt"
45+

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,8 @@ Ingestion </triggerOneOnDemandSnapshotIngestion>`.
6262
options for the ``availableSnapshots`` endpoint, see
6363
:oas-atlas-op:`Return Available Backup Snapshots for One Data Lake
6464
Pipeline </returnAvailableSnapshotsForPipeline>`.
65+
66+
Watch for a Pipeline Run to Complete from the {+atlas-cli+}
67+
-----------------------------------------------------------
68+
69+
.. include:: /includes/extracts/atlas-dataLakePipelines-runs-watch.rst

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ View {+adl+} Pipelines
66

77
.. default-domain:: mongodb
88

9-
You can view all of your {+dl+} pipelines through the |service| |ui|,
10-
{+dl+} Pipelines |api|, and the {+atlas-cli+}, as well as view the details of a specified
11-
{+dl+} Pipeline in your project through the {+atlas-cli+}. You can also retrieve all of your
12-
completed {+dl+} pipeline data ingestion jobs from the |api| and the {+atlas-cli+}.
9+
You can view all of your {+dl+} pipelines and view the details of a specified
10+
{+dl+} Pipeline in your project through the |service| |ui|, {+dl+} Pipelines |api|,
11+
and the {+atlas-cli+}. You can also retrieve all of your completed {+dl+} pipeline
12+
data ingestion jobs from the |api| and the {+atlas-cli+}.
1313

1414
View {+adl+} Pipelines
1515
----------------------------------

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

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
.. _atlas-dataLakePipelines-runs-watch:
2+
3+
==================================
4+
atlas dataLakePipelines runs watch
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+
Watch for the specified data lake pipeline run to complete.
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 watch <pipelineName> [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+
* - pipelineName
41+
- string
42+
- true
43+
- Label that identifies the pipeline
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 watch
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+
Output
90+
------
91+
92+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
93+
94+
.. code-block::
95+
96+
data lake pipeline created
97+
98+
99+
Examples
100+
--------
101+
102+
.. code-block::
103+
104+
# watches the pipeline 'Pipeline1':
105+
atlas dataLakePipelines watch Pipeline1
106+

‎source/includes/command/atlas-dataLakePipelines-watch.txt

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
.. _atlas-dataLakePipelines-watch:
2+
3+
=============================
4+
atlas dataLakePipelines watch
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+
Watch for the specified data lake pipeline to complete.
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 watch <pipelineName> [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+
* - pipelineName
41+
- string
42+
- true
43+
- Label that identifies the pipeline
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 watch
60+
* - -o, --output
61+
- string
62+
- false
63+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
64+
* - --projectId
65+
- string
66+
- false
67+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
68+
69+
Inherited Options
70+
-----------------
71+
72+
.. list-table::
73+
:header-rows: 1
74+
:widths: 20 10 10 60
75+
76+
* - Name
77+
- Type
78+
- Required
79+
- Description
80+
* - -P, --profile
81+
- string
82+
- false
83+
- 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.
84+
85+
Output
86+
------
87+
88+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
89+
90+
.. code-block::
91+
92+
data lake pipeline created
93+
94+
95+
Examples
96+
--------
97+
98+
.. code-block::
99+
100+
# watches the pipeline 'Pipeline1':
101+
atlas dataLakePipelines watch Pipeline1
102+

‎source/includes/command/atlas-kubernetes-operator-install.txt

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
.. _atlas-kubernetes-operator-install:
2+
3+
=================================
4+
atlas kubernetes operator install
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+
Install Atlas Kubernetes Operator to a cluster.
16+
17+
This command installs one of the supported versions of Atlas Kubernetes Operator to an existing cluster, as well as automatically import Atlas resources to be managed by the operator.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas kubernetes operator install [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 install
44+
* - --import
45+
-
46+
- false
47+
- Flag to import existing Atlas resources into the cluster to be managed by the operator.
48+
* - --kubeContext
49+
- string
50+
- false
51+
- The name of the kubeconfig context to use.
52+
* - --kubeconfig
53+
- string
54+
- false
55+
- Path to the kubeconfig file to use for CLI requests.
56+
* - --operatorVersion
57+
- string
58+
- false
59+
- Version of the operator to be installed.
60+
* - --orgId
61+
- string
62+
- false
63+
- Organization ID to use. Overrides the settings in the configuration file or environment variable.
64+
* - --projectName
65+
- string
66+
- false
67+
- Name of the project to create or use with the installed operator.
68+
* - --targetNamespace
69+
- string
70+
- false
71+
- Namespace where to install the operator.
72+
* - --watchNamespace
73+
- strings
74+
- false
75+
- List of namespaces which the operator will be listen to.
76+
77+
Inherited Options
78+
-----------------
79+
80+
.. list-table::
81+
:header-rows: 1
82+
:widths: 20 10 10 60
83+
84+
* - Name
85+
- Type
86+
- Required
87+
- Description
88+
* - -P, --profile
89+
- string
90+
- false
91+
- 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.
92+
93+
Examples
94+
--------
95+
96+
.. code-block::
97+
98+
# Install latest version of the operator into the default namespace:
99+
atlas kubernetes operator install
100+
101+
102+
.. code-block::
103+
104+
# Install an specific version of the operator:
105+
atlas kubernetes operator install --operatorVersion=1.7.0
106+
107+
108+
.. code-block::
109+
110+
# Install an specific version of the operator to a namespace and watch only this namespace and a second one
111+
atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace=<namespace> --watchNamespace=<namespace>,<secondNamespace>

0 commit comments

Comments
 (0)