Skip to content

Commit 784635d

Browse files
jwilliams-mongojwilliams-mongo
authored
* (DOCSP-11716)(DOCSP-11722)(DOCSP-11715)(DOCSP-11714)(DOCSP-11692): atlas privateEndpoint * (DOCSP-11716)(DOCSP-11722)(DOCSP-11715)(DOCSP-11714)(DOCSP-11692): tiny fix * (DOCSP-11716)(DOCSP-11722)(DOCSP-11715)(DOCSP-11714)(DOCSP-11692): consistency fixes * (DOCSP-11716)(DOCSP-11722)(DOCSP-11715)(DOCSP-11714)(DOCSP-11692): one more consistency fix
1 parent b76d61a commit 784635d

11 files changed

+737
-12
lines changed

‎source/reference/atlas.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Atlas ``mongocli`` Commands
6262
Logs </reference/atlas/log-commands>
6363
Metrics </reference/atlas/metric-commands>
6464
Networking </reference/atlas/networking-commands>
65+
Private Endpoints </reference/atlas/privateendpoint-commands>
6566
Processes </reference/atlas/process-commands>
6667
Security </reference/atlas/security-commands>
6768
Whitelists </reference/atlas/whitelist-commands>

‎source/reference/atlas/cluster-watch.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ The ``cluster watch`` command continuously polls a cluster until the
8282
cluster reaches an available state. While the command is polling, it
8383
periodically prints dots (``.``) to the terminal.
8484

85-
When the cluster reaches an available state, or if it is already in an
86-
available state, the command prints a status message and list of hosts
87-
for that cluster.
85+
When the private endpoint connection reaches an available state, or if
86+
it is already in an available state, the command prints a status message
87+
and list of hosts for that cluster.
8888

8989
If the command prints an error, see
9090
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.

‎source/reference/atlas/privateendpoint-commands.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _mcli-reference-atlas-privateendpoint:
2+
3+
==================================
4+
Atlas ``privateEndpoint`` Commands
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
List All Private Endpoint Connections </reference/atlas/privateendpoint-list>
13+
Describe One Private Endpoint Connection </reference/atlas/privateendpoint-describe>
14+
Create One Private Endpoint Connection </reference/atlas/privateendpoint-create>
15+
Watch One Private Endpoint Connection </reference/atlas/privateendpoint-watch>
16+
Delete One Private Endpoint Connection </reference/atlas/privateendpoint-delete>

‎source/reference/atlas/privateendpoint-create.txt

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
.. _mcli-atlas-privateendpoint-create-cmd:
2+
3+
=====================================
4+
mongocli atlas privateendpoint 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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``privateendpoint create`` command creates one private endpoint
18+
connection for a given |service| project.
19+
20+
Syntax
21+
------
22+
23+
.. code-block:: text
24+
25+
mongocli atlas privateendpoint(s)|privateEndpoint(s) create
26+
--region <cloud-provider-region>
27+
[ --output|-o <output-format> ]
28+
[ --profile|-P <profile-name> ]
29+
[ --projectId <project-ID> ]
30+
31+
.. include:: /includes/fact-command-line-help.rst
32+
33+
.. _atlas-privateendpoint-create-options:
34+
35+
Options
36+
-------
37+
38+
.. list-table::
39+
:widths: 20 10 60 10
40+
:header-rows: 1
41+
42+
* - Option
43+
- Type
44+
- Description
45+
- Required?
46+
47+
* - ``--region``
48+
- string
49+
- Cloud provider region in which you want to create the private
50+
endpoint connection.
51+
52+
.. note::
53+
54+
|service| supports private endpoint connections only for
55+
|aws|.
56+
57+
See the :atlas:`Atlas documentation
58+
</security-private-endpoint/#limitations>` for limitations on
59+
the number of private endpoints you can create in different
60+
regions.
61+
62+
Accepted values are:
63+
64+
- ``us-east-1``
65+
- ``us-east-2``
66+
- ``us-west-1``
67+
- ``us-west-2``
68+
- ``ca-central-1``
69+
- ``sa-east-1``
70+
- ``eu-north-1``
71+
- ``eu-west-1``
72+
- ``eu-west-2``
73+
- ``eu-west-3``
74+
- ``eu-central-1``
75+
- ``me-south-1``
76+
- ``ap-northeast-1``
77+
- ``ap-northeast-2``
78+
- ``ap-south-1``
79+
- ``ap-southeast-1``
80+
- ``ap-southeast-2``
81+
- ``ap-east-1``
82+
83+
- yes
84+
85+
* - ``--output``, ``-o``
86+
- string
87+
- .. include:: /includes/extracts/fact-basic-options-output.rst
88+
- no
89+
90+
* - ``--profile``, ``-P``
91+
- string
92+
- Name of the profile where the public and private
93+
keys for the project are saved. If omitted, uses the
94+
{+default-profile+}. To learn more about creating a
95+
profile, see :ref:`mcli-configure`.
96+
- no
97+
98+
* - ``--projectId``
99+
- string
100+
- Unique identifier of the project in which you want to create the
101+
private endpoint connection. If omitted, uses the
102+
project ID in the profile or :ref:`environment variable
103+
<mcli-env-var>`.
104+
- no
105+
106+
.. _atlas-privateendpoint-create-output:
107+
108+
Output
109+
------
110+
111+
If the command succeeds, it returns the following output in the default
112+
format. If the command returns errors, see
113+
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
114+
115+
.. code-block:: sh
116+
:copyable: false
117+
118+
Private endpoint '<private-endpoint-id>' created.
119+
120+
.. include:: /includes/fact-default-output.rst
121+
122+
- :atlas:`Atlas API </reference/api/private-endpoint-create-one-private-endpoint-connection/#response-elements>`
123+
124+
Example
125+
-------
126+
127+
.. tabs::
128+
129+
.. tab:: Default Output
130+
:tabid: default-output
131+
132+
The following command creates one private endpoint connection
133+
for a project using the {+default-profile+}, which contains
134+
credentials and the project ID. The output is returned in the
135+
default format.
136+
137+
.. code-block:: sh
138+
139+
mongocli atlas privateendpoint create --region us-east-1 5f4fc81c1f03a835c2728ff7
140+
141+
The previous command prints the following to the terminal.
142+
143+
.. code-block:: sh
144+
:copyable: false
145+
146+
Private endpoint '5f4fc829a2b47835a58c6d04' created.
147+
148+
.. tab:: JSON Output
149+
:tabid: json-output
150+
151+
The following command creates one private endpoint connection
152+
for a project using the {+default-profile+}, which contains
153+
credentials and the project ID. The output is returned in |json|
154+
format.
155+
156+
.. code-block:: sh
157+
158+
mongocli atlas privateendpoint create --region us-east-1 5f4fc81c1f03a835c2728ff7 --output json
159+
160+
The previous command prints the following to the terminal in
161+
|json| format.
162+
163+
.. code-block:: json
164+
:copyable: false
165+
166+
{
167+
"id": "5f4fc81c1f03a835c2728ff7",
168+
"status": "INITIATING"
169+
}
170+

