AV-91970: [Documentation] 8.0 Uptake on Capella

diagrams.sh

@@ -3,10 +3,10 @@
 [[ -d ./build ]] || mkdir ./build
 
 # install-rr
-[[ -f ./build/rr-2.0-java11.zip ]] || curl -L -o ./build/rr-2.0-java11.zip https://github.com/GuntherRademacher/rr/releases/download/v2.0/rr-2.0-java11.zip
+[[ -f ./build/rr-2.1-java11.zip ]] || curl -L -o ./build/rr-2.1-java11.zip https://github.com/GuntherRademacher/rr/releases/download/v2.1/rr-2.1-java11.zip
 
 # extract-rr
-[[ -f ./build/rr/rr.war ]] || unzip ./build/rr-2.0-java11.zip -d ./build/rr
+[[ -f ./build/rr/rr.war ]] || unzip ./build/rr-2.1-java11.zip -d ./build/rr
 
 for file in n1ql dcl ddl dml dql tcl hints utility
 do

modules/develop/pages/intro.adoc

@@ -31,6 +31,12 @@ This tutorial provides an introductory worked example for developers, showing ho
 
 * xref:tutorials:couchbase-tutorial-student-records.adoc[]
 
+== Migration Tutorial
+
+This tutorial demonstrates how to migrate your data from a MySQL server over to Couchbase Capella.
+
+* xref:tutorials:migration-tutorial-capella/sql-migration-tutorial-capella.adoc[]
+
 == Connect
 
 Choose how you want to connect your app to Couchbase Capella.
@@ -49,17 +55,17 @@ Use the Query Service and the Index Service to issue {sqlpp} queries to extract
 
 * xref:n1ql:query.adoc[]
 
-== Vector Search
+== Vector Indexes
 
-Vector Search builds on the Search Service to provide support for vector indexes.
+The Query Service, the Index Service, and the Search Service provide support for vector indexes.
 You can use vector indexes with existing Large Language Models to develop AI applications.
 
-* xref:vector-search:vector-search.adoc[]
+* xref:vector-index:vectors-and-indexes-overview.adoc[]
 
 == Search
 
-Use the Search Service for full-text search with natural language processing across multiple data types and languages.
-Use custom text analysis, Geospatial search, and more.
+Use the Search Service for Full-Text Search with natural language processing across multiple data types and languages.
+Use custom text analysis, geospatial search, and more.
 
 * xref:search:search.adoc[]
 
@@ -93,10 +99,4 @@ Couchbase offers numerous software development kits (SDKs) that provide programm
 Integrations that Couchbase or partners have developed to enhance Couchbase, Capella, and partner services --
 a vital tool for many larger development projects.
 
-* xref:third-party:integrations.adoc[]
-
-== Migration
-
-A tutorial exercise demonstrating how to migrate your data from a MySQL server over to Couchbase Capella.
-
-* xref:tutorials:migration-tutorial-capella/sql-migration-tutorial-capella.adoc[]
+* xref:third-party:integrations.adoc[]

modules/eventing/pages/eventing-Terminologies.adoc

@@ -15,7 +15,7 @@ The Eventing Service can run one or more Eventing Functions.
 == Eventing Functions
 
 Eventing Functions handle data changes in the Eventing Service. 
-They're standalone JavaScript fragments that trigger in real time as a response to document mutations and that must execute from start to finish before a specified timeout is reached.
+These are standalone JavaScript fragments that trigger in real time as a response to document mutations and must be executed from start to finish before the specified timeout.
 
 Eventing Functions allow you to:
 
@@ -24,7 +24,7 @@ Eventing Functions allow you to:
 ** Work with Atomic Counters, CAS, and TTLS
 * Integrate with the Query Service to use inline {sqlpp} queries or statements
 * Enable a Timer to schedule functions to run in the future
-* Interact with external REST endpoints through cURL functionality
+* Interact with external REST endpoints through cURL capability
 * Route mutations to the entry points `OnUpdate` and `OnDelete`
 * Route fired timers to a user-defined Timer callback
 
@@ -42,28 +42,45 @@ The `OnUpdate` handler is called when you create or modify a document.
 
 The entry point `OnUpdate(doc,meta)` passes `doc`, the document, and `meta`, which contains additional data like the document ID, CAS, expiration date, and data type. 
 
-There are two limitations to the `OnUpdate` handler:
+Limitations of the `OnUpdate` handler:
 
