Skip to content

Commit 2fcd634

Browse files
authored
(DOCSP-47208) Flag deprecation of various subresources (#222)
1 parent 95e2851 commit 2fcd634

8 files changed

+53
-9
lines changed

source/ak8so-network-peering.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,4 +278,4 @@ Enable clients to connect to |service| clusters using a network peering connecti
278278
:language: json
279279
:visible: true
280280

281-
READY
281+
READY

source/atlascustomrole-custom-resource.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
:depth: 2
1414
:class: singlecol
1515

16+
.. include:: /includes/subresource-deprecation.rst
17+
1618
The ``AtlasCustomRole`` custom resource defines a :ref:`custom
1719
database role <mongodb-roles>` to allocate privileges to your
1820
:ref:`database users <mongodb-users>`.

source/atlasipaccesslist-custom-resource.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
:depth: 2
1313
:class: singlecol
1414

15+
.. include:: /includes/subresource-deprecation.rst
16+
1517
The ``AtlasIPAccessList`` custom resource configures an :ref:`IP
1618
access list <access-list>` for an |service| project. An IP access list
1719
allows you to secure your project using a minimum-access policy.

source/atlasnetworkcontainer-custom-resource.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
:depth: 2
1313
:class: singlecol
1414

15+
.. include:: /includes/subresource-deprecation.rst
16+
1517
The ``AtlasNetworkContainer`` custom resource defines a :ref:`network
1618
container <ak8so-network-peering>` for a |service|
1719
project. You create |vpc| peering connections between network

source/atlasnetworkpeering-custom-resource.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
:depth: 2
1313
:class: singlecol
1414

15+
.. include:: /includes/subresource-deprecation.rst
16+
1517
The ``AtlasNetworkPeering`` custom resource defines a :ref:`network
1618
peering connection <ak8so-network-peering>` for a |service|
1719
project. Network peering connections isolate traffic from public

source/atlasprivateendpoint-custom-resource.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
:depth: 2
1313
:class: singlecol
1414

15+
.. include:: /includes/subresource-deprecation.rst
16+
1517
The ``AtlasPrivateEndpoint`` custom resource configures a
1618
:ref:`private endpoint <private-endpoint-overview>` for a |service|
1719
project. This allows you to connect your cloud provider to |service|

source/atlasproject-custom-resource.txt

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,17 +1237,16 @@ This section describes the ``AtlasProject`` custom resource parameters:
12371237

12381238
*Optional*
12391239

1240-
Object that contains your custom role specifications.
1240+
*Deprecated*
12411241

12421242
.. important::
1243-
1244-
This parameter is deprecated beginning in version 2.6. To create
1245-
custom roles with |ak8so|, use the
1246-
:ref:`atlascustomrole-custom-resource`.
12471243

1248-
To learn more about the configuration parameters available from
1249-
the |api|, see the |service| :oas-atlas-op:`Custom Database
1250-
Roles API </createCustomDatabaseRole>`.
1244+
This parameter is deprecated as of |ak8so| ``2.6``. Migrate to the
1245+
:ref:`AtlasPrivateEndpoint Custom Resource
1246+
<atlascustomrole-custom-resource>` in accordance with the
1247+
:ref:`migration guide <ak8so-migrate-ptr>`.
1248+
1249+
Object that contains your custom role specifications.
12511250

12521251
.. setting:: spec.encryptionAtRest
12531252

@@ -1869,6 +1868,16 @@ This section describes the ``AtlasProject`` custom resource parameters:
18691868

18701869
*Optional*
18711870

1871+
*Deprecated*
1872+
1873+
.. important::
1874+
1875+
This parameter is deprecated as of |ak8so| ``2.8``. Migrate to the
1876+
:ref:`AtlasNetworkPeering <atlasnetworkpeering-custom-resource>` and
1877+
:ref:`AtlasNetworkContainer
1878+
<atlasnetworkcontainer-custom-resource>` custom resources in
1879+
accordance with the :ref:`migration guide <ak8so-migrate-ptr>`.
1880+
18721881
List that contains the :ref:`network peering
18731882
<ak8so-network-peering>` configurations for the project.
18741883

@@ -1899,11 +1908,21 @@ This section describes the ``AtlasProject`` custom resource parameters:
18991908

19001909
*Required*
19011910

1911+
*Deprecated*
1912+
1913+
.. important::
1914+
1915+
This parameter is deprecated as of |ak8so| ``2.7``. Migrate to the
1916+
:ref:`AtlasIPAccessList Custom Resource
1917+
<atlasipaccesslist-custom-resource>` in accordance with the
1918+
:ref:`migration guide <ak8so-migrate-ptr>`.
1919+
19021920
IP access list that grants network access to |service| clusters in
19031921
the project. You can specify the following body parameters:
19041922

19051923
.. include:: /includes/api/list-tables/requests/access-list.rst
19061924

1925+
19071926
.. setting:: spec.settings
19081927

19091928
*Type*: object
@@ -1974,6 +1993,15 @@ This section describes the ``AtlasProject`` custom resource parameters:
19741993

19751994
*Optional*
19761995

1996+
*Deprecated*
1997+
1998+
.. important::
1999+
2000+
This parameter is deprecated as of |ak8so| ``2.6``. Migrate to the
2001+
:ref:`AtlasPrivateEndpoint Custom Resource
2002+
<atlasprivateendpoint-custom-resource>` in accordance with the
2003+
:ref:`migration guide <ak8so-migrate-ptr>`.
2004+
19772005
List that contains the :ref:`private endpoint
19782006
<ak8so-private-endpoint>` configurations for the project.
19792007

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. important::
2+
3+
Legacy subresources are deprecated as of the release of their
4+
corresponding CRDs. If your configuration currently relies on the
5+
subresource form of this resource definition, :ref:`migrate to a
6+
CRD <ak8so-migrate-ptr>`.

0 commit comments

Comments
 (0)