(DOCSP-36282) Changes cloudProviderAccess to cloudProviderIntegrations. (#19) (#25)

Author: erabil-mdb

source/ak8so-unified-access.txt

@@ -1,8 +1,8 @@
 .. _ak8so-unified-access:
 
-====================================
-Set Up Unified Cloud Provider Access
-====================================
+==========================================
+Set Up Unified Cloud Provider Integrations
+==========================================
 
 .. default-domain:: mongodb
 
@@ -30,14 +30,14 @@ Procedure
 .. procedure::
    :style: normal
 
-   .. step:: Add the ``spec.cloudProviderAccessRoles`` fields to the ``AtlasProject`` custom resource.
+   .. step:: Add the ``spec.cloudProviderIntegrations`` fields to the ``AtlasProject`` custom resource.
 
       a. Specify an empty value placeholder within the
-         ``spec.cloudProviderAccessRoles.iamAssumedRoleArn``
+         :setting:`spec.cloudProviderIntegrations.iamAssumedRoleArn`
          parameter of the :ref:`atlasproject-custom-resource`.
 
       #. Specify ``AWS`` within the 
-         ``spec.cloudProviderAccessRoles.providerName``
+         :setting:`spec.cloudProviderIntegrations.providerName`
          parameter of the :ref:`atlasproject-custom-resource`.
 
       **Example:**
@@ -57,7 +57,7 @@ Procedure
            projectIpAccessList:     
              - ipAddress: "192.0.2.15"
                comment: "IP address for Application"
-           cloudProviderAccessRoles:
+           cloudProviderIntegrations:
            - providerName: "AWS"
              iamAssumedRoleArn: ""
          EOF
@@ -78,7 +78,7 @@ Procedure
             .. input::
                :language: sh
 
-               kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderAccessRoles.atlasAWSAccountArn.type}'
+               kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderIntegrations.atlasAWSAccountArn.type}'
 
             .. output::
                :language: json
@@ -94,7 +94,7 @@ Procedure
             .. input::
                :language: sh
 
-               kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderAccessRoles.atlasAssumedRoleExternalId.type}'
+               kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderIntegrations.atlasAssumedRoleExternalId.type}'
 
             .. output::
                :language: json
@@ -129,7 +129,7 @@ Procedure
    .. step:: Authorize the |iam| role's access using {+ak8so+}.
 
       Replace the empty value placeholder within the 
-      ``spec.cloudProviderAccessRoles.iamAssumedRoleArn``
+      :setting:`spec.cloudProviderIntegrations.iamAssumedRoleArn`
       parameter of the :ref:`atlasproject-custom-resource` with
       the |iam| role's |aws| |arn| from the previous step.
 
@@ -150,25 +150,25 @@ Procedure
            projectIpAccessList:     
              - ipAddress: "192.0.2.15"
                comment: "IP address for Application"
-           cloudProviderAccessRoles:
+           cloudProviderIntegrations:
            - providerName: "AWS"
              iamAssumedRoleArn: "arn:aws:iam::123456789012:role/aws-service-role/support.amazonaws.com/myRole"
          EOF
 
-   .. step:: Check the status of the ``cloudProviderAccessRole``.
+   .. step:: Check the status of the ``cloudProviderIntegrations``.
 
       a. Run the command to retrieve the status:
 
          .. code-block:: sh
 
-            kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderAccessRoles}'
+            kubectl get atlasprojects my-project -o=jsonpath='{.status.cloudProviderIntegrations}'
 
       #. Check for the ``READY`` status.
 
          - If the status is ``CREATED``, |service| created the role but
            you have not authorized it within |aws|. 
          - If the status is ``EMPTY_ARN``, |service| created the role
            but you have not specified the 
-           ``spec.cloudProviderAccessRoles.iamAssumedRoleArn``.
+           ``spec.cloudProviderIntegrations.iamAssumedRoleArn``.
          - If the status is ``READY``, |service| has created the role
            and you have authorized it within |aws|.

source/atlasproject-custom-resource.txt

@@ -1159,7 +1159,7 @@ This section describes the ``AtlasProject`` custom resource parameters:
 
    *Type*: array
 
-   *Optional*
+   *Deprecated*. Use :setting:`spec.cloudProviderIntegrations` instead.
 
    List that contains your :ref:`unified cloud provider access 
    <ak8so-unified-access>` settings.
@@ -1168,7 +1168,7 @@ This section describes the ``AtlasProject`` custom resource parameters:
 
    *Type*: string
 
-   *Conditional*
+   *Deprecated*. Use :setting:`spec.cloudProviderIntegrations.iamAssumedRoleArn` instead.
 
    Unique |aws| |arn| that identifies the |iam| access role that 
    |service| assumes. If you want to 
@@ -1179,13 +1179,44 @@ This section describes the ``AtlasProject`` custom resource parameters:
 
    *Type*: string
 
-   *Conditional*
+   *Deprecated*. Use :setting:`spec.cloudProviderIntegrations.providerName` instead.
 
    Cloud provider for the access role that |service| assumes. |ak8so|
    supports ``AWS`` for unified cloud provider access. If you want to
    :ref:`set up unified cloud provider access 
    <ak8so-unified-access>`, you must specify this setting.
 
+.. setting:: spec.cloudProviderIntegrations
+
+   *Type*: array
+
+   *Optional*
+
+   List that contains your :ref:`unified cloud provider integration 
+   <ak8so-unified-access>` settings.
+
+.. setting:: spec.cloudProviderIntegrations.iamAssumedRoleArn
+
+   *Type*: string
+
+   *Conditional*
+
+   Unique |aws| |arn| that identifies the |iam| access role that 
+   |service| assumes. If you want to 
+   :ref:`set up unified cloud provider integrations <ak8so-unified-access>`,
+   you must specify this setting.
+
+.. setting:: spec.cloudProviderIntegrations.providerName
+
+   *Type*: string
+
+   *Conditional*
+
+   Cloud provider for the access role that |service| assumes. |ak8so|
+   supports ``AWS`` for unified cloud provider integrations. If you want to
+   :ref:`set up unified cloud provider integrations 
+   <ak8so-unified-access>`, you must specify this setting.
+
 .. setting:: spec.customRoles
 
    *Type*: object

source/configure-ak8so-access-to-atlas.txt

@@ -19,7 +19,7 @@ ID and :ref:`API keys <about-org-api-keys>` from |ak8so|
 - :ref:`secret storage <ak8so-secret-storage>`.
 - :ref:`network peering <ak8so-network-peering>`.
 - :ref:`private endpoints <ak8so-private-endpoint>`.
-- :ref:`Unified Cloud Provider Access <ak8so-unified-access>`.
+- :ref:`Unified Cloud Provider Integrations <ak8so-unified-access>`.
 - :ref:`custom database roles <ak8so-configure-custom-database-roles>`.
 - :ref:`X.509 authentication <ak8so-x509>`
 - :ref:`Encryption at Rest <ak8so-ear>`.
@@ -157,7 +157,7 @@ steps.
    Secret Storage </ak8so-secret-storage>
    Network Peering </ak8so-network-peering>
    Private Endpoints </ak8so-private-link>
-   Cloud Provider Access </ak8so-unified-access>
+   Cloud Provider Integrations </ak8so-unified-access>
    Custom Database Roles </ak8so-configure-custom-database-roles>
    X.509 </ak8so-x509>
    Encrypt Data </ak8so-encryption-at-rest-customer-keys>