Skip to content

Commit 95e2851

Browse files
authored
(DOCSP-48024) Fix description of metadata.namespace (#220)
* (DOCSP-48024) Fix description of metadata.namespace * (DOCSP-48024) Indentation fix.
1 parent 2ea8e0d commit 95e2851

7 files changed

+23
-21
lines changed

source/atlascustomrole-custom-resource.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,25 +132,24 @@ credentials from its parent project.
132132
Parameters
133133
----------
134134

135-
This section describes the ``AtlasTeam`` custom resource parameters available.
135+
This section describes the ``AtlasCustomRole`` custom resource parameters available.
136136

137137
``metadata.name``
138138
*Type*: string
139139

140140
*Required*
141141

142-
Name that the :ref:`atlasproject-custom-resource` uses to add this team to a project.
142+
Name that the :ref:`atlasproject-custom-resource` uses to add this
143+
custom role to a project.
143144

144145
.. setting:: metadata.namespace
145146

146147
*Type*: string
147148

148149
*Optional*
149150

150-
Namespace other than ``default`` that you want to contain the ``atlasTeam``
151-
custom resource. If you define a custom namespace, you must add it to the
152-
:ref:`atlasproject-custom-resource` in the :setting:`spec.teams.teamRef.namespace`
153-
field.
151+
Namespace that you want to contain the ``atlasCustomRole`` custom
152+
resource. If unspecified, |ak8so| uses the current namespace set by ``kubectl``.
154153

155154
.. setting:: spec.connectionSecret.name
156155

source/atlasfederatedauth-custom-resource.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ API documentation to customize your specifications.
107107

108108
*Optional*
109109

110-
Namespace where you want to deploy the ``AtlasFederatedAuth`` custom resource.
110+
Namespace that you want to contain the ``atlasFederatedAuth``
111+
custom resource. If unspecified, |ak8so| uses the current namespace
112+
set by ``kubectl``.
111113

112114
.. _atlasfederatedauth-enabled:
113115

source/atlasipaccesslist-custom-resource.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ This section describes the ``AtlasIPAccessList`` custom resource parameters avai
113113

114114
*Optional*
115115

116-
Namespace other than ``default`` that you want to contain the
117-
``atlasIPAccessList`` custom resource.
116+
Namespace that you want to contain the ``atlasIPAccessList`` custom
117+
resource. If unspecified, |ak8so| uses the current namespace set by ``kubectl``.
118118

119119
.. setting:: spec.connectionSecret.name
120120

source/atlasnetworkcontainer-custom-resource.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ available in this custom resource definition.
116116

117117
*Optional*
118118

119-
Namespace other than ``default`` that you want to contain the
120-
``AtlasNetworkContainer`` custom resource.
119+
Namespace that you want to contain the ``atlasNetworkContainer``
120+
custom resource. If unspecified, |ak8so| uses the current namespace
121+
set by ``kubectl``.
121122

122123
.. setting:: spec.connectionSecret.name
123124

source/atlasnetworkpeering-custom-resource.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ available in this custom resource definition.
132132

133133
*Optional*
134134

135-
Namespace other than ``default`` that you want to contain the
136-
``AtlasNetworkPeering`` custom resource.
135+
Namespace that you want to contain the ``atlasNetworkPeering`` custom
136+
resource. If unspecified, |ak8so| uses the current namespace set by ``kubectl``.
137137

138138
.. setting:: spec.connectionSecret.name
139139

source/atlasprivateendpoint-custom-resource.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,11 @@ This section describes the ``AtlasPrivateEndpoint`` custom resource parameters a
107107

108108
*Optional*
109109

110-
Namespace other than ``default`` that you want to contain the
111-
``atlasPrivateEndpoint`` custom resource. If you define a custom
112-
namespace, you must add it to the
110+
Namespace that you want to contain the ``atlasPrivateEndpoint``
111+
custom resource. If unspecified, |ak8so| uses the current namespace
112+
set by ``kubectl``.
113+
114+
If you define a custom namespace, you must add it to the
113115
:ref:`atlasproject-custom-resource` in the
114116
``spec.privateEndpoint.privateEndpointRef.namespace`` field.
115117

source/atlasteam-custom-resource.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,8 @@ This section describes the ``AtlasTeam`` custom resource parameters available.
6666

6767
*Optional*
6868

69-
Namespace other than ``default`` that you want to contain the ``atlasTeam``
70-
custom resource. If you define a custom namespace, you must add it to the
71-
:ref:`atlasproject-custom-resource` in the :setting:`spec.teams.teamRef.namespace`
72-
field.
69+
Namespace that you want to contain the ``atlasTeam`` custom
70+
resource. If unspecified, |ak8so| uses the current namespace set by ``kubectl``.
7371

7472
.. setting:: spec.name
7573

@@ -86,4 +84,4 @@ This section describes the ``AtlasTeam`` custom resource parameters available.
8684

8785
*Required*
8886

89-
List that contains the |service| usernames for the members of this team.
87+
List that contains the |service| usernames for the members of this team.

0 commit comments

Comments
 (0)