Improve documentation for Eventing/Sync Gateway interactions

Description

We should improve the documentation for utilising Eventing with Sync Gateway. At present, there is not much information present regarding this use case and the best practices/pit falls/known issues or limitations of such a deployment.

One example of this is that there is no documentation regarding not being able to deploy a source mutating eventing function against a bucket that has Sync Gateway acting upon it. This makes sense since it would cause an infinitely recursive function, however knowing this relies on having detailed product knowledge and is not necessarily intuitive to the end user. Unfortunately, this is not documented anywhere and so if a user tries to do this they will see an error message on the UI, but then no reference as to why this was seen.

Environment

None

Release Notes Description

None

Activity

Show:

Ian Bridge February 15, 2021 at 3:40 PM

Remove labels

Ian Bridge January 28, 2021 at 4:43 PM

Jon Strabala May 8, 2020 at 4:48 PM

 please refer to the follwoing:

It has a discussion and small example of using crc64() to work around the duplicate mutation issue.

Hopefully as per my comment in https://couchbasecloud.atlassian.net/browse/MB-37374#icft=MB-37374 for CC both the SG and the Transactions issues in CC might be fixed

Priya Rajagopal May 7, 2020 at 8:48 PM

 Do you have docs covering this issue on the eventing side that sync gateway can reference ? Based on comments above, probably not.  Can you put together a paragraph describing the issue that we can include in sync gateway docs page? (probably need to cross-reference from both docs  )

Won't Fix
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Labels

Story Points

Fix versions

Priority

Instabug

Open Instabug

PagerDuty

Sentry

Zendesk Support

Created May 7, 2020 at 2:06 PM
Updated September 19, 2023 at 6:50 PM
Resolved September 19, 2023 at 6:50 PM
Instabug

Flag notifications