From 26d15aab3bd694893c7c879471983a323eddfb26 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 01/11] DOC_9272-C3 -- B3 --Replace beta01 references https://issues.couchbase.com/browse/DOCS-9272 (cherry picked from commit 41858d71877dea66e8be3597a0e16d7477c288c9) --- antora.yml | 10 ++++--- .../pages/_partials/_attributes-local.adoc | 27 +++++++++++++---- .../_partials/compatibility-cbl-sgw.adoc | 2 +- modules/ROOT/pages/get-started-install.adoc | 30 +++++++++---------- 4 files changed, 43 insertions(+), 26 deletions(-) diff --git a/antora.yml b/antora.yml index b980e47f2..e7d3b4d20 100644 --- a/antora.yml +++ b/antora.yml @@ -1,16 +1,18 @@ name: sync-gateway title: Sync Gateway version: '3.0' -prerelease: BETA -display-version: '3.0 BETA01' +prerelease: beta +display-version: '3.0.0 (beta)' start_page: ROOT:index.adoc nav: - modules/ROOT/nav.adoc asciidoc: attributes: - prerelease: BETA - is-beta: + prerelease: beta + is-beta: true release: '3.0' major: 3 minor: 0 maintenance: 0 + base: 0 + releasetag: beta02 diff --git a/modules/ROOT/pages/_partials/_attributes-local.adoc b/modules/ROOT/pages/_partials/_attributes-local.adoc index 126bacd22..4d9483674 100644 --- a/modules/ROOT/pages/_partials/_attributes-local.adoc +++ b/modules/ROOT/pages/_partials/_attributes-local.adoc @@ -153,14 +153,29 @@ // ifndef::patch[:patch: 2] // ifndef::version[:version: {major}.{minor}] // Sever shared connection for these attributes -:major: 3 -:minor: 0 -:patch: 0 + +// BEGIN -- VERSION ATTRIBUTES +// Version component attributes now seeded from antora.yml +// optional releasetag used yo indicate prerelease versions mainly +:tag: {empty} +ifdef::releasetag[:tag: -{releasetag}] :version: {major}.{minor} -:version-full: {major}.{minor}.0 -:version-maint: {major}.{minor}.{patch} -:version-date: November 2021 +:version-full: {major}.{minor}.{base}{tag} +:version-full-untagged: {major}.{minor}.{base} +// Full version including maintenance release -- this is set in attributes-module as it will vary by module -- here at component level it is always same as version-full + +// begin maintenance versions +// patch is base/zero until first maintenance release and so version-maint/maintenance is same as version-full until first maintenance release +:patch: {base} +:version-maintenance: {version-full} +:version-maint: {version-full} +:version-date: October 2021 :version-maint-date: {version-date} +// end maintenance versions + +// END -- VERSION ATTRIBUTES + + // SYNC GATEWAY VERSIONING // Couchbase Components diff --git a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc index a19dcb640..7cea1f9b4 100644 --- a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc +++ b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc @@ -45,7 +45,7 @@ The table below summarizes the compatible versions of Couchbase Lite with Sync G |1.4{fn-eos-cbl} |1.3{fnref-eos-cbl} -| Release 3.0.0-beta01 +| Release {version-full} |✔ |✔ |✔ diff --git a/modules/ROOT/pages/get-started-install.adoc b/modules/ROOT/pages/get-started-install.adoc index 73f56dcdb..f4b8dbe85 100644 --- a/modules/ROOT/pages/get-started-install.adoc +++ b/modules/ROOT/pages/get-started-install.adoc @@ -16,7 +16,7 @@ include::partial$_std-hdr-sgw.adoc[] :is-prepare!: :is-install!: :is-verify!: -:this-release: 3.0.0 +// :this-release: 3.0.0 :downloads--url: {url-downloads}#couchbase-mobile[Couchbase downloads page] :sg_download_link: {url-package-downloads}/\{version-maint}/ @@ -44,7 +44,7 @@ For other command-line options -- see {command-line-options--xref} :modulename: couchbase-sync-gateway -:beta-url: https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/ +:beta-url: https://packages.couchbase.com/releases/couchbase-sync-gateway/{version-full}/ // END -- Page Attributes @@ -64,7 +64,7 @@ include::partial$_get-started-topic-group.adoc[] == Beta Release Only -{sgw-te} 3.0.0 BETA01 is available for all xref:supported-environments.adoc[supported operating systems] as a direct download only. +{sgw-te} 3.0.0 (beta)01 is available for all xref:supported-environments.adoc[supported operating systems] as a direct download only. You can obtain the downloads from the links here in <>. Unpack the download to an appropriate location and install from there. @@ -74,23 +74,23 @@ Unpack the download to an appropriate location and install from there. |=== ^| Enterprise Edition ^| Community Edition -a|* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_aarch64.rpm[couchbase-sync-gateway-enterprise_3.0.0-beta01_aarch64.rpm] -* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.deb[couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.deb] -* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.rpm[couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.rpm] +a|* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_aarch64.rpm[couchbase-sync-gateway-enterprise_{version-full}_aarch64.rpm] +* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_x86_64.deb[couchbase-sync-gateway-enterprise_{version-full}_x86_64.deb] +* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_x86_64.rpm[couchbase-sync-gateway-enterprise_{version-full}_x86_64.rpm] -* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.msi[couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.msi] +* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_x86_64.msi[couchbase-sync-gateway-enterprise_{version-full}_x86_64.msi] -* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_arm64.zip[couchbase-sync-gateway-enterprise_3.0.0-beta01_arm64.zip] -* {beta-url}couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.zip[couchbase-sync-gateway-enterprise_3.0.0-beta01_x86_64.zip] +* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_arm64.zip[couchbase-sync-gateway-enterprise_{version-full}_arm64.zip] +* {beta-url}couchbase-sync-gateway-enterprise_{version-full}_x86_64.zip[couchbase-sync-gateway-enterprise_{version-full}_x86_64.zip] -a|* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_aarch64.rpm[couchbase-sync-gateway-community_3.0.0-beta01_aarch64.rpm] -* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_x86_64.deb[couchbase-sync-gateway-community_3.0.0-beta01_x86_64.deb] -* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_x86_64.rpm[couchbase-sync-gateway-community_3.0.0-beta01_x86_64.rpm] +a|* {beta-url}couchbase-sync-gateway-community_{version-full}_aarch64.rpm[couchbase-sync-gateway-community_{version-full}_aarch64.rpm] +* {beta-url}couchbase-sync-gateway-community_{version-full}_x86_64.deb[couchbase-sync-gateway-community_{version-full}_x86_64.deb] +* {beta-url}couchbase-sync-gateway-community_{version-full}_x86_64.rpm[couchbase-sync-gateway-community_{version-full}_x86_64.rpm] -* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_x86_64.msi[couchbase-sync-gateway-community_3.0.0-beta01_x86_64.msi] +* {beta-url}couchbase-sync-gateway-community_{version-full}_x86_64.msi[couchbase-sync-gateway-community_{version-full}_x86_64.msi] -* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_arm64.zip[couchbase-sync-gateway-community_3.0.0-beta01_arm64.zip] -* {beta-url}couchbase-sync-gateway-community_3.0.0-beta01_x86_64.zip[couchbase-sync-gateway-community_3.0.0-beta01_x86_64.zip] +* {beta-url}couchbase-sync-gateway-community_{version-full}_arm64.zip[couchbase-sync-gateway-community_{version-full}_arm64.zip] +* {beta-url}couchbase-sync-gateway-community_{version-full}_x86_64.zip[couchbase-sync-gateway-community_{version-full}_x86_64.zip] | |=== From 999a7ff85ed78d448242874fb5128d11a16df91a Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 02/11] =?UTF-8?q?DOC=5F9272-C5=20--=20B5=20--Release=20Not?= =?UTF-8?q?es=20=E2=80=93=20check=20and=20update=20the=20list=20of=20issue?= =?UTF-8?q?s/fixed=20https://issues.couchbase.com/browse/DOCS-9272?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit (cherry picked from commit db1390ca98e264ffaac7c014075d78abb3067ea9) --- modules/ROOT/pages/release-notes.adoc | 106 ++++++++++++++++---------- 1 file changed, 65 insertions(+), 41 deletions(-) diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index 5ee0e9334..8df0204ce 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -11,7 +11,7 @@ include::partial$_std-hdr-sgw.adoc[] :ns-this: {ns} for this release :fn-icr: footnote:icr[As of Sync Gateway version 2.8] -:this-release: 3.0.0-beta01 +// :this-release: {version-full} :docpath: sync-gateway::release-notes.adoc Quicklinks to previous release notes: @@ -25,7 +25,7 @@ xref:2.0@{docpath}[Release 2.0] :docpath!: // DO NOT EDIT -- Header Content Block -:param-abstract: This content describes the key features and changes implemented by release {this-release} of Couchbase Sync{nbsp}Gateway +:param-abstract: This content describes the key features and changes implemented by release {version-full} of Couchbase Sync{nbsp}Gateway :param-related: {whatsnew--xref} | {compatibility--xref} | {supported-environments--xref} include::partial$block-abstract.adoc[] // DO NOT EDIT -- Header Content Block @@ -44,7 +44,7 @@ The migration to 3.0 BETA configuration is a ONE WAY process -- see: {upgrading- [#lbl-rel300] -== Release {this-release} -- September 2021 +== Release {version-full} -- September 2021 Quicklinks: <> *|* <> *|* <> *|* @@ -98,26 +98,48 @@ xref:whatsnew.adoc#use-environment-variables-in-configuration-file[Read More ... [#improvements-300] == Other Enhancements // tag::enhancements-300[] -* https://issues.couchbase.com/browse/CBG-1679[CBG-1679] -- https://issues.couchbase.com/browse/CBG-1679[Apply standardised timeout and retry for all bootstrap connection ops] -* https://issues.couchbase.com/browse/CBG-1664[CBG-1664] -- https://issues.couchbase.com/browse/CBG-1664[Validate javascript syntax in DbConfig.validate()] -* https://issues.couchbase.com/browse/CBG-1659[CBG-1659] -- https://issues.couchbase.com/browse/CBG-1659[SGCollect - Ensure it works / change for admin auth] -* https://issues.couchbase.com/browse/CBG-1650[CBG-1650] -- https://issues.couchbase.com/browse/CBG-1650[sgcollect should get information from new endpoints (with include_runtime parameter, etc.)] -* https://issues.couchbase.com/browse/CBG-1643[CBG-1643] -- https://issues.couchbase.com/browse/CBG-1643[Add additional context for gocb errors when using self-signed cert] -* https://issues.couchbase.com/browse/CBG-1642[CBG-1642] -- https://issues.couchbase.com/browse/CBG-1642[Detect legacy sg-replicate config and log accordingly] -* https://issues.couchbase.com/browse/CBG-1635[CBG-1635] -- https://issues.couchbase.com/browse/CBG-1635[TestBucketPool V2 should close cluster when releasing/obtaining buckets] -* https://issues.couchbase.com/browse/CBG-1473[CBG-1473] -- https://issues.couchbase.com/browse/CBG-1473[Enable log redaction by default] -* https://issues.couchbase.com/browse/CBG-1424[CBG-1424] -- https://issues.couchbase.com/browse/CBG-1424[discoverInterfaceName should resolve hostnames before trying to find network interface stats using IP addresses] -* https://issues.couchbase.com/browse/CBG-1391[CBG-1391] -- https://issues.couchbase.com/browse/CBG-1391[Treat existing cbgt index as recoverable error] -* https://issues.couchbase.com/browse/CBG-1390[CBG-1390] -- https://issues.couchbase.com/browse/CBG-1390[Add warning threshold for excessively large number of channels per user] -* https://issues.couchbase.com/browse/CBG-1359[CBG-1359] -- https://issues.couchbase.com/browse/CBG-1359[Increase default minimum TLS version TLS1.2] -* https://issues.couchbase.com/browse/CBG-1343[CBG-1343] -- https://issues.couchbase.com/browse/CBG-1343[Increase initial wait time for index creation retry] -* https://issues.couchbase.com/browse/CBG-1342[CBG-1342] -- https://issues.couchbase.com/browse/CBG-1342[Avoid retry on 'duplicate index name' index creation error] -* https://issues.couchbase.com/browse/CBG-1337[CBG-1337] -- https://issues.couchbase.com/browse/CBG-1337[Add an option to skip SSL certificates verification while loading JavaScript from HTTPS endpoints] -* https://issues.couchbase.com/browse/CBG-1326[CBG-1326] -- https://issues.couchbase.com/browse/CBG-1326[Log if channels expand to a smaller set than requested] -* https://issues.couchbase.com/browse/CBG-1299[CBG-1299] -- https://issues.couchbase.com/browse/CBG-1299[[Lithium Port] - Implement network connstr flag for cbdatasource alt address shims] -* https://issues.couchbase.com/browse/CBG-1282[CBG-1282] -- https://issues.couchbase.com/browse/CBG-1282[XATTRS Access Grants] -* https://issues.couchbase.com/browse/CBG-1273[CBG-1273] -- https://issues.couchbase.com/browse/CBG-1273[Add Prometheus alert examples] -* https://issues.couchbase.com/browse/CBG-1253[CBG-1253] -- https://issues.couchbase.com/browse/CBG-1253[Add USE INDEX to index readiness queries] + +// tag::Enhancements-3-0-0-beta[] + +* https://issues.couchbase.com//browse/CBG-1705[CBG-1705] -- https://issues.couchbase.com//browse/CBG-1705[Release 'view op' on results close] +* https://issues.couchbase.com//browse/CBG-1679[CBG-1679] -- https://issues.couchbase.com//browse/CBG-1679[Apply standardised timeout and retry for all bootstrap connection ops] +* https://issues.couchbase.com//browse/CBG-1672[CBG-1672] -- https://issues.couchbase.com//browse/CBG-1672[Return 422 status for unprocessible deltas instead of 404 to use non-delta retry handling] +* https://issues.couchbase.com//browse/CBG-1664[CBG-1664] -- https://issues.couchbase.com//browse/CBG-1664[Validate javascript syntax in DbConfig.validate()] +* https://issues.couchbase.com//browse/CBG-1659[CBG-1659] -- https://issues.couchbase.com//browse/CBG-1659[SGCollect - Ensure it works / change for admin auth] +* https://issues.couchbase.com//browse/CBG-1650[CBG-1650] -- https://issues.couchbase.com//browse/CBG-1650[sgcollect should get information from new endpoints (with include_runtime parameter, etc.)] +* https://issues.couchbase.com//browse/CBG-1646[CBG-1646] -- https://issues.couchbase.com//browse/CBG-1646[Add a flag to non-active leaf revisions indicating whether they include v2 attachments] +* https://issues.couchbase.com//browse/CBG-1643[CBG-1643] -- https://issues.couchbase.com//browse/CBG-1643[Add additional context for gocb errors when using self-signed cert] +* https://issues.couchbase.com//browse/CBG-1642[CBG-1642] -- https://issues.couchbase.com//browse/CBG-1642[Detect legacy sg-replicate config and log accordingly] +* https://issues.couchbase.com//browse/CBG-1635[CBG-1635] -- https://issues.couchbase.com//browse/CBG-1635[TestBucketPool V2 should close cluster when releasing/obtaining buckets] +* https://issues.couchbase.com//browse/CBG-1590[CBG-1590] -- https://issues.couchbase.com//browse/CBG-1590[Retrieve existing doc metadata prior to calling downloadOrVerifyAttachments] +* https://issues.couchbase.com//browse/CBG-1473[CBG-1473] -- https://issues.couchbase.com//browse/CBG-1473[Enable log redaction by default] +* https://issues.couchbase.com//browse/CBG-1424[CBG-1424] -- https://issues.couchbase.com//browse/CBG-1424[discoverInterfaceName should resolve hostnames before trying to find network interface stats using IP addresses] +* https://issues.couchbase.com//browse/CBG-1391[CBG-1391] -- https://issues.couchbase.com//browse/CBG-1391[Treat existing cbgt index as recoverable error] +* https://issues.couchbase.com//browse/CBG-1390[CBG-1390] -- https://issues.couchbase.com//browse/CBG-1390[Add warning threshold for excessively large number of channels per user] +* https://issues.couchbase.com//browse/CBG-1359[CBG-1359] -- https://issues.couchbase.com//browse/CBG-1359[Increase default minimum TLS version TLS1.2] +* https://issues.couchbase.com//browse/CBG-1343[CBG-1343] -- https://issues.couchbase.com//browse/CBG-1343[Increase initial wait time for index creation retry] +* https://issues.couchbase.com//browse/CBG-1342[CBG-1342] -- https://issues.couchbase.com//browse/CBG-1342[Avoid retry on 'duplicate index name' index creation error] +* https://issues.couchbase.com//browse/CBG-1337[CBG-1337] -- https://issues.couchbase.com//browse/CBG-1337[Add an option to skip SSL certificates verification while loading JavaScript from HTTPS endpoints] +* https://issues.couchbase.com//browse/CBG-1326[CBG-1326] -- https://issues.couchbase.com//browse/CBG-1326[Log if channels expand to a smaller set than requested] +* https://issues.couchbase.com//browse/CBG-1299[CBG-1299] -- https://issues.couchbase.com//browse/CBG-1299[[Lithium Port] - Implement network connstr flag for cbdatasource alt address shims] +* https://issues.couchbase.com//browse/CBG-1282[CBG-1282] -- https://issues.couchbase.com//browse/CBG-1282[XATTRS Access Grants] +* https://issues.couchbase.com//browse/CBG-1280[CBG-1280] -- https://issues.couchbase.com//browse/CBG-1280[Channel Access Revocation] +* https://issues.couchbase.com//browse/CBG-1273[CBG-1273] -- https://issues.couchbase.com//browse/CBG-1273[Add Prometheus alert examples] +* https://issues.couchbase.com//browse/CBG-1253[CBG-1253] -- https://issues.couchbase.com//browse/CBG-1253[Add USE INDEX to index readiness queries] +* https://issues.couchbase.com//browse/CBG-1251[CBG-1251] -- https://issues.couchbase.com//browse/CBG-1251[Support Apple (M1) Silicon] +* https://issues.couchbase.com//browse/CBG-1245[CBG-1245] -- https://issues.couchbase.com//browse/CBG-1245[Include channel name in validfrom logging] +* https://issues.couchbase.com//browse/CBG-1240[CBG-1240] -- https://issues.couchbase.com//browse/CBG-1240[Remove couchbase/ns_server dependency] +* https://issues.couchbase.com//browse/CBG-1239[CBG-1239] -- https://issues.couchbase.com//browse/CBG-1239[Remove couchbase/retriever dependency] +* https://issues.couchbase.com//browse/CBG-1232[CBG-1232] -- https://issues.couchbase.com//browse/CBG-1232[Add support for loading webhook filter JavaScript from external file or URL] +* https://issues.couchbase.com//browse/CBG-1217[CBG-1217] -- https://issues.couchbase.com//browse/CBG-1217[Ensure change listener goroutines terminates (both Tap and DCP feeds) before the server is stopped] +* https://issues.couchbase.com//browse/CBG-1170[CBG-1170] -- https://issues.couchbase.com//browse/CBG-1170[Upgrade to go 1.15] +* https://issues.couchbase.com//browse/CBG-1127[CBG-1127] -- https://issues.couchbase.com//browse/CBG-1127[Treat resurrected tombstones as non-conflict when no shared history] +* https://issues.couchbase.com//browse/CBG-949[CBG-949] -- https://issues.couchbase.com//browse/CBG-949[Improve error when non-upgradable HTTP request is sent to _blipsync endpoint] +* https://issues.couchbase.com//browse/CBG-841[CBG-841] -- https://issues.couchbase.com//browse/CBG-841[Force users to opt in to accepting unsigned tokens from providers in SG's provider config.] +* https://issues.couchbase.com//browse/CBG-715[CBG-715] -- https://issues.couchbase.com//browse/CBG-715[High CPU usage in high volume basic auth scenarios] +* https://issues.couchbase.com//browse/CBG-641[CBG-641] -- https://issues.couchbase.com//browse/CBG-641[Admin API Auth] +* https://issues.couchbase.com//browse/CBG-551[CBG-551] -- https://issues.couchbase.com//browse/CBG-551[Avoid storing _removed:true revision bodies in the revision cache] +// end::Enhancements-3-0-0-beta[] // end::enhancements-300[] [#issues-and-resolutions-300] @@ -127,30 +149,32 @@ xref:whatsnew.adoc#use-environment-variables-in-configuration-file[Read More ... // tag::known-300[] // .List of issues outstanding at this release -* https://issues.couchbase.com/browse/CBG-798[CBG-798] -- https://issues.couchbase.com/browse/CBG-798[Sync Gateway requires Couchbase Server nodes to use the same SSL memcached port] +* https://issues.couchbase.com//browse/CBG-798[CBG-798] -- https://issues.couchbase.com//browse/CBG-798[Sync Gateway requires Couchbase Server nodes to use the same SSL memcached port] // end::known-300[] == Fixed Issues // tag::fixed-300[] -// .List of issues resolved by this release -* https://issues.couchbase.com/browse/CBG-1438[CBG-1438] -- https://issues.couchbase.com/browse/CBG-1438[SgwIntStat.SetIfMax incorrectly sums old and new values] -* https://issues.couchbase.com/browse/CBG-1412[CBG-1412] -- https://issues.couchbase.com/browse/CBG-1412[JSON strings in some responses not being correctly escaped] -* https://issues.couchbase.com/browse/CBG-1388[CBG-1388] -- https://issues.couchbase.com/browse/CBG-1388[sg_collect does not package archived log files (*.log.gz)] -* https://issues.couchbase.com/browse/CBG-1376[CBG-1376] -- https://issues.couchbase.com/browse/CBG-1376[Some Delta Sync errors logged at WARN level should be DEBUG] -* https://issues.couchbase.com/browse/CBG-1339[CBG-1339] -- https://issues.couchbase.com/browse/CBG-1339[Creating mobile tombstone for existing CBS tombstone causes loop] -* https://issues.couchbase.com/browse/CBG-1335[CBG-1335] -- https://issues.couchbase.com/browse/CBG-1335[Mutating _rev on localDocument in conflict resolver results in merge error] -* https://issues.couchbase.com/browse/CBG-1325[CBG-1325] -- https://issues.couchbase.com/browse/CBG-1325[Incorrect email validation (too strict)] -* https://issues.couchbase.com/browse/CBG-1304[CBG-1304] -- https://issues.couchbase.com/browse/CBG-1304[ISGR: Pull replications incompatible with active-side allow_conflicts=false] -* https://issues.couchbase.com/browse/CBG-1246[CBG-1246] -- https://issues.couchbase.com/browse/CBG-1246[Changes limit incorrectly applied in case of CBG-946] -* https://issues.couchbase.com/browse/CBG-1231[CBG-1231] -- https://issues.couchbase.com/browse/CBG-1231[Prevent import cfg startup races] -* https://issues.couchbase.com/browse/CBG-1200[CBG-1200] -- https://issues.couchbase.com/browse/CBG-1200[Calling DELETE on a non-existent document creates a tombstone with empty body] -* https://issues.couchbase.com/browse/CBG-1172[CBG-1172] -- https://issues.couchbase.com/browse/CBG-1172[ISGR credentials with characters requiring URL encoding cause blipsync to fail] -* https://issues.couchbase.com/browse/CBG-1161[CBG-1161] -- https://issues.couchbase.com/browse/CBG-1161[DefaultPurgeInterval specified in days and used as though in hours] -* https://issues.couchbase.com/browse/CBG-1113[CBG-1113] -- https://issues.couchbase.com/browse/CBG-1113[CBL1.x/Websocket based changes feeds leak goroutine on disconnect] -* https://issues.couchbase.com/browse/CBG-789[CBG-789] -- https://issues.couchbase.com/browse/CBG-789[Updating a blob with new data does not update SG's metadata on sync] - +// tag::Fixed-3-0-0-beta[] + +* https://issues.couchbase.com//browse/CBG-1438[CBG-1438] -- https://issues.couchbase.com//browse/CBG-1438[SgwIntStat.SetIfMax incorrectly sums old and new values] +* https://issues.couchbase.com//browse/CBG-1412[CBG-1412] -- https://issues.couchbase.com//browse/CBG-1412[JSON strings in some responses not being correctly escaped] +* https://issues.couchbase.com//browse/CBG-1388[CBG-1388] -- https://issues.couchbase.com//browse/CBG-1388[sg_collect does not package archived log files (*.log.gz)] +* https://issues.couchbase.com//browse/CBG-1376[CBG-1376] -- https://issues.couchbase.com//browse/CBG-1376[Some Delta Sync errors logged at WARN level should be DEBUG] +* https://issues.couchbase.com//browse/CBG-1339[CBG-1339] -- https://issues.couchbase.com//browse/CBG-1339[Creating mobile tombstone for existing CBS tombstone causes loop] +* https://issues.couchbase.com//browse/CBG-1335[CBG-1335] -- https://issues.couchbase.com//browse/CBG-1335[Mutating _rev on localDocument in conflict resolver results in merge error] +* https://issues.couchbase.com//browse/CBG-1325[CBG-1325] -- https://issues.couchbase.com//browse/CBG-1325[Incorrect email validation (too strict)] +* https://issues.couchbase.com//browse/CBG-1304[CBG-1304] -- https://issues.couchbase.com//browse/CBG-1304[ISGR: Pull replications incompatible with active-side allow_conflicts=false] +* https://issues.couchbase.com//browse/CBG-1246[CBG-1246] -- https://issues.couchbase.com//browse/CBG-1246[Changes limit incorrectly applied in case of CBG-946] +* https://issues.couchbase.com//browse/CBG-1231[CBG-1231] -- https://issues.couchbase.com//browse/CBG-1231[Prevent import cfg startup races] +* https://issues.couchbase.com//browse/CBG-1200[CBG-1200] -- https://issues.couchbase.com//browse/CBG-1200[Calling DELETE on a non-existent document creates a tombstone with empty body] +* https://issues.couchbase.com//browse/CBG-1172[CBG-1172] -- https://issues.couchbase.com//browse/CBG-1172[ISGR credentials with characters requiring URL encoding cause blipsync to fail] +* https://issues.couchbase.com//browse/CBG-1161[CBG-1161] -- https://issues.couchbase.com//browse/CBG-1161[DefaultPurgeInterval specified in days and used as though in hours] +* https://issues.couchbase.com//browse/CBG-1113[CBG-1113] -- https://issues.couchbase.com//browse/CBG-1113[CBL1.x/Websocket based changes feeds leak goroutine on disconnect] +* https://issues.couchbase.com//browse/CBG-789[CBG-789] -- https://issues.couchbase.com//browse/CBG-789[Updating a blob with new data does not update SG's metadata on sync] + +// end::Fixed-3-0-0-beta[] // end::fixed-300[] // tag::api-changed-300[] From 57de0043c21efdddad281f08aa53f027dcdf0770 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 03/11] =?UTF-8?q?DOC-9272-C2=20--=20B.2=20--Config=20Links?= =?UTF-8?q?=20=20=E2=80=93=20check=20redirected=20from=20legacy=20https://?= =?UTF-8?q?issues.couchbase.com/browse/DOCS-9272?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit (cherry picked from commit aefe00ddb90d3a594f9e6788a9daf1ec78f9e89c) (cherry picked from commit 5bcc1e530b62698d1a9fe0b766597cd4c4857bd7) --- modules/ROOT/pages/_partials/_page-index.adoc | 29 ++ .../pages/_partials/sgw-supported-os.adoc | 49 +++- modules/ROOT/pages/access-control-how.adoc | 276 ------------------ modules/ROOT/pages/authentication-certs.adoc | 14 +- modules/ROOT/pages/conflict-resolution.adoc | 4 +- modules/ROOT/pages/database-offline.adoc | 2 +- modules/ROOT/pages/delta-sync.adoc | 11 +- 7 files changed, 82 insertions(+), 303 deletions(-) diff --git a/modules/ROOT/pages/_partials/_page-index.adoc b/modules/ROOT/pages/_partials/_page-index.adoc index b941035b0..ba7dcbb14 100644 --- a/modules/ROOT/pages/_partials/_page-index.adoc +++ b/modules/ROOT/pages/_partials/_page-index.adoc @@ -270,10 +270,23 @@ endif::xref--pfx-sgw[] :configuration-schema-bootstrap--page: configuration-schema-bootstrap.adoc :bootstrap-schema--pfx: {sgw--xref}{configuration-schema-bootstrap--page} +:bootstrap-schema--xref: {bootstrap-schema--pfx}[Bootstrap Configuration] :configuration-schema-bootstrap--xref: {bootstrap-schema--pfx}[Bootstrap Configuration] // :bootstrap-schema--xref--allow_insecure_tls_connections: {bootstrap-schema--pfx}#api-https-allow_insecure_tls_connections[allow_insecure_tls_connections] +:bootstrap-schema--xref--group-id: {bootstrap-schema--pfx}#bootstrap-group-id[bootstrap.group_id] +:bootstrap-schema--xref--config_update_frequency: {bootstap-schema--pfx}#bootstrap-config_update_frequency[bootstrap.config_update_frequency] +:bootstrap-schema--xref--server: {bootstrap-schema--pfx}#bootstrap-server[bootstrap.server] +:bootstrap-schema--xref--username: {bootstrap-schema--pfx}#bootstrap-username[bootstrap.username] +:bootstrap-schema--xref--password: {bootstrap-schema--pfx}#bootstrap-password[bootstrap.password] +:bootstrap-schema--xref--ca_cert_path: {bootstrap-schema--pfx}#bootstrap-ca_cert_path[bootstrap.ca_cert_path] +:bootstrap-schema--xref--server_tls_skip_verify: {bootstrap-schema--pfx}#bootstrap-server_tls_skip_verify[bootstrap.server_tls_skip_verify] +:bootstrap-schema--xref--x509_cert_path: {bootstrap-schema--pfx}#bootstrap-x509_cert_path[bootstrap.x509_cert_path] +:bootstrap-schema--xref--x509_key_path: {bootstrap-schema--pfx}#bootstrap-x509_key_path[bootstrap.x509_key_path] +:bootstrap-schema--xref--server_tls_skip_verify: {bootstrap-schema--pfx}#bootstrap-server_tls_skip_verify[bootstrap.server_tls_skip_verify] +:bootstrap-schema--xref--use_tls_server: {bootstrap-schema--pfx}#bootstrap-use_tls_server[bootstrap.use_tls_server] + :bootstrap-schema--xref--api-admin-interface-authentication: {bootstrap-schema--pfx}#api-admin_interface_authentication[api.api.admin_interface_authentication] :bootstrap-schema--xref--api-admin-interface: {bootstrap-schema--pfx}#api-admin_interface[api.admin_interface] :bootstrap-schema--xref--api-compress-responses: {bootstrap-schema--pfx}#api-compress_responses[api.compress_responses] @@ -381,6 +394,22 @@ endif::xref--pfx-sgw[] :bootstrap-schema--xref--unsupported: {bootstrap-schema--pfx}#unsupported[unsupported] +:configuration-schema-database--page: configuration-schema-database.adoc +:configuration-schema-database--xref: {database-schema--pfx}[Database Configuration Schema] + +:database-schema--pfx: {sgw--xref}{configuration-schema-database--page} +:database-schema--xref: {database-schema--pfx}[Database Configuration Schema] +:database-schema--bmk: {database-schema--pfx}#database_configuration_model- + +:database-schema--xref--bucket: {database-schema--bmk}bucket[database_schema.bucket] +:database-schema--xref--name: {database-schema--bmk}name[database_schema.name] +:database-schema--xref--sync: {database-schema--bmk}sync[database_schema.sync] + +:database-schema--xref--delta-sync: {database-schema--bmk}delta_sync[database_schema.delta_sync] +// :database-schema--xref--bucket: {database-schema--bmk}bucket[database_schema.bucket] +// :database-schema--xref--bucket: {database-schema--bmk}bucket[database_schema.bucket] +// :database-schema--xref--bucket: {database-schema--bmk}bucket[database_schema.bucket] + diff --git a/modules/ROOT/pages/_partials/sgw-supported-os.adoc b/modules/ROOT/pages/_partials/sgw-supported-os.adoc index 14f34ef02..cddd306f1 100644 --- a/modules/ROOT/pages/_partials/sgw-supported-os.adoc +++ b/modules/ROOT/pages/_partials/sgw-supported-os.adoc @@ -14,14 +14,17 @@ | 7.x and 8.x | Ubuntu -| 16.04 LTS and 18.04 +| 20.04 LTS and 18.04 +| 16.04 -- deprecated at {version-full} | Debian -| 8.x and 9.x +| 10.x and 9.x +| 8.x -- deprecated at {version-full} | Windows Server -a| 2012 (64-bit) DEPRECATED at Sync Gateway 2.8+ - 2016 (64-bit) +a| 2019 + +2016 (64-bit) -- deprecated at {version-full} + |=== // end::sup-os-dev-test-prod[] @@ -34,16 +37,17 @@ a| 2012 (64-bit) DEPRECATED at Sync Gateway 2.8+ | Platform| Operating System | Supported Versions |AWS |Amazon Linux AMI -a|2017.09 + -2018.03 +a|LTS |Azure |Ubuntu -|16.04 +| 20.04 + +18.04 |Google Cloud a|Ubuntu -|16.04 +|20.04 + +18.04 |Docker (Docker Hub) |CentOS @@ -64,8 +68,8 @@ a|Ubuntu | Operating System | Supported Versions | macOS -a|10.15(Catalina) + -10.14 (Mojave) +a| 11.x (Big Sur) + +10.15(Catalina) | Windows Desktop | 2010 @@ -94,14 +98,33 @@ Ubuntu 14.04 LTS // end::deprecated[] // tag::removed[] -.Removed at 2.8 +.Removed at 3.0.0 [cols="1,1,1",options="header"] |=== | Operating System | Deprecated Versions | Deprecation Release +// // | Red Hat Enterprise Linux +// // | 6 + +// // 5 +// // | 3.0.0 + +// // | CentOS +// // | 6 + +// // 5 +// // | 3.0.0 + +// | Ubuntu +// | 16.04 + +// 12.04 +// | 3.0.0 + +| Windows Server +| 2012 (64-bit) +| 3.0.0 + | OSX -| 10.12.6 "High Sierra" -| 2.6 +| 10.14 "Mojave" +| 3.0.0 |=== // end::removed[] diff --git a/modules/ROOT/pages/access-control-how.adoc b/modules/ROOT/pages/access-control-how.adoc index e83287df1..9201bd1fc 100644 --- a/modules/ROOT/pages/access-control-how.adoc +++ b/modules/ROOT/pages/access-control-how.adoc @@ -77,65 +77,6 @@ image::channel-access-grant-all.png[,400] include::{howto}create-users.adoc[leveloffset={our-offset}] -// == Create User -// Each user must be created on Sync Gateway before it can be used for access control. -// You can create and-or manage users statically using the {configuration-properties--xref} or dynamically through the {rest-api-admin--xref}. - -// [{tabs}] -// ==== - -// Admin REST API:: -// + -// -- -// Create a new user by sending a POST request to the Admin Rest Api `_user` endpoint ({rest-api-admin-user-post--xref}). -// Update existing users by sending a PUT instead; in this case include the user name at the end of the url. - -// The user credentials (**username**/**password**) are passed in the request body. - -// [source,bash] -// ---- -// $ curl -vX POST "http://localhost:4985/mydatabase/_user/" -H -// "accept: application/json" -H "Content-Type: application/json" -d -// '{"name": "Edge1User", "password": "pass"}' // <.> - -// $ curl -vX PUT "http://localhost:4985/mydatabase/_user/Edge1User" -H -// "accept: application/json" -H "Content-Type: application/json" -d -// '{"name": "Edge1User", "admin_channels": ["RandomChannel"]}' // <.> -// ---- - -// <.> Add new user "Edge1User", no `access_channel` or `role` is specified here. -// <.> Update existing user "Edge1User" and add `access_channels` data - -// -- - -// Configuration File:: -// + -// -- -// Create users by hardcoding their credentials in the {configuration-properties--xref}. -// This method is convenient for testing and to get started. -// Use the *Admin REST API* for production system changes. -// + -// [source,json] -// ---- -// { -// "databases": { -// "mydatabase": { -// "users": { // <1> -// "GUEST": {"disabled": true}, -// "Edge1User": {"password": "pass", -// "admin_channels": ["RandomChannel"]}, -// } -// } -// } -// } -// ---- - -// <.> {configuration-properties--pfx}#databases-this_db-users[databases.$db.users] - -// -- -// <.> Here we add the Edge1 role used in the example in this topic. - -// ==== [#lbl-acc-ctl-roles-create] == Create Roles @@ -144,228 +85,18 @@ include::{howto}create-users.adoc[leveloffset={our-offset}] include::{howto}create-roles.adoc[leveloffset={our-offset}] :include-related!: -// As with users, you create and-or manage roles using either the {rest-api-admin--xref} or {configuration-properties--xref}. - - -// [{tabs}] -// ==== - -// Admin REST API:: -// + -// -- -// Create a new role using the {rest-api-admin-role-post--xref} endpoint. - -// [source,bash] -// ---- -// $ curl -vX POST "http://localhost:4985/mydatabase/_roler/" -H -// "accept: application/json" -H "Content-Type: application/json" -d -// '{"name": "Edge1", "admin_channels": ["channel1", "channel3"]]}' // <.> -// ---- - -// -- - -// Configuration File:: -// + -// -- -// Create users by hardcoding their credentials in the {configuration-properties--xref}. -// This method is convenient for testing and to get started. -// It is recommended to use the *Admin REST API* for production systems. - -// [source,json] -// ---- -// { -// "databases": { -// "mydatabase": { -// "roles": { // <.> -// "Edge1": {"admin_channels": ["channel1", "channel3"]}, // <.> -// "Edge2": {"admin_channels": ["channel2", "channel3"]}, -// "GUEST": {"disabled": true} -// } -// } -// } -// } -// ---- - -// <.> {configuration-properties--pfx}#databases-this_db-users[databases.$db.users] - -// -- -// <.> Here we add the Edge1 role used in the example in this topic. - -// ==== - [#lbl-acc-ctl-roles-add] == Assign Users to Roles include::{howto}assign-users-to-roles.adoc[leveloffset={our-offset}] -// You can add and remove roles from users using either the {rest-api-admin--xref} or {configuration-properties--xref}. - -// Note that removing a role effectively revokes access to the channel that role is associated with and may mean users will lose access to required documents. - -// [{tabs}] -// ==== - -// Admin REST API:: -// + -// -- -// Add a role to an existing user by sending a PUT request to the Admin REST API `_role` endpoint ({rest-api-admin-user-put--xref} ). - -// Specify the roles to be assigned in the `admin_roles` array. - -// [source,bash] -// ---- -// $ curl -vX PUT "http://localhost:4985/mydatabase/_user/{user}" -H -// "accept: application/json" -H "Content-Type: application/json" -d -// '{ "admin_roles": ["Edge1"]}' // <.> -// ---- -// <.> {user} is the user name to be updated, e.g. "Edge1User" - -// See also: {rest-api-admin-role-post--xref} -// -- - -// Configuration:: -// + -// -- -// Add a role to a user in the configuration file. -// This method is convenient for testing and to get started. -// Use the *Admin REST API* for production systems. - -// [source,json] -// ---- -// { -// "databases": { -// "mydatabase": { -// "users": { // <.> -// "GUEST": {"disabled": true}, -// "Edge1User": {"password": "pass", "admin_roles": ["Edge1"], -// "admin_channels": ["RandomChannel"]}, -// "Edge2User": {"password": "pass", "admin_roles": ["Edge2"]} -// } -// } -// } -// } -// ---- -// <.> {configuration-properties--pfx}#databases-this_db-users-this_user-admin_roles[databases.$db.users.$user.admin_roles] -// -- - -// Sync Function:: -// + -// -- -// You can also use the Sync Function's `role(username, rolename)` function to assign roles to users programmatically. - -// Note that both role and user must already exist. -// Nonexistent roles don’t cause an error, but have no effect on the user’s access privileges. - -// [source, javascript] -// ---- -// role ("Edge1User", "role:Edge1"); -// role ("Edge2User", "role:Edge2":); -// ---- -// -- - -// ==== - [#lbl-control-document-access] == Control Document Access include::{howto}control-document-access.adoc[leveloffset={our-offset}] -// You can allow roles and-or users access to channels using: - -// * Configuration -- using the appropriate `admin_channels` property in the {configuration-properties--xref}. - -// * Admin REST API -- alternatively provide that same `admin_channels` property using the admin REST API endpoint ({rest-api-admin-user-put--xref}). - -// * Sync Function -- using the exposed helper function `access()` -- see reference information in {sync-function--xref}. - -// You will often use the document content to govern access and routing. -// The data to drive this can now be secured in metadata, providing an additional level of security -- see <>. - -// [{tabs}] -// ==== - -// Admin REST API:: -// + -// -- -// Add a channel to an existing user by sending a PUT request to the Admin REST API `_role` endpoint ({rest-api-admin-role-put--xref} ). - -// Specify the roles to be assigned in the `admin_channels` array. - -// [source,bash] -// ---- -// $ curl -vX PUT "http://localhost:4985/mydatabase/_user/{user}" -H //<.> -// "accept: application/json" -H "Content-Type: application/json" -d -// '{ "admin_channels": ["Channel1","Channel3]}' // <.> -// ---- - -// <.> {user} is the user name to be updated, e.g. "Edge1User" - -// <.> Here we add _Channel1_ and _Channel3_ to the user - -// -- - -// Configuration:: -// + -// -- -// Add a channel to a user in the configuration file. -// This method is convenient for testing and to get started. -// Use the *Admin REST API* for production systems. - -// [source,json] -// ---- -// { -// "databases": { -// "mydatabase": { -// "users": { -// "GUEST": {"disabled": true}, -// "Edge1User": {"password": "pass", "admin_roles": ["Edge1"], -// "admin_channels": ["Channel1","Channel3","RandomChannel"]} // <.> -// }, -// "roles": { -// "Edge1": {"admin_channels": ["channel1", "channel3"]}, -// "Edge2": {"admin_channels": ["Channel2","Channel3","SkyChannel"]} // <.> -// } -// } -// } -// } -// ---- - -// <.> Here we have added the channel _RandomChannel_ to the user _Edge1User_ {configuration-properties--pfx}#databases-this_db-users-this_user-admin_channels[databases.$db.users.$user.admin_channel] - -// <.> Here we have added the channel _SkyChannel_ to the role _Edge2_ {configuration-properties--pfx}#databases-this_db-roles-this_role-admin_channels[databases.$db.users.$user.admin_channel] - -// -- - -// Sync Function:: -// + -// -- -// You can also use the Sync Function's `access(username, channelname)` function to allow channel access to roles and-or users programmatically. - -// [source, javascript] -// ---- - -// function (doc, olddoc, meta) { - -// // user logic -// access ("Edge1User", "RandomChannel"); // <.> -// access ("role:Edge2", "SkyChannel"); // <.> - -// // user logic -// } -// ---- - -// <.> Here we add access to channel _RandomChannel_ to the user _Edge1User_ - -// <.> The `access()` function can also operate on roles. -// If a user name string begins with `role:` then the remainder of the string is interpreted as a role name. -// There's no ambiguity here, because ":" is an illegal character in a user or role name. -// Here we allow access to the channel _Sky1Channel_ for the role _Edge2_ - -// -- - -// ==== [#lbl-verify-access] @@ -374,13 +105,6 @@ include::{howto}control-document-access.adoc[leveloffset={our-offset}] include::{howto}verify-access.adoc[leveloffset={our-offset}] -// // tag::write-access[] -// [#lbl-control-write-access] -// == Write Access - -// include::{howto}write-access.adoc[leveloffset={our-offset}] - - [#lbl-xattrs] == Use Extended Attributes (XATTRS) diff --git a/modules/ROOT/pages/authentication-certs.adoc b/modules/ROOT/pages/authentication-certs.adoc index ca394530f..50c5a287e 100644 --- a/modules/ROOT/pages/authentication-certs.adoc +++ b/modules/ROOT/pages/authentication-certs.adoc @@ -17,8 +17,8 @@ include::partial$block-abstract.adoc[] *Authentication* In a Couchbase Mobile production deployment, administrators typically perform operations on the Admin REST API. -If Sync Gateway is deployed on an internal network, you can bind the {configuration-properties--pfx}#server[adminInterface] of Sync Gateway to the internal network. -In this case, the firewall should also be configured to allow external connections to the public {configuration-properties--pfx}#server[interface] port. +If Sync Gateway is deployed on an internal network, you can bind the {bootstrap-schema--xref--api-admin-interface} of Sync Gateway to the internal network. +In this case, the firewall should also be configured to allow external connections to the public {bootstrap-schema--xref--api-public-interface}. To access the Admin REST API from an entirely different network or from a remote desktop we recommend to use https://whatbox.ca/wiki/SSH_Tunneling[SSH tunneling]. @@ -162,9 +162,13 @@ If Sync Gateway cannot connect, you may refer to the xref:server:manage:manage-s More detail on the configuration properties for x.509 authentication can be found below. -* {configuration-properties--pfx}#databases-this_db-certpath[databases.$db.certpath] -* {configuration-properties--pfx}#databases-this_db-keypath[databases.$db.keypath] -* {configuration-properties--pfx}#databases-this_db-cacertpath[databases.$db.cacertpath] +* {bootstrap-schema--xref--ca_cert_path} +* {bootstrap-schema--xref--x509_cert_path} +* {bootstrap-schema--xref--x509_key_path} + +// * {configuration-properties--pfx}#databases-this_db-certpath[databases.$db.certpath] +// * {configuration-properties--pfx}#databases-this_db-keypath[databases.$db.keypath] +// * {configuration-properties--pfx}#databases-this_db-cacertpath[databases.$db.cacertpath] If the **username**/**password** properties are also specified in the configuration file then Sync Gateway will use password-based authentication and also include the client certificate in the TLS handshake. diff --git a/modules/ROOT/pages/conflict-resolution.adoc b/modules/ROOT/pages/conflict-resolution.adoc index 18d3f5bfa..144aa2d40 100644 --- a/modules/ROOT/pages/conflict-resolution.adoc +++ b/modules/ROOT/pages/conflict-resolution.adoc @@ -28,7 +28,7 @@ include::partial$_std-hdr-sgw.adoc[] :param-abstract!: -:param-related: {xref-sgw-pg-icr-conflict-resolution} | {configuration-properties--xref} +:param-related: {xref-sgw-pg-icr-conflict-resolution} | {configuration-schema-bootstrap--xref} :topic-group: Sync include::partial$block-abstract.adoc[] @@ -42,7 +42,7 @@ xref:couchbase-lite:android:learn/java-android-conflict.adoc[Java (Android)] | xref:couchbase-lite:csharp:learn/csharp-conflict.adoc[C#] | xref:couchbase-lite:objc:learn/objc-conflict.adoc[Objective-C] -For conflict resolution on 1.x clients -- see: {xref-sgw-pg-resolving-conflicts-legacy}. +For conflict resolution on 1.x clients -- see : {xref-sgw-pg-resolving-conflicts-legacy}. include::partial$block-related-content-sync.adoc[] diff --git a/modules/ROOT/pages/database-offline.adoc b/modules/ROOT/pages/database-offline.adoc index cad67f9e2..6bb013cc6 100644 --- a/modules/ROOT/pages/database-offline.adoc +++ b/modules/ROOT/pages/database-offline.adoc @@ -44,7 +44,7 @@ Specific uses for the database offline/online functionality include: * Taking a database online: {rest-api-admin--pfx}#/database/post\__db___online[POST /+\{db}+/_online] By default, when Sync Gateway starts, it brings all databases that are defined in the configuration file online. -To keep a database offline when Sync Gateway starts, you can add the `offline` configuration property to the database configuration properties for the database, with the value `true` (see {configuration-properties--pfx}#databases-this_db[database properties]). +To keep a database offline when Sync Gateway starts, you can add the `offline` configuration property to the database configuration properties -- see {rest-api-admin--xref--database-configuration}. Later, to bring the database online, you can use the `+POST /\{tkn-db}/_online+` Admin REST API request. diff --git a/modules/ROOT/pages/delta-sync.adoc b/modules/ROOT/pages/delta-sync.adoc index a808dcba6..38ff19751 100644 --- a/modules/ROOT/pages/delta-sync.adoc +++ b/modules/ROOT/pages/delta-sync.adoc @@ -31,7 +31,7 @@ NOTE: Push replications do not use Delta Sync when pushing to a pre-2.8 target. == Configuration -You can enable delta-sync on a per-database basic in your Sync Gateway configuration file using the {configuration-properties--xref--databases-delta-sync} properties -- as shown in <>: +You can enable delta-sync on a per-database basic in your Sync Gateway configuration file using the `delta_sync` properties in{rest-api-admin--xref--database-configuration} -- as shown in <>: [#sample-cfg] .Sample of Database with Delta Sync @@ -46,9 +46,9 @@ You can enable delta-sync on a per-database basic in your Sync Gateway configura "bucket": "default", "allow_conflicts": false, "revs_limit": 20, - "delta_sync": { - "enabled": true, // <.> - "rev_max_age_seconds": 86400 // <.> + "delta_sync": { // <.> + "enabled": true, + "rev_max_age_seconds": 86400 } // ... any other configuration properties as appropriate } @@ -56,8 +56,7 @@ You can enable delta-sync on a per-database basic in your Sync Gateway configura } ---- -<.> {configuration-properties--xref--databases-delta-sync-enabled} -- enabled or disables delta sync for this database -<.> {configuration-properties--xref--databases-delta-sync-max-age} -- allows you to tune the amount of additional Couchbase Server bucket storage used by delta sync -- see: <>. +<.> {database-schema--xref--delta-sync} -- enable or disable delta sync property for this database; also allows you to tune the amount of additional Couchbase Server bucket storage used by delta sync -- see: <>. ==== From 9a3322f4a5a0fa92aaedd2c50e4e758675a21ac4 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 04/11] DOC-9272-C7 -- B.7 --Compatibility -- standardize presentation https://issues.couchbase.com/browse/DOCS-9272 (cherry picked from commit 295206f0aaade09893ce52618db60bfe9b551027) --- .../_partials/compatibility-cbl-sgw.adoc | 118 +++++----- .../_partials/sgw-svr-compatibility.adoc | 209 ++++++++++++------ 2 files changed, 196 insertions(+), 131 deletions(-) diff --git a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc index 7cea1f9b4..13e68acf7 100644 --- a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc +++ b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc @@ -1,6 +1,6 @@ // Inclusion for use in master topics -- shows compatibility of Couchbase Lite and SGW. ifndef::fn-eos-cbl[] -:fn-eos-cbl: footnote:eos-cbl[This Couchbase Lite version is End of Support]] +:fn-eos-cbl: pass:q,a[footnote:eos-cbl[This Couchbase Lite version is End of Support]]] endif::[] ifndef::fnref-eos-cbl[] @@ -8,7 +8,7 @@ ifndef::fnref-eos-cbl[] endif::[] ifndef::fn-eol-sgw[] -:fn-eol-sgw: footnote:eol-sgw[This Sync Gateway version is End of Life] +:fn-eol-sgw: pass:q,a[footnote:eol-sgw[This Sync Gateway version is End of Life]] endif::[] ifndef::fnref-eol-sgw[] @@ -16,81 +16,63 @@ ifndef::fnref-eol-sgw[] endif::[] ifndef::fn-eos-sgw[] -:fn-eos-sgw: footnote:eos-sgw[This Sync Gateway version is End of Support] +:fn-eos-sgw: pass:q,a[footnote:eos-sgw[This Sync Gateway version is End of Support]] endif::[] ifndef::fnref-eos-sgw[] -:fnref-eos-sgw: footnote:eos-sgw[] +:fnref-eos-sgw: pass:q,a[footnote:eos-sgw[]] endif::[] The table below summarizes the compatible versions of Couchbase Lite with Sync Gateway. -// . {fn-eol-cbl} -// . {fn-eos-cbl} -// . {fn-eol-sgw} -// . {fn-eos-sgw} - - - .Sync Gateway and Couchbase Lite Compatibility Matrix -[cols="2,^1,^1,^1,^1,^1,^1"] +[cols="2,^1,^1,^1,^1,^1"] |=== -.2+^|Sync Gateway Versions ↓ -6+|Couchbase Lite → -|3.0 -|2.5 - 2.8 -|2.1 -|2.0 -|1.4{fn-eos-cbl} -|1.3{fnref-eos-cbl} - -| Release {version-full} -|✔ -|✔ -|✔ -|✔ -|✖ -|✖ - -| Releases 2.5 to 2.8 with delta sync disabled -|✔ -|✔ -|✔ -|✔ -|✔ -|✔ - -| Releases 2.5 to 2.8 with delta sync enabled -|✔ -|✔ -|✖ -|✖ -|✖ -|✖ - -| Releases 2.0 and 2.1 -|✔ -|✔ -|✔ -|✔ -|✔ -|✔ - -| Releases 1.4 {fn-eos-sgw} and 1.5{fn-eol-sgw} -|✖ -|✖ -|✖ -|✖ -|✔ -|✔ - -| Release 1.3{fnref-eos-sgw} -|✖ -|✖ -|✖ -|✖ -|✖ -|✔ +.2+^| Sync Gateway Versions ↓ +5+| Couchbase Lite → + +^| 1.4{fn-eos-cbl} +| 2.0 +| 2.1 +| 2.5 - 2.8 +| 3.0.0 (beta) + +h| 1.4 {fn-eos-sgw} and 1.5{fn-eol-sgw} +| ✔ +| ✖ +| ✖ +| ✖ +| ✖ + +h| 2.0 and 2.1 +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +h| 2.5 to 2.8 + +with delta sync disabled +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +h| 2.5 to 2.8 + +with delta sync enabled +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ + +h| 3.0.0 (beta) +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ |=== diff --git a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc b/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc index 6d4c28c0f..4627bf773 100644 --- a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc +++ b/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc @@ -1,6 +1,6 @@ // Inclusion ifndef::fn-eol-svr[] -:fn-eol-svr: footnote:eol-svr[This Couchbase Server version is End of Support] +:fn-eol-svr: pass:q,a[footnote:eol-svr[This Couchbase Server version is End of Support]] endif::[] ifndef::fnref-eol-svr[] @@ -8,7 +8,7 @@ ifndef::fnref-eol-svr[] endif::[] ifndef::fn-eos-svr[] -:fn-eos-svr: footnote:eos-svr[This Couchbase Server version is End of Support] +:fn-eos-svr: pass:q,a[footnote:eos-svr[This Couchbase Server version is End of Support]] endif::[] ifndef::fnref-eos-svr[] @@ -16,7 +16,7 @@ ifndef::fnref-eos-svr[] endif::[] ifndef::fn-eol-cbl[] -:fn-eol-cbl: footnote:eol-cbl[This Couchbase Lite version is End of Support] +:fn-eol-cbl: pass:q,a[footnote:eol-cbl[This Couchbase Lite version is End of Support]] endif::[] ifndef::fnref-eol-cbl[] @@ -24,7 +24,7 @@ ifndef::fnref-eol-cbl[] endif::[] ifndef::fn-eos-cbl[] -:fn-eos-cbl: footnote:eos-cbl[This Couchbase Lite version is End of Support] +:fn-eos-cbl: pass:q,a[footnote:eos-cbl[This Couchbase Lite version is End of Support]] endif::[] ifndef::fnref-eos-cbl[] @@ -32,7 +32,7 @@ ifndef::fnref-eos-cbl[] endif::[] ifndef::fn-eol-sgw[] -:fn-eol-sgw: footnote:eol-sgw[This Sync Gateway version is End of Life] +:fn-eol-sgw: pass:q,a[footnote:eol-sgw[This Sync Gateway version is End of Life]] endif::[] ifndef::fnref-eol-sgw[] @@ -40,7 +40,7 @@ ifndef::fnref-eol-sgw[] endif::[] ifndef::fn-eos-sgw[] -:fn-eos-sgw: footnote:eos-sgw[This Sync Gateway version is End of Support] +:fn-eos-sgw: pass:q,a[footnote:eos-sgw[This Sync Gateway version is End of Support]] endif::[] ifndef::fnref-eos-sgw[] @@ -48,7 +48,7 @@ ifndef::fnref-eos-sgw[] endif::[] -:fn3-0: footnote:3-0beta[The 3.0 Beta is compatible with these versions but its use is not recommended] +:fn3-0: pass:q,a[footnote:3-0beta[The 3.0 Beta is compatible with these versions but its use is not recommended]] :fnref3-0: footnote:3-0beta[] @@ -77,71 +77,154 @@ include::partial$block-caveats.adoc[tag="cbs6.0ke-xattrs"] .2+^|Sync Gateway ↓ 8+|Couchbase Server →|4.0{fn-eos-svr}|4.1{fnref-eos-svr}|4.5{fnref-eos-svr}|4.6{fnref-eos-svr}|5.0 {fn3-0}|5.1 {fnref3-0}|5.5-6.6|7.0 -|3.0 BETA |||||✔|✔|✔|✔ +| 1.4{fn-eos-sgw} -|2.5-2.8 - -`shared_bucket_access: false` - -`use_views: true`|✔|✔|✔|✔|✔|✔|✔| -// |✔ - -|2.5-2.8 - -`shared_bucket_access: true`|✖|✖|✖|✖|✔|✔|✔| -// |✔ - -|2.5-2.8 - -`use_views: false`|✖|✖|✖|✖|✖|✖|✔| +`feed_type: ""DCP""` " +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ - - -|2.1 +| 1.5{fn-eol-sgw} `shared_bucket_access: false` +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +| 1.5{fnref-eol-sgw} + +`shared_bucket_access: true` +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.0 -`use_views: true`|✔|✔|✔|✔|✔|✔|✔| -// |✔ - -|2.1 - -`shared_bucket_access: true`|✖|✖|✖|✖|✔|✔|✔| -// |✔ - -|2.1 - -`use_views: false`|✖|✖|✖|✖|✖|✖|✔| -// |✔ - -|2.0 - -`shared_bucket_access: false`|✔|✔|✔|✔|✔|✔|✔| -// |✔ - -|2.0 - -`shared_bucket_access: true`|✖|✖|✖|✖|✔|✔|✔| -// |✔ - - -|1.5{fn-eol-sgw} - -`shared_bucket_access: false`|✔|✔|✔|✔|✔|✔|✔| -// |✔ - -|1.5{fnref-eol-sgw} +`shared_bucket_access: false` +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.0 + +`shared_bucket_access: true` +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.1 -`shared_bucket_access: true`|✖|✖|✖|✖|✔|✔|✔| -// |✔ +`shared_bucket_access: false` -|1.4{fn-eos-sgw} -`feed_type: "DCP"`|✖|✖|✖|✖|✔|✔|✔| -// |✔ +`use_views: true` +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.1 + +`shared_bucket_access: true` +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.1 + +`use_views: false` +| ✖ +| ✖ +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ + +| 2.5-2.8 -|1.3{fnref-eos-sgw} +`shared_bucket_access: false` -`feed_type: "DCP"`|✖|✖|✖|✖|✔|✔|✔| +`use_views: true` +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.5-2.8 + +`shared_bucket_access: true` +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ +| ✔ +| ✔ + +| 2.5-2.8 + +`use_views: false` +| ✖ +| ✖ +| ✖ +| ✖ +| ✖ +| ✖ +| ✔ +| ✔ + +| 3.0.0 (beta) +| +| +| +| +| ✔ +| ✔ +| ✔ +| ✔ +// |1.3{fnref-eos-sgw} + +// `feed_type: "DCP"`|✖|✖|✖|✖|✔|✔|✔| // |✔ // |✔ From b6994956c79329ad2f3dc16fac45dd10c0b3f295 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 05/11] DOC-9272-C7 -- B.7 --Compatibility -- standardize presentation (#2) https://issues.couchbase.com/browse/DOCS-9272 (cherry picked from commit e47191e5b21d306c4b269c3d23bc2f6823cd6a59) --- .../_partials/compatibility-cbl-sgw.adoc | 16 ++++++------ .../_partials/sgw-svr-compatibility.adoc | 26 +++++-------------- 2 files changed, 14 insertions(+), 28 deletions(-) diff --git a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc index 13e68acf7..f21a9e8c3 100644 --- a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc +++ b/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc @@ -1,6 +1,6 @@ // Inclusion for use in master topics -- shows compatibility of Couchbase Lite and SGW. ifndef::fn-eos-cbl[] -:fn-eos-cbl: pass:q,a[footnote:eos-cbl[This Couchbase Lite version is End of Support]]] +:fn-eos-cbl: pass:q,a[footnote:eos-cbl[This Couchbase Lite version is End of Support]] endif::[] ifndef::fnref-eos-cbl[] @@ -29,30 +29,30 @@ The table below summarizes the compatible versions of Couchbase Lite with Sync G [cols="2,^1,^1,^1,^1,^1"] |=== -.2+^| Sync Gateway Versions ↓ +.2+^.>| Sync Gateway Versions ↓ 5+| Couchbase Lite → -^| 1.4{fn-eos-cbl} +^| 1.4 *{fn-eos-cbl}* | 2.0 | 2.1 | 2.5 - 2.8 | 3.0.0 (beta) -h| 1.4 {fn-eos-sgw} and 1.5{fn-eol-sgw} +| 1.4 *{fn-eos-sgw}* and 1.5 *{fn-eol-sgw}* | ✔ | ✖ | ✖ | ✖ | ✖ -h| 2.0 and 2.1 +| 2.0 and 2.1 | ✔ | ✔ | ✔ | ✔ | ✔ -h| 2.5 to 2.8 + +| 2.5 to 2.8 + with delta sync disabled | ✔ | ✔ @@ -60,7 +60,7 @@ with delta sync disabled | ✔ | ✔ -h| 2.5 to 2.8 + +| 2.5 to 2.8 + with delta sync enabled | ✖ | ✖ @@ -68,7 +68,7 @@ with delta sync enabled | ✔ | ✔ -h| 3.0.0 (beta) +| 3.0.0 (beta) | ✖ | ✔ | ✔ diff --git a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc b/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc index 4627bf773..1aad52bad 100644 --- a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc +++ b/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc @@ -53,31 +53,17 @@ endif::[] :fnref3-0: footnote:3-0beta[] - - -// * {fn-eol-cbl} -// * {fn-eol-sgw} -// * {fn-eol-svr} -// * {fn-eos-cbl} -// * {fn-eos-sgw} -// * {fn-eos-svr} -// * {fnref-eol-cbl} -// * {fnref-eol-sgw} -// * {fnref-eol-svr} -// * {fnref-eos-cbl} -// * {fnref-eos-sgw} -// * {fnref-eos-svr} - include::partial$block-caveats.adoc[tag="cbs6.0ke-xattrs"] -.Sync Gateway/Couchbase Server Compatibility Matrix +.Sync Gateway/Couchbase Server +Compatibility Matrix [cols="2,^1,^1,^1,^1,^1,^1,^1,^1"] |=== .2+^|Sync Gateway ↓ -8+|Couchbase Server →|4.0{fn-eos-svr}|4.1{fnref-eos-svr}|4.5{fnref-eos-svr}|4.6{fnref-eos-svr}|5.0 {fn3-0}|5.1 {fnref3-0}|5.5-6.6|7.0 +8+|Couchbase Server →|4.0 *{fn-eos-svr}* |4.1 *{fnref-eos-svr}* |4.5 *{fnref-eos-svr}* | 4.6 *{fnref-eos-svr}* |5.0 *{fn3-0}* |5.1 *{fnref3-0}* |5.5-6.6|7.0 -| 1.4{fn-eos-sgw} +| 1.4 *{fn-eos-sgw}* `feed_type: ""DCP""` " | ✖ @@ -89,7 +75,7 @@ include::partial$block-caveats.adoc[tag="cbs6.0ke-xattrs"] | ✔ | ✔ -| 1.5{fn-eol-sgw} +| 1.5 *{fn-eol-sgw}* `shared_bucket_access: false` | ✔ @@ -101,7 +87,7 @@ include::partial$block-caveats.adoc[tag="cbs6.0ke-xattrs"] | ✔ | ✔ -| 1.5{fnref-eol-sgw} +| 1.5 *{fnref-eol-sgw}* `shared_bucket_access: true` | ✖ From 88a44526cf3018123623bfc5c2687820e12098a5 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:25 +0100 Subject: [PATCH 06/11] DOC-9272-C9 -- B.9 --DP for AWS Linux 2 Gravition and M1 https://issues.couchbase.com/browse/DOCS-9272 (cherry picked from commit 3c1e3bb1ae666295fef690ade6a320431b539ea3) --- .../ROOT/pages/_partials/sgw-supported-os.adoc | 17 +++++++++++------ modules/ROOT/pages/supported-environments.adoc | 14 ++++++++++++++ 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/modules/ROOT/pages/_partials/sgw-supported-os.adoc b/modules/ROOT/pages/_partials/sgw-supported-os.adoc index cddd306f1..f128d99cc 100644 --- a/modules/ROOT/pages/_partials/sgw-supported-os.adoc +++ b/modules/ROOT/pages/_partials/sgw-supported-os.adoc @@ -13,11 +13,11 @@ | CentOS | 7.x and 8.x -| Ubuntu +.2+| Ubuntu | 20.04 LTS and 18.04 | 16.04 -- deprecated at {version-full} -| Debian +.2+| Debian | 10.x and 9.x | 8.x -- deprecated at {version-full} @@ -35,8 +35,12 @@ a| 2019 + [cols="50,50,135",options="header"] |=== | Platform| Operating System | Supported Versions -|AWS -|Amazon Linux AMI + +.2+|AWS + +|Amazon Linux 2 +a|LTS +|Amazon Linux 2 Graviton 2 footnote:[Developer Preview] a|LTS |Azure @@ -63,12 +67,13 @@ a|Ubuntu // tag::sup-os-dev-test[] .Supported Operating Systems for Development and Testing Only -[cols="100,135",options="header"] +[cols="1,2",options="header"] |=== | Operating System | Supported Versions | macOS -a| 11.x (Big Sur) + +| 11.x (Big Sur) + +11.x (Big Sur) M1 footnote:[Developer Preview] + 10.15(Catalina) | Windows Desktop diff --git a/modules/ROOT/pages/supported-environments.adoc b/modules/ROOT/pages/supported-environments.adoc index 9b96e40fd..e5a013ee3 100644 --- a/modules/ROOT/pages/supported-environments.adoc +++ b/modules/ROOT/pages/supported-environments.adoc @@ -40,6 +40,20 @@ Nodes in a Sync Gateway cluster should all be running on the same OS, and every include::partial$sgw-supported-os.adoc[tag=supported] + +.Developer Preview Versions +[NOTE] +-- +Developer previews of {sgw-t} {version-full} are available for: + +* _Amazon{nbsp}Linux{nbsp}2{nbsp}Graviton{nbsp}2_ +https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-community_3.0.0-beta01_aarch64.rpm[Community] | +https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-enterprise_3.0.0-beta01_aarch64.rpm[Enterprise] + +* _Apple M1_ https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-community_3.0.0-beta01_arm64.zip[Community] | +https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-enterprise_3.0.0-beta01_arm64.zip[Enterprise] +-- + + == Deprecated Versions Deprecated versions will be removed in a future release and we recommend that you plan to migrate away from the deprecated OS versions. From 89b2f93a39b7e1ef9232606ad688e9ae5aaa1f8d Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:26 +0100 Subject: [PATCH 07/11] DOC-9272-C10 -- B.10--SGW Breaking changes feedback https://issues.couchbase.com/browse/DOCS-9272 (cherry picked from commit 446fd7f7b206c7992eaea12aebb64f40fbeec927) --- .../pages/_partials/_related-content.adoc | 16 ++- .../pages/get-started-verify-install.adoc | 2 +- modules/ROOT/pages/release-notes.adoc | 103 +++++++++++++----- .../ROOT/pages/supported-environments.adoc | 8 +- 4 files changed, 94 insertions(+), 35 deletions(-) diff --git a/modules/ROOT/pages/_partials/_related-content.adoc b/modules/ROOT/pages/_partials/_related-content.adoc index e7d7c62f1..9f9a42582 100644 --- a/modules/ROOT/pages/_partials/_related-content.adoc +++ b/modules/ROOT/pages/_partials/_related-content.adoc @@ -48,13 +48,20 @@ // tag::reference-icr[] // tag::reference-config[] -* {configuration-properties--xref} + + * xref:configuration-schema-bootstrap.adoc[Bootstrap] + * xref:configuration-schema-database.adoc[Database] + * xref:configuration-schema-db-security.adoc[Database Security] + * xref:configuration-schema-access-control.adoc[Access Control] + * xref:configuration-schema-import-filter.adoc[Import Filter] + * xref:configuration-schema-isgr.adoc[Inter-Sync{nbsp}Gateway Replication] + * xref:configuration-properties.adoc[Legacy Pre-3.0 BETA Configuration] + // end::reference-config[] // tag::reference-api[] * {rest-api--xref} * {rest-api-admin--xref} * {rest-api-metrics--xref} -* {rest-api-client-app--xref} // end::reference-api[] // end::reference-icr[] @@ -90,8 +97,9 @@ Blog Entries // tag::concept-syncfunc[] -* {xref-sgw-pg-icr-sgreplicate} -* {xref-sgw-pg-shared-bucket-access} + * xref:configuration-schema-access-control.adoc[Access Control] + * xref:rest-api-admin.html#/Access_Control/update_sync_function[Add/Update Sync Function] + * xref:sync-function-overview.adoc[Sync Function Overview] // end::concept-syncfunc[] // tag::null-content[] diff --git a/modules/ROOT/pages/get-started-verify-install.adoc b/modules/ROOT/pages/get-started-verify-install.adoc index 3671a98d5..a2398f267 100644 --- a/modules/ROOT/pages/get-started-verify-install.adoc +++ b/modules/ROOT/pages/get-started-verify-install.adoc @@ -81,7 +81,7 @@ About the Configuration Properties:: <.> Here we point to the Couchbase Server cluster using secure connection. Server ships with self signed certs that work out of the box, as long as `server_tls_skip_verify` is set, as it is below. <.> Here we provide the credentials for the RBAC user that you created on the Couchbase Server Admin Console -- see {get-started-prepare--config-server--xref} <.> Here we opt to ignore CA Cert verification of the certificate presented by the server; allowing for example use of self-signed certificate. The connection is unverified but encrypted. -<.> Optionally, you can choose to run without TLS, in which case you should also use `couchbase//localhost` for connection +<.> Optionally, you can choose to run without TLS, in which case you should also use `couchbase://localhost` for connection <.> Define your logging requirements: + Here we set general diagnostic console logs on. If you're having issues then refer to {logging--xref} for how to tune diagnostics to provide additional troubleshooting help diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index 8df0204ce..a779147bc 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -189,58 +189,109 @@ xref:whatsnew.adoc#use-environment-variables-in-configuration-file[Read More ... // – identify any REST API changes // tag::api-changes-300[] // tag::all-changed-300-api[] -This release introduces significant configuration and persistent API changes; some of which may be breaking changes if then impact a feature you rely on -- see the items identified in <>. +This release introduces significant configuration and persistent API changes; some of which may be breaking changes if they impact a feature you rely on -- see the items identified in <> | <> | <>. -.Potential Breaking Changes -[#tbl-breaking, cols="2a,2a,1a", options="header"] +=== Breaks compatibility + +.Breaks compatibility +[#tbl-breaking, cols="1a,1a", options="header"] |=== +.>| Feature +.>| Link + +// | Cannot start sync gateway in CLI without providing either a configuration file or a CLI flag +// | + +| enable_shared_bucket_access -- enabled by default -| Feature | Link ^| Status +The change _ought to be_ transparent to the user, *if*: -| SG-Replicate | xref:2.8@sync-gateway:ROOT:legacy-sg-replicate.adoc[Legacy -- SG-Replicate] | Dropped +* Doc metadata is smaller than 1MB +* There is no reliance on inspecting doc metadata using the `_sync` property in a document on the server side -| enable_shared_bucket_access -- enabled by default | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-enable_shared_bucket_access[enable_shared_bucket_access] | breaks compatibility +Old documents are automatically migrated to the `xattr` metadata format. -| enable_shared_bucket_access -- disabled option | | Deprecated +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-enable_shared_bucket_access[enable_shared_bucket_access] -| admin UI | | Dropped +| Enforce TLS by default +| xref:secure-sgw-access.html#lbl-cbs-comms[Couchbase Server Connection] -| logging.default config section | xref:legacy-logging-pre2-1.adoc[Legacy - Pre-2.1 Logging] | Dropped +|=== + +=== Deprecated -| configServer property | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#configServer[configserver] | Dropped +.Deprecated +[#tbl-deprecated, cols="1a,1a", options="header"] +|=== +.>| Feature +.>| Link -| old cache config values :databases.this_db.cache.max_wait_pending | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_pending[db-cache-max_wait_pending] | Dropped +| allow_conflicts confg +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-allow_conflicts[allow_conflicts] -| old cache config values :databases.this_db.cache.max_num_pending | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_num_pending[max_num_pending] | Dropped +| enable_shared_bucket_access -- disabled option +| -| old cache config values :databases.this_db.cache.max_wait_skipped | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_skipped[max_num_skipped] | Dropped +| Facebook User Auth Config +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#facebook[facebook] + +| Google User Auth Config +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#facebook[Google] + +| Logging API +| +| Deprecated +|=== + +=== Dropped or removed +.Dropped or removed +[#tbl-dropped, cols="1a,1a", options="header"] +|=== +.>| Feature +.>| Link -| old cache config values :databases.this_db.cache.enable_star_channel | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-enable_star_channel[enable_star_channel] | Dropped +| admin UI +| -| old cache config values :databases.this_db.cache.channel_cache_max_length | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_max_length[channel_cache_max_length] | Dropped +| configServer property +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#configServer[configserver] -| old cache config values :databases.this_db.cache.channel_cache_min_length | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_min_length[channel_cache_min_length] | Dropped +| databases.this_db.cache.channel_cache_expiry +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_expiry[channel_cache_expiry] -| databases.this_db.cache.channel_cache_expiry | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_expiry[channel_cache_expiry] | Dropped +| databases.this_db.feed_type +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-feed_type[feed_type] -| databases.this_db.feed_type | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-feed_type[feed_type] | Dropped +| logging.default config section +| xref:legacy-logging-pre2-1.adoc[Legacy - Pre-2.1 Logging] -| old cache config values: databases.this_db.rev_cache_size | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-rev_cache_size[rev_cache_size] | Dropped +| old cache config values :databases.this_db.cache.channel_cache_max_length +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_max_length[channel_cache_max_length] -| Facebook User Auth Config | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#facebook[facebook] | Deprecated +| old cache config values :databases.this_db.cache.channel_cache_min_length +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_min_length[channel_cache_min_length] -| Google User Auth Config | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#facebook[Google] | Deprecated +| old cache config values :databases.this_db.cache.enable_star_channel +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-enable_star_channel[enable_star_channel] -| allow_conflicts confg | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-allow_conflicts[allow_conflicts] | Deprecated +| old cache config values :databases.this_db.cache.max_num_pending +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_num_pending[max_num_pending] -| walrus (should not be default database mode) | xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-server[server] | Dropped +| old cache config values :databases.this_db.cache.max_wait_pending +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_pending[db-cache-max_wait_pending] -| Enforce TLS by default | | breaks compatibility +| old cache config values :databases.this_db.cache.max_wait_skipped +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_skipped[max_num_skipped] -| Cannot start sync gateway in CLI without any config options | | breaks compatibility +| old cache config values: databases.this_db.rev_cache_size +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-rev_cache_size[rev_cache_size] -| Logging API | | Deprecated +| SG-Replicate +| xref:2.8@sync-gateway:ROOT:legacy-sg-replicate.adoc[Legacy -- SG-Replicate] +| walrus (should not be default database mode) +| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-server[server] +| Dropped |=== diff --git a/modules/ROOT/pages/supported-environments.adoc b/modules/ROOT/pages/supported-environments.adoc index e5a013ee3..bf3fe026a 100644 --- a/modules/ROOT/pages/supported-environments.adoc +++ b/modules/ROOT/pages/supported-environments.adoc @@ -47,10 +47,10 @@ include::partial$sgw-supported-os.adoc[tag=supported] Developer previews of {sgw-t} {version-full} are available for: * _Amazon{nbsp}Linux{nbsp}2{nbsp}Graviton{nbsp}2_ -https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-community_3.0.0-beta01_aarch64.rpm[Community] | -https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-enterprise_3.0.0-beta01_aarch64.rpm[Enterprise] + -* _Apple M1_ https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-community_3.0.0-beta01_arm64.zip[Community] | -https://packages.couchbase.com/releases/couchbase-sync-gateway/3.0.0-beta01/couchbase-sync-gateway-enterprise_3.0.0-beta01_arm64.zip[Enterprise] +https://packages.couchbase.com/releases/couchbase-sync-gateway/{version-full}/couchbase-sync-gateway-community_{version-full}_aarch64.rpm[Community] | +https://packages.couchbase.com/releases/couchbase-sync-gateway/{version-full}/couchbase-sync-gateway-enterprise_{version-full}_aarch64.rpm[Enterprise] + +* _Apple M1_ https://packages.couchbase.com/releases/couchbase-sync-gateway/{version-full}/couchbase-sync-gateway-community_{version-full}_arm64.zip[Community] | +https://packages.couchbase.com/releases/couchbase-sync-gateway/{version-full}/couchbase-sync-gateway-enterprise_{version-full}_arm64.zip[Enterprise] -- From cac6c9b44738856fdfe604781eab94c7108b5a20 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:26 +0100 Subject: [PATCH 08/11] DOC-9302 -- Add use_tls_server and server_tls_skip_verify to legacy config https://issues.couchbase.com/browse/DOC-9302 (cherry picked from commit b9d378a5be92d292494f245682713393c2a02155) --- .../configuration-properties-legacy.yaml | 17 ++++++++++++++--- .../ROOT/pages/_partials/_attributes-local.adoc | 4 ++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml b/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml index c4582ae6f..45fda0152 100644 --- a/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml +++ b/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml @@ -5,7 +5,7 @@ properties: default: '127.0.0.1:4985' admin_interface_authentication: type: boolean - default: true + default: 'true' description: |+ Use `admin_interface_authentication=false` to turn of the secure remote administration feature introduced in 3.0 BETA. @@ -28,7 +28,7 @@ properties: metrics_interface_authentication: type: boolean - default: true + default: 'true' description: |+ Use `metrics_interface_authentication=false` to turn of the secure remote administration feature introduced in 3.0 BETA. @@ -1346,7 +1346,7 @@ properties: disable_persistent_config: type: boolean - default: false + default: 'false' description: |+ Set to true to disable the persistent configuration handling introduced in 3.0 BETA facebook: @@ -1701,6 +1701,17 @@ properties: description: Log warnings if N1QL or View queries made by Sync Gateway take this many milliseconds or longer. type: integer default: 500 + server_tls_skip_verify: + description: |+ + Allow empty server CA Cert Path without attempting to use system root pool. + type: boolean + default: 'false' + use_tls_server: + description: |+ + Use TLS for CBS to-from SGW communications + type: boolean + default: 'true' + SSLCert: description: Absolute or relative path on the filesystem to the TLS certificate file, if TLS is used to secure Sync Gateway connections, or "nil" for plaintext. A relative path is from the directory that contains the Sync Gateway executable file. type: string diff --git a/modules/ROOT/pages/_partials/_attributes-local.adoc b/modules/ROOT/pages/_partials/_attributes-local.adoc index 4d9483674..7faa4e47d 100644 --- a/modules/ROOT/pages/_partials/_attributes-local.adoc +++ b/modules/ROOT/pages/_partials/_attributes-local.adoc @@ -56,7 +56,7 @@ :xref-pfx-cao: xref:{component-cao}: // :xref-pfx-shared: xref:{component-mob}: -:xref-url-cb-downloads: {url-cb-downloads}[Couchbase Downloads page] +:xref-url-mobile-downloads: {url-mobile-downloads}[Couchbase Downloads page] :xref-url-cb-blog: {url-cb-blog}[Blog] :xref-url-cb-forum: {url-cb-forum}[Forum] :xref-url-cb-forum-mobile: {url-cb-forum-mobile}[Forum] @@ -88,7 +88,7 @@ :url-cb-pfx: https://www.couchbase.com/ :url-cb-jira: https://issues.couchbase.com/browse :url-cb-issues-sync: https://github.com/couchbase/sync_gateway/issues -:url-cb-downloads: {url-cb-pfx}downloads/?family=mobile +:url-mobile-downloads: {url-cb-pfx}downloads/?family=mobile :url-cb-package-downloads: http://packages.couchbase.com/releases/couchbase-sync-gateway :url-cb-blog: https://blog.couchbase.com/ :url-cb-forum: https://forums.couchbase.com/ From e8358e4e2db6c36e115cb5f5d7550b93b59c886a Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:26 +0100 Subject: [PATCH 09/11] DOC-9304 -- Add max_concurrent_query_ops Sets the maximum number of concurrent query operations allowed https://issues.couchbase.com/browse/DOC-9304 (cherry picked from commit de5aeedc86171ab9c803b0aaa1b9592393906663) --- .../configuration-properties-legacy.yaml | 7 ++++- .../ROOT/assets/attachments/sg-bootstrap.yaml | 26 +++++++++++-------- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml b/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml index 45fda0152..7cbffa855 100644 --- a/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml +++ b/modules/ROOT/assets/attachments/configuration-properties-legacy.yaml @@ -865,7 +865,12 @@ properties: description: |+ The view query timeout in seconds. This property allows you to specify the time Sync Gateway should wait for a view query response from Couchbase Server before it times out. The timeout is used for both view and N1QL queries issued by Sync Gateway. default: 75 - # + max_concurrent_query_ops: + description: |+ + Sets the maximum number of concurrent query operations allowed + type: integer + default: 1000 + # # END : Define Server # container: diff --git a/modules/ROOT/assets/attachments/sg-bootstrap.yaml b/modules/ROOT/assets/attachments/sg-bootstrap.yaml index 3ae12f6d9..4917ff5d0 100644 --- a/modules/ROOT/assets/attachments/sg-bootstrap.yaml +++ b/modules/ROOT/assets/attachments/sg-bootstrap.yaml @@ -83,7 +83,7 @@ properties: use_tls_server: type: boolean - default: true + default: 'true' description: |+ Default to `true`, which forces the connection to Couchbase Server to use TLS. @@ -93,7 +93,11 @@ properties: If the scheme used does not match that indicated by the `use_tls_server` value (for example, `couchbases://` with `use_tls_server` = `false`) then Sync Gateway will error and refuse to start. - Use in conjunction with + max_concurrent_query_ops: + description: |+ + Sets the maximum number of concurrent query operations allowed + type: integer + default: 1000 api: type: object @@ -112,7 +116,7 @@ properties: Change requires restart of Admin API admin_interface_authentication: type: boolean - default: true + default: 'true' description: |+ Use the `admin_interface_authentication` property to disable authentication for the metrics API. This option should be used with discretion and only in test environments. @@ -132,7 +136,7 @@ properties: ```"metricsInterface": "127.0.0.1:4986"``` metrics_interface_authentication: type: boolean - default: true + default: 'true' description: |+ Use the `metrics_interface_authentication` property to disable authentication for the metrics API. This option should be used with discretion and only in test environments. @@ -215,7 +219,7 @@ properties: description: An allowed origin array element hide_product_version: type: boolean - default: false + default: 'false' description: |+ Determines whether product versions are removed from Server headers and REST API responses. This setting does not apply to the Admin REST API. @@ -227,7 +231,7 @@ properties: properties: # allow_insecure_tls_connections: # type: boolean - # default: false + # default: 'false' # description: |+ # Secure TLS connections are used by default for all REST API dialogs. @@ -287,7 +291,7 @@ properties: Change requires HTTP server restart pretty: type: boolean - default: false + default: 'false' description: |+ (**Deprecated**) Whether to pretty-print JSON responses. @@ -616,7 +620,7 @@ properties: properties: enabled: type: boolean - default: true + default: 'true' description: |+ Whether to enable this log level. @@ -659,7 +663,7 @@ properties: properties: enabled: type: boolean - default: false + default: 'false' description: |+ Sets this logging-level on or off. @@ -819,12 +823,12 @@ properties: http2.enabled: type: boolean - default: false + default: 'false' description: use_stdlib_json: type: boolean - default: false + default: 'false' description: From 2aad47d91d72685afda03ab1d17bcfa9c331df67 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:26 +0100 Subject: [PATCH 10/11] QF211019-1 -- Fix release date (cherry picked from commit 7a20f66cc671edaa3a6a37c20e3017a364f18cf7) --- modules/ROOT/pages/release-notes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index a779147bc..e322424a0 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -44,7 +44,7 @@ The migration to 3.0 BETA configuration is a ONE WAY process -- see: {upgrading- [#lbl-rel300] -== Release {version-full} -- September 2021 +== Release {version-full} -- October 2021 Quicklinks: <> *|* <> *|* <> *|* From 631fe1fbbc22103298e818a5967bcbe653e46836 Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 19 Oct 2021 22:49:26 +0100 Subject: [PATCH 11/11] DOC-9047-C48 -- RN Issue List Updates https://issues.couchbase.com/browse/DOC-9047 (cherry picked from commit 8b89a92dc9aef4c5f7195e7ea3942451c76b2bf2) --- .../ROOT/pages/_partials/pn-issues-list.adoc | 198 +++++++++--------- 1 file changed, 95 insertions(+), 103 deletions(-) diff --git a/modules/ROOT/pages/_partials/pn-issues-list.adoc b/modules/ROOT/pages/_partials/pn-issues-list.adoc index e224d26a0..bef99f053 100644 --- a/modules/ROOT/pages/_partials/pn-issues-list.adoc +++ b/modules/ROOT/pages/_partials/pn-issues-list.adoc @@ -1,104 +1,96 @@ -// Sync Gateway Issues List - -// tag::enhancements[] -* https://issues.couchbase.com/browse/CBG-1022[CBG-1022] -- Require replication to be stopped prior to upsert -* https://issues.couchbase.com/browse/CBG-921[CBG-921] -- Ignore transaction ATR documents during DCP processing -* https://issues.couchbase.com/browse/CBG-905[CBG-905] -- Support using custom OIDC claim as Sync Gateway username -* https://issues.couchbase.com/browse/CBG-880[CBG-880] -- Python 3 support for sgcollect -* https://issues.couchbase.com/browse/CBG-877[CBG-877] -- Remove inappropriate logging warning related JSON parsing from ReadJSONFromMIME when request body is empty -* https://issues.couchbase.com/browse/CBG-876[CBG-876] -- Include Bearer prefix when sending token base authentication request in OIDC E2E tests -* https://issues.couchbase.com/browse/CBG-864[CBG-864] -- Improve addJSON-related error handling -* https://issues.couchbase.com/browse/CBG-821[CBG-821] -- Limit on channel queries triggered by 2.x replication -* https://issues.couchbase.com/browse/CBG-820[CBG-820] -- Add state for OIDC auth code authentication -* https://issues.couchbase.com/browse/CBG-803[CBG-803] -- Support for OIDC provider config refresh -* https://issues.couchbase.com/browse/CBG-802[CBG-802] -- Being able to configure OIDC Test Provider with HTTPS -* https://issues.couchbase.com/browse/CBG-801[CBG-801] -- Auto-generated OIDC callback URL should include provider when non-default -* https://issues.couchbase.com/browse/CBG-800[CBG-800] -- OnDemandImportForWrite bypasses migrate handling -* https://issues.couchbase.com/browse/CBG-752[CBG-752] -- sgcollect: Re-gzip rotated logfiles post-redaction, clean up intermediate extracted files -* https://issues.couchbase.com/browse/CBG-751[CBG-751] -- Improve REST-based sgcollect_info options validation -* https://issues.couchbase.com/browse/CBG-719[CBG-719] -- Update OIDC library -* https://issues.couchbase.com/browse/CBG-714[CBG-714] -- Log warning on ignored, invalid channel data -* https://issues.couchbase.com/browse/CBG-709[CBG-709] -- Inter-Sync Gateway Replication -* https://issues.couchbase.com/browse/CBG-697[CBG-697] -- SGW startup routine could use more retry logic while CBS warms up -* https://issues.couchbase.com/browse/CBG-688[CBG-688] -- Improve logging for x.509 connection errors -* https://issues.couchbase.com/browse/CBG-673[CBG-673] -- Include USE INDEX hint with channel queries -* https://issues.couchbase.com/browse/CBG-665[CBG-665] -- Make trace level logging a typical file logger -* https://issues.couchbase.com/browse/CBG-664[CBG-664] -- Enhance trace logging for blip messages -* https://issues.couchbase.com/browse/CBG-658[CBG-658] -- Optimize LogKey string lookup -* https://issues.couchbase.com/browse/CBG-653[CBG-653] -- Add 'norev' BLIP handler to log detailed error information -* https://issues.couchbase.com/browse/CBG-640[CBG-640] -- Wrong content type for _user and _role -* https://issues.couchbase.com/browse/CBG-633[CBG-633] -- Clean up duplicate db definitions in blipHandler/blipSyncContext -* https://issues.couchbase.com/browse/CBG-630[CBG-630] -- Validate whether multiple databases connect to the same bucket -* https://issues.couchbase.com/browse/CBG-624[CBG-624] -- Add database config option for HttpOnly cookies -* https://issues.couchbase.com/browse/CBG-622[CBG-622] -- Use secure cookies when SG is configured to listen over TLS -* https://issues.couchbase.com/browse/CBG-600[CBG-600] -- sgcollect_info TMPDIR setting should be a real argument -* https://issues.couchbase.com/browse/CBG-585[CBG-585] -- Avoid log redaction cost via UD/MD/SD when log-level disabled -* https://issues.couchbase.com/browse/CBG-581[CBG-581] -- Write simple JSON HTTP responses directly as raw bytes -* https://issues.couchbase.com/browse/CBG-437[CBG-437] -- Return error when receiving deltas for deltaSrc revisions which are tombstoned - -// end::enhancements[] - -// tag::deprecated[] -// tag::dnsgw-28[] all deprecations for the release -// tag::dnsgw-28-001-sgr1[] -== SG{nbsp}Replicate replication protocol -// tag::dnsgw-28-001-sgr1-announce[] -SG{nbsp}Replicate is deprecated in Sync Gateway version 2.8. -You should plan your transition to inter-Sync Gateway replication now to avoid potential issues when this functionality is removed -- see https://issues.couchbase.com/browse/CBG-904?src=confmacro[CBG-904] -// end::dnsgw-28-001-sgr1-announce[] - -// tag::dnsgw-28-001-sgr1-impact[] -The functionality of SG{nbsp}Replicate remains unchanged, unless explicitly stated in these release notes and-or in the appropriate documentation section. -Refer to {xref-sgw-pg-upgrade} for more information on upgrading from SG Replicate to Inter-Sync Gateway replication. -// end::dnsgw-28-001-sgr1-impact[] - -== Configuration deprecations -// tag::dnsgw-28-001-sgr1-specifics[] -// tag::dnsgw-28-001-sgr1-cfg[] -https://issues.couchbase.com/browse/CBG-904[CBG-904] -- The SG Replicate configuration method is deprecated at version 2.8. - -Replications configured at the configuration file's root level will continue to function, but you should configure new replications under the appropriate database using the `databases.{dbname}.replications.{replication_id}` property. - -// end::dnsgw-28-001-sgr1-cfg[] - -== REST API Deprecations -// tag::dnsgw-28-001-sgr1-endpoints[] -https://issues.couchbase.com/browse/CBG-904[CBG-904] These SG Replicate REST endpoints are deprecated: - -* `_active_tasks` -- superseded by new monitoring endpoint -* `_replicate` -- superseded by the `_replication` endpoint - -// end::dnsgw-28-001-sgr1-endpoints[] -// end::dnsgw-28-001-sgr1-specifics[] -// end::dnsgw-28-001-sgr1 - -== Operating Systems -Support for Microsoft Windows 2012 (64-bit) is deprecated - -// end::dnsgw-28[] -// end::deprecated[] - -// tag::fixed[] -* https://issues.couchbase.com/browse/CBG-1072[CBG-1072] -- CAS race can result in unordered recentSequences -* https://issues.couchbase.com/browse/CBG-983[CBG-983] -- _all_docs with keys parameter not returning revID -* https://issues.couchbase.com/browse/CBG-951[CBG-951] -- Deleted documents should set _deleted:true for import filter function -* https://issues.couchbase.com/browse/CBG-946[CBG-946] -- Repeated change entries on access grant to doc's previous channel -* https://issues.couchbase.com/browse/CBG-926[CBG-926] -- User name not being logged for initial HTTP request -* https://issues.couchbase.com/browse/CBG-819[CBG-819] -- Generate empty delta as {} instead of null -* https://issues.couchbase.com/browse/CBG-812[CBG-812] -- Running compact when UseViews=true causes an infinite loop -* https://issues.couchbase.com/browse/CBG-744[CBG-744] -- OldDoc body in sync function for tombstone resurrections does not contain _deleted=true -* https://issues.couchbase.com/browse/CBG-743[CBG-743] -- Doc body in sync function contains _deleted=false -* https://issues.couchbase.com/browse/CBG-741[CBG-741] -- 403 Attachment's doc not being synced during CBL replication -* https://issues.couchbase.com/browse/CBG-731[CBG-731] -- Channels query performance degradation when using limit -* https://issues.couchbase.com/browse/CBG-727[CBG-727] -- Panic when connecting to non-standard memcached port using couchbase(s):// scheme -* https://issues.couchbase.com/browse/CBG-695[CBG-695] -- Alternate addresses are always used if defined instead of applying heuristic -* https://issues.couchbase.com/browse/CBG-661[CBG-661] -- Errors from REST API produce invalid JSON - -// end::fixed[] - -// tag::knownissues[] -* https://issues.couchbase.com/browse/CBG-1127[CBG-1127] -- Treat resurrected tombstones as non-conflict when no shared history -* https://issues.couchbase.com/browse/CBG-798[CBG-798] -- Sync Gateway requires Couchbase Server nodes to use the same SSL memcached port - -// end::knownissues[] += Release Note issues for SG + +// tag::issues-3-0-0-beta[] + + +== Fixed + +// tag::Fixed-3-0-0-beta[] + +* https://issues.couchbase.com//browse/CBG-1438[CBG-1438] -- https://issues.couchbase.com//browse/CBG-1438[SgwIntStat.SetIfMax incorrectly sums old and new values] +* https://issues.couchbase.com//browse/CBG-1412[CBG-1412] -- https://issues.couchbase.com//browse/CBG-1412[JSON strings in some responses not being correctly escaped] +* https://issues.couchbase.com//browse/CBG-1388[CBG-1388] -- https://issues.couchbase.com//browse/CBG-1388[sg_collect does not package archived log files (*.log.gz)] +* https://issues.couchbase.com//browse/CBG-1376[CBG-1376] -- https://issues.couchbase.com//browse/CBG-1376[Some Delta Sync errors logged at WARN level should be DEBUG] +* https://issues.couchbase.com//browse/CBG-1339[CBG-1339] -- https://issues.couchbase.com//browse/CBG-1339[Creating mobile tombstone for existing CBS tombstone causes loop] +* https://issues.couchbase.com//browse/CBG-1335[CBG-1335] -- https://issues.couchbase.com//browse/CBG-1335[Mutating _rev on localDocument in conflict resolver results in merge error] +* https://issues.couchbase.com//browse/CBG-1325[CBG-1325] -- https://issues.couchbase.com//browse/CBG-1325[Incorrect email validation (too strict)] +* https://issues.couchbase.com//browse/CBG-1304[CBG-1304] -- https://issues.couchbase.com//browse/CBG-1304[ISGR: Pull replications incompatible with active-side allow_conflicts=false] +* https://issues.couchbase.com//browse/CBG-1246[CBG-1246] -- https://issues.couchbase.com//browse/CBG-1246[Changes limit incorrectly applied in case of CBG-946] +* https://issues.couchbase.com//browse/CBG-1231[CBG-1231] -- https://issues.couchbase.com//browse/CBG-1231[Prevent import cfg startup races] +* https://issues.couchbase.com//browse/CBG-1200[CBG-1200] -- https://issues.couchbase.com//browse/CBG-1200[Calling DELETE on a non-existent document creates a tombstone with empty body] +* https://issues.couchbase.com//browse/CBG-1172[CBG-1172] -- https://issues.couchbase.com//browse/CBG-1172[ISGR credentials with characters requiring URL encoding cause blipsync to fail] +* https://issues.couchbase.com//browse/CBG-1161[CBG-1161] -- https://issues.couchbase.com//browse/CBG-1161[DefaultPurgeInterval specified in days and used as though in hours] +* https://issues.couchbase.com//browse/CBG-1113[CBG-1113] -- https://issues.couchbase.com//browse/CBG-1113[CBL1.x/Websocket based changes feeds leak goroutine on disconnect] +* https://issues.couchbase.com//browse/CBG-789[CBG-789] -- https://issues.couchbase.com//browse/CBG-789[Updating a blob with new data does not update SG's metadata on sync] +// end::Fixed-3-0-0-beta[] + + +== Enhancements + +// tag::Enhancements-3-0-0-beta[] + +* https://issues.couchbase.com//browse/CBG-1705[CBG-1705] -- https://issues.couchbase.com//browse/CBG-1705[Release 'view op' on results close] +* https://issues.couchbase.com//browse/CBG-1679[CBG-1679] -- https://issues.couchbase.com//browse/CBG-1679[Apply standardised timeout and retry for all bootstrap connection ops] +* https://issues.couchbase.com//browse/CBG-1672[CBG-1672] -- https://issues.couchbase.com//browse/CBG-1672[Return 422 status for unprocessible deltas instead of 404 to use non-delta retry handling] +* https://issues.couchbase.com//browse/CBG-1664[CBG-1664] -- https://issues.couchbase.com//browse/CBG-1664[Validate javascript syntax in DbConfig.validate()] +* https://issues.couchbase.com//browse/CBG-1659[CBG-1659] -- https://issues.couchbase.com//browse/CBG-1659[SGCollect - Ensure it works / change for admin auth] +* https://issues.couchbase.com//browse/CBG-1650[CBG-1650] -- https://issues.couchbase.com//browse/CBG-1650[sgcollect should get information from new endpoints (with include_runtime parameter, etc.)] +* https://issues.couchbase.com//browse/CBG-1646[CBG-1646] -- https://issues.couchbase.com//browse/CBG-1646[Add a flag to non-active leaf revisions indicating whether they include v2 attachments] +* https://issues.couchbase.com//browse/CBG-1643[CBG-1643] -- https://issues.couchbase.com//browse/CBG-1643[Add additional context for gocb errors when using self-signed cert] +* https://issues.couchbase.com//browse/CBG-1642[CBG-1642] -- https://issues.couchbase.com//browse/CBG-1642[Detect legacy sg-replicate config and log accordingly] +* https://issues.couchbase.com//browse/CBG-1635[CBG-1635] -- https://issues.couchbase.com//browse/CBG-1635[TestBucketPool V2 should close cluster when releasing/obtaining buckets] +* https://issues.couchbase.com//browse/CBG-1590[CBG-1590] -- https://issues.couchbase.com//browse/CBG-1590[Retrieve existing doc metadata prior to calling downloadOrVerifyAttachments] +* https://issues.couchbase.com//browse/CBG-1473[CBG-1473] -- https://issues.couchbase.com//browse/CBG-1473[Enable log redaction by default] +* https://issues.couchbase.com//browse/CBG-1424[CBG-1424] -- https://issues.couchbase.com//browse/CBG-1424[discoverInterfaceName should resolve hostnames before trying to find network interface stats using IP addresses] +* https://issues.couchbase.com//browse/CBG-1391[CBG-1391] -- https://issues.couchbase.com//browse/CBG-1391[Treat existing cbgt index as recoverable error] +* https://issues.couchbase.com//browse/CBG-1390[CBG-1390] -- https://issues.couchbase.com//browse/CBG-1390[Add warning threshold for excessively large number of channels per user] +* https://issues.couchbase.com//browse/CBG-1359[CBG-1359] -- https://issues.couchbase.com//browse/CBG-1359[Increase default minimum TLS version TLS1.2] +* https://issues.couchbase.com//browse/CBG-1343[CBG-1343] -- https://issues.couchbase.com//browse/CBG-1343[Increase initial wait time for index creation retry] +* https://issues.couchbase.com//browse/CBG-1342[CBG-1342] -- https://issues.couchbase.com//browse/CBG-1342[Avoid retry on 'duplicate index name' index creation error] +* https://issues.couchbase.com//browse/CBG-1337[CBG-1337] -- https://issues.couchbase.com//browse/CBG-1337[Add an option to skip SSL certificates verification while loading JavaScript from HTTPS endpoints] +* https://issues.couchbase.com//browse/CBG-1326[CBG-1326] -- https://issues.couchbase.com//browse/CBG-1326[Log if channels expand to a smaller set than requested] +* https://issues.couchbase.com//browse/CBG-1301[CBG-1301] -- https://issues.couchbase.com//browse/CBG-1301[Persistent Config] +* https://issues.couchbase.com//browse/CBG-1299[CBG-1299] -- https://issues.couchbase.com//browse/CBG-1299[[Lithium Port] - Implement network connstr flag for cbdatasource alt address shims] +* https://issues.couchbase.com//browse/CBG-1282[CBG-1282] -- https://issues.couchbase.com//browse/CBG-1282[XATTRS Access Grants] +* https://issues.couchbase.com//browse/CBG-1280[CBG-1280] -- https://issues.couchbase.com//browse/CBG-1280[Channel Access Revocation] +* https://issues.couchbase.com//browse/CBG-1273[CBG-1273] -- https://issues.couchbase.com//browse/CBG-1273[Add Prometheus alert examples] +* https://issues.couchbase.com//browse/CBG-1253[CBG-1253] -- https://issues.couchbase.com//browse/CBG-1253[Add USE INDEX to index readiness queries] +* https://issues.couchbase.com//browse/CBG-1251[CBG-1251] -- https://issues.couchbase.com//browse/CBG-1251[Support Apple (M1) Silicon] +* https://issues.couchbase.com//browse/CBG-1245[CBG-1245] -- https://issues.couchbase.com//browse/CBG-1245[Include channel name in validfrom logging] +* https://issues.couchbase.com//browse/CBG-1240[CBG-1240] -- https://issues.couchbase.com//browse/CBG-1240[Remove couchbase/ns_server dependency] +* https://issues.couchbase.com//browse/CBG-1239[CBG-1239] -- https://issues.couchbase.com//browse/CBG-1239[Remove couchbase/retriever dependency] +* https://issues.couchbase.com//browse/CBG-1232[CBG-1232] -- https://issues.couchbase.com//browse/CBG-1232[Add support for loading webhook filter JavaScript from external file or URL] +* https://issues.couchbase.com//browse/CBG-1217[CBG-1217] -- https://issues.couchbase.com//browse/CBG-1217[Ensure change listener goroutines terminates (both Tap and DCP feeds) before the server is stopped] +* https://issues.couchbase.com//browse/CBG-1170[CBG-1170] -- https://issues.couchbase.com//browse/CBG-1170[Upgrade to go 1.15] +* https://issues.couchbase.com//browse/CBG-1127[CBG-1127] -- https://issues.couchbase.com//browse/CBG-1127[Treat resurrected tombstones as non-conflict when no shared history] +* https://issues.couchbase.com//browse/CBG-949[CBG-949] -- https://issues.couchbase.com//browse/CBG-949[Improve error when non-upgradable HTTP request is sent to _blipsync endpoint] +* https://issues.couchbase.com//browse/CBG-841[CBG-841] -- https://issues.couchbase.com//browse/CBG-841[Force users to opt in to accepting unsigned tokens from providers in SG's provider config.] +* https://issues.couchbase.com//browse/CBG-715[CBG-715] -- https://issues.couchbase.com//browse/CBG-715[High CPU usage in high volume basic auth scenarios] +* https://issues.couchbase.com//browse/CBG-641[CBG-641] -- https://issues.couchbase.com//browse/CBG-641[Admin API Auth] +* https://issues.couchbase.com//browse/CBG-551[CBG-551] -- https://issues.couchbase.com//browse/CBG-551[Avoid storing _removed:true revision bodies in the revision cache] +// end::Enhancements-3-0-0-beta[] + + +== KI + +// tag::KI-3-0-0-beta[] + +* https://issues.couchbase.com//browse/CBG-798[CBG-798] -- https://issues.couchbase.com//browse/CBG-798[Sync Gateway requires Couchbase Server nodes to use the same SSL memcached port] +// end::KI-3-0-0-beta[] + + +== Deprecated + +// tag::Deprecated-3-0-0-beta[] + +// end::Deprecated-3-0-0-beta[] + + +== Removed + +// tag::Removed-3-0-0-beta[] + +// end::Removed-3-0-0-beta[] + +// end::issues-3-0-0-beta[]