-* If you modify a document several times in a short period of time, the handler calls can merge into a single event due to deduplication
-* It is not possible to distinguish between Create and Update operations
+* If you modify a document several times in a short period of time, the handler calls can merge into a single event due to deduplication.
+* It is not possible to distinguish between Create and Update operations.
 
 NOTE: To prevent the suppression of binary documents, you must set the language compatibility of your Function to Couchbase Server version 6.6.2 or later.
 
 ==== `OnDelete`
 
 The `OnDelete` handler is called when you delete a document or when the document expires.
 
-The entry point `OnDelete(meta,options)` passes `meta`, which contains information like the document, and `options`, which contains the boolean parameter `options.expired` that indicates if the document was removed because of a deletion or an expiration.
+The entry point `OnDelete(meta,options)` passes `meta`, which contains information like the document, and `options`, that contains the boolean parameter `options.expired` that indicates if the document was removed because of a deletion or an expiration.
 
 It is not possible to get the value of a document that has been deleted or expired.
 
+==== `OnDeploy`
+
+[.status]#Couchbase Server 8.0#
+
+The `OnDeploy` handler runs once when an Eventing function is deployed or resumed, before any mutations are processed.
+
+The entry point `OnDeploy(action)` receives an `action` parameter, like `deploy` or `resume`, indicating the reason for invocation. It also includes a `delay` value (in milliseconds), showing the time since the function was paused. For deployment operations, this value is `0`.
+
+*Limitation*: Avoid long-running operations within the `OnDeploy` as they can delay function deployment.
+
+Use `OnDeploy` for one-time setup tasks such as:
+
+* Registering a Timer.
+* Initializing resources required by the function.
+
+If `OnDeploy` fails, no mutations are processed, and the function remains in its previous state.
+
 ==== Timer Callback
 
 Timer callbacks are user-defined JavaScript functions passed as the `callback` argument to the built-in function call `createTimer(callback,date,reference,context)`.
 
 When you create a Timer, the `callback` argument is executed at or close to the `date` argument.
 The `reference` argument works as an identifier for the Timer scoped to an Eventing Function and callback.
-The `context` argument must be serializable data that is available to the callback when the Timer is fired.
+When the Timer fires, the `context` argument data must be in serialized form and available to the callback.
 
 For more information about Timer callbacks, see xref:eventing-timers.adoc#createtimer-function[`createTimer()` and `cancelTimer()`].
 
@@ -72,13 +89,13 @@ For more information about Timer callbacks, see xref:eventing-timers.adoc#create
 
 The persistent state of an Eventing Function is captured in the following external elements:
 
-* Documents or mutations and their extended attributes
-* Listen to Location, or the Eventing source: a collection that is the source of mutations sent to the Function through the Database Change Protocol (DCP)
-* Eventing Storage, or the Eventing metadata: a collection used as a scratchpad for the state of the Function
+* Documents or mutations and their extended attributes.
+* Listen to Location, or the Eventing source: a collection that's the source of mutations sent to the Function through the Database Change Protocol (DCP).
+* Eventing Storage, or the Eventing metadata: a collection used as a scratchpad for the state of the Function.
 * Optional bindings for the Function:
-** Bucket alias: an alias and access mode used by the Function to access a collection
-** URL alias: an alias and HTTP/S setting used by the Function to access external REST APIs
-** Constant alias: an alias to an integer, decimal number, string, boolean, or a JSON object used as a global variable within the Function
+** Bucket alias: an alias and access mode used by the Function to access a collection.
+** URL alias: an alias and HTTP/S setting used by the Function to access external REST APIs.
+** Constant alias: an alias to an integer, decimal number, string, boolean, or a JSON object used as a global variable within the Function.
 
 All states in the execution stack are short-lived.
 
@@ -150,12 +167,11 @@ The keyspaces `bucket.scope.collection` are accessible by the bound name as a Ja
 You can add bucket aliases by selecting *Bucket alias* and entering an alias-name, a keyspace, and the access level.
 This sequence of values does the following:
 
-* alias-name is the name you can use to refer to the keyspace or collection from your Eventing Function code
-* keyspace is the full path to a collection in the cluster
-* the access level provides access to the keyspace as `read only` or `read and write`
-** `read only` lets you read documents from the collection but not write (create, update, or delete) documents in the collection
-** `read and write` lets you read and write documents in the collection
-
+* alias-name is the name you can use to refer to the keyspace or collection from your Eventing Function code.
+* keyspace is the full path to a collection in the cluster.
+* the access level provides access to the keyspace as `read only` or `read and write`.
+** `read only` lets you read documents from the collection but not write (create, update, or delete) documents in the collection.
+** `read and write` lets you read and write documents in the collection.
 NOTE: You must have one or more bucket alias bindings for your Eventing Function to perform operations directly against the Data Service.
 
 An Eventing Function can listen to multiple collections when you use the `{asterisk}` wildcard in its scope or collection.
