From 2232c126a73f2427d42aac4aea8c7361f8fc118b Mon Sep 17 00:00:00 2001 From: ibsoln <52778946+ibsoln@users.noreply.github.com> Date: Tue, 26 Oct 2021 11:55:37 +0100 Subject: [PATCH] Revert "DOC-9307 -- Release Notes for 2.8.3 (#597)" This reverts commit 122d375611d44dbac57d6167c348d2b0ef7abf1e. --- modules/ROOT/nav.adoc | 5 +- .../pages/_partials/common-release-notes.adoc | 80 --------- .../ROOT/pages/_partials/pn-issues-list.adoc | 154 ++++++++++++------ modules/ROOT/pages/release-notes.adoc | 6 +- 4 files changed, 107 insertions(+), 138 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index e8e5b253b..e7949f4b6 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -54,12 +54,9 @@ include::ROOT:partial$_page-index.adoc[] * {what-are-tombstones--xref} * {revisions--xref} -// - +.{configuration-properties--pfx}[Configuration] * {configuration-properties--pfx}[Configuration] -// - .REST API * {rest-api-access--xref} * {rest-api--xref} diff --git a/modules/ROOT/pages/_partials/common-release-notes.adoc b/modules/ROOT/pages/_partials/common-release-notes.adoc index b968a99e0..7add00afa 100644 --- a/modules/ROOT/pages/_partials/common-release-notes.adoc +++ b/modules/ROOT/pages/_partials/common-release-notes.adoc @@ -23,86 +23,6 @@ include::{root-partials}block-abstract.adoc[] // END DO NOT REMOVE - -[#lbl-rel283] -== Release 2.8.3 (October 2021) -// ==== -// <> *|* <> *|* <> -// ==== -// tag::feature-highlights-283[] -// tag::new-283-all[] - -TIP: Users of earlier Sync Gateway releases should plan to upgrade to this release at the earliest opportunity. - -[#new-features-283] -// === New Features - -// tag::features-283[] -// Metrics REST API:: -// end::features-283[] -// end::new-283-all[] -// end::feature-highlights-283[] - -[#improvements-283] -// tag::other-enhancements-283[] -// tag::other-enhancements-highlights-283[] -// end::other-enhancements-highlights-283[] -// end::other-enhancements-283[] - - -[#issues-and-resolutions-283] -=== Issues and Resolutions -// tag::issue-resolutions-283[] - -// tag::issue-resolutions-summary-283[] -==== Enhancements -* https://issues.couchbase.com//browse/CBG-1665[CBG-1665] -- https://issues.couchbase.com//browse/CBG-1665[Limit the number of open N1QL connections] -* https://issues.couchbase.com//browse/CBG-1444[CBG-1444] -- https://issues.couchbase.com//browse/CBG-1444[- discoverInterfaceName should resolve hostnames before trying to find network interface stats using IP addresses] - -// end::issue-resolutions-summary-283[] - -==== Known Issues - - -// tag::known-283[] -// .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] - -// end::known-283[] - -==== Fixed Issues - -{empty} -// tag::fixed-283[] -// .List of issues resolved by this release -[#tbl-fixed] - -* https://issues.couchbase.com//browse/CBG-1725[CBG-1725] -- https://issues.couchbase.com//browse/CBG-1725[ISGR Pull checkpoint sequences unreliable] -* https://issues.couchbase.com//browse/CBG-1724[CBG-1724] -- https://issues.couchbase.com//browse/CBG-1724[Incorrect email validation (too strict)] -* https://issues.couchbase.com//browse/CBG-1723[CBG-1723] -- https://issues.couchbase.com//browse/CBG-1723[CBL1.x/Websocket based changes feeds leak goroutine on disconnect] -* https://issues.couchbase.com//browse/CBG-1717[CBG-1717] -- https://issues.couchbase.com//browse/CBG-1717[norev message sequence has wrong property name] -* https://issues.couchbase.com//browse/CBG-1696[CBG-1696] -- https://issues.couchbase.com//browse/CBG-1696[Empty query results when using bypass channel cache] -* https://issues.couchbase.com//browse/CBG-1543[CBG-1543] -- https://issues.couchbase.com//browse/CBG-1543[Metrics API port should not serve public API routes] -* https://issues.couchbase.com//browse/CBG-1454[CBG-1454] -- https://issues.couchbase.com//browse/CBG-1454[ISGR: filtered push replication replicates channel removal revisions] -* https://issues.couchbase.com//browse/CBG-1451[CBG-1451] -- https://issues.couchbase.com//browse/CBG-1451[SgwIntStat.SetIfMax incorrectly sums old and new values] -* https://issues.couchbase.com//browse/CBG-1379[CBG-1379] -- https://issues.couchbase.com//browse/CBG-1379[Retry OIDC client initialization when the provider is not reachable ] -* https://issues.couchbase.com//browse/CBG-1362[CBG-1362] -- https://issues.couchbase.com//browse/CBG-1362[Fix cacert-only handling for DCP connection] - -// end::fixed-283[] -// end::issue-resolutions-283[] - -// tag::other-changes -// tag::api-changed-283[] -// tbd -// end::api-changed-283[] - -// tag::cfg-changed-283[] -// tbd -// end::cfg-changed-283[] - -// end::other-changes - - [#lbl-rel282] == Release 2.8.2 (March 2021) // ==== diff --git a/modules/ROOT/pages/_partials/pn-issues-list.adoc b/modules/ROOT/pages/_partials/pn-issues-list.adoc index 75ee6b7f9..e224d26a0 100644 --- a/modules/ROOT/pages/_partials/pn-issues-list.adoc +++ b/modules/ROOT/pages/_partials/pn-issues-list.adoc @@ -1,52 +1,104 @@ -= Release Note issues for SG - -// tag::issues-3-0-0-beta[] - - -== Fixed - -// tag::Fixed-3-0-0-beta[] - -* https://issues.couchbase.com//browse/CBG-1725[CBG-1725] -- https://issues.couchbase.com//browse/CBG-1725[ISGR Pull checkpoint sequences unreliable] -* https://issues.couchbase.com//browse/CBG-1724[CBG-1724] -- https://issues.couchbase.com//browse/CBG-1724[Incorrect email validation (too strict)] -* https://issues.couchbase.com//browse/CBG-1723[CBG-1723] -- https://issues.couchbase.com//browse/CBG-1723[CBL1.x/Websocket based changes feeds leak goroutine on disconnect] -* https://issues.couchbase.com//browse/CBG-1696[CBG-1696] -- https://issues.couchbase.com//browse/CBG-1696[Empty query results when using bypass channel cache] -* https://issues.couchbase.com//browse/CBG-1543[CBG-1543] -- https://issues.couchbase.com//browse/CBG-1543[Metrics API port should not serve public API routes] -* https://issues.couchbase.com//browse/CBG-1451[CBG-1451] -- https://issues.couchbase.com//browse/CBG-1451[SgwIntStat.SetIfMax incorrectly sums old and new values] -* https://issues.couchbase.com//browse/CBG-1379[CBG-1379] -- https://issues.couchbase.com//browse/CBG-1379[Retry OIDC client initialization when the provider is not reachable ] -* https://issues.couchbase.com//browse/CBG-1362[CBG-1362] -- https://issues.couchbase.com//browse/CBG-1362[Fix cacert-only handling for DCP connection] -// end::Fixed-3-0-0-beta[] - - -== Enhancements - -// tag::Enhancements-3-0-0-beta[] - -* https://issues.couchbase.com//browse/CBG-1665[CBG-1665] -- https://issues.couchbase.com//browse/CBG-1665[Limit the number of open N1QL connections] -* https://issues.couchbase.com//browse/CBG-1444[CBG-1444] -- https://issues.couchbase.com//browse/CBG-1444[- discoverInterfaceName should resolve hostnames before trying to find network interface stats using IP addresses] -// 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[] +// 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[] diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index f0dbf40b1..1f413eb78 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -43,9 +43,9 @@ 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 {version} of Couchbase Sync{nbsp}Gateway -// :param-related: {xref-sgw-pg-whatsnew} | {compatibility--xref} | {xref-sgw-pg-supported-os} -// include::partial$block-abstract.adoc[] +:param-abstract: This content describes the key features and changes implemented by release {version} of Couchbase Sync{nbsp}Gateway +:param-related: {xref-sgw-pg-whatsnew} | {compatibility--xref} | {xref-sgw-pg-supported-os} +include::{root-partials}block-abstract.adoc[] // DO NOT EDIT -- Header Content Block include::partial$common-release-notes.adoc[]