Skip to content

Commit fa3997a

Browse files
DOCSP-20364: update docs URLs based on new locations (mongodb#937)
1 parent 0e7e3c7 commit fa3997a

8 files changed

+28
-28
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,21 @@ See the [documentation](/docs) to learn how to:
2929
1. [Create a database user](/docs/users.md) with SCRAM authentication.
3030
1. [Secure MongoDB resource connections](/docs/secure.md) using TLS.
3131

32-
*NOTE: [MongoDB Enterprise Kubernetes Operator](https://docs.mongodb.com/kubernetes-operator/master/) docs are for the enterprise operator use case and NOT for the community operator. In addition to the docs mentioned above, you can refer to this [blog post](https://www.mongodb.com/blog/post/run-secure-containerized-mongodb-deployments-using-the-mongo-db-community-kubernetes-oper) as well to learn more about community operator deployment*
32+
*NOTE: [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/master/) docs are for the enterprise operator use case and NOT for the community operator. In addition to the docs mentioned above, you can refer to this [blog post](https://www.mongodb.com/blog/post/run-secure-containerized-mongodb-deployments-using-the-mongo-db-community-kubernetes-oper) as well to learn more about community operator deployment*
3333

3434
## Supported Features
3535

3636
The MongoDB Community Kubernetes Operator supports the following features:
3737

38-
- Create [replica sets](https://docs.mongodb.com/manual/replication/)
38+
- Create [replica sets](https://www.mongodb.com/docs/manual/replication/)
3939
- Upgrade and downgrade MongoDB server version
4040
- Scale replica sets up and down
4141
- Read from and write to the replica set while scaling, upgrading, and downgrading. These operations are done in an "always up" manner.
4242
- Report MongoDB server state via the [MongoDBCommunity resource](/config/crd/bases/mongodbcommunity.mongodb.com_mongodbcommunity.yaml) `status` field
4343
- Use any of the available [Docker MongoDB images](https://hub.docker.com/_/mongo/)
4444
- Connect to the replica set from inside the Kubernetes cluster (no external connectivity)
4545
- Secure client-to-server and server-to-server connections with TLS
46-
- Create users with [SCRAM](https://docs.mongodb.com/manual/core/security-scram/) authentication
46+
- Create users with [SCRAM](https://www.mongodb.com/docs/manual/core/security-scram/) authentication
4747
- Create custom roles
4848
- Enable a [metrics target that can be used with Prometheus](docs/prometheus/README.md)
4949

SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Reporting a Vulnerability
44

55
Any security concerns or vulnerabilities discovered in one of MongoDB’s products or hosted services
6-
can be responsibly disclosed by utilizing one of the methods described in our [create a vulnerability report](https://docs.mongodb.com/manual/tutorial/create-a-vulnerability-report/) docs page.
6+
can be responsibly disclosed by utilizing one of the methods described in our [create a vulnerability report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/) docs page.
77

88
While we greatly appreciate community reports regarding security issues, at this time MongoDB does not provide compensation for vulnerability reports.

api/v1/mongodbcommunity_types.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ type MongoDBCommunitySpec struct {
6868

6969
// Arbiters is the number of arbiters to add to the Replica Set.
7070
// It is not recommended to have more than one arbiter per Replica Set.
71-
// More info: https://docs.mongodb.com/manual/tutorial/add-replica-set-arbiter/
71+
// More info: https://www.mongodb.com/docs/manual/tutorial/add-replica-set-arbiter/
7272
// +optional
7373
Arbiters int `json:"arbiters"`
7474

@@ -99,7 +99,7 @@ type MongoDBCommunitySpec struct {
9999

100100
// AdditionalMongodConfig is additional configuration that can be passed to
101101
// each data-bearing mongod at runtime. Uses the same structure as the mongod
102-
// configuration file: https://docs.mongodb.com/manual/reference/configuration-options/
102+
// configuration file: https://www.mongodb.com/docs/manual/reference/configuration-options/
103103
// +kubebuilder:validation:Type=object
104104
// +optional
105105
// +kubebuilder:pruning:PreserveUnknownFields
@@ -227,7 +227,7 @@ type Privilege struct {
227227
}
228228

229229
// Resource specifies specifies the resources upon which a privilege permits actions.
230-
// See https://docs.mongodb.com/manual/reference/resource-document for more.
230+
// See https://www.mongodb.com/docs/manual/reference/resource-document for more.
231231
type Resource struct {
232232
// +optional
233233
DB *string `json:"db,omitempty"`

config/crd/bases/mongodbcommunity.mongodb.com_mongodbcommunity.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ spec:
5656
additionalMongodConfig:
5757
description: 'AdditionalMongodConfig is additional configuration that
5858
can be passed to each data-bearing mongod at runtime. Uses the same
59-
structure as the mongod configuration file: https://docs.mongodb.com/manual/reference/configuration-options/'
59+
structure as the mongod configuration file: https://www.mongodb.com/docs/manual/reference/configuration-options/'
6060
nullable: true
6161
type: object
6262
x-kubernetes-preserve-unknown-fields: true
6363
arbiters:
6464
description: 'Arbiters is the number of arbiters to add to the Replica
6565
Set. It is not recommended to have more than one arbiter per Replica
66-
Set. More info: https://docs.mongodb.com/manual/tutorial/add-replica-set-arbiter/'
66+
Set. More info: https://www.mongodb.com/docs/manual/tutorial/add-replica-set-arbiter/'
6767
type: integer
6868
automationConfig:
6969
description: AutomationConfigOverride is merged on top of the operator
@@ -218,7 +218,7 @@ spec:
218218
type: array
219219
resource:
220220
description: Resource specifies specifies the resources
221-
upon which a privilege permits actions. See https://docs.mongodb.com/manual/reference/resource-document
221+
upon which a privilege permits actions. See https://www.mongodb.com/docs/manual/reference/resource-document
222222
for more.
223223
properties:
224224
anyResource:

docs/architecture.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ The MongoDB Community Kubernetes Operator is a [Custom Resource Definition](http
1212

1313
You create and update MongoDBCommunity resources by defining a MongoDBCommunity resource definition. When you apply the MongoDBCommunity resource definition to your Kubernetes environment, the Operator:
1414

15-
1. Creates a [StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) that contains one [pod](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/) for each [replica set](https://docs.mongodb.com/manual/replication/) member.
15+
1. Creates a [StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) that contains one [pod](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/) for each [replica set](https://www.mongodb.com/docs/manual/replication/) member.
1616
1. Writes the Automation configuration as a [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) and mounts it to each pod.
1717
1. Creates one [init container](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) and two [containers](https://kubernetes.io/docs/concepts/containers/overview/) in each pod:
1818

1919
- An init container which copies the `cmd/versionhook` binary to the main `mongod` container. This is run before `mongod` starts to handle [version upgrades](#example-mongodb-version-upgrade).
2020

21-
- A container for the [`mongod`](https://docs.mongodb.com/manual/reference/program/mongod/index.html) process binary. `mongod` is the primary daemon process for the MongoDB system. It handles data requests, manages data access, and performs background management operations.
21+
- A container for the [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod/index.html) process binary. `mongod` is the primary daemon process for the MongoDB system. It handles data requests, manages data access, and performs background management operations.
2222

2323
- A container for the MongoDB Agent. The Automation function of the MongoDB Agent handles configuring, stopping, and restarting the `mongod` process. The MongoDB Agent periodically polls the `mongod` to determine status and can deploy changes as needed.
2424

@@ -59,7 +59,7 @@ When you update the MongoDB version in your resource definition and reapply it t
5959

6060
1. The Operator updates the [image](https://kubernetes.io/docs/concepts/containers/images/) specification to the new version of MongoDB and writes a new Automation configuration ConfigMap to each pod.
6161

62-
1. The MongoDB Agent chooses the first pod to upgrade and stops the `mongod` process using a local connection and [`db.shutdownServer`](https://docs.mongodb.com/manual/reference/method/db.shutdownServer/#db.shutdownServer).
62+
1. The MongoDB Agent chooses the first pod to upgrade and stops the `mongod` process using a local connection and [`db.shutdownServer`](https://www.mongodb.com/docs/manual/reference/method/db.shutdownServer/#db.shutdownServer).
6363

6464
1. Kubernetes will restart the `mongod` container causing the version change hook to run and check the state of the MongoDB Agent. If the MongoDB Agent expects the `mongod` process to start with a new version, the hook uses a Kubernetes API call to delete the pod.
6565

docs/deploy-configure.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To deploy your first replica set:
3333
| Variable | Description | Value in Sample |
3434
|----|----|----|
3535
| `<metadata.name>` | Name of the MongoDB database resource. | `example-mongodb` |
36-
| `<auth-db>` | [Authentication database](https://docs.mongodb.com/manual/core/security-users/#std-label-user-authentication-database) where you defined the database user. | `admin` |
36+
| `<auth-db>` | [Authentication database](https://www.mongodb.com/docs/manual/core/security-users/#std-label-user-authentication-database) where you defined the database user. | `admin` |
3737
| `<username>` | Username of the database user. | `my-user` |
3838

3939
Update the variables in the following command, then run it to retrieve a user's connection strings to the replica set from the secret:
@@ -45,7 +45,7 @@ To deploy your first replica set:
4545
-o json | jq -r '.data | with_entries(.value |= @base64d)'
4646
```
4747

48-
The command returns the replica set's standard and DNS seed list [connection strings](https://docs.mongodb.com/manual/reference/connection-string/#connection-string-formats) in addition to the user's name and password:
48+
The command returns the replica set's standard and DNS seed list [connection strings](https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-formats) in addition to the user's name and password:
4949

5050
```json
5151
{
@@ -56,7 +56,7 @@ To deploy your first replica set:
5656
}
5757
```
5858

59-
**NOTE**: The Community Kubernetes Operator sets the [`ssl` connection option](https://docs.mongodb.com/manual/reference/connection-string/#connection-options) to `true` if you [Secure MongoDBCommunity Resource Connections using TLS](secure.md#secure-mongodbcommunity-resource-connections-using-tls).</br></br>
59+
**NOTE**: The Community Kubernetes Operator sets the [`ssl` connection option](https://www.mongodb.com/docs/manual/reference/connection-string/#connection-options) to `true` if you [Secure MongoDBCommunity Resource Connections using TLS](secure.md#secure-mongodbcommunity-resource-connections-using-tls).</br></br>
6060

6161
You can use the connection strings in this secret in your application:
6262

@@ -84,7 +84,7 @@ To deploy your first replica set:
8484
user@app:~$
8585
```
8686
87-
6. Use one of the connection strings returned in step 4 to connect to the replica set. The following example uses [`mongosh`](https://docs.mongodb.com/mongodb-shell/) to connect to a replica set:
87+
6. Use one of the connection strings returned in step 4 to connect to the replica set. The following example uses [`mongosh`](https://www.mongodb.com/docs/mongodb-shell/) to connect to a replica set:
8888
8989
```
9090
mongosh "mongodb+srv://<username>:<password>@example-mongodb-svc.mongodb.svc.cluster.local/admin?ssl=true"
@@ -136,7 +136,7 @@ To scale a replica set:
136136

137137
## Add Arbiters to a Replica Set
138138

139-
To add [arbiters](https://docs.mongodb.com/manual/core/replica-set-arbiter/) to your replica set, add the `spec.arbiters` field to your MongoDBCommunity resource definition.
139+
To add [arbiters](https://www.mongodb.com/docs/manual/core/replica-set-arbiter/) to your replica set, add the `spec.arbiters` field to your MongoDBCommunity resource definition.
140140

141141
The value of the `spec.arbiters` field must be:
142142

@@ -201,9 +201,9 @@ You can upgrade the major, minor, and/or feature compatibility versions of your
201201

202202
- To upgrade your resource's major and/or minor versions, set the `spec.version` setting to the desired MongoDB version. Make sure to specify a full image tag, such as `5.0.3`. Setting the `spec.version` to loosely-defined tags such as `5.0` is not currently supported.
203203

204-
- To modify your resource's [feature compatibility version](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion/), set the `spec.featureCompatibilityVersion` setting to the desired version.
204+
- To modify your resource's [feature compatibility version](https://www.mongodb.com/docs/manual/reference/command/setFeatureCompatibilityVersion/), set the `spec.featureCompatibilityVersion` setting to the desired version.
205205

206-
If you update `spec.version` to a later version, consider setting `spec.featureCompatibilityVersion` to the current working MongoDB version to give yourself the option to downgrade if necessary. To learn more about feature compatibility, see [`setFeatureCompatibilityVersion`](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion/) in the MongoDB Manual.
206+
If you update `spec.version` to a later version, consider setting `spec.featureCompatibilityVersion` to the current working MongoDB version to give yourself the option to downgrade if necessary. To learn more about feature compatibility, see [`setFeatureCompatibilityVersion`](https://www.mongodb.com/docs/manual/reference/command/setFeatureCompatibilityVersion/) in the MongoDB Manual.
207207

208208
### Example
209209

@@ -239,7 +239,7 @@ To upgrade this resource from `4.0.6` to `4.2.7`:
239239
featureCompatibilityVersion: "4.0"
240240
```
241241

242-
**NOTE:** Setting `featureCompatibilityVersion` to `4.0` disables [4.2 features incompatible with MongoDB 4.0](https://docs.mongodb.com/manual/release-notes/4.2-compatibility/#compatibility-enabled).
242+
**NOTE:** Setting `featureCompatibilityVersion` to `4.0` disables [4.2 features incompatible with MongoDB 4.0](https://www.mongodb.com/docs/manual/release-notes/4.2-compatibility/#compatibility-enabled).
243243

244244
2. Reapply the configuration to Kubernetes:
245245
```
@@ -258,7 +258,7 @@ See [here](../deploy/openshift/operator_openshift.yaml) for an example of how to
258258

259259
## Define a Custom Database Role
260260

261-
You can define [custom roles](https://docs.mongodb.com/manual/core/security-user-defined-roles/) to give you fine-grained access control over your MongoDB database resource.
261+
You can define [custom roles](https://www.mongodb.com/docs/manual/core/security-user-defined-roles/) to give you fine-grained access control over your MongoDB database resource.
262262

263263
**NOTE**: Custom roles are scoped to a single MongoDB database resource.
264264

@@ -269,14 +269,14 @@ To define a custom role:
269269
| Key | Type | Description | Required? |
270270
|----|----|----|----|
271271
| `spec.security.authentication.ignoreUnknownUsers` | boolean | Flag that indicates whether you can add users that don't exist in the `MongoDBCommunity` resource. If omitted, defaults to `true`. | No |
272-
| `spec.security.roles` | array | Array that defines [custom roles](https://docs.mongodb.com/manual/core/security-user-defined-roles/) roles that give you fine-grained access control over your MongoDB deployment. | Yes |
272+
| `spec.security.roles` | array | Array that defines [custom roles](https://www.mongodb.com/docs/manual/core/security-user-defined-roles/) roles that give you fine-grained access control over your MongoDB deployment. | Yes |
273273
| `spec.security.roles.role` | string | Name of the custom role. | Yes |
274274
| `spec.security.roles.db` | string | Database in which you want to store the user-defined role. | Yes |
275275
| `spec.security.roles.authenticationRestrictions` | array | Array that defines the IP address from which and to which users assigned this role can connect. | No |
276276
| `spec.security.roles.authenticationRestrictions.clientSource` | array | Array of IP addresses or CIDR blocks from which users assigned this role can connect. <br><br> MongoDB servers reject connection requests from users with this role if the requests come from a client that is not present in this array. | No |
277277
| `spec.security.roles.authenticationRestrictions.serverAddress` | array | Array of IP addresses or CIDR blocks to which users assigned this role can connect. <br><br> MongoDB servers reject connection requests from users with this role if the client requests to connect to a server that is not present in this array. | No |
278-
| `spec.security.roles.privileges` | array | List of actions that users granted this role can perform. For a list of accepted values, see [Privilege Actions](https://docs.mongodb.com/manual/reference/privilege-actions/#database-management-actions) in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator. | Yes |
279-
| `spec.security.roles.privileges.actions` | array | Name of the role. Valid values are [built-in roles](https://docs.mongodb.com/manual/reference/built-in-roles/#built-in-roles). | Yes |
278+
| `spec.security.roles.privileges` | array | List of actions that users granted this role can perform. For a list of accepted values, see [Privilege Actions](https://www.mongodb.com/docs/manual/reference/privilege-actions/#database-management-actions) in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator. | Yes |
279+
| `spec.security.roles.privileges.actions` | array | Name of the role. Valid values are [built-in roles](https://www.mongodb.com/docs/manual/reference/built-in-roles/#built-in-roles). | Yes |
280280
| `spec.security.roles.privileges.resource.database`| string | Database for which the privilege `spec.security.roles.privileges.actions` apply. An empty string (`""`) indicates that the privilege actions apply to all databases. <br><br> If you provide a value for this setting, you must also provide a value for `spec.security.roles.privileges.resource.collection`. | Conditional |
281281
| `spec.security.roles.privileges.resource.collection`| string | Collection for which the privilege `spec.security.roles.privileges.actions` apply. An empty string (`""`) indicates that the privilege actions apply to all of the database's collections.<br><br> If you provide a value for this setting, you must also provide a value for `spec.security.roles.privileges.resource.database`. | Conditional |
282282
| `spec.security.roles.privileges.resource.cluster`| string | Flag that indicates that the privilege `spec.security.roles.privileges.actions` apply to all databases and collections in the MongoDB deployment. If omitted, defaults to `false`.<br><br> If set to `true`, do not provide values for `spec.security.roles.privileges.resource.database` and `spec.security.roles.privileges.resource.collection`. | Conditional |

docs/secure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To secure connections to MongoDBCommunity resources using TLS:
5454
1. Add the following fields to the MongoDBCommunity resource definition:
5555
5656
- `spec.security.tls.enabled`: Encrypts communications using TLS certificates between MongoDB hosts in a replica set and client applications and MongoDB deployments. Set to `true`.
57-
- `spec.security.tls.optional`: (**Optional**) Enables the members of the replica set to accept both TLS and non-TLS client connections. Equivalent to setting the MongoDB[`net.tls.mode`](https://docs.mongodb.com/manual/reference/configuration-options/#net.tls.mode) setting to `preferSSL`. If omitted, defaults to `false`.
57+
- `spec.security.tls.optional`: (**Optional**) Enables the members of the replica set to accept both TLS and non-TLS client connections. Equivalent to setting the MongoDB[`net.tls.mode`](https://www.mongodb.com/docs/manual/reference/configuration-options/#net.tls.mode) setting to `preferSSL`. If omitted, defaults to `false`.
5858
5959
---
6060
**NOTE**

0 commit comments

Comments
 (0)