Skip to content

Commit 098b64c

Browse files
jwilliams-mongojwilliams-mongo
authored
rename + release notes cleanup (#2)
* rename + release notes cleanup * version cleanup * warnings * more fixes * more name changes
1 parent 75352cd commit 098b64c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+84
-1109
lines changed

‎README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
====================================================
2-
MongoDB Enterprise Kubernetes Operator Documentation
2+
MongoDB Controllers for Kubernetes Documentation
33
====================================================
44

55
This repository contains documentation regarding components of the
6-
the MongoDB Enterprise Kubernetes Operator.
6+
the MongoDB Controllers for Kubernetes.
77

88
Building
99
--------

‎config/sphinx_local.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ paths:
44
static: ['source/.static']
55
theme:
66
name: 'kubernetes-operator'
7-
sitename: 'MongoDB Enterprise Kubernetes Operator'
7+
sitename: 'MongoDB Controllers for Kubernetes'
88
jira: 'DOCSP'
99
google_analytics: 'UA-7301842-8'
1010
nav_excluded:

‎snooty.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ toc_landing_pages = [
3737
aagent = "MongoDB Agent or legacy Automation Agent"
3838
aagents = "MongoDB Agents or legacy Automation Agents"
3939
appdb = "Application Database"
40-
k8s-op-short = "Kubernetes Operator"
40+
k8s-op-short = "Controllers for Kubernetes"
4141
k8s-api-version = "v1.26"
4242
k8s-crds = "`CustomResourceDefinitions <https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/>`__"
4343
k8s-crd = "`CustomResourceDefinition <https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/>`__"
@@ -50,8 +50,8 @@ mdb-ent-db = "MongoDB Enterprise Database"
5050
mdb-support = "`MongoDB Support <https://support.mongodb.com/welcome>`__"
5151
mdb-version = "8.0.0"
5252
monitoring-agent = "Monitoring Agent"
53-
version = "1.32"
54-
dl-version = "1.32.0"
53+
version = "1.0"
54+
dl-version = "1.0.0"
5555
github-branch = "enterprise-operator-release-1-32-0"
5656

5757
[substitutions]
@@ -152,9 +152,9 @@ k8s-nss = "`namespaces <https://kubernetes.io/docs/concepts/overview/working-wit
152152
k8s-ns = "`namespace <https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/>`__"
153153
k8s-objs = "`objects <https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`__"
154154
k8s-obj = "`object <https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`__"
155-
k8s-op-full = "MongoDB Enterprise Kubernetes Operator"
156-
k8s-op-short = "Kubernetes Operator"
157-
k8s-op = "MongoDB Enterprise Kubernetes Operator"
155+
k8s-op-full = "MongoDB Controllers for Kubernetes"
156+
k8s-op-short = "Controllers for Kubernetes"
157+
k8s-op = "MongoDB Controllers for Kubernetes"
158158
k8s-pods = "`Pods <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__"
159159
k8s-pod = "`Pod <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__"
160160
k8s-pvcs = "`Persistent Volume Claims <https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims>`__"

‎source/includes/facts/fact-custom-resource-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The :github:`MongoDB Enterprise Kubernetes Operator </mongodb/mongodb-enterprise-kubernetes>`
1+
The :github:`MongoDB Controllers for Kubernetes </mongodb/mongodb-enterprise-kubernetes>`
22
creates |k8s| |k8s-statefulsets| from specification files that you write.
33

44
The |k8s-op-short| creates MongoDB-specific resources in |k8s| as

‎source/includes/facts/fact-disable-tls.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎source/includes/facts/fact-external-domain-spec.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ connections still use the hostname with the external domain:
2626
- |mongod| to connect to other |mongod| instances.
2727

2828
:red:`WARNING:` Specifying this field changes how |onprem| registers |mongod| processes.
29-
You can specify this field only for new replica set deployments starting in |k8s-op-short|
30-
version 1.19. You can't change the value of this field or any ``processes[n].hostname`` fields
29+
You can't change the value of this field or any ``processes[n].hostname`` fields
3130
in the |onprem| :opsmgr:`automation configuration </reference/cluster-configuration>` for a running
3231
replica set deployment.

‎source/includes/facts/fact-must-migrate-specified-appdb.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎source/includes/list-tables/compatibility-k8s-os.rst

Lines changed: 3 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,8 @@
88
- |k8s| Version
99
- OpenShift Version
1010

11-
* - 1.31
12-
- February 11, 2025
13-
- February 11, 2026
11+
* - 1.0.0
12+
- April 21, 2025
13+
- April 21, 2026
1414
- 1.30, 1.31
1515
- 4.17
16-
17-
* - 1.30
18-
- December 20, 2024
19-
- December 20, 2025
20-
- 1.29, 1.30, 1.31
21-
- 4.17
22-
23-
* - 1.29
24-
- November 11, 2024
25-
- November 11, 2025
26-
- 1.28, 1.29, 1.30
27-
- 4.15, 4.16
28-
29-
* - 1.28
30-
- October 02, 2024
31-
- October 02, 2025
32-
- 1.28, 1.29, 1.30
33-
- 4.15, 4.16
34-
35-
* - 1.27
36-
- August 27, 2024
37-
- August 27, 2025
38-
- 1.28, 1.29, 1.30
39-
- 4.15, 4.16
40-
41-
* - 1.26
42-
- June 21, 2024
43-
- June 21, 2025
44-
- 1.27, 1.28, 1.29
45-
- 4.15
46-
47-
48-
* - 1.25
49-
- April 30, 2024
50-
- April 30, 2025
51-
- 1.27, 1.28, 1.29
52-
- 4.14
53-

‎source/includes/list-tables/compatibility-mdb.rst

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,5 @@
55
* - |k8s-op-short| Release Series
66
- Base Image
77

8-
* - 1.31.x
8+
* - 1.0.0
99
- Red Hat UBI 9 Base Image
10-
11-
* - 1.30.x
12-
- Red Hat UBI 9 Base Image
13-
14-
* - 1.29.x
15-
- Red Hat UBI 9 Base Image
16-
17-
* - 1.28.x
18-
- Red Hat UBI 9 Base Image
19-
20-
* - 1.27.x
21-
- Red Hat UBI 8 Base Image
22-
23-
* - 1.26.x
24-
- Red Hat UBI 8 Base Image
25-
26-
* - 1.25.x
27-
- Red Hat UBI 8 Base Image

‎source/includes/list-tables/compatibility-om.rst

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,5 @@
55
* - |k8s-op-short| Release Series
66
- |onprem| Version
77

8-
* - 1.31.x
9-
- 6.0, 7.0, 8.0
10-
11-
* - 1.30.x
12-
- 6.0, 7.0, 8.0
13-
14-
* - 1.29.x
15-
- 6.0, 7.0, 8.0
16-
17-
* - 1.28.x
18-
- 6.0, 7.0, 8.0
19-
20-
* - 1.27.x
21-
- 6.0, 7.0
22-
23-
* - 1.26.x
24-
- 6.0, 7.0
25-
26-
* - 1.25.x
27-
- 6.0, 7.0
8+
* - 1.0.0
9+
- 7.0, 8.0

‎source/includes/prereqs-deploy-resource.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ To deploy a |deployment| using an |k8s-obj|, you must:
22

33
- Have or create an :opsmgr:`Ops Manager instance </installation>` or a :opsmgr:`Cloud Manager organization </tutorial/manage-organizations/#create-organization>`.
44

5-
- Have or install the :ref:`MongoDB Enterprise Kubernetes Operator <install-k8s>`.
5+
- Have or install the :ref:`MongoDB Controllers for Kubernetes <install-k8s>`.
66

77
- Create or generate a :ref:`Kubernetes Operator ConfigMap <create-k8s-project>`.
88

‎source/includes/prereqs-secure-resource-x509.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
Enabling X.509 authentication at the project level configures all
22
agents to use X.509 client authentication when communicating with
33
MongoDB deployments.
4-
5-
X.509 client authentication requires one of the following:
6-
7-
- |cloud-short|
8-
- |onprem| 4.1.7 or later
9-
- |onprem| 4.0.11 or later

‎source/includes/setting-k8sRsConf-spec.security.tls.enabled.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎source/includes/setting-k8sSaConf-spec.exposedExternally.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎source/includes/steps-install-master.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Navigate to the directory in which you cloned the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`."
2+
title: "Navigate to the directory in which you cloned the :github:`MongoDB Controllers for Kubernetes repository </mongodb/mongodb-enterprise-kubernetes>`."
33
level: 4
44
ref: install-master-cd
55
content: |

‎source/includes/steps-install-oc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Clone the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`."
2+
title: "Clone the :github:`MongoDB Controllers for Kubernetes repository </mongodb/mongodb-enterprise-kubernetes>`."
33
level: 4
44
ref: install-kubectl-clone-repo
55
stepnum: 1

‎source/includes/steps-install-prereqs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ content: |
1414
stepnum: 2
1515
level: 4
1616
ref: clone-k8s-repo
17-
title: "Clone the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`."
17+
title: "Clone the :github:`MongoDB Controllers for Kubernetes repository </mongodb/mongodb-enterprise-kubernetes>`."
1818
content: |
1919
2020
.. code-block:: sh

‎source/includes/steps-multi-cluster-source.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -522,7 +522,7 @@ ref: download-k8sop-version
522522
content: |
523523
524524
Download your desired |k8s-op-short| package version from the
525-
:github:`Release Page of the MongoDB Enterprise Kubernetes Operator Repository </mongodb/mongodb-enterprise-kubernetes/releases>`.
525+
:github:`Release Page of the MongoDB Controllers for Kubernetes Repository </mongodb/mongodb-enterprise-kubernetes/releases>`.
526526
527527
The package's name uses this pattern:
528528
``kubectl-mongodb_{{ .Version }}_{{ .Os }}_{{ .Arch }}.tar.gz``.

‎source/includes/steps-openshift-quick-start.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
stepnum: 1
33
level: 4
44
ref: clone-k8s-repo-openshift
5-
title: "Clone the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`."
5+
title: "Clone the :github:`MongoDB Controllers for Kubernetes repository </mongodb/mongodb-enterprise-kubernetes>`."
66
content: |
77
88
.. code-block:: sh

‎source/index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
:noprevnext:
44

55
======================================
6-
MongoDB Enterprise Kubernetes Operator
6+
MongoDB Controllers for Kubernetes
77
======================================
88

99
.. meta::
10-
:description: Discover how the MongoDB Enterprise Kubernetes Operator automates the deployment and management of MongoDB clusters using Kubernetes, integrating with Cloud Manager or Ops Manager.
10+
:description: Discover how the MongoDB Controllers for Kubernetes automates the deployment and management of MongoDB clusters using Kubernetes, integrating with Cloud Manager or Ops Manager.
1111

1212
.. default-domain:: mongodb
1313

‎source/multi-cluster-arch.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ service mesh, such as:
141141
.. figure:: /images/multi-cluster-arch-with-service-mesh.svg
142142
:alt: Diagram showing the high-level architecture of a multi-cluster-Kubernetes
143143
deployment across regions and availability zones using the
144-
MongoDB Enterprise Kubernetes Operator, with a service mesh
144+
MongoDB Controllers for Kubernetes, with a service mesh
145145
:figwidth: 600px
146146

147147
.. _multi-cluster-diagram-no-service-mesh:
@@ -160,7 +160,7 @@ on Pods in distinct |k8s| clusters, :ref:`use external domains and DNS zones <dn
160160
.. figure:: /images/multi-cluster-arch-no-service-mesh.svg
161161
:alt: Diagram showing the high-level architecture of a multi-cluster-Kubernetes
162162
deployment across regions and availability zones using the
163-
MongoDB Enterprise Kubernetes Operator, and without a service mesh
163+
MongoDB Controllers for Kubernetes, and without a service mesh
164164
:figwidth: 600px
165165

166166
You can host your application on any of the member clusters.

‎source/multi-cluster-overview.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To learn more, see :ref:`multi-cluster-arch-ref`.
5050
.. figure:: /images/multi-cluster-arch-with-service-mesh.svg
5151
:alt: Diagram showing the high-level architecture of a multi-cluster-Kubernetes
5252
deployment across regions and availability zones using the
53-
MongoDB Enterprise Kubernetes Operator, with a service mesh
53+
MongoDB Controllers for Kubernetes, with a service mesh
5454
:figwidth: 600px
5555

5656
.. note::

‎source/multi-cluster-prerequisites.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ See :ref:`supported hardware architectures <k8s-supported-hardware-arch-compatib
3232
Clone the |k8s-op-full| Repository
3333
----------------------------------
3434

35-
Clone the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`:
35+
Clone the :github:`MongoDB Controllers for Kubernetes repository </mongodb/mongodb-enterprise-kubernetes>`:
3636

3737
.. code-block:: sh
3838

‎source/multi-cluster-services-tools.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Services and Tools
88

99
.. meta::
1010
:keywords: multicluster, multi-cluster, MongoDB, mongodbmulti, istio, mesh, gke, helm,charts, multi-Kubernetes
11-
:description: Review third-party and other tools, such as the MongoDB kubectl plugin and Helm Charts for Kubernetes that the MongoDB Enterprise Kubernetes Operator uses to deploy MongoDB multi-Kubernetes custom resources on nodes in multiple Kubernetes clusters.
11+
:description: Review third-party and other tools, such as the MongoDB kubectl plugin and Helm Charts for Kubernetes that the MongoDB Controllers for Kubernetes uses to deploy MongoDB multi-Kubernetes custom resources on nodes in multiple Kubernetes clusters.
1212

1313
.. contents:: On this page
1414
:local:
@@ -33,7 +33,7 @@ tools, and their documentation:
3333
clusters. Each |k8s| member cluster hosts a MongoDB replica set deployment
3434
and represents a data center that serves your application.
3535

36-
- :github:`MongoDB Enterprise Kubernetes Operator repository
36+
- :github:`MongoDB Controllers for Kubernetes repository
3737
</mongodb/mongodb-enterprise-kubernetes>` with configuration files that
3838
the |k8s-op-short| needs to deploy a |k8s| cluster.
3939

‎source/reference-architectures/deploy-operator.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _reference-architectures-deploy-operator:
22

33
=======================================
4-
Deploy the MongoDB Enterprise Operator
4+
Deploy the |k8s-op-short|
55
=======================================
66

77
.. default-domain:: mongodb

‎source/reference-architectures/how-to-use.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ How to Execute
3232
Each section of the reference architecture contains complete and working code
3333
snippets. If you would like to clone the source code to your local machine
3434
rather than copying and pasting from the guides directly, you can find
35-
it in the `MongoDB Enterprise Operator repository <https://github.com/mongodb/mongodb-enterprise-kubernetes>`__.
35+
it in the `MongoDB Controllers for Kubernetes repository <https://github.com/mongodb/mongodb-enterprise-kubernetes>`__.
3636

3737
.. code-block:: bash
3838

0 commit comments

Comments
 (0)