Feature/beta02

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

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.
 
@@ -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:
@@ -1346,7 +1351,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 +1706,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

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:
 
 

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/
@@ -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

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]
+
 
 
 

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[]