Skip to content

Commit

Permalink
Edge Server: Public Preview (mongodb#727)
Browse files Browse the repository at this point in the history
* Edge Server: Add findAndModify command (mongodb#726)

* Add findAndModify command

* Apply review suggestion

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* (DOCSP-38851): Add a Manage Edge Servers page (mongodb#728)

* Draft Manage Edge Servers page

* Grammatical and other minor fixes

* Add info about Edge Server using Device Sync

* Formatting fixes

* Refactor enable Device Sync callout to include

* Add info about updating a data model

* Remove placeholders on Configure page in favor of other PR

* Remove 'Register' details as this occurs during configuration

* Add details about supported authentication providers

* Incorporate tech review feedback

* Clarify Edge Server service, instance language, grammar and typo fixes

* Fix wireprotocol to Wire Protocol

* Incorporate review feedback

* Change 'MongoDB URI' reference to 'Driver'

* Clarify details about _id field type

* (DOCSP-38550): Update Edge Server landing page for Public Preview (mongodb#739)

* Update Edge Server landing page for public preview

* Add meta description

* Apply suggestions from review

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Add info about the template app to the CTA

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* (DOCSP-38852): Update the 'Configure' page for Public Preview (mongodb#733)

* Update the 'Configure' page for Public Preview

* Clarify and add details, improve table styling in procedure

* More details and table formatting fixes

* Incorporate review feedback

* Add table widths to fix formatting

* Incorporate more review feedback

* Incorporate tech review feedback

* Apply tech review feedback

* Clarify linked data source

* Simplify collection/schema in the example copy

* (DOCSP-38553): Update the 'Connect' page for Public Preview (mongodb#735)

* Update the 'Connect' page for Public Preview

* Product naming and grammar fixes

* Update server/instance/service language per discussion

* Incorporate review feedback

* Incorporate tech review feedback and test connecting

* Remove the 'Supported Auth Providers' section

* Apply review suggestions

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Incorporate review feedback

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Note that num_local_clients does not include Wire Protocol connections

* (DOCSP-38875): Edge Server Permissions Guide (mongodb#745)

* Draft Edge Server permissions page

* Reverse the order of client permissions to match example image

* Rename section and update refs to match

* Wording clarifications

* Apply suggestions from review

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Move explanations above examples

* Apply tech review feedback

* Fix snippet highlighting range

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* (DOCSP-38560): Edge Server Admin API Endpoint Documentation (mongodb#741)

* Initial draft of new Edge endpoints

* Remove endpoints to try to get docs to build

* Fix nesting maybe

* Add type for Get response schema

* Add examples

* Add info about user_id, status enum options

* Add examples for combined schema

* Remove inline examples

* Add Edge Server tag

* Change 'examples' to 'example'

* Move examples to schema definition

* Add examples back to inline base definition

* Move base example to schema level instead of inline

* Remove base object and move definitions into separate objects

* Minor tweaks to descriptions and required fields

* Updates based on API code

* Incorporate review feedback

* Note that 'hostname' is not currently populated

* Update HTTP responses for newly-tested endpoints

* Wrap date times in quotes

* Add metrics details

* Fix build error

* Remove 'placeholder' boilerplate

* Update example query to a more general, representative example

* Update the correct query example

* (DOCSP-38554): Add a Monitor Edge Server page (mongodb#748)

* WIP draft monitor page

* Populate log details

* Adjust table spacing

* Adjust table spacing

* Adjust table spacing

* Adjust table spacing

* Adjust table spacing

* Apply suggestions from review

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Add BOOTSTRAPPING to the status options

* Move table contents over by one space to fix formatting issue

* Change widths to adjust spacing

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* (DOCSP-39016): Update `edgectl` details for `init`, `query` and `profile` (mongodb#747)

* Update edgectl details for release

* Fix unexpected intent error

* Update the cycle registration token flag

* Apply review feedback

* (DOCSP-38863): Address TODOs and placeholders to prepare Feature Branch for merging (mongodb#749)

* Populate Admin API details in procedures on the Manage page

* Populate placeholder refs to Metrics and Logs on Manage page

* Fix title underline length issues on Permissions page

* Populate Admin API endpoint placeholder on Permissions page

* Populate Admin API placeholders on Monitor page

* Add info about adding Edge Servers to a Device Sync App

* Add detail about stopping and starting an instance to add a new collection

* Apply suggestions from review

Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>

---------

Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>

* Apply suggestions from review

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

* Be more explicit in edgectl bool flags and remove unneeded flag

* Fix missing Admin API placeholders

* Add boostrapping state for Edge Server status in the UI

* Capitalize Wire Protocol

* Replace generic Data Services procedure with specific procedure

---------

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>
  • Loading branch information
3 people authored and MongoCaleb committed Jun 3, 2024
1 parent b0d59af commit b6e9921
Show file tree
Hide file tree
Showing 20 changed files with 2,682 additions and 410 deletions.
1 change: 1 addition & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ intersphinx = [
"https://www.mongodb.com/docs/manual/objects.inv",
"https://www.mongodb.com/docs/atlas/objects.inv",
"https://www.mongodb.com/docs/realm/objects.inv",
"https://www.mongodb.com/docs/compass/current/objects.inv"
]

# These are the pages that open when you click on them (instead of just being containers)
Expand Down
48 changes: 27 additions & 21 deletions source/edge-server.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,19 @@
Atlas Edge Server
=================

.. meta::
:description: Atlas Edge Server provides an on-premises MongoDB that syncs seamlessly between local devices and Atlas.

.. toctree::
:titlesonly:
:hidden:

Manage Edge Servers </edge-server/manage-edge-servers>
Configure Edge Server </edge-server/configure>
Connect to Edge Server </edge-server/connect>
Use MongoDB APIs with Edge Server </edge-server/mongodb>
Permissions Guide </edge-server/permissions>
Monitor Edge Server </edge-server/monitor>

.. introduction::

Expand All @@ -26,9 +32,9 @@ Atlas Edge Server
Edge Server runs on-premises and handles sync between local devices,
and bi-directional sync between the Edge Server and Atlas.

Edge Server is currently in Private Preview. Learn more about previewing
the
`Atlas Device Sync Edge Server <https://www.mongodb.com/products/platform/atlas-edge-server>`__.
.. TODO: Add this CTA text with a blog link once marketing provides the link.
Edge Server is now in Public Preview. Read our blog to learn about what's
new. [INSERT LINK HERE WHEN IT IS PUBLISHED]

.. image:: /images/plp/Technical_SOFTWARE_DataSync_Spot.png
:alt: Atlas Data Sync Illustration
Expand All @@ -48,10 +54,9 @@ Key Features
:icon: /images/icons/General_CLOUD_Transfer10x.png
:icon-alt: An icon depicting a cloud with a two-way transfer icon

Edge server is a local instance of MongoDB paired with a Device Sync
server that runs on-premises. It brings real-time sync, disconnection
tolerance, and conflict resolution to the location's devices. It
seamlessly syncs with Atlas when it has a network connection.
Edge Server is a local instance of MongoDB paired with a Device Sync
server that runs on-premises. It seamlessly syncs with Atlas when it has
a network connection.

.. card::
:headline: Optimize Bandwidth
Expand Down Expand Up @@ -79,28 +84,28 @@ Edge Server Setup

.. procedure::

.. step:: Create a Device Sync-Enabled App
.. step:: Create an Edge Server Service

Create an :ref:`App Services App <create-app>` with
:ref:`Device Sync enabled <enable-sync>`. To get started quickly,
:ref:`create a template app <create-template-app>`.
You can use Edge Server with MongoDB Drivers and tools in an Edge
Server Service. Or you can use Edge Server with Atlas Device SDK to
develop Sync-enabled mobile and edge applications, and get the
benefits of conflict resolution and roaming between servers.

Once your App is created, coordinate with your Product or Account
Representative to enable Edge Server.
To get started quickly using an Atlas Device SDK mobile app,
:ref:`create a template app <create-template-app>`. This creates a
a Device Sync-enabled App with a downloadable client that you can
use to connect to an Edge Server.

.. step:: Install and Configure the Edge Server

Configure hardware on-site or a cloud server to host your Edge Server.
Install the Edge Server on your hardware, complete a basic
``config.json`` with your configuration details, and install required
dependencies.

Add an authorization provider, and start the Edge Server.
Use our command line tool ``edgectl`` to install and configure an
Edge Server instance on your hardware.

.. step:: Connect to the Edge Server from a Client

Configure your client to connect to the Edge Server instead of directly
to your Atlas App. Local clients can sync data through the Edge Server
Connect to an Edge Server with a MongoDB Driver or an Atlas Device SDK
client. Local clients can sync data through the Edge Server
even without network connectivity. When the Edge Server connects
with Atlas, it syncs data from the local clients.

Expand Down Expand Up @@ -129,7 +134,8 @@ Secure, Powerful, Fast

Edge Server uses the Device Sync engine to handle conflicts. You don't
have to write complex custom code to resolve conflicting writes from
multiple clients.
multiple Edge Servers. When you pair Edge Server with Atlas Device SDK,
you get conflict resolution on the clients, too.

.. card::
:headline: Reduce Latency
Expand Down
Loading

0 comments on commit b6e9921

Please sign in to comment.