Skip to content

Commit 52efa06

Browse files
copy review
1 parent 320b9aa commit 52efa06

File tree

4 files changed

+28
-17
lines changed

4 files changed

+28
-17
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you are a MongoDB Enterprise customer, or need Enterprise features such as Ba
1515

1616
## Documentation
1717

18-
See the [`/docs`](/docs) directory to view documentation on how to:
18+
See the [documentation](/docs) to learn how to:
1919

2020
1. [Install or upgrade](/docs/install-upgrade.md) the Operator.
2121
1. [Deploy and configure](/docs/deploy-configure.md) MongoDB resources.
@@ -26,15 +26,15 @@ See the [`/docs`](/docs) directory to view documentation on how to:
2626

2727
The MongoDB Community Kubernetes Operator supports the following features:
2828

29-
- MongoDB Topology: [replica sets](https://docs.mongodb.com/manual/replication/)
30-
- Upgrading and downgrading MongoDB server version
31-
- Scaling replica sets up and down
32-
- Reading from and writing to the replica set while scaling, upgrading, and downgrading. These operations are done in an "always up" manner.
33-
- Reporting of MongoDB server state via the [MongoDB resource](/deploy/crds/mongodb.com_mongodb_crd.yaml) `status` field
34-
- Use of any of the available [Docker MongoDB images](https://hub.docker.com/_/mongo/)
35-
- Clients inside the Kubernetes cluster can connect to the replica set (no external connectivity)
36-
- TLS support for client-to-server and server-to-server communication
37-
- Creating users with SCRAM-SHA authentication
29+
- Create [replica sets](https://docs.mongodb.com/manual/replication/)
30+
- Upgrade and downgrade MongoDB server version
31+
- Scale replica sets up and down
32+
- Read from and write to the replica set while scaling, upgrading, and downgrading. These operations are done in an "always up" manner.
33+
- Report MongoDB server state via the [MongoDB resource](/deploy/crds/mongodb.com_mongodb_crd.yaml) `status` field
34+
- Use any of the available [Docker MongoDB images](https://hub.docker.com/_/mongo/)
35+
- Connect to the replica set from inside the Kubernetes cluster (no external connectivity)
36+
- Secure client-to-server and server-to-server connections with TLS
37+
- Create users with [SCRAM](https://docs.mongodb.com/manual/core/security-scram/) authentication
3838

3939
### Planned Features
4040
- Server internal authentication via keyfile
@@ -43,8 +43,8 @@ The MongoDB Community Kubernetes Operator supports the following features:
4343

4444
Before you contribute to the MongoDB Community Kubernetes Operator, please read:
4545

46-
- [MongoDB Community Kubernetes Operator Architecture](docs/architecture.md)
47-
- [Contributing to MongoDB Community Kubernetes Operator](docs/contributing.md)
46+
- [MongoDB Community Kubernetes Operator Architecture](/docs/architecture.md)
47+
- [Contributing to MongoDB Community Kubernetes Operator](/docs/contributing.md)
4848

4949
Please file issues before filing PRs. For PRs to be accepted, contributors must sign our [CLA](https://www.mongodb.com/legal/contributor-agreement).
5050

docs/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# MongoDB Community Kubernetes Operator Documentation #
2+
3+
# Table of Contents
4+
5+
- [Contribute to the MongoDB Kubernetes Operator](/docs/contributing.md)
6+
- [MongoDB Community Kubernetes Operator Architecture](/docs/architecutre.md)
7+
- [Install and Upgrade the Community Kubernetes Operator](/docs/install-upgrade.md)
8+
- [Deploy and Configure MongoDB Resources](/docs/deploy-configure.md)
9+
- [Create Database Users](/docs/users.md)
10+
- [Secure MongoDB Resources](/docs/secure.md)

docs/secure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Table of Contents
44

55
- [Secure MongoDB Resource Connections using TLS](#secure-mongodb-resource-connections-using-tls)
6-
- [Prerequisites](#prerequisites-1)
7-
- [Procedure](#procedure-1)
6+
- [Prerequisites](#prerequisites)
7+
- [Procedure](#procedure)
88

99
## Secure MongoDB Resource Connections using TLS
1010

docs/users.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Create a Database User #
22

3-
You can create a MongoDB database user to authenticate to your MongoDB resource using SCRAM. First, [create a Kubernetes secret](#create-a-user-secret) for the new user's password. Then, [modify and apply the MongoDB CRD](#modify-the-mongodb-crd).
3+
You can create a MongoDB database user to authenticate to your MongoDB resource using [SCRAM](https://docs.mongodb.com/manual/core/security-scram/). First, [create a Kubernetes secret](#create-a-user-secret) for the new user's password. Then, [modify and apply the MongoDB CRD](#modify-the-mongodb-crd).
44

55
You cannot disable SCRAM authentication.
66

@@ -19,7 +19,8 @@ You cannot disable SCRAM authentication.
1919
password: <my-plain-text-password> # corresponds to spec.users.passwordSecretRef.key in the MongoDB CRD
2020
...
2121
```
22-
1. Update `metadata.name` with the name of the secret and `stringData.password` with the user's password.
22+
1. Update the value of `metadata.name` with any name for this secret.
23+
1. Update the value of `stringData.password` with the user's password.
2324
1. Save the secret with a `.yaml` file extension.
2425
1. Apply the secret in Kubernetes:
2526
```
@@ -72,7 +73,7 @@ You cannot disable SCRAM authentication.
7273
```
7374
kubectl apply -f <mongodb-crd>.yaml --namespace <my-namespace>
7475
```
75-
1. Once the MongoDB resource is running, securely store the user's password and then delete the user secret:
76+
1. After the MongoDB resource is running, securely store the user's password and then delete the user secret:
7677
```
7778
kubectl delete secret <db-user-secret> --namespace <my-namespace>
7879
```

0 commit comments

Comments
 (0)