(DOCSP-8235): Rename clusterName to clusterDomain configuration option (#168)

* (DOCSP-8253): Rename clusterName to clusterDomain configuration option

* (DOCSP-8243): WIP

* (DOCSP-8253): Change examples/mentions

* (DOCSP-8235): Update OM resource

* Copy review

Author: melissamahoney-mongodb

source/includes/admonitions/warning-set-cluster-name.rst

@@ -1,7 +1,8 @@
 .. warning::
 
-   You must set :setting:`spec.clusterName` if your |k8s| cluster has a
-   :k8sdocs:`default domain </concepts/services-networking/dns-pod-service#what-things-get-dns-names>`
-   different from default ``cluster.local``. If you neither use the
-   default nor set this option, the |k8s-op-short| may not function as
-   expected.
+   You must set :setting:`spec.clusterDomain` if your |k8s| cluster has
+   a :k8sdocs:`default domain
+   </concepts/services-networking/dns-pod-service#what-things-get-dns-names>`
+   other than the default ``cluster.local``. If you neither use the
+   default nor set the :setting:`spec.clusterDomain` option, the
+   |k8s-op-short| might not function as expected. 

source/includes/options-k8s-replica-set.yaml

@@ -76,6 +76,18 @@ inherit:
   program: _shared
   file: options-k8s-shared.yaml
 
+---
+program: k8sRsConf
+name: spec.clusterDomain
+type: string
+directive: setting
+optional: true
+default: cluster.local
+inherit:
+  name: spec.clusterDomain
+  program: _shared
+  file: options-k8s-shared.yaml
+
 ---
 program: k8sRsConf
 name: spec.clusterName
@@ -87,6 +99,7 @@ inherit:
   name: spec.clusterName
   program: _shared
   file: options-k8s-shared.yaml
+
 ---
 program: k8sRsConf
 name: spec.credentials

source/includes/options-k8s-shared.yaml

@@ -92,13 +92,36 @@ description: |
   users to create their custom services and lets the Operator reuse
   them.
 
+---
+program: _shared
+name: spec.clusterDomain
+type: string
+directive: setting
+optional: true
+default: cluster.local
+description: |
+
+  Domain name of the |k8s| cluster where you deploy the Operator. When
+  |k8s| creates a |k8s-statefulset|, the |k8s| assigns each |k8s-pod| a
+  |fqdn|. To update |com|, the |k8s-op-short| calculates the |fqdn| for
+  each |k8s-pod| using a provided cluster name. |k8s| doesn't provide
+  an |api| to query these hostnames.
+
+  .. include:: /includes/admonitions/warning-set-cluster-name.rst
+
 ---
 program: _shared
 name: spec.clusterName
 type: string
 directive: setting
 optional: true
 default: cluster.local
+pre: |
+
+  .. admonition:: ``spec.clusterName`` is Deprecated
+     :class: important
+
+     Use :setting:`spec.clusterDomain` instead.
 description: |
 
   Domain name of the |k8s| cluster where you deploy the Operator. When

source/includes/options-k8s-shared_cluster.yaml

@@ -103,6 +103,18 @@ inherit:
   program: _shared
   file: options-k8s-shared.yaml
 
+---
+program: k8sScConf
+name: spec.clusterDomain
+type: string
+directive: setting
+optional: true
+default: cluster.local
+inherit:
+  name: spec.clusterDomain
+  program: _shared
+  file: options-k8s-shared.yaml
+
 ---
 program: k8sScConf
 name: spec.clusterName
@@ -114,6 +126,7 @@ inherit:
   name: spec.clusterName
   program: _shared
   file: options-k8s-shared.yaml
+  
 ---
 program: k8sScConf
 name: spec.credentials

source/includes/options-k8s-standalone.yaml

@@ -90,6 +90,18 @@ inherit:
   program: _shared
   file: options-k8s-shared.yaml
 
+---
+program: k8sSaConf
+name: spec.clusterDomain
+type: string
+directive: setting
+optional: true
+default: cluster.local
+inherit:
+  name: spec.clusterDomain
+  program: _shared
+  file: options-k8s-shared.yaml
+
 ---
 program: k8sSaConf
 name: spec.clusterName

source/includes/steps-deploy-k8s-opsmgr.yaml

@@ -251,7 +251,7 @@ content: |
   You can add any of the following optional settings to the
   |k8s-obj| specification file for an |onprem| deployment:
 
-  - ``spec.``:opsmgrkube:`~spec.clusterName`
+  - ``spec.``:opsmgrkube:`~spec.clusterDomain`
   - ``spec.``:opsmgrkube:`~spec.configuration`
   - ``spec.applicationDatabase.``:setting:`~spec.logLevel`
   - ``spec.applicationDatabase.``:setting:`~spec.featureCompatibilityVersion`

source/includes/steps-source-deploy-k8s-resource.yaml

@@ -138,7 +138,7 @@ content: |
   You can also add any of the following optional settings to the
   |k8s-obj| specification file for a {{k8sResource}} deployment:
 
-  - :setting:`spec.clusterName`
+  - :setting:`spec.clusterDomain`
   - :setting:`spec.featureCompatibilityVersion`
   - :setting:`spec.logLevel`
   - :setting:`spec.podSpec.cpu`
@@ -165,7 +165,7 @@ content: |
   |k8s-obj| specification file for a :term:`sharded cluster`
   deployment:
 
-  - :setting:`spec.clusterName`
+  - :setting:`spec.clusterDomain`
   - :setting:`spec.exposedExternally`
   - :setting:`spec.logLevel`
   - :setting:`spec.featureCompatibilityVersion`

source/reference/k8s-operator-om-specification.txt

@@ -351,11 +351,23 @@ Optional |onprem| Resource Settings
    *Required if you enable Backup.*
 
    Name of the |aws| |s3| bucket or |s3|-compatible bucket that hosts
-   the snapshot store. 
+   the snapshot store.
 
+.. opsmgrkube:: spec.clusterDomain
+
+   *Type*: string
+
+   |k8s| assigns each |k8s-pod| a |fqdn|. The |k8s-op-short| calculates 
+   the |fqdn| for each |k8s-pod| using a provided ``clusterDomain``. 
+   |k8s| does not provide an |api| to query these hostnames.
 
 .. opsmgrkube:: spec.clusterName
 
+   .. admonition:: ``spec.clusterName`` is Deprecated
+      :class: important
+
+      Use :setting:`spec.clusterDomain` instead.
+
    *Type*: string
 
    |k8s| assigns each |k8s-pod| a |fqdn|. The |k8s-op-short| calculates 

source/reference/k8s-operator-specification.txt

@@ -85,6 +85,7 @@ Optional
 Every resource type may use the following settings:
 
 .. include:: /includes/option/setting-k8sSaConf-spec.featureCompatibilityVersion.rst
+.. include:: /includes/option/setting-k8sSaConf-spec.clusterDomain.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.clusterName.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.service.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.logLevel.rst

source/reference/k8s/shardedclusterpodspec.yaml

@@ -15,7 +15,7 @@ spec:
   ## Please Note: The default Kubernetes cluster name is
   ## `cluster.local`.
   ## If your cluster has been configured with another name, you can
-  ## specify it with the `clusterName` attribute.
+  ## specify it with the `clusterDomain` attribute.
 
   opsManager: # Alias of cloudManager
     configMapRef:

source/reference/troubleshooting.txt

@@ -220,7 +220,7 @@ To view all |k8s-mdbrsc| specifications in the provided
         annotations:
           kubectl.kubernetes.io/last-applied-configuration: |
             {"apiVersion":"mongodb.com/v1","kind":"MongoDB","metadata":{"annotations":{},"name":"dublin","namespace":"mongodb"},"spec":{"credentials":"alis-credentials","persistent":false,"podSpec":{"memory":"1G"},"project":"my-om-config","type":"Standalone","version":"4.0.0-ent"}}
-        clusterName: ""
+        clusterDomain: ""
         creationTimestamp: 2018-09-12T17:15:32Z
         generation: 1
         name: dublin