Skip to content

Commit a3a6e2f

Browse files
authored
(DOCSP-48026) First draft of migration guide changes. (#211)
* (DOCSP-48026) First draft of migration guide changes. * (DOCSP-48026) Formatting fix. * (DOCSP-48026) Copy review.
1 parent 986e0b7 commit a3a6e2f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

source/migrate-parameter-to-resource.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,65 @@ The following configurations are affected:
4242
* - :setting:`spec.privateEndpoints`
4343
- :ref:`atlasprivateendpoint-custom-resource`
4444

45+
* - :setting:`spec.projectIpAccessList`
46+
- :ref:`atlasipaccesslist-custom-resource`
47+
48+
* - :setting:`spec.networkPeers`
49+
- :ref:`atlasnetworkpeering-custom-resource`
50+
51+
* - ``spec.networkPeers.containerId``
52+
- :ref:`atlasnetworkcontainer-custom-resource`
53+
54+
.. _ak8so-migrate-ptr-considerations:
55+
56+
Resource-Specific Considerations
57+
--------------------------------
58+
59+
Before you migrate parameters to resources, consider any
60+
implementation details specific to those parameters.
61+
62+
.. _ak8so-migrate-ptr-considerations-networkpeering:
63+
64+
Network Peering
65+
~~~~~~~~~~~~~~~
66+
67+
The following considerations apply to ``atlasNetworkPeering``
68+
resources:
69+
70+
- An ``atlasNetworkPeering`` CRD can refer to its corresponding
71+
``atlasNetworkContainer`` by a |k8s| name reference or ID.
72+
73+
- An ``atlasNetworkPeering`` CRD can refer to the ``atlasProject``
74+
that hosts it by a |k8s| name reference or ID.
75+
76+
- The :setting:`spec.networkPeers` parameter of an ``atlasProject``
77+
CRD contains details of both the peering connection itself and the
78+
container that supports it. When you migrate from this parameter to
79+
an ``atlasNetworkPeering`` CRD, you might need to create an
80+
``atlasNetworkContainer`` CRD for the container that supports
81+
it. To learn more, see :ref:`ak8so-migrate-ptr-considerations-networkcontainer`.
82+
83+
.. _ak8so-migrate-ptr-considerations-networkcontainer:
84+
85+
Network Container
86+
~~~~~~~~~~~~~~~~~
87+
88+
The following considerations apply to ``atlasNetworkContainer``
89+
resources:
90+
91+
- You don't need to create a new ``atlasNetworkContainer`` resource
92+
when you migrate the ``atlasNetworkPeering`` connection from a
93+
parameter to a resource if either:
94+
95+
- You manage the network container supporting an ``atlasNetworkPeering``
96+
connection outside of the |ak8so| ``atlasProject`` in which you
97+
manage the ``atlasNetworkPeering`` connection
98+
- An ``atlasNetworkContainer`` resource for the
99+
``atlasNetworkPeering`` connection's container already exists.
100+
101+
- An ``atlasNetworkContainer`` CRD can refer to its host
102+
``atlasProject`` by a |k8s| name reference or ID.
103+
45104
.. _ak8so-migrate-ptr-procedure:
46105

47106
Migration Procedure

0 commit comments

Comments
 (0)