Skip to content

Update and clarify documentation #1703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update and clarify documentation #1703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/deploy-configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ To deploy your first replica set:

**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>

You can use the connection strings in this secret in your application:
To connect your application you can reference the connection string directly from the secret:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To connect your application you can reference the connection string directly from the secret:
5. To connect your application you can reference the connection string directly from the secret:


```yaml
containers:
Expand All @@ -84,7 +84,7 @@ To deploy your first replica set:
name: <metadata.name>-<auth-db>-<username>
key: connectionString.standardSrv

5. Connect to one of your application's pods in the Kubernetes cluster:
6. Connect to one of your application's pods in the Kubernetes cluster:

**NOTE**: You can access your replica set only from a pod in the same Kubernetes cluster. You can't access your replica set from outside of the Kubernetes cluster.

Expand All @@ -98,7 +98,7 @@ To deploy your first replica set:
user@app:~$
```

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:
7. 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:

```
mongosh "mongodb+srv://<username>:<password>@example-mongodb-svc.mongodb.svc.cluster.local/admin?ssl=true"
Expand Down Expand Up @@ -392,4 +392,4 @@ For ex:
env:
- name: CLUSTER_DOMAIN
value: $CUSTOM_DOMAIN
```
```