Skip to content

Commit a93ea07

Browse files
(DOCS-13939): minor improvements per feedback (#411)
* (DOCS-13939): minor improvements per feedback * (DOCS-13939): fix build warnings
1 parent 2899fda commit a93ea07

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@
130130
'.. |json| replace:: :abbr:`JSON (Javascript Object Notation)`',
131131
'.. |jedec| replace:: :abbr:`JEDEC (Joint Electron Device Engineering Council Solid State Technology Association)`',
132132
'.. |jvm| replace:: :abbr:`JVM (Java Virtual Machine)`',
133+
'.. |k8s-cr| replace:: `ClusterRole <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole>`__',
134+
'.. |k8s-crb| replace:: `ClusterRoleBinding <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding>`__',
133135
'.. |k8s-configmaps| replace:: `ConfigMaps <https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/>`__',
134136
'.. |k8s-configmap| replace:: `ConfigMap <https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/>`__',
135137
'.. |k8s-custom-resource| replace:: `Custom Resource <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`__',
@@ -159,6 +161,7 @@
159161
'.. |k8s-secret| replace:: `secret <https://kubernetes.io/docs/concepts/configuration/secret/>`__',
160162
'.. |k8s-statefulsets| replace:: `StatefulSets <https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/>`__',
161163
'.. |k8s-statefulset| replace:: `StatefulSet <https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/>`__',
164+
'.. |k8s-webhook| replace:: `Webhook <https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#what-are-admission-webhooks>`__',
162165
'.. |k8s| replace:: Kubernetes',
163166
'.. |kdc| replace:: :abbr:`KDC (Key Distribution Center)`',
164167
'.. |kmip| replace:: :abbr:`KMIP (Key Management Interoperability)`',

source/includes/op-setting-descs/watch-namespace.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ the Operator's ServiceAccount :k8sdocs:`can access
55
this namespace.
66

77
Use **\*** to specify *all namespaces*. To watch all namespaces, you
8-
must also assign the `ClusterRole
9-
<https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole>`__
10-
to the ``mongodb-enterprise-operator`` ServiceAccount,
11-
which is the ServiceAccount used to run the |k8s-op-short|.
8+
must also assign the |k8s-cr| to the ``mongodb-enterprise-operator``
9+
ServiceAccount, which is the ServiceAccount used to run the
10+
|k8s-op-short|.
1211

1312
.. include:: /includes/admonitions/fact-create-service-account-namespaces.rst
1413

source/tutorial/plan-k8s-op-considerations.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ them every three weeks.
6060
Validation Webhook
6161
------------------
6262

63-
The |k8s-op-short| uses a webhook to prevent users from applying
63+
The |k8s-op-short| uses a |k8s-webhook| to prevent users from applying
6464
invalid resource definitions. The webhook rejects invalid requests.
6565
The |k8s-op-short| doesn't create or update the resource.
6666

67-
The ``ClusterRole`` and ``ClusterRoleBinding`` for the webhook are
67+
The |k8s-cr| and |k8s-crb| for the webhook are
6868
included in the default configuration files that you apply during
6969
installation. To create the role and binding, you must have
7070
:k8sdocs:`cluster-admin privileges </reference/access-authn-authz/rbac/#user-facing-roles>`.
@@ -98,7 +98,7 @@ errors, the |k8s-op-short| issues warnings.
9898
--------------------------------
9999

100100
You can deploy the |k8s-op-short| with different scopes based on where
101-
you want to deploy |onprem| and |k8s-mdbrscs| resources:
101+
you want to deploy |onprem| and |k8s-mdbrscs|:
102102

103103
- :ref:`ns-scope-same-ns` *(Default)*
104104
- :ref:`ns-scope-different-ns`

0 commit comments

Comments
 (0)