Skip to content

Commit a08bc9d

Browse files
sarahsimperssarahsimpers
authored
(DOCSP-30127) Sets up docurl and literal includes for data lake (#282)
1 parent 6b3c517 commit a08bc9d

File tree

5 files changed

+309
-0
lines changed

5 files changed

+309
-0
lines changed

‎assets.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[assets.output_paths]
2+
repository_path = "source/includes"
3+
4+
[[assets.sources.repository]]
5+
repo = "mongodb/mongodb-atlas-cli"
6+
version = "atlascli/v1.6.0"
7+
8+
[[assets.sources.repository.targets]]
9+
source = "docs/atlascli/command/atlas-accessLists-create.txt"
10+
output = "command/atlas-accessLists-create.txt"

‎snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ toc_landing_pages = ["/get-started"]
88
[constants]
99
adl = "Atlas Data Lake"
1010
adf = "Atlas Data Federation"
11+
atlas-cli = "Atlas CLI"
1112
aws-pl = "AWS PrivateLink"
1213
df = "Data Federation"
1314
dl = "Data Lake"

‎source/includes/command/atlas-accessLists-create.txt

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
.. _atlas-accessLists-create:
2+
3+
========================
4+
atlas accessLists create
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+
Create an IP access list entry for your project.
16+
17+
The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project.
18+
19+
The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries.
20+
21+
To use this command, you must authenticate with a user account or an API key that has the Read Write role.
22+
23+
Syntax
24+
------
25+
26+
.. code-block::
27+
:caption: Command Syntax
28+
29+
atlas accessLists create [entry] [options]
30+
31+
.. Code end marker, please don't delete this comment
32+
33+
Arguments
34+
---------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 10 60
39+
40+
* - Name
41+
- Type
42+
- Required
43+
- Description
44+
* - entry
45+
- string
46+
- false
47+
- IP address, CIDR address, or AWS security group ID that you want to add to the access list.
48+
49+
Options
50+
-------
51+
52+
.. list-table::
53+
:header-rows: 1
54+
:widths: 20 10 10 60
55+
56+
* - Name
57+
- Type
58+
- Required
59+
- Description
60+
* - --comment
61+
- string
62+
- false
63+
- Optional description or comment for the entry.
64+
* - --currentIp
65+
-
66+
- false
67+
- Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option.
68+
* - --deleteAfter
69+
- string
70+
- false
71+
- ISO-8601-formatted UTC date after which Atlas removes the entry from the access list.
72+
* - -h, --help
73+
-
74+
- false
75+
- help for create
76+
* - -o, --output
77+
- string
78+
- false
79+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
80+
* - --projectId
81+
- string
82+
- false
83+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
84+
* - --type
85+
- string
86+
- false
87+
- Type of access list entry. Valid values are cidrBlock, ipAddress, or awsSecurityGroup. This value defaults to "ipAddress".
88+
89+
Inherited Options
90+
-----------------
91+
92+
.. list-table::
93+
:header-rows: 1
94+
:widths: 20 10 10 60
95+
96+
* - Name
97+
- Type
98+
- Required
99+
- Description
100+
* - -P, --profile
101+
- string
102+
- false
103+
- Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.
104+
105+
Output
106+
------
107+
108+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
109+
110+
.. code-block::
111+
112+
Created new IP access list.
113+
114+
115+
Examples
116+
--------
117+
118+
.. code-block::
119+
120+
# Create an IP access list entry using the current IP address:
121+
atlas accessList create --currentIp
122+
123+
124+
.. code-block::
125+
126+
# Create an access list entry for the IP address 192.0.2.15 in the project with ID 5e2211c17a3e5a48f5497de3:
127+
atlas accessList create 192.0.2.15 --type ipAddress --projectId 5e2211c17a3e5a48f5497de3 --comment "IP address for app server 2" --output json
128+
129+
130+
.. code-block::
131+
132+
# Create an access list entry in CIDR notation for 73.231.201.205/24 in the project with ID 5e2211c17a3e5a48f5497de3:
133+
atlas accessList create 73.231.201.205/24 --type cidrBlock --projectId 5e2211c17a3e5a48f5497de3 --output json --comment "CIDR block for servers C - F"
134+
135+
136+
.. code-block::
137+
138+
# Create an access list entry for the AWS security group sg-903004f8 in the project with ID 5e2211c17a3e5a48f5497de3:
139+
atlas accessList create sg-903004f8 --type awsSecurityGroup
140+
--projectId 5e2211c17a3e5a48f5497de3 --output json --comment "AWS Security Group"

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
ref: atlas-accessLists-create
2+
inherit:
3+
ref: atlas-cli-source-tabs
4+
file: extracts-atlas-cli-source-tabs.yaml
5+
replacement:
6+
task: "create an IP access list for your project"
7+
commandWithDashes: "atlas-accessLists-create"
8+
commandWithoutDashes: "atlas accessLists create"
9+
10+
...

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

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
ref: atlas-cli-source-tabs
2+
content: |
3+
4+
To {{task}} using the
5+
{+atlas-cli+}, run the following command:
6+
7+
.. literalinclude:: /includes/command/{{commandWithDashes}}.txt
8+
:start-after: :caption: Command Syntax
9+
:end-before: .. Code end marker, please don't delete this comment
10+
:language: sh
11+
:dedent:
12+
13+
To learn more about the command syntax and parameters, see the
14+
{+atlas-cli+} documentation for :atlascli:`{{commandWithoutDashes}}
15+
</command/{{commandWithDashes}}>`.
16+
17+
{{optionalTutorialLine}}
18+
19+
.. see:: Related Links
20+
21+
- :atlascli:`Install the {+atlas-cli+} </install-atlas-cli/>`
22+
- :atlascli:`Connect to the {+atlas-cli+} </connect-atlas-cli/>`
23+
24+
replacement:
25+
task: ""
26+
commandWithDashes: "atlas-accessLists-create"
27+
commandWithoutDashes: "atlas accessLists create"
28+
optionalTutorialLine: ""
29+
30+
---
31+
ref: atlas-cli-source-tabs-two-related-commands
32+
content: |
33+
34+
To {{task1}} using the {+atlas-cli+}, run the following command:
35+
36+
.. literalinclude:: /includes/command/{{commandWithDashes1}}.txt
37+
:start-after: :caption: Command Syntax
38+
:end-before: .. Code end marker, please don't delete this comment
39+
:language: sh
40+
:dedent:
41+
42+
To {{task2}} using the {+atlas-cli+}, run the following command:
43+
44+
.. literalinclude:: /includes/command/{{commandWithDashes2}}.txt
45+
:start-after: :caption: Command Syntax
46+
:end-before: .. Code end marker, please don't delete this comment
47+
:language: sh
48+
:dedent:
49+
50+
{{optionalInfoLine}}
51+
52+
To learn more about the syntax and parameters for the previous commands, see the {+atlas-cli+} documentation for
53+
:atlascli:`{{commandWithoutDashes1}}
54+
</command/{{commandWithDashes1}}>` and
55+
:atlascli:`{{commandWithoutDashes2}}
56+
</command/{{commandWithDashes2}}>`.
57+
58+
.. see:: Related Links
59+
60+
- :atlascli:`Install the {+atlas-cli+} </install-atlas-cli/>`
61+
- :atlascli:`Connect to the {+atlas-cli+} </connect-atlas-cli/>`
62+
63+
replacement:
64+
task1: ""
65+
task2: ""
66+
commandWithDashes1: "atlas-accessLists-create"
67+
commandWithoutDashes1: "atlas accessLists create"
68+
commandWithDashes2: "atlas-accessLists-create"
69+
commandWithoutDashes2: "atlas accessLists create"
70+
optionalInfoLine: ""
71+
72+
---
73+
ref: atlas-cli-source-tabs-no-install-links
74+
content: |
75+
76+
To {{task}} using the
77+
{+atlas-cli+}, run the following command:
78+
79+
.. literalinclude:: /includes/command/{{commandWithDashes}}.txt
80+
:start-after: :caption: Command Syntax
81+
:end-before: .. Code end marker, please don't delete this comment
82+
:language: sh
83+
:dedent:
84+
85+
To learn more about the command syntax and parameters, see the
86+
{+atlas-cli+} documentation for :atlascli:`{{commandWithoutDashes}}
87+
</command/{{commandWithDashes}}>`.
88+
89+
replacement:
90+
task: ""
91+
commandWithDashes: "atlas-accessLists-create"
92+
commandWithoutDashes: "atlas accessLists create"
93+
94+
---
95+
ref: atlas-cli-source-tabs-two-related-no-install-links
96+
content: |
97+
98+
To {{task1}} using the {+atlas-cli+}, run the following command:
99+
100+
.. literalinclude:: /includes/command/{{commandWithDashes1}}.txt
101+
:start-after: :caption: Command Syntax
102+
:end-before: .. Code end marker, please don't delete this comment
103+
:language: sh
104+
:dedent:
105+
106+
To {{task2}} using the {+atlas-cli+}, run the following command:
107+
108+
.. literalinclude:: /includes/command/{{commandWithDashes2}}.txt
109+
:start-after: :caption: Command Syntax
110+
:end-before: .. Code end marker, please don't delete this comment
111+
:language: sh
112+
:dedent:
113+
114+
{{optionalInfoLine}}
115+
116+
To learn more about the syntax and parameters for the previous commands, see the {+atlas-cli+} documentation for
117+
:atlascli:`{{commandWithoutDashes1}}
118+
<command/{{commandWithDashes1}}>` and :atlascli:`{{commandWithoutDashes2}}
119+
</command/{{commandWithDashes2}}>`.
120+
121+
replacement:
122+
task1: ""
123+
task2: ""
124+
commandWithDashes1: "atlas-accessLists-create"
125+
commandWithoutDashes1: "atlas accessLists create"
126+
commandWithDashes2: "atlas-accessLists-create"
127+
commandWithoutDashes2: "atlas accessLists create"
128+
optionalInfoLine: ""
129+
130+
---
131+
ref: atlas-cli-source-tabs-no-intro-no-install
132+
content: |
133+
134+
.. literalinclude:: /includes/command/{{commandWithDashes}}.txt
135+
:start-after: :caption: Command Syntax
136+
:end-before: .. Code end marker, please don't delete this comment
137+
:language: sh
138+
:dedent:
139+
140+
To learn more about the command syntax and parameters, see the
141+
{+atlas-cli+} documentation for :atlascli:`{{commandWithoutDashes}} </command/{{commandWithDashes}}>`.
142+
143+
replacement:
144+
commandWithDashes: "atlas-accessLists-create"
145+
commandWithoutDashes: "atlas accessLists create"
146+
optionalTutorialLine: ""
147+
148+
...

0 commit comments

Comments
 (0)