‎source/reference/atlas/privateendpoint-delete.txt

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
.. _mcli-atlas-privateendpoint-delete-cmd:
2+
3+
=====================================
4+
mongocli atlas privateendpoint delete
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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``privateendpoint delete`` command deletes one
18+
private endpoint connection for a given |service| project.
19+
20+
Syntax
21+
------
22+
23+
.. code-block:: text
24+
25+
mongocli atlas privateendpoint(s)|privateEndpoint(s) delete <private-endpoint-id>
26+
[ --force ]
27+
[ --profile|-P <profile-name> ]
28+
[ --projectId <project-ID> ]
29+
30+
.. include:: /includes/fact-command-line-help.rst
31+
32+
.. _atlas-privateendpoint-delete-arguments:
33+
34+
Arguments
35+
---------
36+
37+
.. list-table::
38+
:header-rows: 1
39+
:widths: 20 10 60 10
40+
41+
* - Argument
42+
- Type
43+
- Description
44+
- Required?
45+
46+
* - ``<private-endpoint-id>``
47+
- string
48+
- Unique identifier of the private endpoint connection that you
49+
want to delete.
50+
- yes
51+
52+
.. _atlas-privateendpoint-delete-options:
53+
54+
Options
55+
-------
56+
57+
.. list-table::
58+
:widths: 20 10 60 10
59+
:header-rows: 1
60+
61+
* - Option
62+
- Type
63+
- Description
64+
- Required?
65+
66+
* - ``--force``
67+
-
68+
- Flag that indicates that the agent API key can
69+
be deleted without requiring confirmation.
70+
- no
71+
72+
* - ``--profile``, ``-P``
73+
- string
74+
- Name of the profile where the public and private
75+
keys for the project are saved. If omitted, uses the
76+
{+default-profile+}. To learn more about creating a
77+
profile, see :ref:`mcli-configure`.
78+
- no
79+
80+
* - ``--projectId``
81+
- string
82+
- Unique identifier of the project that contains the private
83+
endpoint connection that you want to delete. If omitted, uses the
84+
project ID in the profile or :ref:`environment variable
85+
<mcli-env-var>`.
86+
- no
87+
88+
.. _atlas-privateendpoint-delete-output:
89+
90+
Output
91+
------
92+
93+
If the command succeeds, it returns the following output in the default
94+
format. If the command returns errors, see
95+
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
96+
97+
.. code-block:: sh
98+
:copyable: false
99+
100+
? Are you sure you want to delete: <private-endpoint-id> Yes
101+
Private endpoint '<private-endpoint-id>' deleted
102+
103+
Example
104+
-------
105+
106+
The following command deletes one private endpoint connection for a
107+
project using the {+default-profile+}, which contains credentials and
108+
the project ID. The output is returned in the default format.
109+
110+
.. code-block:: sh
111+
112+
mongocli atlas privateendpoints delete 5f4fc14da2b47835a58c63a2
113+
114+
The previous command prints the following to the terminal.
115+
116+
.. code-block:: sh
117+
:copyable: false
118+
119+
? Are you sure you want to delete: 5f4fc14da2b47835a58c63a2 Yes
120+
Private endpoint '5f4fc14da2b47835a58c63a2' deleted

0 commit comments

Comments
 (0)