Skip to content

Commit 10480b5

Browse files
authored
(DOCSP-50816) Third-Party Integration CRD (#245)
* (DOCSP-50816) Third-Party Integration CRD * (DOCSP-50816) Add to ToC * (DOCSP-50816) Content review. * (DOCSP-50816) Content review. * (DOCSP-50816) Formatting fix. * (DOCSP-50816) Migration info. * (DOCSP-50816) Migration changes. * (DOCSP-50816) Typos. * (DOCSP-50816) Integration page fix. * (DOCSP-50816) Remove dead ref
1 parent 12c6470 commit 10480b5

7 files changed

+550
-395
lines changed

source/ak8so-integrate-third-party.txt

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,8 @@ To learn more, see :ref:`ak8so-access-to-atlas-ref`.
3535
Procedure
3636
---------
3737

38-
To integrate |service| with a third-party service, configure the
39-
:ref:`atlasproject-custom-resource`.
40-
41-
**Example:**
42-
43-
.. code-block:: sh
44-
45-
cat <<EOF | kubectl apply -f -
46-
apiVersion: atlas.mongodb.com/v1
47-
kind: AtlasProject
48-
metadata:
49-
name: my-project
50-
spec:
51-
name: TestDatadogIntegration
52-
connectionSecretRef:
53-
name: my-atlas-key
54-
projectIpAccessList:
55-
- cidrBlock: "0.0.0.0/1"
56-
comment: "Everyone has access. For test purposes only."
57-
- cidrBlock: "128.0.0.0/1"
58-
comment: "Everyone has access. For test purposes only."
59-
integrations:
60-
- type: "DATADOG"
61-
apiKeyRef:
62-
name: key-name
63-
namespace: key-namespace
64-
region: "US"
65-
EOF
66-
67-
The parameters that you must specify in the
68-
:ref:`atlasproject-custom-resource` depend on the third-party service
69-
that you want to configure:
70-
71-
.. include:: /includes/list-tabel-integration-settings.rst
72-
73-
For another example, see :ref:`prometheus-example`.
74-
75-
.. include:: /includes/fact-ak8so-grafana.rst
38+
To integrate |service| with a third-party service, configure an
39+
:ref:`atlasthirdpartyintegration-custom-resource`.
7640

7741
To learn more about the configuration parameters available from
7842
the |api|, see the |service| :oas-atlas-op:`Third-Party Integration

source/atlasprivateendpoint-custom-resource.txt

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ virtual network.
2323

2424
.. include:: /includes/fact-ak8so-crds.rst
2525

26-
|ak8so| does one of the following actions using the |service|
26+
|ak8so| takes one of the following actions using the |service|
2727
:oas-atlas-tag:`Private Endpoint Service API Resource
2828
</Private-Endpoint-Services>`:
2929

3030
- Creates a new private endpoint service.
3131
- Updates an existing private endpoint service.
3232

33-
To learn more about implememting private endpoints in |ak8so|, see
33+
To learn more about implementing private endpoints in |ak8so|, see
3434
:ref:`Manage Private Endpoints <ak8so-private-endpoint>`.
3535

3636
Examples
@@ -82,7 +82,7 @@ inherit API credentials from its parent project.
8282
metadata:
8383
name: my-atlas-pe1
8484
spec:
85-
atlasRef:
85+
externalProjectRef:
8686
projectID: 66e2f2b621571b7e69a89b66
8787
connectionSecret:
8888
name: atlas-connection-secret
@@ -94,22 +94,24 @@ inherit API credentials from its parent project.
9494
Parameters
9595
----------
9696

97-
This section describes the ``AtlasPrivateEndpoint`` custom resource parameters available.
97+
This section describes the ``AtlasPrivateEndpoint`` custom resource
98+
parameters available.
9899

99100
``metadata.name``
100101
*Type*: string
101102

102103
*Required*
103104

104-
Name that the :ref:`atlasproject-custom-resource` uses to add this private endpoint to a project.
105+
Name that the :ref:`atlasprivateendpoint-custom-resource` uses to
106+
add this private endpoint to a project.
105107

106108
.. setting:: metadata.namespace
107109

108110
*Type*: string
109111

110112
*Optional*
111113

112-
Namespace that you want to contain the ``atlasPrivateEndpoint``
114+
Namespace that you want to contain the ``AtlasPrivateEndpoint``
113115
custom resource. If unspecified, |ak8so| uses the current namespace
114116
set by ``kubectl``.
115117

@@ -248,7 +250,7 @@ This section describes the ``AtlasPrivateEndpoint`` custom resource parameters a
248250
parameter applies only to private endpoints that belong to projects
249251
managed by the same instance |ak8so|.
250252

251-
For deployments that belong to projects managed by either:
253+
For private endpoints that belong to projects managed by either:
252254

253255
- a different instance of |ak8so|
254256
- tooling other than |ak8so|

0 commit comments

Comments
 (0)