Skip to content
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.

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

(DOCSP-33859): Edge Server: Add required networking details #623

Merged
merged 2 commits into from
Nov 7, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Nov 2, 2023

Pull Request Info

Jira

Staged Changes

Reminder Checklist

You might need to also update some corresponding pages. Check if completed or N/A.

  • Create Jira ticket for corresponding docs-realm update(s), if any
  • Checked/updated Admin API
  • Checked/updated CLI reference

Review Guidelines

REVIEWING.md

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

Nice work, Dachary! No blocking comments, but I do have some questions and suggestions.

@@ -113,8 +113,19 @@ server, or hardware that you provision on-site.
Required Network Access
~~~~~~~~~~~~~~~~~~~~~~~

The host that runs the Edge Server must allow access to port 80 via HTTP
to the general internet.
To accept connections from sync clients or connections via the wireprotocol,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Generally good to avoid Latin words and phrases.

Suggested change
To accept connections from sync clients or connections via the wireprotocol,
To accept connections from sync clients or connections using the wireprotocol,

Comment on lines 119 to 121
While Edge Server is in Preview, you can stand up a demo using EC2 or another
cloud provider by opening port 80 via HTTP to the general internet.
In production, we recommend opening port 443 with SSL.
Copy link
Collaborator

Choose a reason for hiding this comment

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

There's an implicit suggestion that Preview === dev environment. Do we know if this is true? Beyond that, is using HTTP in a dev environment going away after Edge Server moves out of Preview? If not, we may want to refer to "using Edge Server in a development environment" instead of "While Edge Server is in Preview". Also, maybe we should address the "general internet vs owned infrastructure" a bit earlier?

Here's something to show what I'm getting at:

Suggested change
While Edge Server is in Preview, you can stand up a demo using EC2 or another
cloud provider by opening port 80 via HTTP to the general internet.
In production, we recommend opening port 443 with SSL.
If you need to open Edge Server to the genera internet, you should open different ports with different methods appropriate for your environment.
- Development. Use port 80 and HTTP.
- Production. Use port 443 and SSL.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good call - reworded and reorganized this section a little.

devices can access it.

Edge Server supports TLS. You can find configuration details in the
"Complete the Edge Server Configuration Details" section.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are using the "see on this page" construction? Or was that only if we're including links to other sections on the same page?

@dacharyc dacharyc merged commit 4792bf4 into mongodb:master Nov 7, 2023
4 checks passed
@dacharyc dacharyc deleted the DOCSP-33859 branch November 7, 2023 22:01
@docs-builder-bot
Copy link

MongoCaleb pushed a commit to MongoCaleb/docs-app-services that referenced this pull request Jun 3, 2024
)

* Add required networking details

* Incorporate review feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants