CNG

Author: RichardSmedley

modules/hello-world/pages/start-using-sdk.adoc

@@ -240,6 +240,19 @@ Now that you have a `Cluster`, add this code snippet to access your `Bucket`:
 include::devguide:example$StartUsingCapella.java[tag=bucket,indent=0]
 ----
 
+
+
+////
+[TIP]
+.Connecting to Cloud Native Gateway, for Kubernetes or OpenShift
+====
+Couchbase's large number of ports across the URLs of many services can be proxied by using a `couchbase2://` endpoint as the connection string -- read more on the xref:howtos:managing-connections.adoc#cloud-native-gateway[Connections] page.
+====
+////
+
+
+
+
 === Add and Retrieve Documents
 
 The Java SDK supports full integration with the xref:{version-server}@server:learn:data/scopes-and-collections.adoc[Collections] feature introduced in Couchbase Server 7.0.

modules/howtos/pages/error-handling.adoc

@@ -466,3 +466,15 @@ Please note that we do not provide any stability guarantees on the names and val
 | If already sent to a node contains the channel ID that can be used to correlate with the server logs.
 
 |===
+
+
+
+
+
+
+== Cloud Native Gateway
+
+If you connect to the Kubernetes or OpenShift over our xref:howtos:managing-connections.adoc#cloud-native-gateway[CloudNative Gateway], using the new `couchbase2://` endpoints, there are a few changes in the error messages returned.
+
+Some error codes are more generic -- in cases where the client would not be expected to need to take specific action -- but should cause no problem, unless you have written code looking at individual strings within the error messages.
+

modules/howtos/pages/managing-connections.adoc

@@ -230,6 +230,45 @@ E.....@.@.............+....Z.'yZ..#........
 --
 ====
 
+
+
+
+
+== Cloud Native Gateway
+
+
+Couchbase's next generation connection protocol, introduced in Go SDK 2.7 and a future release of Couchbase Autonomous Operator, can be enabled simply by changing the connection string to `couchbase2://` but there are a few differences to be aware of, described <<#limitations,below>>.
+// Couchbase's next generation connection protocol, introduced in Go SDK 2.7 and Couchbase Autonomous Operator 2.6.1, can be enabled simply by changing the connection string to `couchbase2://` but there are a few differences to be aware of, described <<#limitations,below>>.
+
+The protocol implements a gRPC-style interface between the SDK and Couchbase Server (in this case, only available in the Server running on Kubernetes or OpenShift, with a forthcoming release of xref:operator::overview.adoc[Couchbase Autonomous Operator].
+
+
+
+=== Limitations
+
+The protostellar protocol will not work with certain legacy features: MapReduce Views (a deprecated Service -- 
+use xref:howtos:n1ql-queries-with-sdk.adoc[Query] instead) and 
+Memcached buckets (superseded by the improved xref:{server_version}@server:learn:buckets-memory-and-storage/buckets.adoc#bucket-types[Ephemeral Buckets]).
+
+The following are not currently implemented over the `couchbase2://` protocol:
+
+* Authentication by client certificate.
+* Multi-document ACID transactions.
+* Analytics service.
+* Health Check.
+
+There are some different behaviors seen with this protocol:
+
+* Some config options are unsupported -- see the xref:ref:client-settings.adoc#cloud-native-gateway[Settings page].
+* The SDK will poll the gRPC channels until they are in a good state, or return an error, or timeout while waiting -- in our standard protocol there is an option of setting `waitUntilReady()` for just certain services to become available.
+* Some error codes are more generic -- in cases where the client would not be expected to need to take specific action -- but should cause no problem, unless you have written code looking at individual strings within the error messages.
+* Although documents continue to be stored compressed by Couchbase Server, they will not be transmitted in compressed form (to and from the client) over the wire, using `couchbase2://`.
+
+
+
+
+
+
 include::{version-common}@sdk:shared:partial$dnssrv-pars.adoc[tag=dnssrv]
 
 DNS SRV bootstrapping is available in the Java SDK from version 2.1.0.

modules/project-docs/pages/compatibility.adoc

@@ -154,6 +154,7 @@ The downside of these workarounds is potentially reduced performance, which can
 [.table-merge-cells]
 [cols="7,5,6.7"]
 |===
+
 | | Server 6.6 | Server 7.0 & 7.1 | Server 7.2
 
 | Enhanced Durability
@@ -188,7 +189,7 @@ The downside of these workarounds is potentially reduced performance, which can
 
 | Cloud Native Gateway
 2+| Not Supported
-| From SDK 3.5.0 (with xref:operator::overview.adoc[Couchbase Autonomous Operator] 2.6+)
+| From SDK 3.5.0 (with xref:operator::overview.adoc[Couchbase Autonomous Operator] 2.6.1+)
 |===
 
 

modules/ref/pages/client-settings.adoc

@@ -680,3 +680,15 @@ This profile changes the default timeouts.
 | `managementTimeout`
 | 120s
 |===
+
+
+
+== Cloud Native Gateway
+////
+Using the xref:howtos:managing-connections.adoc#cloud-native-gateway[Cloud Native Gateway] protocol (to connect to Couchbase Server running on xref:operator::overview.adoc[Couchbase Autonomous Operator] 2.6.1 or newer) should not need any changes to config.
+////
+Some settings will be ignored when using the `couchbase2://` protocol -- and this will be logged at `WARNING` level.
+Currently, these include:
+
+* Compression
+* `numKvConnections`