Skip to content

Commit 08b188d

Browse files
authored
(DOCSP-31281) Removes clusterDomain because it's not supported. (#1407)
* (DOCSP-31281) Removes clusterDomain because it's not supported. * Comments-out clusterDomain spec and description. * Adds internal note.
1 parent 6af3409 commit 08b188d

File tree

2 files changed

+39
-37
lines changed

2 files changed

+39
-37
lines changed

source/multi-cluster-prerequisites.txt

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -417,43 +417,23 @@ If you don't use a service mesh, do the following to enable external
417417
connectivity to and between ``mongod`` processes and the
418418
|onprem| Automation Agent:
419419

420-
- Register ``mongod`` processes on externally-available hostnames using
421-
one of the following approaches:
422-
423-
- When you create a |k8s| cluster for your |multi-cluster|, use the
424-
:ref:`spec.clusterDomain <multi-spec-clusterdomain>` setting to specify
425-
an externally-available custom domain instead of the default domain.
426-
With the default cluster domain, ``mongod`` processes use ``*.cluster.local``
427-
hostnames. However, if you specify an externally-available custom domain
428-
for each |k8s| cluster in a |multi-cluster|, ``mongod`` processes use
429-
hostnames in the following pattern:
420+
- When you create a |multi-cluster|, use
421+
the :ref:`spec.clusterSpecList.externalAccess.externalDomain <multi-spec-clusterspeclist-externaldomain>`
422+
setting to specify an external domain and instruct the |k8s-op-short| to
423+
configure hostnames for ``mongod`` processes in the following pattern:
430424

431-
.. code-block:: sh
432-
433-
<pod-name>.<replica-set-name>-svc.<namespace>.svc.<externally-available-cluster-domain>
434-
435-
.. note::
436-
437-
You can set a custom cluster domain **only** when creating a |k8s| cluster
438-
for a |multi-cluster|.
439-
440-
- When you create a |multi-cluster|, use
441-
the :ref:`spec.clusterSpecList.externalAccess.externalDomain <multi-spec-clusterspeclist-externaldomain>`
442-
setting to specify an external domain and instruct the |k8s-op-short| to
443-
configure hostnames for ``mongod`` processes in the following pattern:
444-
445-
.. code-block:: sh
425+
.. code-block:: sh
446426

447-
<pod-name>.<externalDomain>
427+
<pod-name>.<externalDomain>
448428

449-
.. note::
429+
.. note::
450430

451-
You can specify external domains **only** for new deployments. You
452-
can't change external domains after you configure a |multi-cluster|.
431+
You can specify external domains **only** for new deployments. You
432+
can't change external domains after you configure a |multi-cluster|.
453433

454-
After you configure an external domain in this way, the |onprem|
455-
Automation Agents and ``mongod`` processes use this domain to connect
456-
to each other.
434+
After you configure an external domain in this way, the |onprem|
435+
Automation Agents and ``mongod`` processes use this domain to connect
436+
to each other.
457437

458438
- Customize external services that the |k8s-op-short| creates for each Pod
459439
in the |k8s| cluster. Use the global configuration in the :ref:`spec.externalAccess <multi-spec-externalaccess>`
@@ -469,6 +449,25 @@ connectivity to and between ``mongod`` processes and the
469449
You may also need to configure firewall rules to allow TCP traffic on
470450
ports 27017 and 27018.
471451

452+
..
453+
Feature for unknown future release - ER 7/13/23
454+
- When you create a |k8s| cluster for your |multi-cluster|, use the
455+
:ref:`spec.clusterDomain <multi-spec-clusterdomain>` setting to specify
456+
an externally-available custom domain instead of the default domain.
457+
With the default cluster domain, ``mongod`` processes use ``*.cluster.local``
458+
hostnames. However, if you specify an externally-available custom domain
459+
for each |k8s| cluster in a |multi-cluster|, ``mongod`` processes use
460+
hostnames in the following pattern:
461+
462+
.. code-block:: sh
463+
464+
<pod-name>.<replica-set-name>-svc.<namespace>.svc.<externally-available-cluster-domain>
465+
466+
.. note::
467+
468+
You can set a custom cluster domain **only** when creating a |k8s| cluster
469+
for a |multi-cluster|.
470+
472471
After you complete these prerequisites, you can
473472
:ref:`deploy a multi-Kubernetes cluster without a service mesh <multi-cluster-no-service-mesh-deploy-rs>`.
474473

source/reference/k8s-operator-multi-cluster-specification.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -318,13 +318,16 @@ Optional ``MongoDBMultiCluster`` Resource Settings
318318

319319
Alias for :ref:`spec.opsManager.configMapRef.name <multi-spec-opsmanager-configmapref-name>`.
320320

321-
.. _multi-spec-clusterdomain:
322-
323-
``spec.clusterDomain``
321+
..
322+
Feature for unknown future release - ER 7/13/23
323+
.. _multi-spec-clusterdomain:
324+
325+
``spec.clusterDomain``
326+
324327
*Type*: string
325-
328+
326329
*Default*: cluster.local
327-
330+
328331
Domain name of the |k8s| cluster where you deploy the |k8s-op-short|. When
329332
|k8s| creates a |k8s-statefulset|, the |k8s| assigns each |k8s-pod| a
330333
|fqdn|. To update |com|, the |k8s-op-short| calculates the |fqdn| for

0 commit comments

Comments
 (0)