@@ -193,10 +209,10 @@ A keyspace is a path to a collection in the format `bucket-name.scope-name.colle
 For backward compatibility, you can also use the format `bucket-name._default._default`.
 This is the format of a bucket from Couchbase Server version 6.6 that has been upgraded to version 7.0.
 
-The following are the two keyspaces used by Eventing Functions:
+The two keyspaces used by Eventing Functions are:
 
-* <<listen-to-location,Listen to Location>>, which represents the Eventing source
-* <<eventing-storage,Eventing Storage>>, which represents the Eventing metadata
+* <<listen-to-location,Listen to Location>>, which represents the Eventing source.
+* <<eventing-storage,Eventing Storage>>, which represents the Eventing metadata.
 
 [#listen-to-location]
 ==== Listen to Location
@@ -279,7 +295,7 @@ You can only modify the Feed Boundary when you create a Function or when a Funct
 
 |System Log Level
 |Determines the granularity of messages logged across the Eventing Function.
-Can be one of `Info` (the default), `Error`, `Debug`, `Warning`, or `Trace`.
+Can be `Info` (the default), `Error`, `Debug`, `Warning`, or `Trace`.
 
 |Application Log Location
 |The directory path to the log file for the Eventing Function.
@@ -313,15 +329,22 @@ New Functions default to the highest compatibility version available of 6.6.2.
 In version 6.5.0, trying to access a non-existing item from a keyspace returns an undefined value.
 In version 6.0.0, it throws an exception.
 
-Only a Function with a language compability setting of version 6.6.2 passes binary documents to Eventing Function handlers.
+Only a Function with a language compatibility setting of version 6.6.2 passes binary documents to Eventing Function handlers.
 Versions 6.0.0 and 6.5.0 filter all binary documents out of the DCP mutation stream.
 
 |Script Timeout
-|The number of seconds to elapse before the script times out and is terminated.
+|The number of seconds to elapse before the script times out and terminates.
 
 The entry points into the handler processing for each mutation must run from start to finish before the specified timeout duration.
 The default number of seconds is `60`.
 
+|OnDeploy Timeout
+|The number of seconds to elapse before the OnDeploy entry point times out and terminates.
+
+The timeout is set to `60` seconds, by default. 
+
+The OnDeploy Timeout defines the maximum duration allowed for an Eventing Function to complete its initialization during deployment or resumption. 
+
 |Time Context Max Size
 |The size limit of the context for any Timer created by the Eventing Function.
 

modules/eventing/pages/eventing-faq.adoc

@@ -47,8 +47,7 @@ This means that the event entry points of *OnUpdate* and *OnDelete* to the Event
 
 * Can a Function listen to all changes across Couchbase Server?
 +
-A defined Function listens only to changes that are exposed using the DCP for the source collection (Couchbase and Ephemeral) in the data-nodes.
-Memcached buckets (and thus underlying collections) are not supported.
+A defined Function listens only to changes that are exposed using the DCP for the source collection in the data-nodes.
 The Function cannot listen to changes happening in other Couchbase components, such as FTS, Views, or GSI; nor can it listen to system events.
 
 

modules/eventing/pages/eventing-language-constructs.adoc

@@ -558,17 +558,18 @@ The Eventing Service calls the following JavaScript functions on events like mut
 
 * <<onupdate_handler>>
 * <<ondelete_handler>>
+* <<ondeploy_handler>>
 * <<timer_callback_handler>>
 
 [#onupdate_handler]
 === OnUpdate Handler
 
-The `OnUpdate` handler is called when you create or modify a document using an operation like insert or update.
+The `OnUpdate` handler is called when you create or modify a document.
 The entry point `OnUpdate(doc, meta)` listens to mutations in the associated source bucket.
 
 The `OnUpdate` handler has the following limitations:
 
-* If a document is modified several times in a short period of time, the handler calls might be combined into a single event due to deduplication.
+* If a document is modified several times in a short period of time, the handler calls can merge into a single event due to deduplication.
 * You cannot distinguish between a Create and an Update operation.
 
 [source,javascript]
@@ -618,6 +619,33 @@ function OnDelete(meta) {
 }
 ----
 
+[#ondeploy_handler]
+=== OnDeploy Handler
+
+[.status]#Couchbase Server 8.0#
+
+The `OnDeploy` handler is invoked once when an Eventing function is deployed or resumed, before any mutations are processed.
+The entry point `OnDeploy(action)` is used for one-time setup tasks like resource initialization, creation of timers, and so on.
+
+The `OnDeploy` handler has a limitation. Avoid any long-running operations within the `OnDeploy` as they can delay function deployment.
+
+The timeout for OnDeploy execution is configurable separately in the xref:eventing:eventing-Terminologies.adoc#function-settings[Eventing Function Settings].
+
+----
+function OnDeploy(action) {
+    log("OnDeploy triggered. Reason:", action.reason, "Delay (ms):", action.delay);
+
+    if (action.reason === "deploy") {
+        // Perform operations for fresh deployment (like timer creation, resource initialisation)
+        log("Deploy: perform first time setup for function");
+    } 
+    else if (action.reason === "resume") {
+        // Function was paused and resumed: refresh any cached information
+        log("Resume: perform operations before function resumption");
+    }
+} 
+----
+
 [#timer_callback_handler]
 === Timer Callback Handler
 

modules/eventing/pages/eventing-lifecycle.adoc

@@ -127,22 +127,33 @@ The minimum value is 1 (the default) and the recommended maximum is 64.
 If the semantics of a language construct change in any given release the “Language compatibility” setting will ensure an older Eventing Function will continue to see the runtime behavior that existed at the time it was authored, until such behavior is deprecated and removed. Note 6.0.0, 6.5.0, and 6.6.2 (the default) are the only currently defined versions.
 
 * *Script Timeout*: Script Timeout provides a timeout option to terminate a non-responsive Function.
-The entry points into the Eventing Function, e.g. OnUpdate and OnDelete, processing for each mutation must complete from start to finish prior to this specified timeout duration. The default is 60 seconds. In addition an Timer callback must also complete within this period.
+The entry points into the Eventing Function, like OnUpdate and OnDelete, processing for each mutation must complete from start to finish prior to this specified timeout duration. 
+The default is 60 seconds. 
+In addition an Timer callback must also complete within this period.
+
+* *OnDeploy Timeout*: OnDeploy Timeout defines the maximum duration allowed for an Eventing Function to complete its initialization during deployment or resumption. 
+The OnDeploy entry point must complete execution, from start to end, within the specified timeout period. 
+If the runtime exceeds the specified duration, the function is reverted to its previous state. 
+By default, the timeout is set to 60 seconds. 
 
 * *Timer Context Max Size*: Timer Context Max Size limits the size of the context for any Timer created by the Function.
-Eventing Timers can store and access a context which can be any JSON document, the context is used to store state when the timer is created and retrieve state when the timer fires.  By default the size is 1024 bytes, but this can be adjusted on a per Function basis.
+Eventing Timers can store and access a context which can be any JSON document, the context is used to store state when the timer is created and retrieve state when the timer fires. By default the size is 1024 bytes, but this can be adjusted on a per Function basis.
 
 | Bindings
 a|
-A binding is a construct that allows separating environment specific variables (example: bucket names, external endpoint URLs, constants) from the Eventing Function's JavaScript source code.  Currently Eventing Functions support the following binding types:
+A binding is a construct that allows separating environment specific variables (example: bucket names, external endpoint URLs, constants) from the Eventing Function's JavaScript source code. 
+
+Currently Eventing Functions support the following binding types:
 
 * *Bucket Bindings*: to access the Data Service or KV.
 
 * *URL Bindings*: to communicate externally via cURL.
 
 * *Constant Bindings*: to pass global settings/constants into the function.
 
-An Eventing Function can have no bindings, just one binding, or several bindings. For more information on Bindings, refer to xref:eventing-Terminologies.adoc#section_mzd_l1p_m2b[Terminologies - Bindings].
+An Eventing Function can have no bindings, just one binding, or several bindings. 
+For more information on Bindings, refer to xref:eventing-Terminologies.adoc#section_mzd_l1p_m2b[Terminologies - Bindings].
+
 |===
 
 . In the *ADD FUNCTION* dialog, configure the following information:

modules/eventing/pages/eventing-rbac.adoc

@@ -71,7 +71,7 @@ The following minimal resources are required for a non-privileged user to access
 * Data DCP reader
 ** Mutation Source
 * Eventing / Manage Scope Function
-** bucket.scope or bucket.*
+** bucket.scope or bucket.
 
 == Minimal Eventing RBAC role example
 
@@ -107,7 +107,7 @@ image::rbac_min_c.png[,538,align=middle]
 
 * Access the Couchbase Web Console > Security 
 
-* Select GROUPS on the right, you should see your definition for GROUP "eventing_min"
+* Select GROUPS on the right, you should see your definition for GROUP `eventing_min`.
 +
 image::rbac_min_groups.png[,%100]