From 0a4eb5f9ad6a044cdbe83f280e2cfcb1e6157d4a Mon Sep 17 00:00:00 2001 From: Fortune Ikechi Date: Mon, 4 Aug 2025 17:47:44 +0100 Subject: [PATCH] restructured files into folders --- modules/ROOT/nav.adoc | 170 ++-- .../_define_component_attributes.adoc | 2 +- .../pages/_partials/_define_page_index.adoc | 188 +++-- .../block_related_content_menulists.adoc | 18 +- .../pages/_partials/common-releasenotes.adoc | 2 +- .../_partials/howto/how-to-create-roles.adoc | 2 +- .../_partials/incpg-icr-initialization.adoc | 2 +- .../access-control-concepts.adoc | 0 ...ess-control-how-assign-users-to-roles.adoc | 0 ...s-control-how-control-document-access.adoc | 0 .../access-control-how-create-roles.adoc | 0 .../access-control-how-create-users.adoc | 0 ...trol-how-use-xattrs-for-access-grants.adoc | 0 .../access-control-how-verify-access.adoc | 0 .../access-control-how.adoc | 2 +- .../access-control-model.adoc | 0 .../auto-purge-channel-access-revocation.adoc | 12 +- .../pages/{ => access-control}/channels.adoc | 0 .../pages/{ => access-control}/roles.adoc | 0 .../sync-function-api-access-cmd.adoc | 0 .../sync-function-api-channel-cmd.adoc | 0 .../sync-function-api-expiry-cmd.adoc | 0 .../sync-function-api-require-access-cmd.adoc | 0 .../sync-function-api-require-admin-cmd.adoc | 0 .../sync-function-api-require-role-cmd.adoc | 0 .../sync-function-api-require-user-cmd.adoc | 0 .../sync-function-api-role-cmd.adoc | 0 .../sync-function-api-throw-cmd.adoc | 0 .../sync-function-api}/sync-function-api.adoc | 0 .../sync-function-api}/sync-function.adoc | 0 .../pages/{ => access-control}/users.adoc | 0 modules/ROOT/pages/audit-log-events.adoc | 789 ------------------ .../configuration-environment-variables.adoc | 0 .../configuration-javascript-functions.adoc | 0 .../configuration-overview.adoc | 0 .../configuration-properties-legacy.adoc | 0 .../configuration-rest-api.adoc | 0 .../configuration-schema-access-control.adoc | 0 .../configuration-schema-bootstrap.adoc | 0 .../configuration-schema-database.adoc | 0 .../configuration-schema-db-security.adoc | 0 .../configuration-schema-import-filter.adoc | 14 +- .../configuration-schema-isgr.adoc | 0 .../scopes-and-collections-config.adoc | 18 +- .../ROOT/pages/{ => deploy}/changes-feed.adoc | 0 .../{ => deploy}/command-line-options.adoc | 0 .../ROOT/pages/{ => deploy}/deployment.adoc | 6 +- .../pages/{ => deploy}/index-partitions.adoc | 4 +- modules/ROOT/pages/{ => deploy}/indexing.adoc | 2 +- .../pages/{ => deploy}/load-balancer.adoc | 0 .../pages/{ => deploy}/os-level-tuning.adoc | 0 .../{ => deploy}/setting-up-dr-cluster.adoc | 0 .../pages/{ => deploy}/stats-prometheus.adoc | 0 modules/ROOT/pages/{ => deploy}/webhooks.adoc | 0 modules/ROOT/pages/glossary.adoc | 2 +- modules/ROOT/pages/index.adoc | 14 +- modules/ROOT/pages/introduction.adoc | 106 +-- .../pages/{ => manage}/database-offline.adoc | 0 modules/ROOT/pages/{ => manage}/logging.adoc | 2 +- .../{ => manage}/managing-tombstones.adoc | 0 modules/ROOT/pages/{ => manage}/resync.adoc | 0 .../ROOT/pages/{ => manage}/revisions.adoc | 10 +- .../pages/{ => manage}/sgcollect-info.adoc | 0 .../{ => manage}/stats-monitoring-json.adoc | 0 .../stats-monitoring-prometheus.adoc | 4 +- .../pages/{ => manage}/stats-monitoring.adoc | 6 +- .../{ => product-notes}/compatibility.adoc | 0 .../{ => product-notes}/release-notes.adoc | 0 .../supported-environments.adoc | 0 .../rest-api-access-rbac-roles.adoc | 0 .../pages/{ => rest-api}/rest-api-access.adoc | 0 .../pages/{ => rest-api}/rest-api-admin.adoc | 4 +- .../{ => rest-api}/rest-api-metrics.adoc | 2 +- .../ROOT/pages/{ => rest-api}/rest-api.adoc | 0 .../pages/{ => rest-api}/rest_api_admin.adoc | 0 .../pages/{ => rest-api}/rest_api_metric.adoc | 0 .../pages/{ => rest-api}/rest_api_public.adoc | 0 .../ROOT/pages/security/audit-log-events.adoc | 789 ++++++++++++++++++ .../pages/{ => security}/audit-logging.adoc | 22 +- .../{ => security}/authentication-certs.adoc | 0 .../{ => security}/authentication-users.adoc | 0 .../{ => security}/manage-audit-logs.adoc | 34 +- .../{ => security}/secure-sgw-access.adoc | 0 .../server-compatibility-backups.adoc | 0 .../server-compatibility-buckets.adoc | 0 .../server-compatibility-collections.adoc | 0 .../server-compatibility-eventing.adoc | 0 .../server-compatibility-transactions.adoc | 0 .../server-compatibility-xdcr.adoc | 0 .../xdcr-active-active-eventing.adoc | 0 .../{ => start-here}/get-started-install.adoc | 0 .../{ => start-here}/get-started-prepare.adoc | 0 .../get-started-verify-install.adoc | 0 modules/ROOT/pages/{ => sync}/delta-sync.adoc | 2 +- .../pages/{ => sync}/import-processing.adoc | 14 +- ...inter-syncgateway-conflict-resolution.adoc | 0 .../sync-inter-syncgateway-manage.adoc | 0 .../sync-inter-syncgateway-monitor.adoc | 0 .../sync-inter-syncgateway-overview.adoc | 4 +- .../sync-inter-syncgateway-run.adoc | 0 .../ROOT/pages/{ => sync}/sync-using-app.adoc | 0 .../sync-with-couchbase-server.adoc | 0 .../deploy-cluster-to-kubernetes.adoc | 0 modules/ROOT/pages/whatsnew.adoc | 6 +- 104 files changed, 1135 insertions(+), 1117 deletions(-) rename modules/ROOT/pages/{ => access-control}/access-control-concepts.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-assign-users-to-roles.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-control-document-access.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-create-roles.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-create-users.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-use-xattrs-for-access-grants.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how-verify-access.adoc (100%) rename modules/ROOT/pages/{ => access-control}/access-control-how.adoc (93%) rename modules/ROOT/pages/{ => access-control}/access-control-model.adoc (100%) rename modules/ROOT/pages/{ => access-control}/auto-purge-channel-access-revocation.adoc (97%) rename modules/ROOT/pages/{ => access-control}/channels.adoc (100%) rename modules/ROOT/pages/{ => access-control}/roles.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-access-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-channel-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-expiry-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-require-access-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-require-admin-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-require-role-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-require-user-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-role-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api-throw-cmd.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function-api.adoc (100%) rename modules/ROOT/pages/{ => access-control/sync-function-api}/sync-function.adoc (100%) rename modules/ROOT/pages/{ => access-control}/users.adoc (100%) delete mode 100644 modules/ROOT/pages/audit-log-events.adoc rename modules/ROOT/pages/{ => configuration}/configuration-environment-variables.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-javascript-functions.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-overview.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-properties-legacy.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-rest-api.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-access-control.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-bootstrap.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-database.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-db-security.adoc (100%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-import-filter.adoc (93%) rename modules/ROOT/pages/{ => configuration}/configuration-schema-isgr.adoc (100%) rename modules/ROOT/pages/{ => configuration}/scopes-and-collections-config.adoc (95%) rename modules/ROOT/pages/{ => deploy}/changes-feed.adoc (100%) rename modules/ROOT/pages/{ => deploy}/command-line-options.adoc (100%) rename modules/ROOT/pages/{ => deploy}/deployment.adoc (93%) rename modules/ROOT/pages/{ => deploy}/index-partitions.adoc (94%) rename modules/ROOT/pages/{ => deploy}/indexing.adoc (97%) rename modules/ROOT/pages/{ => deploy}/load-balancer.adoc (100%) rename modules/ROOT/pages/{ => deploy}/os-level-tuning.adoc (100%) rename modules/ROOT/pages/{ => deploy}/setting-up-dr-cluster.adoc (100%) rename modules/ROOT/pages/{ => deploy}/stats-prometheus.adoc (100%) rename modules/ROOT/pages/{ => deploy}/webhooks.adoc (100%) rename modules/ROOT/pages/{ => manage}/database-offline.adoc (100%) rename modules/ROOT/pages/{ => manage}/logging.adoc (99%) rename modules/ROOT/pages/{ => manage}/managing-tombstones.adoc (100%) rename modules/ROOT/pages/{ => manage}/resync.adoc (100%) rename modules/ROOT/pages/{ => manage}/revisions.adoc (92%) rename modules/ROOT/pages/{ => manage}/sgcollect-info.adoc (100%) rename modules/ROOT/pages/{ => manage}/stats-monitoring-json.adoc (100%) rename modules/ROOT/pages/{ => manage}/stats-monitoring-prometheus.adoc (85%) rename modules/ROOT/pages/{ => manage}/stats-monitoring.adoc (80%) rename modules/ROOT/pages/{ => product-notes}/compatibility.adoc (100%) rename modules/ROOT/pages/{ => product-notes}/release-notes.adoc (100%) rename modules/ROOT/pages/{ => product-notes}/supported-environments.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest-api-access-rbac-roles.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest-api-access.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest-api-admin.adoc (95%) rename modules/ROOT/pages/{ => rest-api}/rest-api-metrics.adoc (94%) rename modules/ROOT/pages/{ => rest-api}/rest-api.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest_api_admin.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest_api_metric.adoc (100%) rename modules/ROOT/pages/{ => rest-api}/rest_api_public.adoc (100%) create mode 100644 modules/ROOT/pages/security/audit-log-events.adoc rename modules/ROOT/pages/{ => security}/audit-logging.adoc (88%) rename modules/ROOT/pages/{ => security}/authentication-certs.adoc (100%) rename modules/ROOT/pages/{ => security}/authentication-users.adoc (100%) rename modules/ROOT/pages/{ => security}/manage-audit-logs.adoc (91%) rename modules/ROOT/pages/{ => security}/secure-sgw-access.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-backups.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-buckets.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-collections.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-eventing.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-transactions.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/server-compatibility-xdcr.adoc (100%) rename modules/ROOT/pages/{ => server-compatibility}/xdcr-active-active-eventing.adoc (100%) rename modules/ROOT/pages/{ => start-here}/get-started-install.adoc (100%) rename modules/ROOT/pages/{ => start-here}/get-started-prepare.adoc (100%) rename modules/ROOT/pages/{ => start-here}/get-started-verify-install.adoc (100%) rename modules/ROOT/pages/{ => sync}/delta-sync.adoc (97%) rename modules/ROOT/pages/{ => sync}/import-processing.adoc (82%) rename modules/ROOT/pages/{ => sync}/sync-inter-syncgateway-conflict-resolution.adoc (100%) rename modules/ROOT/pages/{ => sync}/sync-inter-syncgateway-manage.adoc (100%) rename modules/ROOT/pages/{ => sync}/sync-inter-syncgateway-monitor.adoc (100%) rename modules/ROOT/pages/{ => sync}/sync-inter-syncgateway-overview.adoc (98%) rename modules/ROOT/pages/{ => sync}/sync-inter-syncgateway-run.adoc (100%) rename modules/ROOT/pages/{ => sync}/sync-using-app.adoc (100%) rename modules/ROOT/pages/{ => sync}/sync-with-couchbase-server.adoc (100%) rename modules/ROOT/pages/{ => use-kubernetes}/deploy-cluster-to-kubernetes.adoc (100%) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index fdca3e05a..294ff923f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -12,9 +12,9 @@ .Start Here! // * xref:index.adoc[Quick Links] -* xref:get-started-prepare.adoc[Prepare] -* xref:get-started-install.adoc[Install] -* xref:get-started-verify-install.adoc[Verify] +* xref:start-here/get-started-prepare.adoc[Prepare] +* xref:start-here/get-started-install.adoc[Install] +* xref:start-here/get-started-verify-install.adoc[Verify] // @@ -23,97 +23,97 @@ // .Configuration - * xref:configuration-overview.adoc[Overview] - * xref:configuration-schema-bootstrap.adoc[Bootstrap] - * xref:configuration-schema-database.adoc[Database] - ** xref:scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway] - * 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 Gateway Replication] - * xref:configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] - * xref:configuration-javascript-functions.adoc[Javascript Functions] - * xref:configuration-environment-variables.adoc[Environment Variables] + * xref:configuration/configuration-overview.adoc[Overview] + * xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap] + * xref:configuration/configuration-schema-database.adoc[Database] + ** xref:configuration/scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway] + * xref:configuration/configuration-schema-db-security.adoc[Database Security] + * xref:configuration/configuration-schema-access-control.adoc[Access Control] + * xref:configuration/configuration-schema-import-filter.adoc[Import Filter] + * xref:configuration/configuration-schema-isgr.adoc[Inter-Sync Gateway Replication] + * xref:configuration/configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] + * xref:configuration/configuration-javascript-functions.adoc[Javascript Functions] + * xref:configuration/configuration-environment-variables.adoc[Environment Variables] .Security - * xref:secure-sgw-access.adoc[Secure Access] - * xref:authentication-users.adoc[User Authentication] - * xref:authentication-certs.adoc[TLS Cert Authentication] - * xref:audit-logging.adoc[] - ** xref:manage-audit-logs.adoc[] - ** xref:audit-log-events.adoc[] + * xref:security/secure-sgw-access.adoc[Secure Access] + * xref:security/authentication-users.adoc[User Authentication] + * xref:security/authentication-certs.adoc[TLS Cert Authentication] + * xref:security/audit-logging.adoc[] + ** xref:security/manage-audit-logs.adoc[] + ** xref:security/audit-log-events.adoc[] .Access Control - * xref:access-control-concepts.adoc[Concepts] - ** xref:access-control-model.adoc[Access Control Model] - ** xref:channels.adoc[Channels] - ** xref:roles.adoc[Roles] - ** xref:users.adoc[Users] - * xref:sync-function.adoc[Sync Function] - ** xref:sync-function-api.adoc[API Reference] - *** xref:sync-function-api-access-cmd.adoc[access()] - *** xref:sync-function-api-channel-cmd.adoc[channel()] - *** xref:sync-function-api-expiry-cmd.adoc[expiry()] - *** xref:sync-function-api-require-access-cmd.adoc[requireAccess()] - *** xref:sync-function-api-require-admin-cmd.adoc[requireAdmin()] - *** xref:sync-function-api-require-role-cmd.adoc[requireRole()] - *** xref:sync-function-api-require-user-cmd.adoc[requireUser()] - *** xref:sync-function-api-role-cmd.adoc[role()] - *** xref:sync-function-api-throw-cmd.adoc[throw()] - * xref:access-control-how.adoc[How-to] - ** xref:access-control-how-create-users.adoc[Create Users] - ** xref:access-control-how-create-roles.adoc[Create Roles] - ** xref:access-control-how-assign-users-to-roles.adoc[Assign User to Role] - ** xref:access-control-how-control-document-access.adoc[Control Document Access] - ** xref:access-control-how-verify-access.adoc[Verify Access] - ** xref:access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants] - * xref:auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation] + * xref:access-control/access-control-concepts.adoc[Concepts] + ** xref:access-control/access-control-model.adoc[Access Control Model] + ** xref:access-control/channels.adoc[Channels] + ** xref:access-control/roles.adoc[Roles] + ** xref:access-control/users.adoc[Users] + * xref:access-control/sync-function-api/sync-function.adoc[Sync Function] + ** xref:access-control/sync-function-api/sync-function-api.adoc[API Reference] + *** xref:access-control/sync-function-api/sync-function-api-access-cmd.adoc[access()] + *** xref:access-control/sync-function-api/sync-function-api-channel-cmd.adoc[channel()] + *** xref:access-control/sync-function-api/sync-function-api-expiry-cmd.adoc[expiry()] + *** xref:access-control/sync-function-api/sync-function-api-require-access-cmd.adoc[requireAccess()] + *** xref:access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc[requireAdmin()] + *** xref:access-control/sync-function-api/sync-function-api-require-role-cmd.adoc[requireRole()] + *** xref:access-control/sync-function-api/sync-function-api-require-user-cmd.adoc[requireUser()] + *** xref:access-control/sync-function-api/sync-function-api-role-cmd.adoc[role()] + *** xref:access-control/sync-function-api/sync-function-api-throw-cmd.adoc[throw()] + * xref:access-control/access-control-how.adoc[How-to] + ** xref:access-control/access-control-how-create-users.adoc[Create Users] + ** xref:access-control/access-control-how-create-roles.adoc[Create Roles] + ** xref:access-control/access-control-how-assign-users-to-roles.adoc[Assign User to Role] + ** xref:access-control/access-control-how-control-document-access.adoc[Control Document Access] + ** xref:access-control/access-control-how-verify-access.adoc[Verify Access] + ** xref:access-control/access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants] + * xref:access-control/auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation] .REST API - * xref:rest-api-access.adoc[Secure Access] - * xref:rest-api-admin.adoc[Admin REST API] + * xref:rest-api/rest-api-access.adoc[Secure Access] + * xref:rest-api/rest-api-admin.adoc[Admin REST API] ** xref:rest_api_admin_static.adoc[Admin API Reference] - * xref:rest-api-metrics.adoc[Metrics REST API] + * xref:rest-api/rest-api-metrics.adoc[Metrics REST API] ** xref:rest_api_metrics_static.adoc[Metrics API Reference] - * xref:rest-api.adoc[Public REST API] + * xref:rest-api/rest-api.adoc[Public REST API] ** xref:rest_api_public_static.adoc[Public API Reference] - * xref:rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] + * xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] .Sync - * xref:sync-with-couchbase-server.adoc[Sync with Server] - * xref:sync-using-app.adoc[Sync with Application] + * xref:sync/sync-with-couchbase-server.adoc[Sync with Server] + * xref:sync/sync-using-app.adoc[Sync with Application] * Inter-Sync Gateway Replication - ** xref:sync-inter-syncgateway-overview.adoc[Overview] - ** xref:sync-inter-syncgateway-run.adoc[Initialize] - ** xref:sync-inter-syncgateway-manage.adoc[Manage] - ** xref:sync-inter-syncgateway-monitor.adoc[Monitor] - ** xref:sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution] - * xref:delta-sync.adoc[Delta Sync] - * xref:import-processing.adoc[Import Processing] + ** xref:sync/sync-inter-syncgateway-overview.adoc[Overview] + ** xref:sync/sync-inter-syncgateway-run.adoc[Initialize] + ** xref:sync/sync-inter-syncgateway-manage.adoc[Manage] + ** xref:sync/sync-inter-syncgateway-monitor.adoc[Monitor] + ** xref:sync/sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution] + * xref:sync/delta-sync.adoc[Delta Sync] + * xref:sync/import-processing.adoc[Import Processing] .Manage - * xref:revisions.adoc[Revisions] - * xref:managing-tombstones.adoc[Tombstones] - * xref:resync.adoc[Resync] - * xref:stats-monitoring.adoc[Stats Monitoring] - ** xref:stats-monitoring-json.adoc[] - ** xref:stats-monitoring-prometheus.adoc[] - * xref:database-offline.adoc[Database Offline] - * xref:logging.adoc[Logging] - ** xref:sgcollect-info.adoc[SG Collect Info] + * xref:manage/revisions.adoc[Revisions] + * xref:manage/managing-tombstones.adoc[Tombstones] + * xref:manage/resync.adoc[Resync] + * xref:manage/stats-monitoring.adoc[Stats Monitoring] + ** xref:manage/stats-monitoring-json.adoc[] + ** xref:manage/stats-monitoring-prometheus.adoc[] + * xref:manage/database-offline.adoc[Database Offline] + * xref:manage/logging.adoc[Logging] + ** xref:manage/sgcollect-info.adoc[SG Collect Info] .Deploy - * xref:deployment.adoc[Overview] - * xref:command-line-options.adoc[Command Line Options] - * xref:load-balancer.adoc[Load Balancer] - * xref:os-level-tuning.adoc[OS Level Tuning] - * xref:webhooks.adoc[Webhooks] - * xref:changes-feed.adoc[Changes Feed] + * xref:deploy/deployment.adoc[Overview] + * xref:deploy/command-line-options.adoc[Command Line Options] + * xref:deploy/load-balancer.adoc[Load Balancer] + * xref:deploy/os-level-tuning.adoc[OS Level Tuning] + * xref:deploy/webhooks.adoc[Webhooks] + * xref:deploy/changes-feed.adoc[Changes Feed] // * xref:integrating-external-stores.adoc[External Stores] - * xref:stats-prometheus.adoc[Prometheus Feed] - * xref:indexing.adoc[Indexing] - ** xref:index-partitions.adoc[] - * xref:setting-up-dr-cluster.adoc[Disaster Recovery] + * xref:deploy/stats-prometheus.adoc[Prometheus Feed] + * xref:deploy/indexing.adoc[Indexing] + ** xref:deploy/index-partitions.adoc[] + * xref:deploy/setting-up-dr-cluster.adoc[Disaster Recovery] // @@ -122,18 +122,18 @@ // .Use Kubernetes - * xref:deploy-cluster-to-kubernetes.adoc[Deploy] + * xref:use-kubernetes/deploy-cluster-to-kubernetes.adoc[Deploy] * xref:operator:ROOT:tutorial-sync-gateway-manage.adoc[Manage a Sync Gateway Cluster] * xref:operator:ROOT:tutorial-sync-gateway-clients.adoc[Expose Sync Gateway to Couchbase Lite clients] .Server Compatibility - * xref:server-compatibility-buckets.adoc[Buckets] - * xref:server-compatibility-collections.adoc[Collections] - * xref:server-compatibility-eventing.adoc[Eventing] - * xref:server-compatibility-transactions.adoc[Transactions] - * xref:server-compatibility-xdcr.adoc[XDCR] - * xref:xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing] - * xref:server-compatibility-backups.adoc[Backup and Restore] + * xref:server-compatibility/server-compatibility-buckets.adoc[Buckets] + * xref:server-compatibility/server-compatibility-collections.adoc[Collections] + * xref:server-compatibility/server-compatibility-eventing.adoc[Eventing] + * xref:server-compatibility/server-compatibility-transactions.adoc[Transactions] + * xref:server-compatibility/server-compatibility-xdcr.adoc[XDCR] + * xref:server-compatibility/xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing] + * xref:server-compatibility/server-compatibility-backups.adoc[Backup and Restore] .Product Notes * xref:release-notes.adoc[Release Notes] diff --git a/modules/ROOT/pages/_partials/_define_component_attributes.adoc b/modules/ROOT/pages/_partials/_define_component_attributes.adoc index e90f34ea9..24b984b29 100644 --- a/modules/ROOT/pages/_partials/_define_component_attributes.adoc +++ b/modules/ROOT/pages/_partials/_define_component_attributes.adoc @@ -256,7 +256,7 @@ ifdef::releasetag[:tag: -{releasetag}] :fn_post270: footnote:fnpost270[Since 2.7] :fnref_post270: footnote:fnpost270[] -:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]] +:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration/configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]] :fnref_legacy: footnote:fnlegacy[] diff --git a/modules/ROOT/pages/_partials/_define_page_index.adoc b/modules/ROOT/pages/_partials/_define_page_index.adoc index 7113efa6d..0ec6703cb 100644 --- a/modules/ROOT/pages/_partials/_define_page_index.adoc +++ b/modules/ROOT/pages/_partials/_define_page_index.adoc @@ -123,103 +123,112 @@ endif::xref--pfx-sgw[] // BEGIN -- SYNC GATEWAY PAGE ATTRIBUTES -:access--control-model--page: access-control-model.adoc +:access--control-model--page: access-control/access-control-model.adoc :access--control-model--xref: {sgw--xref}{access--control-model--page}[Access Control Model] -:access-control-overview--page: access-control-overview.adoc +:access-control-overview--page: access-control/access-control-overview.adoc :access-control-overview--xref: {sgw--xref}{access-control-overview--page}[Access Control Overview] -:access-control-concepts--page: access-control-concepts.adoc +:access-control-concepts--page: access-control/access-control-concepts.adoc :access-control-concepts--xref: {sgw--xref}{access-control-concepts--page}[Access Control Concepts] -:access-control-how--page: access-control-how.adoc +:access-control-how--page: access-control/access-control-how.adoc :access-control-how--xref: {sgw--xref}{access-control-how--page}[Access Control How-to] -:access-control-how-assign-users-to-roles--page: access-control-how-assign-users-to-roles.adoc +:access-control-how-assign-users-to-roles--page: access-control/access-control-how-assign-users-to-roles.adoc :access-control-how-assign-users-to-roles--xref: {sgw--xref}{access-control-how-assign-users-to-roles--page}[Assign Users to Roles] -:access-control-how-control-document-access--page: access-control-how-control-document-access.adoc +:access-control-how-control-document-access--page: access-control/access-control-how-control-document-access.adoc :access-control-how-control-document-access--xref: {sgw--xref}{access-control-how-control-document-access--page}[Control Document Access] :access-control-how-control-document-access--xref-write-access: {sgw--xref}{access-control-how-control-document-access--page}[Control Write Access] -:access-control-how-create-roles--page: access-control-how-create-roles.adoc +:access-control-how-create-roles--page: access-control/access-control-how-create-roles.adoc :access-control-how-create-roles--xref: {sgw--xref}{access-control-how-create-roles--page}[Create Roles] -:access-control-how-create-users--page: access-control-how-create-users.adoc +:access-control-how-create-users--page: access-control/access-control-how-create-users.adoc :access-control-how-create-users--xref: {sgw--xref}{access-control-how-create-users--page}[Create Users] -:access-control-how-verify-access--page: access-control-how-verify-access.adoc +:access-control-how-verify-access--page: access-control/access-control-how-verify-access.adoc :access-control-how-verify-access--xref: {sgw--xref}{access-control-how-verify-access--page}[Verify Access] -:access-control-how-use-xattrs--page: access-control-how-use-xattrs.adoc +:access-control-how-use-xattrs--page: access-control/access-control-how-use-xattrs.adoc :access-control-how-use-xattrs--xref: {sgw--xref}{access-control-how-use-xattrs--page}[Use XATTRS for Access Grants] -:access-control-how-write-access--page: access-control-how-write-access.adoc +:access-control-how-write-access--page: access-control/access-control-how-write-access.adoc :access-control-how-write-access--xref: {sgw--xref}{access-control-how-write-access--page}[Write Access] -:access-control-how-use-xattrs-for-access-grants--page: access-control-how-use-xattrs-for-access-grants.adoc +:access-control-how-use-xattrs-for-access-grants--page: access-control/access-control-how-use-xattrs-for-access-grants.adoc :access-control-how-use-xattrs-for-access-grants--xref: {sgw--xref}{access-control-how-use-xattrs-for-access-grants--page}[Use XATTRs for Access Grants] -:access-control-model--page: access-control-model.adoc +:access-control-model--page: access-control/access-control-model.adoc :access-control-model--xref: {sgw--xref}{access-control-model--page}[Access control Model] -:access-grants--page: access-grants.adoc +:access-grants--page: access-control/access-grants.adoc :access-grants--xref: {sgw--xref}{access-grants--page}[Access Grants] :access-grants--xref-access-grant: {sgw--xref}{access-grants--page}#lbl-access-grants[Access Grants] :access-grants--xref-control-write-access: {sgw--xref}{access-grants--page}#lbl-control-write-access[Controlling Write Access] :access-grants--xref: {sgw--xref}{access-grants--page}[Access Grants] // Begin -- Authentication Certs Cross-Reference Attributes -:authentication-certs--page: authentication-certs.adoc +:authentication-certs--page: security/authentication-certs.adoc :authentication-certs--xref: {sgw--xref}{authentication-certs--page}[TLS Certificate Authentication] -:authentication-users--page: authentication-users.adoc +:authentication-users--page: security/authentication-users.adoc :authentication-users--xref: {sgw--xref}{authentication-users--page}[User Authentication] // End -- Authentication Certs Cross-Reference Attributes -:auto-purge-channel-access-revocation--page: auto-purge-channel-access-revocation.adoc +// Begin -- Audit Logging Cross-Reference Attributes +:audit-logging--page: security/audit-logging.adoc +:audit-logging--xref: {sgw--xref}{audit-logging--page}[Audit Logging] +:manage-audit-logs--page: security/manage-audit-logs.adoc +:manage-audit-logs--xref: {sgw--xref}{manage-audit-logs--page}[Manage Audit Logs] +:audit-log-events--page: security/audit-log-events.adoc +:audit-log-events--xref: {sgw--xref}{audit-log-events--page}[Audit Log Events] +// End -- Audit Logging Cross-Reference Attributes + +:auto-purge-channel-access-revocation--page: access-control/auto-purge-channel-access-revocation.adoc :auto-purge-channel-access-revocation--xref: {sgw--xref}{auto-purge-channel-access-revocation--page}[Auto-purge on Channel Access Revocation] -:changes-feed--page: changes-feed.adoc +:changes-feed--page: deploy/changes-feed.adoc :changes-feed--xref: {sgw--xref}{changes-feed--page}[Changes Feed] // Begin -- Channels Cross-Reference Attributes -:channels--page: channels.adoc +:channels--page: access-control/channels.adoc :channels--xref: {sgw--xref}{channels--page}[Channels] :channel--xref: {sgw--xref}{channels--page}[Channel] :channels--xref-public-channel: {sgw--xref}{channels--page}#lbl-public-channel[Public Channel] // End -- Channels Cross-Reference Attributes -:command-line-options--page: command-line-options.adoc +:command-line-options--page: deploy/command-line-options.adoc :command-line-options--xref: {sgw--xref}{command-line-options--page}[Command Line Options] :compatibility--page: compatibility.adoc :compatibility--xref: {sgw--xref}{compatibility--page}[Compatibility Matrix] -:configuration-environment-variables--page: configuration-environment-variables.adoc +:configuration-environment-variables--page: configuration/configuration-environment-variables.adoc :configuration-environment-variables--xref: {sgw--xref}{configuration-environment-variables--page}[Configuration Environment Variables] -:configuration-javascript-functions--page: configuration-javascript-functions.adoc +:configuration-javascript-functions--page: configuration/configuration-javascript-functions.adoc :configuration-javascript-functions--xref: {sgw--xref}{configuration-javascript-functions--page}[Configuration Javascript Functions] -:configuration-overview--page: configuration-overview.adoc +:configuration-overview--page: configuration/configuration-overview.adoc :configuration-overview--pfx: {sgw--xref}{configuration-overview--page} :configuration-overview--xref: {configuration-overview--pfx}[Configuration Overview] :configuration-overview--xref--groups: {configuration-overview--pfx}#lbl-config-grp[Configuration Groups] -:configuration-rest-api--page: configuration-rest-api.adoc +:configuration-rest-api--page: configuration/configuration-rest-api.adoc :configuration-rest-api--xref: {sgw--xref}{configuration-rest-api--page}[Configuration REST API] -:configuration-schema-database--page: configuration-schema-database.adoc +:configuration-schema-database--page: configuration/configuration-schema-database.adoc :configuration-schema-database--xref: {sgw--xref}{configuration-schema-database--page}[Database Configuration] :configuration-schema-database--xref--enable-shared-bucket-access: {sgw--xref}{configuration-schema-database--page}#enable_shared_bucket_access[database.enable_shared_bucket_access] :configuration-schema-database--xref-user-xattr-key: {sgw--xref}{configuration-schema-database--page}#databases-this_db-user_xattr_key[user_xattr_key] -:configuration-schema-db-security--page: configuration-schema-db-security.adoc +:configuration-schema-db-security--page: configuration/configuration-schema-db-security.adoc :configuration-schema-db-security--xref: {sgw--xref}{configuration-schema-db-security--page}[Database Security Configuration] -:configuration-schema-access-control--page: configuration-schema-access-control.adoc +:configuration-schema-access-control--page: configuration/configuration-schema-access-control.adoc :configuration-schema-access-control--xref: {sgw--xref}{configuration-schema-access-control--page}[Access Control Configuration] -:configuration-schema-import-filter--page: configuration-schema-import-filter.adoc +:configuration-schema-import-filter--page: configuration/configuration-schema-import-filter.adoc :configuration-schema-import-filter--xref: {sgw--xref}{configuration-schema-import-filter--page}[Import Filter Configuration] -:configuration-schema-isgr--page: configuration-schema-isgr.adoc +:configuration-schema-isgr--page: configuration/configuration-schema-isgr.adoc :configuration-schema-isgr--xref: {sgw--xref}{configuration-schema-isgr--page}[Inter-Sync Gateway Configuration] @@ -233,34 +242,34 @@ endif::xref--pfx-sgw[] :data-modeling--page: data-modeling.adoc :data-modeling--xref: {sgw--xref}{data-modeling--page}[Data Modeling] -:database-offline--page: database-offline.adoc +:database-offline--page: manage/database-offline.adoc :database-offline--xref: {sgw--xref}{database-offline--page}[Database Offline] -:delta-sync--page: delta-sync.adoc +:delta-sync--page: sync/delta-sync.adoc :delta-sync--xref: {sgw--xref}{delta-sync--page}[Delta Sync] -:deploy-cluster-to-kubernetes--page: deploy-cluster-to-kubernetes.adoc +:deploy-cluster-to-kubernetes--page: use-kubernetes/deploy-cluster-to-kubernetes.adoc :deploy-cluster-to-kubernetes--xref: {sgw--xref}{deploy-cluster-to-kubernetes--page}[Deploy Cluster To Kubernetes] -:deployment--page: deployment.adoc +:deployment--page: deploy/deployment.adoc :deployment--xref: {sgw--xref}{deployment--page}[Deployment] -:rest-api-access--page: rest-api-access.adoc +:rest-api-access--page: rest-api/rest-api-access.adoc :rest-api-access--xref: {sgw--xref}{rest-api-access--page}[REST API Access] -:rest-api-access-rbac-roles--xref: {sgw--xref}rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] +:rest-api-access-rbac-roles--xref: {sgw--xref}rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] :get-started-configure-server--page: get-started-configure-server.adoc :get-started-configure-server--xref: {sgw--xref}{get-started-configure-server--page}[Configure Server for Sync Gateway] -:get-started-install--page: get-started-install.adoc +:get-started-install--page: start-here/get-started-install.adoc :get-started-install--xref: {sgw--xref}{get-started-install--page}[Install] -:get-started-prepare--page: get-started-prepare.adoc +:get-started-prepare--page: start-here/get-started-prepare.adoc :get-started-prepare--pfx: {sgw--xref}{get-started-prepare--page} :get-started-prepare--xref: {get-started-prepare--pfx}[Prepare] :get-started-prepare--config-server--xref: {get-started-prepare--pfx}#configure-server[Configure Server for Sync Gateway] :get-started-prepare--xref--create-rbac-users: {get-started-prepare--pfx}#step-2create-rbac-user[Create RBAC users] -:get-started-verify-install--page: get-started-verify-install.adoc +:get-started-verify-install--page: start-here/get-started-verify-install.adoc :get-started-verify-install--xref: {sgw--xref}{get-started-verify-install--page}[Verify] :glossary--page: glossary.adoc @@ -274,9 +283,12 @@ endif::xref--pfx-sgw[] :index--page: index.adoc :index--xref: {sgw--xref}{index--page}[Index] -:indexing--page: indexing.adoc +:indexing--page: deploy/indexing.adoc :indexing--xref: {sgw--xref}{indexing--page}[Indexing] +:index-partitions--page: deploy/index-partitions.adoc +:index-partitions--xref: {sgw--xref}{index-partitions--page}[Index Partitions] + :integrating-external-stores--page: integrating-external-stores.adoc :integrating-external-stores--xref: {sgw--xref}{integrating-external-stores--page}[Integrating External Stores] @@ -284,7 +296,7 @@ endif::xref--pfx-sgw[] :introduction--xref: {sgw--xref}{introduction--page}[Introduction] -:configuration-schema-bootstrap--page: configuration-schema-bootstrap.adoc +:configuration-schema-bootstrap--page: configuration/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] @@ -504,7 +516,7 @@ endif::xref--pfx-sgw[] // LEGACY CONFIG -:configuration-properties-legacy--page: configuration-properties-legacy.adoc +:configuration-properties-legacy--page: configuration/configuration-properties-legacy.adoc :configuration-properties-legacy--pfx: {sgw--xref}{configuration-properties-legacy--page} :configuration-properties-legacy--pfx--db: {configuration-properties-legacy--pfx}#databases @@ -584,16 +596,16 @@ endif::xref--pfx-sgw[] :configuration-properties-legacy--xref--schema: {configuration-properties-legacy--pfx}#configuration-reference[Configuration] -:load-balancer--page: load-balancer.adoc +:load-balancer--page: deploy/load-balancer.adoc :load-balancer--xref: {sgw--xref}{load-balancer--page}[Load Balancer] -:logging--page: logging.adoc +:logging--page: manage/logging.adoc :logging--xref: {sgw--xref}{logging--page}[Logging] -:managing-tombstones--page: managing-tombstones.adoc +:managing-tombstones--page: manage/managing-tombstones.adoc :managing-tombstones--xref: {sgw--xref}{managing-tombstones--page}[Managing Tombstones] -:os-level-tuning--page: os-level-tuning.adoc +:os-level-tuning--page: deploy/os-level-tuning.adoc :os-level-tuning--xref: {sgw--xref}{os-level-tuning--page}[OS-Level Tuning] :quickstart--page: quickstart.adoc @@ -610,7 +622,7 @@ endif::xref--pfx-sgw[] :release-notes--page: release-notes.adoc :release-notes--xref: {sgw--xref}{release-notes--page}[Release Notes] -:rest-api--page: rest-api.adoc +:rest-api--page: rest-api/rest-api.adoc :rest-api--xref: {sgw--xref}{rest-api--page}[Public REST API] // :configuration-schema-database--page: rest-api-admin-database.adoc @@ -622,12 +634,12 @@ endif::xref--pfx-sgw[] // :configuration-schema-access-control--page: rest-api-admin-access-control.adoc // :configuration-schema-access-control--xref: {sgw--xref}{configuration-schema-access-control--page}[Access Control Configuration API] -:configuration-schema--isgr--page: configuration-schema-isgr.adoc +:configuration-schema--isgr--page: configuration/configuration-schema-isgr.adoc :configuration-schema--isgr--xref: {sgw--xref}{configuration-schema--isgr--page}[Inter-Sync{nbsp}Replication Configuration API] -:rest-api-admin--page: rest-api-admin.adoc +:rest-api-admin--page: rest-api/rest-api-admin.adoc :rest-api-admin--pfx: {sgw--xref}{rest-api-admin--page} :rest-api-admin--xref: {rest-api-admin--pfx}[Admin REST API] @@ -662,7 +674,7 @@ endif::xref--pfx-sgw[] // :configuration-schema-database--xref-configure: {sgw--xref}{configuration-schema-database--page}#/configure[Configure Database] // :configuration-schema-database--xref-configure-model: {sgw--xref}{configuration-schema-database--page}#/configure/put__db___config[Database Configuration - Data Model] -:rest-api-admin-user--page: rest-api-admin.adoc +:rest-api-admin-user--page: rest-api/rest-api-admin.adoc :rest-api-admin-user-post--xref: {sgw--xref}{rest-api-admin--page}#tag/Database-Security/operation/put_db-_user-name[\{db\}/_user/\{name\}] // :configuration-schema--isgr--page: rest-api-admin-isgr.adoc @@ -676,110 +688,116 @@ endif::xref--pfx-sgw[] :rest-api-client-app--page: rest-api-client-app.adoc :rest-api-client-app--xref: {sgw--xref}{rest-api-client-app--page}[Use the REST API?] -:rest-api-metrics--page: rest-api-metrics.adoc +:rest-api-metrics--page: rest-api/rest-api-metrics.adoc :rest-api-metrics--xref: {sgw--xref}{rest-api-metrics--page}[Metrics REST API] -:resync--page: resync.adoc +:resync--page: manage/resync.adoc :resync--xref: {sgw--xref}{resync--page}[Resync] -:revisions--page: revisions.adoc +:revisions--page: manage/revisions.adoc :revisions--pfx: {sgw--xref}{revisions--page} :revisions--xref: {revisions--pfx}[Revisions] :revisions--xref-compacting: {revisions--pfx}#compacting[Revisions -- Compacting] -:roles--page: roles.adoc +:roles--page: access-control/roles.adoc :roles--xref: {sgw--xref}{roles--page}[Roles] :role--xref: {sgw--xref}{roles--page}[Role] -:secure-sgw-access--page: secure-sgw-access.adoc +:secure-sgw-access--page: security/secure-sgw-access.adoc :secure-sgw-access--pfx: {sgw--xref}{secure-sgw-access--page} :secure-sgw-access--xref: {secure-sgw-access--pfx}[Secure Sync Gateway Access] -:setting-up-dr-cluster--page: setting-up-dr-cluster.adoc +:setting-up-dr-cluster--page: deploy/setting-up-dr-cluster.adoc :setting-up-dr-cluster--xref: {sgw--xref}{setting-up-dr-cluster--page}[Disaster Recovery] -:server-compatibility-buckets--page: server-compatibility-buckets.adoc +:server-compatibility-buckets--page: server-compatibility/server-compatibility-buckets.adoc :server-compatibility-buckets-xref: {sgw--xref}{server-compatibility-buckets--page}[Server Compatibility - Buckets] -:server-compatibility-collections--page: server-compatibility-collections.adoc +:server-compatibility-collections--page: server-compatibility/server-compatibility-collections.adoc :server-compatibility-collections--xref: {sgw--xref}{server-compatibility-collections--page}[Server Compatibility - Collections] -:server-compatibility-eventing--page: server-compatibility-eventing.adoc +:server-compatibility-eventing--page: server-compatibility/server-compatibility-eventing.adoc :server-compatibility-eventing--xref: {sgw--xref}{server-compatibility-eventing--page}[Server Compatibility - Eventing] -:server-compatibility-transactions--page: server-compatibility-transactions.adoc +:server-compatibility-transactions--page: server-compatibility/server-compatibility-transactions.adoc :server-compatibility-transactions--xref: {sgw--xref}{server-compatibility-transactions--page}[Server Compatibility - Transactions] -:server-compatibility-xdcr--page: server-compatibility-xdcr.adoc +:server-compatibility-xdcr--page: server-compatibility/server-compatibility-xdcr.adoc :server-compatibility-xdcr--xref: {sgw--xref}{server-compatibility-xdcr--page}[Server Compatibility - XDCR] -:server-compatibility-backup-and-restore--page: server-compatibility-backups.adoc +:server-compatibility-backup-and-restore--page: server-compatibility/server-compatibility-backups.adoc :server-compatibility-backup-and-restore--xref: {sgw--xref}{server-compatibility-backup-and-restore--page}[Server Compatibility - Backup and restore] -:sgcollect-info--page: sgcollect-info.adoc + +:xdcr-active-active-eventing--page: server-compatibility/xdcr-active-active-eventing.adoc +:xdcr-active-active-eventing--xref: {sgw--xref}{xdcr-active-active-eventing--page}[XDCR Active-Active and Eventing] +:sgcollect-info--page: manage/sgcollect-info.adoc :sgcollect-info--xref: {sgw--xref}{sgcollect-info--page}[SGCollect Info] -:stats-monitoring--page: stats-monitoring.adoc +:stats-monitoring--page: manage/stats-monitoring.adoc :stats-monitoring--xref: {sgw--xref}{stats-monitoring--page}[Stats Monitoring] -:stats-prometheus--page: stats-prometheus.adoc +:stats-prometheus--page: deploy/stats-prometheus.adoc :stats-prometheus--xref: {sgw--xref}{stats-prometheus--page}[Stats Prometheus] :supported-environments--page: supported-environments.adoc :supported-environments--xref: {sgw--xref}{supported-environments--page}[Supported OS] -:sync-function-overview--page: sync-function-overview.adoc +:sync-function-overview--page: access-control/sync-function-api/sync-function-overview.adoc :sync-function-overview--xref: {sgw--xref}{sync-function-overview--page}[Sync Function Overview] -:sync-function--page: sync-function.adoc +:sync-function--page: access-control/sync-function-api/sync-function.adoc :sync-function--xref: {sgw--xref}{sync-function--page}[Sync Function] -:sync-function-api--page: sync-function-api.adoc +:sync-function-api--page: access-control/sync-function-api/sync-function-api.adoc :sync-function-api--xref: {sgw--xref}{sync-function-api--page}[Sync Function API] -:sync-function-api-access-cmd--page: sync-function-api-access-cmd.adoc +:sync-function-api-access-cmd--page: access-control/sync-function-api/sync-function-api-access-cmd.adoc :sync-function-api-access-cmd--xref: {sgw--xref}{sync-function-api-access-cmd--page}[access()] -:sync-function-api-channel-cmd--page: sync-function-api-channel-cmd.adoc +:sync-function-api-channel-cmd--page: access-control/sync-function-api/sync-function-api-channel-cmd.adoc :sync-function-api-channel-cmd--xref: {sgw--xref}{sync-function-api-channel-cmd--page}[channel()] -:sync-function-api-expiry-cmd--page: sync-function-api-expiry-cmd.adoc +:sync-function-api-expiry-cmd--page: access-control/sync-function-api/sync-function-api-expiry-cmd.adoc :sync-function-api-expiry-cmd--xref: {sgw--xref}{sync-function-api-expiry-cmd--page}[expiry()] -:sync-function-api-require-access-cmd--page: sync-function-api-require-access-cmd.adoc +:sync-function-api-require-access-cmd--page: access-control/sync-function-api/sync-function-api-require-access-cmd.adoc :sync-function-api-require-access-cmd--xref: {sgw--xref}{sync-function-api-require-access-cmd--page}[requireAccess()] -:sync-function-api-require-admin-cmd--page: sync-function-api-require-admin-cmd.adoc +:sync-function-api-require-admin-cmd--page: access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc :sync-function-api-require-admin-cmd--xref: {sgw--xref}{sync-function-api-require-admin-cmd--page}[requireAdmin()] -:sync-function-api-require-role-cmd--page: sync-function-api-require-role-cmd.adoc +:sync-function-api-require-role-cmd--page: access-control/sync-function-api/sync-function-api-require-role-cmd.adoc :sync-function-api-require-role-cmd--xref: {sgw--xref}{sync-function-api-require-role-cmd--page}[requireRole()] -:sync-function-api-require-user-cmd--page: sync-function-api-require-user-cmd.adoc +:sync-function-api-require-user-cmd--page: access-control/sync-function-api/sync-function-api-require-user-cmd.adoc :sync-function-api-require-user-cmd--xref: {sgw--xref}{sync-function-api-require-user-cmd--page}[requireUser()] -:sync-function-api-role-cmd--page: sync-function-api-role-cmd.adoc +:sync-function-api-role-cmd--page: access-control/sync-function-api/sync-function-api-role-cmd.adoc :sync-function-api-role-cmd--xref: {sgw--xref}{sync-function-api-role-cmd--page}[role()] -:sync-function-api-throw-cmd--page: sync-function-api-throw-cmd.adoc +:sync-function-api-throw-cmd--page: access-control/sync-function-api/sync-function-api-throw-cmd.adoc :sync-function-api-throw-cmd--xref: {sgw--xref}{sync-function-api-throw-cmd--page}[throw()] // :sync-function-api-require-channel: {sgw--xref}{sync-function-api--page}#lbl-require-channel[requireChannel()role] -:sync-inter-syncgateway-conflict-resolution--page: sync-inter-syncgateway-conflict-resolution.adoc +:sync-inter-syncgateway-conflict-resolution--page: sync/sync-inter-syncgateway-conflict-resolution.adoc :sync-inter-syncgateway-conflict-resolution--xref: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}[Inter Sync Gateway Sync - Conflict Resolution] :sync-inter-syncgateway-conflict-resolution--custom-conflict-resolution: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}#custom-conflict-resolution-ee[Inter Sync Gateway Sync - Custom Conflict Resolution] -:sync-inter-syncgateway-manage--page: sync-inter-syncgateway-manage.adoc +:sync-inter-syncgateway-manage--page: sync/sync-inter-syncgateway-manage.adoc :sync-inter-syncgateway-manage--pfx: {sgw--xref}{sync-inter-syncgateway-manage--page} :sync-inter-syncgateway-manage--xref: {sync-inter-syncgateway-manage--pfx}[Inter Sync Gateway Sync - Manage] :sync-inter-syncgateway-manage--xref-start: {sync-inter-syncgateway-manage--pfx}#starting-a-replication[Starting a replication] -:sync-inter-syncgateway-monitor--page: sync-inter-syncgateway-monitor.adoc +:sync-inter-syncgateway-monitor--page: sync/sync-inter-syncgateway-monitor.adoc :sync-inter-syncgateway-monitor--xref: {sgw--xref}{sync-inter-syncgateway-monitor--page}[Inter Sync Gateway Sync - Monitor] -:sync-inter-syncgateway-overview--page: sync-inter-syncgateway-overview.adoc +:sync-inter-syncgateway-overview--page: sync/sync-inter-syncgateway-overview.adoc :sync-inter-syncgateway-overview--xref: {sgw--xref}{sync-inter-syncgateway-overview--page}[Inter Sync Gateway Sync - Overview] -:sync-inter-syncgateway-run--page: sync-inter-syncgateway-run.adoc +:sync-inter-syncgateway-run--page: sync/sync-inter-syncgateway-run.adoc :sync-inter-syncgateway-run--xref: {sgw--xref}{sync-inter-syncgateway-run--page}[Inter Sync Gateway Sync - Run] -:sync-using-app--page: sync-using-app.adoc +:sync-using-app--page: sync/sync-using-app.adoc :sync-using-app--xref: {sgw--xref}{sync-using-app--page}[Sync Using App] -:sync-with-couchbase-server--page: sync-with-couchbase-server.adoc +:sync-with-couchbase-server--page: sync/sync-with-couchbase-server.adoc :sync-with-couchbase-server--xref: {sgw--xref}{sync-with-couchbase-server--page}[Sync with Couchbase Server] +:import-processing--page: sync/import-processing.adoc +:import-processing--xref: {sgw--xref}{import-processing--page}[Import Processing] + :upgrading--page: upgrading.adoc :upgrading--xref: {sgw--xref}{upgrading--page}[Upgrading] -:users--page: users.adoc +:users--page: access-control/users.adoc :users--xref: {sgw--xref}{users--page}[Users] :user--xref: {sgw--xref}{users--page}[User] -:webhooks--page: webhooks.adoc +:webhooks--page: deploy/webhooks.adoc :webhooks--xref: {sgw--xref}{webhooks--page}[Webhooks] diff --git a/modules/ROOT/pages/_partials/block_related_content_menulists.adoc b/modules/ROOT/pages/_partials/block_related_content_menulists.adoc index 26132ec7f..c1930aff0 100644 --- a/modules/ROOT/pages/_partials/block_related_content_menulists.adoc +++ b/modules/ROOT/pages/_partials/block_related_content_menulists.adoc @@ -60,13 +60,13 @@ // tag::reference-icr[] // tag::reference-config[] - * 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-legacy.adoc[Legacy Pre-3.0 Configuration] + * xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap] +* xref:configuration/configuration-schema-database.adoc[Database] +* xref:configuration/configuration-schema-db-security.adoc[Database Security] +* xref:configuration/configuration-schema-access-control.adoc[Access Control] +* xref:configuration/configuration-schema-import-filter.adoc[Import Filter] +* xref:configuration/configuration-schema-isgr.adoc[Inter-Sync{nbsp}Gateway Replication] +* xref:configuration/configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] // end::reference-config[] @@ -114,9 +114,9 @@ Blog Entries // tag::concept-syncfunc[] - * xref:configuration-schema-access-control.adoc[Access Control] + * xref:configuration/configuration-schema-access-control.adoc[Access Control] * xref:rest_api_admin.adoc#tag/Database-Configuration/operation/put_keyspace-_config-sync[Add/Update Sync Function] - * xref:sync-function-overview.adoc[Sync Function Overview] + * xref:access-control/sync-function-api/sync-function-overview.adoc[Sync Function Overview] // end::concept-syncfunc[] diff --git a/modules/ROOT/pages/_partials/common-releasenotes.adoc b/modules/ROOT/pages/_partials/common-releasenotes.adoc index b710bf7ae..178778f00 100644 --- a/modules/ROOT/pages/_partials/common-releasenotes.adoc +++ b/modules/ROOT/pages/_partials/common-releasenotes.adoc @@ -234,7 +234,7 @@ It makes the switching of the runtime behavior -- for example during development // end::new-300-environment-vars-full[] More:: - xref:configuration-environment-variables.adoc[Configuration Environment Variables] + xref:configuration/configuration-environment-variables.adoc[Configuration Environment Variables] // end::new-300-environment-vars[] // tag::feature1-300[] diff --git a/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc b/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc index f6db98fe3..14d4c02bf 100644 --- a/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc +++ b/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc @@ -22,7 +22,7 @@ Roles are created via the Sync Gateway Admin REST API -- see: {rest-api-admin--x + *Note* To use this option in v3.x, you must use the `-disable_persistent_config` CLI option. + -Configure roles in the xref:configuration-properties-legacy.adoc[Legacy Configuration Properties] file. +Configure roles in the xref:configuration/configuration-properties-legacy.adoc[Legacy Configuration Properties] file. *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. diff --git a/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc b/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc index 144973f08..16ef86254 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc +++ b/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc @@ -193,7 +193,7 @@ However, you should avoid initializing identical pre-2.8 (SG Replicate) and 2.8+ == Running Configured Replications Replications in the configuration file start automatically whenever Sync Gateway is (re)started. -Unless you inhibit this by adding an `"initial_state": "stopped"` parameter to the replication definition -- see: xref:configuration-schema-database.adoc#replications-replication_id-initial_state[initial_state]. +Unless you inhibit this by adding an `"initial_state": "stopped"` parameter to the replication definition -- see: xref:configuration/configuration-schema-database.adoc#replications-replication_id-initial_state[initial_state]. You can manually start 'stopped' replication using {sync-inter-syncgateway-manage--xref-start}. .Configured Replications -- Continuous and One-shot diff --git a/modules/ROOT/pages/access-control-concepts.adoc b/modules/ROOT/pages/access-control/access-control-concepts.adoc similarity index 100% rename from modules/ROOT/pages/access-control-concepts.adoc rename to modules/ROOT/pages/access-control/access-control-concepts.adoc diff --git a/modules/ROOT/pages/access-control-how-assign-users-to-roles.adoc b/modules/ROOT/pages/access-control/access-control-how-assign-users-to-roles.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-assign-users-to-roles.adoc rename to modules/ROOT/pages/access-control/access-control-how-assign-users-to-roles.adoc diff --git a/modules/ROOT/pages/access-control-how-control-document-access.adoc b/modules/ROOT/pages/access-control/access-control-how-control-document-access.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-control-document-access.adoc rename to modules/ROOT/pages/access-control/access-control-how-control-document-access.adoc diff --git a/modules/ROOT/pages/access-control-how-create-roles.adoc b/modules/ROOT/pages/access-control/access-control-how-create-roles.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-create-roles.adoc rename to modules/ROOT/pages/access-control/access-control-how-create-roles.adoc diff --git a/modules/ROOT/pages/access-control-how-create-users.adoc b/modules/ROOT/pages/access-control/access-control-how-create-users.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-create-users.adoc rename to modules/ROOT/pages/access-control/access-control-how-create-users.adoc diff --git a/modules/ROOT/pages/access-control-how-use-xattrs-for-access-grants.adoc b/modules/ROOT/pages/access-control/access-control-how-use-xattrs-for-access-grants.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-use-xattrs-for-access-grants.adoc rename to modules/ROOT/pages/access-control/access-control-how-use-xattrs-for-access-grants.adoc diff --git a/modules/ROOT/pages/access-control-how-verify-access.adoc b/modules/ROOT/pages/access-control/access-control-how-verify-access.adoc similarity index 100% rename from modules/ROOT/pages/access-control-how-verify-access.adoc rename to modules/ROOT/pages/access-control/access-control-how-verify-access.adoc diff --git a/modules/ROOT/pages/access-control-how.adoc b/modules/ROOT/pages/access-control/access-control-how.adoc similarity index 93% rename from modules/ROOT/pages/access-control-how.adoc rename to modules/ROOT/pages/access-control/access-control-how.adoc index 4607baa87..52feb1ce2 100644 --- a/modules/ROOT/pages/access-control-how.adoc +++ b/modules/ROOT/pages/access-control/access-control-how.adoc @@ -54,7 +54,7 @@ There are a number of ways in which you can control document distribution and us [#lst1] .Ways to configure access -* Legacy Pre 3.0: Use the xref:configuration-properties-legacy.adoc[Legacy Configuration Properties] file's xref:configuration-properties-legacy.adoc#databases-user-admin-channels[admin_user_channels] +* Legacy Pre 3.0: Use the xref:configuration/configuration-properties-legacy.adoc[Legacy Configuration Properties] file's xref:configuration/configuration-properties-legacy.adoc#databases-user-admin-channels[admin_user_channels] * Dynamically ** At the time of user creation with Admin REST Endpoint {rest-api-admin-user-post--xref} using `admin_channel` ** Using the Sync Function's {sync-function-api-access-cmd--xref}. diff --git a/modules/ROOT/pages/access-control-model.adoc b/modules/ROOT/pages/access-control/access-control-model.adoc similarity index 100% rename from modules/ROOT/pages/access-control-model.adoc rename to modules/ROOT/pages/access-control/access-control-model.adoc diff --git a/modules/ROOT/pages/auto-purge-channel-access-revocation.adoc b/modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc similarity index 97% rename from modules/ROOT/pages/auto-purge-channel-access-revocation.adoc rename to modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc index d2916a1d9..c7d6b0299 100644 --- a/modules/ROOT/pages/auto-purge-channel-access-revocation.adoc +++ b/modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc @@ -132,7 +132,7 @@ NOTE: This behavior is the *reverse* of that between {sgw-t} and Couchbase Lite By default, documents are *not* auto purged on the active sync gateway even if the user on the passive sync gateway loses channel access. -You can opt-in to auto-purge behavior using the replicator level option `purge_on_removal` in the REST API -- see: xref:configuration-schema-isgr.adoc#replication-purge_on_removal[replication-purge_on_removal]. +You can opt-in to auto-purge behavior using the replicator level option `purge_on_removal` in the REST API -- see: xref:configuration/configuration-schema-isgr.adoc#replication-purge_on_removal[replication-purge_on_removal]. Documents will then *be* auto-purged -- on active Sync Gateway nodes that have opted-in -- if they do not belong to *any* of the replicating user’s footnote:[pass:q,a[The _replicating user_ is the user on the _passive_ sync gateway cluster; the user specified in the replication definition.]] channels -- see: <>. @@ -244,8 +244,8 @@ Subsequent changes to previously rejected documents are automatically pushed up. [#ex-sync-function-auto-purge] == Sync Function Examples -Couchbase Sync Gateway defines a Sync Function at the `collection` level. -Defining at this level helps simplify data management and improve data reliability. +Couchbase Sync Gateway defines a Sync Function at the `collection` level. +Defining at this level helps simplify data management and improve data reliability. Each collection in the system allows for only one Sync Function, which enables the specification of Access Control rules. .Default Sync Function @@ -256,8 +256,8 @@ Each collection in the system allows for only one Sync Function, which enables t [source, javascript] ---- -function (doc, oldDoc, meta) { - channel(CollectionName); +function (doc, oldDoc, meta) { + channel(CollectionName); } ---- @@ -282,7 +282,7 @@ To override this, use a custom sync function or a Specified Default Sync Functio function (doc, oldDoc, meta) { channel(doc.channels); -} +} ---- Here is the default Sync Function when you have upgraded; it remains the same as the previous version. diff --git a/modules/ROOT/pages/channels.adoc b/modules/ROOT/pages/access-control/channels.adoc similarity index 100% rename from modules/ROOT/pages/channels.adoc rename to modules/ROOT/pages/access-control/channels.adoc diff --git a/modules/ROOT/pages/roles.adoc b/modules/ROOT/pages/access-control/roles.adoc similarity index 100% rename from modules/ROOT/pages/roles.adoc rename to modules/ROOT/pages/access-control/roles.adoc diff --git a/modules/ROOT/pages/sync-function-api-access-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-access-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-access-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-access-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-channel-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-channel-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-channel-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-channel-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-expiry-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-expiry-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-expiry-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-expiry-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-require-access-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-access-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-require-access-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-access-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-require-admin-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-require-admin-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-require-role-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-role-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-require-role-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-role-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-require-user-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-user-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-require-user-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-require-user-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-role-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-role-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-role-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-role-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api-throw-cmd.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api-throw-cmd.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api-throw-cmd.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api-throw-cmd.adoc diff --git a/modules/ROOT/pages/sync-function-api.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function-api.adoc similarity index 100% rename from modules/ROOT/pages/sync-function-api.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function-api.adoc diff --git a/modules/ROOT/pages/sync-function.adoc b/modules/ROOT/pages/access-control/sync-function-api/sync-function.adoc similarity index 100% rename from modules/ROOT/pages/sync-function.adoc rename to modules/ROOT/pages/access-control/sync-function-api/sync-function.adoc diff --git a/modules/ROOT/pages/users.adoc b/modules/ROOT/pages/access-control/users.adoc similarity index 100% rename from modules/ROOT/pages/users.adoc rename to modules/ROOT/pages/access-control/users.adoc diff --git a/modules/ROOT/pages/audit-log-events.adoc b/modules/ROOT/pages/audit-log-events.adoc deleted file mode 100644 index 2ed12bd2e..000000000 --- a/modules/ROOT/pages/audit-log-events.adoc +++ /dev/null @@ -1,789 +0,0 @@ -= Audit Logging Events Reference -:page-edition: Enterprise -:description: Audit Logging provides tools for administrators to track operational irregularities and to support regulatory and security compliance standards, such as link:https://www.hhs.gov/hipaa/index.html[HIPAA] and link:https://soc2.co.uk/soc2[SOC-2]. Below is a list of possible Audit Events. - - -[abstract] -{description} - -== About Audit Events - -You can use audit events to track and provide context on user activity within your application. - -.Events table field description -[cols="2*"] -|=== - -| Field Name | Description - -|`ID` -|A unique number used to distinguish between Audit Events. -You can use the value to specify which events will be present or written to your audit logs, either globally or on a database level. - -|`Name` -|A short descriptive name, this will be outputted as a field in the audit log. - -|`Description` -|A longer name, this is will be outputted as a field in the audit log. - -|`DefaultEnabled` -|If `true`, the given Audit Event is enabled by default. - -|`Filterable` -|If `true`, the given audit event can be disabled. - -|`EventScope` -|The scope of the event. -This can be `Global` or `Database`. -You can configure global scope events via the xref:configuration-schema-bootstrap.adoc#logging-audit-audit_log_file_path[bootstrap config], and database events via the xref:rest_api_admin.adoc[Admin REST API]. - -|`EventType` -|The type of action performed by the event. -This can be `user`, `admin`, or `data`. - -|`MandatoryFields` -|Fields that are always present in a given Audit Event. - -|`OptionalFields` -|May or may not be present in a given Audit Event. - -|=== - -=== Audit Event Types - -Audit Events can be one of the following types: - -* `Admin` - Events that track administrative and configuration changes. - -* `Data` - Events that track attempts to access and change data. - -* `User` - Events that track end-user operations. - -=== Audit Event Scopes - -Audit events have scope, this affects how they can be configured. -The audit events scopes are: - -* `Database` - These events are specific to a database such as `AuditIDDocumentUpdate 55002`, and can only be enabled/disabled at the database configuration level. -Database level audit events are segregated into per Sync Gateway database specific audit logs. - -* `Global` - These events are considered global such as `AuditIDSyncGatewayStartup 53260`, and have to be enabled/disabled in the bootstrap config. - - -=== Auditing Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|53248 -|Auditing enabled -|Audit logging was enabled -|TRUE -|FALSE -|Global -|admin -|audit_scope, description, id, name, timestamp, db - -|53249 -|Auditing disabled -|Audit logging was disabled -|TRUE -|FALSE -|Global -|admin -|audit_scope, description, id, name, timestamp - -|53250 -|Auditing configuration changed -|Audit logging configuration was changed -|TRUE -|FALSE -|Global -|admin -|audit_scope, cid, db, description, id, local, name, payload, real_userid, remote, timestamp - -|=== - -=== Sync Gateway Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|53260 -|Sync Gateway startup -|Sync Gateway started -|TRUE -|FALSE -|Global -|admin -|admin_interface_authentication, bcrypt_cost, description, disable_persistent_config, id, log_file_path, metrics_interface_authentication, name, server_tls_skip_verify, sg_version, timestamp, use_tls_server - -|53270 -|Public HTTP API request -|Public HTTP API request was made -|FALSE -|TRUE -|Global -|user -|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body - -|53271 -|Admin HTTP API request -|Admin HTTP API request was made -|FALSE -|TRUE -|Global -|admin -|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body - -|53272 -|Metrics HTTP API request -|Metrics HTTP API request was made -|FALSE -|TRUE -|Global -|admin -|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body - -|53280 -|Public API user authenticated -|Public API user successfully authenticated -|TRUE -|TRUE -|Database -|user -|auth_method, description, id, name, timestamp, oidc_issuer - -|53281 -|Public API user authentication failed -|Public API user failed to authenticate -|TRUE -|TRUE -|Database -|user -|auth_method, description, id, name, timestamp, username - -|53282 -|Public API user session created -|Public API user session was created -|TRUE -|TRUE -|Database -|user -|description, id, name, session_id, timestamp, username - -|53283 -|Public API user session deleted -|Public API user session was deleted -|TRUE -|TRUE -|Database -|user -|description, id, name, session_id, timestamp, username - -|53284 -|Public API user all sessions deleted -|All sessions were deleted for a Public API user -|TRUE -|TRUE -|Database -|user -|description, id, name, timestamp, username - -|53290 -|Admin API user authenticated -|Admin API user successfully authenticated -|TRUE -|TRUE -|Database -|admin -|description, id, name, timestamp - -|53291 -|Admin API user authentication failed -|Admin API user failed to authenticate -|TRUE -|TRUE -|Database -|admin -|description, id, name, timestamp, username - -|53292 -|Admin API user authorization failed -|Admin API user failed to authorize -|TRUE -|TRUE -|Database -|admin -|description, id, name, timestamp, username - -|53300 -|sgcollect_info status -|sgcollect_info status was viewed -|TRUE -|TRUE -|Global -|admin -|cid, description, id, local, name, real_userid, remote, timestamp - -|53301 -|sgcollect_info start -|sgcollect_info was started -|TRUE -|TRUE -|Global -|admin -|cid, customer, description, id, keep_zip, local, name, output_dir, real_userid, remote, ticket, timestamp, upload_host, zip_filename - -|53302 -|sgcollect_info stop -|sgcollect_info was stopped -|TRUE -|TRUE -|Global -|admin -|cid, description, id, local, name, real_userid, remote, timestamp - -|53303 -|stats requested -|stats were requested -|FALSE -|TRUE -|Global -|admin -|cid, description, id, local, name, real_userid, remote, stats_format, timestamp - -|53304 -|profiling requested -|profiling was requested -|TRUE -|TRUE -|Global -|admin -|description, id, name, profile_type, timestamp, filename - -|53350 -|Sync Gateway cluster info read -|Sync Gateway cluster info was viewed -|TRUE -|TRUE -|Global -|admin -|description, id, name, timestamp - -|=== - -=== Database Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|54000 -|Create database -|A new database was created -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, payload, real_userid, remote, timestamp - -|54001 -|Read database -|Information about this database was viewed -|FALSE -|TRUE -|Database -|user -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54002 -|Delete database -|A database was deleted -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54003 -|Read all databases -|All databases were viewed -|FALSE -|TRUE -|Global -|admin -|cid, db_names, description, id, local, name, real_userid, remote, timestamp - -|54010 -|Read database config -|Database configuration was viewed -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54011 -|Update database config -|Database configuration was updated -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, payload, real_userid, remote, timestamp - -|54020 -|Database offline -|Database was taken offline -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54021 -|Database online -|Database was brought online -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54030 -|Database compaction status -|Database compaction status was viewed -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp, type - -|54031 -|Database attachment compaction start -|Database attachment compaction was started -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp, type, dry_run, reset - -|54032 -|Database compaction stop -|Database compaction was stopped -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp, type - -|54040 -|Database resync status -|Database resync status was viewed -|FALSE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54041 -|Database resync start -|Database resync was started -|TRUE -|TRUE -|Database -|admin -|cid, collections, db, description, id, local, name, real_userid, regenerate_sequences, remote, reset, timestamp - -|54042 -|Database resync stop -|Database resync was stopped -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54043 -|Post-upgrade -|Post-upgrade was run for Sync Gateway databases -|TRUE -|TRUE -|Global -|admin -|cid, description, id, local, name, preview, real_userid, remote, timestamp - -|54044 -|Database repair -|Database repair was run -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54045 -|Database flush -|Database flush was run -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|=== - - -=== User and Role Administration Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|54100 -|Create user -|A new user was created -|TRUE -|TRUE -|Database -|admin -|channels, db, description, id, name, roles, timestamp, username - -|54101 -|Read user -|Information about this user was viewed -|TRUE -|TRUE -|Database -|admin -|db, description, id, name, timestamp, username - -|54102 -|Update user -|User was updated -|TRUE -|TRUE -|Database -|admin -|channels, db, description, id, name, roles, timestamp, username - -|54103 -|Delete user -|User was deleted -|TRUE -|TRUE -|Database -|admin -|db, description, id, name, timestamp, username - -|54104 -|Read all users -|List of all users was viewed -|TRUE -|TRUE -|Database -|admin -|db, description, id, name, name_only, timestamp, limit - -|54110 -|Create role -|A new role was created -|TRUE -|TRUE -|Database -|admin -|admin_channels, db, description, id, name, role, timestamp - -|54111 -|Read role -|Information about this role was viewed -|TRUE -|TRUE -|Database -|admin -|db, description, id, name, role, timestamp - -|54112 -|Update role -|Role was updated -|TRUE -|TRUE -|Database -|admin -|admin_channels, db, description, id, name, role, timestamp - -|54113 -|Delete role -|Role was deleted -|TRUE -|TRUE -|Database -|admin -|db, description, id, name, role, timestamp - -|54114 -|Read all roles -|List of all roles was viewed -|TRUE -|TRUE -|Database -|admin -|db, description, id, include_deleted, name, timestamp, limit - -|=== - -=== Replication Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|54200 -|Changes feed started -|Changes feed was started -|TRUE -|TRUE -|Database -|data -|cid, db, description, id, ks, local, name, real_userid, remote, since, timestamp, channels, doc_ids, feed_type, filter, include_docs - -|54300 -|Replication connect -|A replication client connected -|TRUE -|TRUE -|Database -|user -|cid, client_type, db, description, id, local, name, real_userid, remote, timestamp, client_version - -|54301 -|Replication disconnect -|A replication client disconnected -|TRUE -|TRUE -|Database -|user -|cid, client_type, db, description, id, local, name, real_userid, remote, timestamp - -|54400 -|Create Inter-Sync Gateway Replication -|A new Inter-Sync Gateway Replication was created -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, payload, real_userid, remote, replication_id, timestamp - -|54401 -|Read Inter-Sync Gateway Replication -|Information about this Inter-Sync Gateway Replication was viewed -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54402 -|Update Inter-Sync Gateway Replication -|Inter-Sync Gateway Replication was updated -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, payload, real_userid, remote, replication_id, timestamp - -|54403 -|Delete Inter-Sync Gateway Replication -|Inter-Sync Gateway Replication was deleted -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54410 -|Inter-Sync Gateway Replication status -|Inter-Sync Gateway Replication status was document viewed -|FALSE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54411 -|Inter-Sync Gateway Replication start -|Inter-Sync Gateway Replication was started -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54412 -|Inter-Sync Gateway Replication stop -|Inter-Sync Gateway Replication was stopped -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54413 -|Inter-Sync Gateway Replication reset -|Inter-Sync Gateway Replication was reset -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp - -|54420 -|All Inter-Sync Gateway Replication status -|All Inter-Sync Gateway Replication statuses were viewed -|FALSE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|54421 -|Read all Inter-Sync Gateway Replications -|All Inter-Sync Gateway Replications were viewed -|TRUE -|TRUE -|Database -|admin -|cid, db, description, id, local, name, real_userid, remote, timestamp - -|=== - -=== Document Related Events - -[cols="8*"] -|=== -|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields - -|55000 -|Create document -|A new document was created -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55001 -|Read document -|A document was viewed -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55002 -|Update document -|A document was updated -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55003 -|Delete document -|A document was deleted -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, id, ks, name, real_userid, timestamp, cid, doc_version, local, purged, remote - -|55004 -|Read document metadata -|Document metadata was viewed -|FALSE -|TRUE -|Database -|data -|cid, db, description, doc_id, id, ks, local, name, real_userid, remote, timestamp - -|55005 -|Import document -|A document was imported -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, timestamp - -|55006 -|Resync document -|A document was resynced -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, timestamp - -|55007 -|Revoke document -|A document revocation request was sent to a client -|FALSE -|TRUE -|Database -|data -|db, description, doc_id, doc_version, id, ks, name, timestamp - -|55010 -|Create attachment -|A new attachment was created -|FALSE -|TRUE -|Database -|data -|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55011 -|Read attachment -|An attachment was viewed -|FALSE -|TRUE -|Database -|data -|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55012 -|Update attachment -|An attachment was updated -|FALSE -|TRUE -|Database -|data -|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote - -|55013 -|Delete attachment -|An attachment was deleted -|FALSE -|TRUE -|Database -|data -|attachment_id, db, description, doc_id, id, ks, name, real_userid, timestamp, cid, doc_version, local, remote - -|=== - -== See Also - -* xref:audit-logging.adoc[] - -* xref:manage-audit-logs.adoc[] - -* xref:sgcollect-info.adoc[] - -* xref:rest_api_admin.adoc[Admin REST API Reference] - -* xref:rest_api_admin_static.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/configuration-environment-variables.adoc b/modules/ROOT/pages/configuration/configuration-environment-variables.adoc similarity index 100% rename from modules/ROOT/pages/configuration-environment-variables.adoc rename to modules/ROOT/pages/configuration/configuration-environment-variables.adoc diff --git a/modules/ROOT/pages/configuration-javascript-functions.adoc b/modules/ROOT/pages/configuration/configuration-javascript-functions.adoc similarity index 100% rename from modules/ROOT/pages/configuration-javascript-functions.adoc rename to modules/ROOT/pages/configuration/configuration-javascript-functions.adoc diff --git a/modules/ROOT/pages/configuration-overview.adoc b/modules/ROOT/pages/configuration/configuration-overview.adoc similarity index 100% rename from modules/ROOT/pages/configuration-overview.adoc rename to modules/ROOT/pages/configuration/configuration-overview.adoc diff --git a/modules/ROOT/pages/configuration-properties-legacy.adoc b/modules/ROOT/pages/configuration/configuration-properties-legacy.adoc similarity index 100% rename from modules/ROOT/pages/configuration-properties-legacy.adoc rename to modules/ROOT/pages/configuration/configuration-properties-legacy.adoc diff --git a/modules/ROOT/pages/configuration-rest-api.adoc b/modules/ROOT/pages/configuration/configuration-rest-api.adoc similarity index 100% rename from modules/ROOT/pages/configuration-rest-api.adoc rename to modules/ROOT/pages/configuration/configuration-rest-api.adoc diff --git a/modules/ROOT/pages/configuration-schema-access-control.adoc b/modules/ROOT/pages/configuration/configuration-schema-access-control.adoc similarity index 100% rename from modules/ROOT/pages/configuration-schema-access-control.adoc rename to modules/ROOT/pages/configuration/configuration-schema-access-control.adoc diff --git a/modules/ROOT/pages/configuration-schema-bootstrap.adoc b/modules/ROOT/pages/configuration/configuration-schema-bootstrap.adoc similarity index 100% rename from modules/ROOT/pages/configuration-schema-bootstrap.adoc rename to modules/ROOT/pages/configuration/configuration-schema-bootstrap.adoc diff --git a/modules/ROOT/pages/configuration-schema-database.adoc b/modules/ROOT/pages/configuration/configuration-schema-database.adoc similarity index 100% rename from modules/ROOT/pages/configuration-schema-database.adoc rename to modules/ROOT/pages/configuration/configuration-schema-database.adoc diff --git a/modules/ROOT/pages/configuration-schema-db-security.adoc b/modules/ROOT/pages/configuration/configuration-schema-db-security.adoc similarity index 100% rename from modules/ROOT/pages/configuration-schema-db-security.adoc rename to modules/ROOT/pages/configuration/configuration-schema-db-security.adoc diff --git a/modules/ROOT/pages/configuration-schema-import-filter.adoc b/modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc similarity index 93% rename from modules/ROOT/pages/configuration-schema-import-filter.adoc rename to modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc index 050c565a0..04775c981 100644 --- a/modules/ROOT/pages/configuration-schema-import-filter.adoc +++ b/modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc @@ -15,11 +15,11 @@ include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] Using an import filter will significantly improve efficiency if you're working with large datasets: -* Import filters are defined at the collection level and allow you to retrieve only the relevant documents you need rather than the entire dataset. -The import filter helps determine which documents can be copied by Sync Gateway. +* Import filters are defined at the collection level and allow you to retrieve only the relevant documents you need rather than the entire dataset. +The import filter helps determine which documents can be copied by Sync Gateway. It looks at the application's needs and applies these criteria to all future changes. -* By reducing the amount of data that needs to be processed, an import filter will improve the performance of your queries and analysis. +* By reducing the amount of data that needs to be processed, an import filter will improve the performance of your queries and analysis. It's worth noting that Sync Gateway imports all documents by default, so it's generally a good idea to use an import filter unless you have a strong reason not to. See: {import-filter--xref} for more. @@ -34,10 +34,10 @@ See: {configuration-properties-legacy--xref--databases-import-filter}. == Configuration NOTE: You need Couchbase Lite 3.1+ and Sync Gateway 3.1+ to use `custom` Scopes and Collections. + -If you're using Capella App Services or Sync Gateway releases that are older than version 3.1, you won't be able to access `custom` Scopes and Collections. +If you're using Capella App Services or Sync Gateway releases that are older than version 3.1, you won't be able to access `custom` Scopes and Collections. To use Couchbase Lite 3.1+ with these older versions, you can use the `default` Collection as a backup option. -The configuration settings described here are provisioned through the xref:rest-api-admin.adoc[Database Configuration] endpoints. +The configuration settings described here are provisioned through the xref:rest-api/rest-api-admin.adoc[Database Configuration] endpoints. [source,JSON] ---- @@ -55,13 +55,13 @@ The configuration settings described here are provisioned through the xref:rest- } ---- -For more information, see xref:configuration-schema-database.adoc#DatabaseConfig[Sync Gateway Configuration Schema]. +For more information, see xref:configuration/configuration-schema-database.adoc#DatabaseConfig[Sync Gateway Configuration Schema]. [cols="2", options="header"] |=== | Property | Description -| scopename +| scopename | Represents the name of each scope | collections diff --git a/modules/ROOT/pages/configuration-schema-isgr.adoc b/modules/ROOT/pages/configuration/configuration-schema-isgr.adoc similarity index 100% rename from modules/ROOT/pages/configuration-schema-isgr.adoc rename to modules/ROOT/pages/configuration/configuration-schema-isgr.adoc diff --git a/modules/ROOT/pages/scopes-and-collections-config.adoc b/modules/ROOT/pages/configuration/scopes-and-collections-config.adoc similarity index 95% rename from modules/ROOT/pages/scopes-and-collections-config.adoc rename to modules/ROOT/pages/configuration/scopes-and-collections-config.adoc index 5dda84934..6e3f05fd1 100644 --- a/modules/ROOT/pages/scopes-and-collections-config.adoc +++ b/modules/ROOT/pages/configuration/scopes-and-collections-config.adoc @@ -6,7 +6,7 @@ ifdef::prerelease[:page-status: {prerelease}] :page-content: conceptual :description: pass:q[Configure Scopes and Collections for Sync Gateway - Examples with descriptions.] -This section explains how to configure Scopes and Collections for Sync Gateway. +This section explains how to configure Scopes and Collections for Sync Gateway. It describes configuration options and provides example configuration code. == Understanding Buckets, Scopes, and Collections @@ -14,8 +14,8 @@ You can define 1 custom scope per database with up to 1000 custom collections. I == Configuration Options -When upgrading to Sync Gateway 3.1, it's not necessary to include `scopes` and `collections` in the configuration. -If you choose not to specify them, your previous data set will still be compatible. +When upgrading to Sync Gateway 3.1, it's not necessary to include `scopes` and `collections` in the configuration. +If you choose not to specify them, your previous data set will still be compatible. Keep in mind that the provided examples are optional. You have these options to configure Scopes and Collections Sync for Gateway: @@ -97,19 +97,19 @@ This example covers a configuration with 1 custom Scope and 2 custom Collections | collections | An object representing collections within the `scope1` scope. Each collection has its sync and import filter functions. | | | collection1 | The name of the first collection within `scope1`. -| sync | The sync function associated with `collection1`. This function is triggered when a document is created or updated in the collection. This code example illustrates a specific use case for sync functions. -For more information, see xref:sync-function.adoc[Sync Functions]. +| sync | The sync function associated with `collection1`. This function is triggered when a document is created or updated in the collection. This code example illustrates a specific use case for sync functions. +For more information, see xref:access-control/sync-function-api/sync-function.adoc[Sync Functions]. | | The sync function checks if the `type` field of the document is not `default`. If it's not, it throws a `forbidden` error, rejecting the document. | | After the rejection, it sends a message to the `legacy` channel. -| import_filter | The import filter function associated with `collection1`. This function is used when importing documents into the collection. +| import_filter | The import filter function associated with `collection1`. This function is used when importing documents into the collection. For more information, see xref:import-filter.adoc[Import Filters]. | | The import filter checks if the `type` field of the document is `mobile`. If it is, the document will be imported; otherwise, it will be skipped. | | | collection2 | The name of the second collection within `scope1`. -| sync | The sync function associated with `collection2`. This function is triggered when a document is created or updated in the collection. -For more information, see xref:sync-function.adoc[Sync Functions]. +| sync | The sync function associated with `collection2`. This function is triggered when a document is created or updated in the collection. +For more information, see xref:access-control/sync-function-api/sync-function.adoc[Sync Functions]. | | The sync function sends a message to the `collection1` channel. -| import_filter | The import filter function associated with `collection2`. This function is used when importing documents into the collection. +| import_filter | The import filter function associated with `collection2`. This function is used when importing documents into the collection. For more information, see xref:import-filter.adoc[Import Filters]. | | The import filter checks if the `type` field of the document is `mobile`. If it is, the document will be imported; otherwise, it will be skipped. | | diff --git a/modules/ROOT/pages/changes-feed.adoc b/modules/ROOT/pages/deploy/changes-feed.adoc similarity index 100% rename from modules/ROOT/pages/changes-feed.adoc rename to modules/ROOT/pages/deploy/changes-feed.adoc diff --git a/modules/ROOT/pages/command-line-options.adoc b/modules/ROOT/pages/deploy/command-line-options.adoc similarity index 100% rename from modules/ROOT/pages/command-line-options.adoc rename to modules/ROOT/pages/deploy/command-line-options.adoc diff --git a/modules/ROOT/pages/deployment.adoc b/modules/ROOT/pages/deploy/deployment.adoc similarity index 93% rename from modules/ROOT/pages/deployment.adoc rename to modules/ROOT/pages/deploy/deployment.adoc index 263bdcd2f..cb37f7800 100644 --- a/modules/ROOT/pages/deployment.adoc +++ b/modules/ROOT/pages/deploy/deployment.adoc @@ -48,7 +48,7 @@ Replicator node:: If you are using inter-Sync Gateway replication then you will have a designated replicator node whose configuration is different than the rest of the nodes -- see {sync-inter-syncgateway-overview--xref}. Sync Gateway nodes are "shared-nothing," so they don’t need to coordinate any state or even know about each other. -With multiple Sync Gateways, we recommend placing this cluster behind a load balancer server to coordinate connection requests in clients (see the xref:load-balancer.adoc[Load Balancer] guide). +With multiple Sync Gateways, we recommend placing this cluster behind a load balancer server to coordinate connection requests in clients (see the xref:deploy/load-balancer.adoc[Load Balancer] guide). == Channel and Revision Caches .Enterprise Edition only @@ -80,8 +80,8 @@ Therefore, adding more CPU cores to a Sync Gateway node can speed it up. - As is typical with databases, writes are going to put a greater load on the system than reads. In particular, every write operation gets processed by the {sync-function--xref} and triggers notifications to other clients with read access, who then perform reads to get the new data. - Each client running a continuous replication has an open socket to be notified of changes. These sockets remain idle most of the time (unless documents are modified at a very high rate), so the actual data traffic is low — the issue is just managing that many sockets. -We recommend developers to optimize how many connections they need to open to the sync tier (see the xref:os-level-tuning.adoc[OS Level Tuning] guide). -- In a Sync Gateway deployment with xref:indexing.adoc[GSI/{sqlpp} indexing], the resources allocated to the Couchbase Server index node must be sufficient to support Sync Gateway operations. +We recommend developers to optimize how many connections they need to open to the sync tier (see the xref:deploy/os-level-tuning.adoc[OS Level Tuning] guide). +- In a Sync Gateway deployment with xref:deploy/indexing.adoc[GSI/{sqlpp} indexing], the resources allocated to the Couchbase Server index node must be sufficient to support Sync Gateway operations. - As Sync Gateway is optimized to use RAM, performance can be gained (or at minimum not lost) by changing the Linux swappiness value to 0 (see the xref:server:install:install-swap-space.adoc[Swap Space and Kernel Swappiness] guide). include::partial$block-related-content-deploy.adoc[] diff --git a/modules/ROOT/pages/index-partitions.adoc b/modules/ROOT/pages/deploy/index-partitions.adoc similarity index 94% rename from modules/ROOT/pages/index-partitions.adoc rename to modules/ROOT/pages/deploy/index-partitions.adoc index c3706c8fe..5cc15594f 100644 --- a/modules/ROOT/pages/index-partitions.adoc +++ b/modules/ROOT/pages/deploy/index-partitions.adoc @@ -90,7 +90,7 @@ The advantage is no downtime; the disadvantage is temporarily higher resource us . Optionally, rebalance index nodes using Couchbase Server. For details, see xref:server:learn:clusters-and-availability/rebalance.adoc#index-redistribution[Index Redistribution] in the Couchbase Server documentation. -WARNING: If you are using xref:configuration-overview.adoc#lbl-config-grp[configuration groups] running on a different index configuration, calling xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] can delete indexes out from under a running database. +WARNING: If you are using xref:configuration/configuration-overview.adoc#lbl-config-grp[configuration groups] running on a different index configuration, calling xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] can delete indexes out from under a running database. Please ensure that all configuration groups have consistent index configuration. For details, see <>. @@ -132,7 +132,7 @@ Changing the number of partitions "just to test it" may permanently increase ind [#config-groups] == Configuration Group Considerations -If your deployment uses xref:configuration-overview.adoc#lbl-config-grp[Configuration Groups], ensure that: +If your deployment uses xref:configuration/configuration-overview.adoc#lbl-config-grp[Configuration Groups], ensure that: * All nodes are updated with the new config before running xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`]. * Import and sync workloads are not unintentionally unbalanced across partitions. diff --git a/modules/ROOT/pages/indexing.adoc b/modules/ROOT/pages/deploy/indexing.adoc similarity index 97% rename from modules/ROOT/pages/indexing.adoc rename to modules/ROOT/pages/deploy/indexing.adoc index b0bd6f55b..c6b200b13 100644 --- a/modules/ROOT/pages/indexing.adoc +++ b/modules/ROOT/pages/deploy/indexing.adoc @@ -19,7 +19,7 @@ It also improves overall query performance. Sync Gateway 3.3 supports partitioned indexes. This enables you to divide and spread a large index across multiple nodes. -For details, see xref:index-partitions.adoc[]. +For details, see xref:deploy/index-partitions.adoc[]. == Configuration This capability is enabled by default and is supported by two properties in the configuration file which can be adjusted: diff --git a/modules/ROOT/pages/load-balancer.adoc b/modules/ROOT/pages/deploy/load-balancer.adoc similarity index 100% rename from modules/ROOT/pages/load-balancer.adoc rename to modules/ROOT/pages/deploy/load-balancer.adoc diff --git a/modules/ROOT/pages/os-level-tuning.adoc b/modules/ROOT/pages/deploy/os-level-tuning.adoc similarity index 100% rename from modules/ROOT/pages/os-level-tuning.adoc rename to modules/ROOT/pages/deploy/os-level-tuning.adoc diff --git a/modules/ROOT/pages/setting-up-dr-cluster.adoc b/modules/ROOT/pages/deploy/setting-up-dr-cluster.adoc similarity index 100% rename from modules/ROOT/pages/setting-up-dr-cluster.adoc rename to modules/ROOT/pages/deploy/setting-up-dr-cluster.adoc diff --git a/modules/ROOT/pages/stats-prometheus.adoc b/modules/ROOT/pages/deploy/stats-prometheus.adoc similarity index 100% rename from modules/ROOT/pages/stats-prometheus.adoc rename to modules/ROOT/pages/deploy/stats-prometheus.adoc diff --git a/modules/ROOT/pages/webhooks.adoc b/modules/ROOT/pages/deploy/webhooks.adoc similarity index 100% rename from modules/ROOT/pages/webhooks.adoc rename to modules/ROOT/pages/deploy/webhooks.adoc diff --git a/modules/ROOT/pages/glossary.adoc b/modules/ROOT/pages/glossary.adoc index 64df60453..27b6c5534 100644 --- a/modules/ROOT/pages/glossary.adoc +++ b/modules/ROOT/pages/glossary.adoc @@ -471,7 +471,7 @@ They have the '“_deleted”: true' property, are replicated, but are not retur } ---- Mentioned in: -* xref:managing-tombstones.adoc[Managing Tombstones] +* xref:manage/managing-tombstones.adoc[Managing Tombstones] * xref:shared-bucket-access.adoc#metadata-purge-interval[Metadata Purge Interval] * {configuration-schema-database--pfx--db}-enable_shared_bucket_access[$dbname.enable_shared_bucket_access] * xref:server:learn:buckets-memory-and-storage/storage.adoc#tombstones[Server Tombstones] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index db54a2795..e1f963e6e 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -79,16 +79,16 @@ It serves as the synchronization server in a Couchbase Mobile deployment, enabli .Features * Data Sync - ** xref:sync-with-couchbase-server.adoc[Sync with Server] - ** xref:sync-using-app.adoc[Sync with Application] - ** xref:sync-function.adoc[Sync Function] + ** xref:sync/sync-with-couchbase-server.adoc[Sync with Server] +** xref:sync/sync-using-app.adoc[Sync with Application] + ** xref:access-control/sync-function-api/sync-function.adoc[Sync Function] ** xref:import-filter.adoc[Import Filter] * Inter Sync Gateway Sync - ** xref:sync-inter-syncgateway-overview.adoc[Overview] - ** xref:sync-inter-syncgateway-run.adoc[Initialize] - ** xref:sync-inter-syncgateway-manage.adoc[Manage] - ** xref:sync-inter-syncgateway-monitor.adoc[Monitor] + ** xref:sync/sync-inter-syncgateway-overview.adoc[Overview] +** xref:sync/sync-inter-syncgateway-run.adoc[Initialize] +** xref:sync/sync-inter-syncgateway-manage.adoc[Manage] +** xref:sync/sync-inter-syncgateway-monitor.adoc[Monitor] * {logging--xref} * {indexing--xref} diff --git a/modules/ROOT/pages/introduction.adoc b/modules/ROOT/pages/introduction.adoc index 4051f36a1..d87c16620 100644 --- a/modules/ROOT/pages/introduction.adoc +++ b/modules/ROOT/pages/introduction.adoc @@ -19,19 +19,19 @@ image::cbm-architecture.png[] As you can see from <> Sync Gateway synchronizes changes made by web clients through its REST API, Couchbase Lite mobile-device applications, and Couchbase Server buckets. -You can read more about the Data Synchronization process in xref:sync-with-couchbase-server.adoc[Sync with Couchbase Server]. -Some of its most central, and commonly used features, are those used to secure xref:access-control-model.adoc[Access Control]. +You can read more about the Data Synchronization process in xref:sync/sync-with-couchbase-server.adoc[Sync with Couchbase Server]. +Some of its most central, and commonly used features, are those used to secure xref:access-control/access-control-model.adoc[Access Control]. Sync Gateway assures secure access control using: * **User authentication**, which ensures that only authorized users can connect to Sync Gateway. For more information see the -xref:users.adoc[Users], xref:roles.adoc[Roles] and xref:authentication-users.adoc[User Authentication] content. +xref:access-control/users.adoc[Users], xref:access-control/roles.adoc[Roles] and xref:security/authentication-users.adoc[User Authentication] content. -* *Data Routing*, which ensures that authorized users can only access documents in those xref:channels.adoc[Channels] assigned to them and only in accordance with their assigned privileges. -You can set those privileges to confer xref:access-control-how-control-document-access.adoc#lbl-read-access[Read Access] and-or xref:access-control-how-control-document-access.adoc#lbl-write-access[Write Access] as required. +* *Data Routing*, which ensures that authorized users can only access documents in those xref:access-control/channels.adoc[Channels] assigned to them and only in accordance with their assigned privileges. +You can set those privileges to confer xref:access-control/access-control-how-control-document-access.adoc#lbl-read-access[Read Access] and-or xref:access-control/access-control-how-control-document-access.adoc#lbl-write-access[Write Access] as required. -The business logic behind the validation and authorization of document access is provided by the customizable xref:sync-function.adoc[Sync Function]. +The business logic behind the validation and authorization of document access is provided by the customizable xref:access-control/sync-function-api/sync-function.adoc[Sync Function]. == Why Use Sync Gateway? @@ -68,9 +68,9 @@ TIP: For more information about the latest changes to Sync Gateway, see xref:wha Get started with Sync Gateway, from preparing your environment to installing and verifying your installation. -* xref:get-started-prepare.adoc[Prepare your environment] -* xref:get-started-install.adoc[Install Sync Gateway] -* xref:get-started-verify-install.adoc[Verify your installation] +* xref:start-here/get-started-prepare.adoc[Prepare your environment] +* xref:start-here/get-started-install.adoc[Install Sync Gateway] +* xref:start-here/get-started-verify-install.adoc[Verify your installation] == Data Modeling @@ -82,82 +82,82 @@ Learn how to design and structure your data buckets and documents using Sync Gat Learn how to configure Sync Gateway for cloud to edge synchronization including bootstrap, database settings, security, and more. -* xref:configuration-schema-bootstrap.adoc[] -* xref:configuration-schema-database.adoc[] -* xref:configuration-schema-db-security.adoc[] -* xref:configuration-schema-access-control.adoc[] -* xref:configuration-schema-import-filter.adoc[] -* xref:configuration-schema-isgr.adoc[] -* xref:configuration-javascript-functions.adoc[] -* xref:configuration-environment-variables.adoc[] +* xref:configuration/configuration-schema-bootstrap.adoc[] +* xref:configuration/configuration-schema-database.adoc[] +* xref:configuration/configuration-schema-db-security.adoc[] +* xref:configuration/configuration-schema-access-control.adoc[] +* xref:configuration/configuration-schema-import-filter.adoc[] +* xref:configuration/configuration-schema-isgr.adoc[] +* xref:configuration/configuration-javascript-functions.adoc[] +* xref:configuration/configuration-environment-variables.adoc[] == Security Implement comprehensive security measures to protect your data and control access to Sync Gateway. -* xref:secure-sgw-access.adoc[] -* xref:authentication-users.adoc[] -* xref:authentication-certs.adoc[] -* xref:audit-logging.adoc[] +* xref:security/secure-sgw-access.adoc[] +* xref:security/authentication-users.adoc[] +* xref:security/authentication-certs.adoc[] +* xref:security/audit-logging.adoc[] == Access Control Configure fine-grained access control with users, roles, channels, and sync functions. -* xref:access-control-concepts.adoc[] -* xref:sync-function.adoc[] -* xref:access-contrlol-how.adoc[How to] -* xref:auto-purge-channel-access-revocation.adoc[] +* xref:access-control/access-control-concepts.adoc[] +* xref:access-control/sync-function-api/sync-function.adoc[] +* xref:access-control/access-control-how.adoc[How to] +* xref:access-control/auto-purge-channel-access-revocation.adoc[] == REST API Interact with Sync Gateway programmatically using comprehensive REST API interfaces. -* xref:rest-api-access.adoc[] -* xref:rest-api-admin.adoc[] -* xref:rest-api-metrics.adoc[] -* xref:rest-api.adoc[] -* xref:rest-api-access-rbac-roles.adoc[] +* xref:rest-api/rest-api-access.adoc[] +* xref:rest-api/rest-api-admin.adoc[] +* xref:rest-api/rest-api-metrics.adoc[] +* xref:rest-api/rest-api.adoc[] +* xref:rest-api/rest-api-access-rbac-roles.adoc[] == Sync Synchronize data between Sync Gateway and your applications, servers, and other Sync Gateway instances. -* xref:sync-with-server.adoc[] -* xref:sync-using-app.adoc[] -* xref:inter-syncgateway-overview.adoc[] -* xref:delta-sync.adoc[] -* xref:import-processing.adoc[] +* xref:sync/sync-with-couchbase-server.adoc[] +* xref:sync/sync-using-app.adoc[] +* xref:sync/sync-inter-syncgateway-overview.adoc[] +* xref:sync/delta-sync.adoc[] +* xref:sync/import-processing.adoc[] == Manage Perform administrative and operational tasks to maintain and monitor Sync Gateway. -* xref:revisions.adoc[] -* xref:managing-tombstones.adoc[] -* xref:resync.adoc[] -* xref:stats-monitoring.adoc[] -* xref:database-offline.adoc[] -* xref:logging.adoc[] +* xref:manage/revisions.adoc[] +* xref:manage/managing-tombstones.adoc[] +* xref:manage/resync.adoc[] +* xref:manage/stats-monitoring.adoc[] +* xref:manage/database-offline.adoc[] +* xref:manage/logging.adoc[] == Deploy Deploy Sync Gateway in production environments with scalability and reliability considerations. -* xref:command-line-options.adoc[] -* xref:load-balancer.adoc[] -* xref:webhooks.adoc[] -* xref:stats-prometheus.adoc[] -* xref:indexing.adoc[] -* xref:deploy-cluster-to-kubernetes.adoc[] +* xref:deploy/command-line-options.adoc[] +* xref:deploy/load-balancer.adoc[] +* xref:deploy/webhooks.adoc[] +* xref:deploy/stats-prometheus.adoc[] +* xref:deploy/indexing.adoc[] +* xref:use-kubernetes/deploy-cluster-to-kubernetes.adoc[] == Server Compatibility Understand Sync Gateway compatibility with Couchbase Server features and services. -* xref:server-compatibility-buckets.adoc[Buckets] -* xref:server-compatibility-collections.adoc[Collections] -* xref:server-compatibility-eventing.adoc[Eventing] -* xref:server-compatibility-transactions.adoc[Transactions] -* xref:server-compatibility-xdcr.adoc[XDCR] -* xref:server-compatibility-backups.adoc[Backup and Restore] \ No newline at end of file +* xref:server-compatibility/server-compatibility-buckets.adoc[Buckets] +* xref:server-compatibility/server-compatibility-collections.adoc[Collections] +* xref:server-compatibility/server-compatibility-eventing.adoc[Eventing] +* xref:server-compatibility/server-compatibility-transactions.adoc[Transactions] +* xref:server-compatibility/server-compatibility-xdcr.adoc[XDCR] +* xref:server-compatibility/server-compatibility-backups.adoc[Backup and Restore] \ No newline at end of file diff --git a/modules/ROOT/pages/database-offline.adoc b/modules/ROOT/pages/manage/database-offline.adoc similarity index 100% rename from modules/ROOT/pages/database-offline.adoc rename to modules/ROOT/pages/manage/database-offline.adoc diff --git a/modules/ROOT/pages/logging.adoc b/modules/ROOT/pages/manage/logging.adoc similarity index 99% rename from modules/ROOT/pages/logging.adoc rename to modules/ROOT/pages/manage/logging.adoc index cff75cffa..8816fe3d5 100644 --- a/modules/ROOT/pages/logging.adoc +++ b/modules/ROOT/pages/manage/logging.adoc @@ -35,7 +35,7 @@ include::partial$_show_page_header_block.adoc[] :fn-clog: footnote:fn-clog[Introduced in Sync Gateway version 2.1] // :fn-dep-cfg: footnote:fn-dep-cfg[The pre-2.1 logging configuration method, using 'logging.default` is deprecated. If upgrading from a pre2.1 Sync Gateway version, then you will observe warnings on startup stating what is required to update your configuration -- see also: {legacy-logging-pre2-1--xref} ] -:fn-legacy-text: pass:q,a[For legacy Pre-3.0 see xref:configuration-properties-legacy.adoc[legacy Pre-3.0 configuration]] +:fn-legacy-text: pass:q,a[For legacy Pre-3.0 see xref:configuration/configuration-properties-legacy.adoc[legacy Pre-3.0 configuration]] :fn-legacy-pre-3-0: footnote:fnleg3-0[{fn-legacy-text}] :fnref-legacy-pre-3-0: footnote:fnleg3-0[] diff --git a/modules/ROOT/pages/managing-tombstones.adoc b/modules/ROOT/pages/manage/managing-tombstones.adoc similarity index 100% rename from modules/ROOT/pages/managing-tombstones.adoc rename to modules/ROOT/pages/manage/managing-tombstones.adoc diff --git a/modules/ROOT/pages/resync.adoc b/modules/ROOT/pages/manage/resync.adoc similarity index 100% rename from modules/ROOT/pages/resync.adoc rename to modules/ROOT/pages/manage/resync.adoc diff --git a/modules/ROOT/pages/revisions.adoc b/modules/ROOT/pages/manage/revisions.adoc similarity index 92% rename from modules/ROOT/pages/revisions.adoc rename to modules/ROOT/pages/manage/revisions.adoc index dc230abcb..153d604e5 100644 --- a/modules/ROOT/pages/revisions.adoc +++ b/modules/ROOT/pages/manage/revisions.adoc @@ -105,7 +105,7 @@ This setting may affect the conflict resolution process, as insufficient revisio -- The default and minimum values of `revs_limit` are dependent on whether -xref:configuration-schema-database.html#database-allow_conflicts[allow conflicts] +xref:configuration/configuration-schema-database.html#database-allow_conflicts[allow conflicts] is set True or False -- see <>. The process to remove obsolete revisions is called pruning and runs automatically every time a revision is added. @@ -196,7 +196,7 @@ Whenever a document is accessed its revision tree (or at least some portion of i === Control You can control the size of the revision cache using the {configuration-schema-database--xref--cache--rev-cache} settings within the configuration file, specifically: -* xref:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[rev_cache.max_memory_count_mb] +* xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[rev_cache.max_memory_count_mb] * {configuration-schema-database--xref--cache--rev-cache--shard-count} @@ -205,7 +205,7 @@ You can control the size of the revision cache using the {configuration-schema-d [#lbl-cache-limit-config] === Cache Limit Configuration -There are two ways to configure the size of the revision cache: set a memory limit in MB using xref:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`], or set the maximum number of document revisions in cache xref:configuration-schema-database.adoc#cache-rev_cache_size[`rev_cache.size`]. +There are two ways to configure the size of the revision cache: set a memory limit in MB using xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`], or set the maximum number of document revisions in cache xref:configuration/configuration-schema-database.adoc#cache-rev_cache_size[`rev_cache.size`]. These configurations allow you to configure both limits to the number of documents and the maximum memory usage within the rev cache to reduce the risk of Out of Memory (OOM) issues. If both configs are set, this results in eviction behavior of the rev cache based on both the memory footprint and number of items in the cache. If any of these limits are reached, cache eviction will be performed. @@ -220,7 +220,7 @@ This can be useful when working on servers with limited memory and in cases when ==== Cache Maximum Memory -You can use the xref:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`] setting to specify the maximum amount of memory the revision cache should take up in MB. +You can use the xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`] setting to specify the maximum amount of memory the revision cache should take up in MB. Setting the value to `0` will disable any eviction based on memory at rev cache. IMPORTANT: `rev_cache.max_memory_count_mb` is an Enterprise only setting. @@ -236,7 +236,7 @@ You can control the number of shards into which Sync Gateway will split its revi More shards means lower cache contention when accessing distinct revisions, at the cost of some memory overhead per-shard. -IMPORTANT: Do not change the default xref:configuration-schema-database.adoc#database-cache-rev_cache-shard_count[database.cache.rev_cache.shard_count] unless advised to do so by Couchbase Support -- see: {url-cb-support-policy}. +IMPORTANT: Do not change the default xref:configuration/configuration-schema-database.adoc#database-cache-rev_cache-shard_count[database.cache.rev_cache.shard_count] unless advised to do so by Couchbase Support -- see: {url-cb-support-policy}. [#lbl-deltasync] === Delta Sync diff --git a/modules/ROOT/pages/sgcollect-info.adoc b/modules/ROOT/pages/manage/sgcollect-info.adoc similarity index 100% rename from modules/ROOT/pages/sgcollect-info.adoc rename to modules/ROOT/pages/manage/sgcollect-info.adoc diff --git a/modules/ROOT/pages/stats-monitoring-json.adoc b/modules/ROOT/pages/manage/stats-monitoring-json.adoc similarity index 100% rename from modules/ROOT/pages/stats-monitoring-json.adoc rename to modules/ROOT/pages/manage/stats-monitoring-json.adoc diff --git a/modules/ROOT/pages/stats-monitoring-prometheus.adoc b/modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc similarity index 85% rename from modules/ROOT/pages/stats-monitoring-prometheus.adoc rename to modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc index 117c1f1af..923f32464 100644 --- a/modules/ROOT/pages/stats-monitoring-prometheus.adoc +++ b/modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc @@ -20,7 +20,7 @@ include::partial$_define_stats_item_names.adoc[] == Prometheus format -Like other Couchbase services, Sync Gateway offers xref:stats-prometheus.adoc[Prometheus-compatible metrics] in a flat JSON format. +Like other Couchbase services, Sync Gateway offers xref:deploy/stats-prometheus.adoc[Prometheus-compatible metrics] in a flat JSON format. Use the `metrics` endpoint to request these metrics: @@ -33,7 +33,7 @@ curl -X GET "http://localhost:4986/metrics" -H "accept: application/json" ---- ==== -This endpoint's data will be scraped at configurable interval, when the `metricsInterface` is activated and Sync Gateway integrated with Prometheus -- see: xref:stats-prometheus.adoc[] and our blog entry {url-blog-prometheus}. +This endpoint's data will be scraped at configurable interval, when the `metricsInterface` is activated and Sync Gateway integrated with Prometheus -- see: xref:deploy/stats-prometheus.adoc[] and our blog entry {url-blog-prometheus}. The response in Prometheus format is defined as follows: diff --git a/modules/ROOT/pages/stats-monitoring.adoc b/modules/ROOT/pages/manage/stats-monitoring.adoc similarity index 80% rename from modules/ROOT/pages/stats-monitoring.adoc rename to modules/ROOT/pages/manage/stats-monitoring.adoc index 45e5d1e49..512f93c9b 100644 --- a/modules/ROOT/pages/stats-monitoring.adoc +++ b/modules/ROOT/pages/manage/stats-monitoring.adoc @@ -31,14 +31,14 @@ Sync Gateway's Metrics REST API_ facilitates the process of gathering this essen It also provides for integration with Prometheus. -Use the Metrics REST API to request the statistics in either xref:stats-monitoring-json.adoc[JSON] or xref:stats-monitoring-prometheus.adoc[Prometheus] format. +Use the Metrics REST API to request the statistics in either xref:manage/stats-monitoring-json.adoc[JSON] or xref:manage/stats-monitoring-prometheus.adoc[Prometheus] format. == Advantages of JSON format -The custom xref:stats-monitoring-json.adoc[JSON] format was created specifically to describe Sync Gateway metrics, and provides rich, nested data. +The custom xref:manage/stats-monitoring-json.adoc[JSON] format was created specifically to describe Sync Gateway metrics, and provides rich, nested data. == Advantages of Prometheus format -As with all Couchbase services, Sync Gateway exposes a xref:stats-monitoring-prometheus.adoc[Prometheus]-compatible format in flat JSON. +As with all Couchbase services, Sync Gateway exposes a xref:manage/stats-monitoring-prometheus.adoc[Prometheus]-compatible format in flat JSON. This familiar and consistent format is simple yet attractive for powerful comparisons using Prometheus, potentially across multiple services. diff --git a/modules/ROOT/pages/compatibility.adoc b/modules/ROOT/pages/product-notes/compatibility.adoc similarity index 100% rename from modules/ROOT/pages/compatibility.adoc rename to modules/ROOT/pages/product-notes/compatibility.adoc diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/product-notes/release-notes.adoc similarity index 100% rename from modules/ROOT/pages/release-notes.adoc rename to modules/ROOT/pages/product-notes/release-notes.adoc diff --git a/modules/ROOT/pages/supported-environments.adoc b/modules/ROOT/pages/product-notes/supported-environments.adoc similarity index 100% rename from modules/ROOT/pages/supported-environments.adoc rename to modules/ROOT/pages/product-notes/supported-environments.adoc diff --git a/modules/ROOT/pages/rest-api-access-rbac-roles.adoc b/modules/ROOT/pages/rest-api/rest-api-access-rbac-roles.adoc similarity index 100% rename from modules/ROOT/pages/rest-api-access-rbac-roles.adoc rename to modules/ROOT/pages/rest-api/rest-api-access-rbac-roles.adoc diff --git a/modules/ROOT/pages/rest-api-access.adoc b/modules/ROOT/pages/rest-api/rest-api-access.adoc similarity index 100% rename from modules/ROOT/pages/rest-api-access.adoc rename to modules/ROOT/pages/rest-api/rest-api-access.adoc diff --git a/modules/ROOT/pages/rest-api-admin.adoc b/modules/ROOT/pages/rest-api/rest-api-admin.adoc similarity index 95% rename from modules/ROOT/pages/rest-api-admin.adoc rename to modules/ROOT/pages/rest-api/rest-api-admin.adoc index 468b37fe3..384e03400 100644 --- a/modules/ROOT/pages/rest-api-admin.adoc +++ b/modules/ROOT/pages/rest-api/rest-api-admin.adoc @@ -20,7 +20,7 @@ The Admin REST API is for administrator use only, and hence is *not* accessible To allow users to access the Admin API up you need to create a Couchbase Server-based RBAC-user for them -- see: {rest-api-access--xref}. Couchbase recommends that you do not expose the Sync Gateway admin interface to the internet. -Due to this, features such as CORS are not supported on the admin interface. +Due to this, features such as CORS are not supported on the admin interface. NOTE: For document changes sent to Sync Gateway through the Admin REST API, the Sync Function executes with *admin* privileges. + Calls to `requireUser`, `requireAccess` and `requireRole` will be no-ops, and will always appear successful. @@ -31,7 +31,7 @@ Calls to `requireUser`, `requireAccess` and `requireRole` will be no-ops, and wi The xref:rest_api_admin.adoc[API reference] groups all the endpoints by functionality. Each endpoint description specifies its RBAC role requirements, but see -xref:rest-api-access-rbac-roles.adoc[RBAC Roles] +xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Roles] and the Couchbase Server documentation here {server-security-roles--xref} if further information is required. diff --git a/modules/ROOT/pages/rest-api-metrics.adoc b/modules/ROOT/pages/rest-api/rest-api-metrics.adoc similarity index 94% rename from modules/ROOT/pages/rest-api-metrics.adoc rename to modules/ROOT/pages/rest-api/rest-api-metrics.adoc index ab154ba7b..be85febea 100644 --- a/modules/ROOT/pages/rest-api-metrics.adoc +++ b/modules/ROOT/pages/rest-api/rest-api-metrics.adoc @@ -40,6 +40,6 @@ include::partial$prometheus-activation.adoc[] == API Reference The xref:rest_api_metric.adoc[API reference] groups all the endpoints by functionality. -For more information, refer to xref:stats-monitoring.adoc[View Statistics and Metrics]. +For more information, refer to xref:manage/stats-monitoring.adoc[View Statistics and Metrics]. include::partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/rest-api.adoc b/modules/ROOT/pages/rest-api/rest-api.adoc similarity index 100% rename from modules/ROOT/pages/rest-api.adoc rename to modules/ROOT/pages/rest-api/rest-api.adoc diff --git a/modules/ROOT/pages/rest_api_admin.adoc b/modules/ROOT/pages/rest-api/rest_api_admin.adoc similarity index 100% rename from modules/ROOT/pages/rest_api_admin.adoc rename to modules/ROOT/pages/rest-api/rest_api_admin.adoc diff --git a/modules/ROOT/pages/rest_api_metric.adoc b/modules/ROOT/pages/rest-api/rest_api_metric.adoc similarity index 100% rename from modules/ROOT/pages/rest_api_metric.adoc rename to modules/ROOT/pages/rest-api/rest_api_metric.adoc diff --git a/modules/ROOT/pages/rest_api_public.adoc b/modules/ROOT/pages/rest-api/rest_api_public.adoc similarity index 100% rename from modules/ROOT/pages/rest_api_public.adoc rename to modules/ROOT/pages/rest-api/rest_api_public.adoc diff --git a/modules/ROOT/pages/security/audit-log-events.adoc b/modules/ROOT/pages/security/audit-log-events.adoc new file mode 100644 index 000000000..87f9c1ffc --- /dev/null +++ b/modules/ROOT/pages/security/audit-log-events.adoc @@ -0,0 +1,789 @@ += Audit Logging Events Reference +:page-edition: Enterprise +:description: Audit Logging provides tools for administrators to track operational irregularities and to support regulatory and security compliance standards, such as link:https://www.hhs.gov/hipaa/index.html[HIPAA] and link:https://soc2.co.uk/soc2[SOC-2]. Below is a list of possible Audit Events. + + +[abstract] +{description} + +== About Audit Events + +You can use audit events to track and provide context on user activity within your application. + +.Events table field description +[cols="2*"] +|=== + +| Field Name | Description + +|`ID` +|A unique number used to distinguish between Audit Events. +You can use the value to specify which events will be present or written to your audit logs, either globally or on a database level. + +|`Name` +|A short descriptive name, this will be outputted as a field in the audit log. + +|`Description` +|A longer name, this is will be outputted as a field in the audit log. + +|`DefaultEnabled` +|If `true`, the given Audit Event is enabled by default. + +|`Filterable` +|If `true`, the given audit event can be disabled. + +|`EventScope` +|The scope of the event. +This can be `Global` or `Database`. +You can configure global scope events via the xref:configuration/configuration-schema-bootstrap.adoc#logging-audit-audit_log_file_path[bootstrap config], and database events via the xref:rest_api_admin.adoc[Admin REST API]. + +|`EventType` +|The type of action performed by the event. +This can be `user`, `admin`, or `data`. + +|`MandatoryFields` +|Fields that are always present in a given Audit Event. + +|`OptionalFields` +|May or may not be present in a given Audit Event. + +|=== + +=== Audit Event Types + +Audit Events can be one of the following types: + +* `Admin` - Events that track administrative and configuration changes. + +* `Data` - Events that track attempts to access and change data. + +* `User` - Events that track end-user operations. + +=== Audit Event Scopes + +Audit events have scope, this affects how they can be configured. +The audit events scopes are: + +* `Database` - These events are specific to a database such as `AuditIDDocumentUpdate 55002`, and can only be enabled/disabled at the database configuration level. +Database level audit events are segregated into per Sync Gateway database specific audit logs. + +* `Global` - These events are considered global such as `AuditIDSyncGatewayStartup 53260`, and have to be enabled/disabled in the bootstrap config. + + +=== Auditing Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|53248 +|Auditing enabled +|Audit logging was enabled +|TRUE +|FALSE +|Global +|admin +|audit_scope, description, id, name, timestamp, db + +|53249 +|Auditing disabled +|Audit logging was disabled +|TRUE +|FALSE +|Global +|admin +|audit_scope, description, id, name, timestamp + +|53250 +|Auditing configuration changed +|Audit logging configuration was changed +|TRUE +|FALSE +|Global +|admin +|audit_scope, cid, db, description, id, local, name, payload, real_userid, remote, timestamp + +|=== + +=== Sync Gateway Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|53260 +|Sync Gateway startup +|Sync Gateway started +|TRUE +|FALSE +|Global +|admin +|admin_interface_authentication, bcrypt_cost, description, disable_persistent_config, id, log_file_path, metrics_interface_authentication, name, server_tls_skip_verify, sg_version, timestamp, use_tls_server + +|53270 +|Public HTTP API request +|Public HTTP API request was made +|FALSE +|TRUE +|Global +|user +|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body + +|53271 +|Admin HTTP API request +|Admin HTTP API request was made +|FALSE +|TRUE +|Global +|admin +|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body + +|53272 +|Metrics HTTP API request +|Metrics HTTP API request was made +|FALSE +|TRUE +|Global +|admin +|cid, description, http_method, http_path, http_status, id, local, name, remote, timestamp, real_userid, request_body + +|53280 +|Public API user authenticated +|Public API user successfully authenticated +|TRUE +|TRUE +|Database +|user +|auth_method, description, id, name, timestamp, oidc_issuer + +|53281 +|Public API user authentication failed +|Public API user failed to authenticate +|TRUE +|TRUE +|Database +|user +|auth_method, description, id, name, timestamp, username + +|53282 +|Public API user session created +|Public API user session was created +|TRUE +|TRUE +|Database +|user +|description, id, name, session_id, timestamp, username + +|53283 +|Public API user session deleted +|Public API user session was deleted +|TRUE +|TRUE +|Database +|user +|description, id, name, session_id, timestamp, username + +|53284 +|Public API user all sessions deleted +|All sessions were deleted for a Public API user +|TRUE +|TRUE +|Database +|user +|description, id, name, timestamp, username + +|53290 +|Admin API user authenticated +|Admin API user successfully authenticated +|TRUE +|TRUE +|Database +|admin +|description, id, name, timestamp + +|53291 +|Admin API user authentication failed +|Admin API user failed to authenticate +|TRUE +|TRUE +|Database +|admin +|description, id, name, timestamp, username + +|53292 +|Admin API user authorization failed +|Admin API user failed to authorize +|TRUE +|TRUE +|Database +|admin +|description, id, name, timestamp, username + +|53300 +|sgcollect_info status +|sgcollect_info status was viewed +|TRUE +|TRUE +|Global +|admin +|cid, description, id, local, name, real_userid, remote, timestamp + +|53301 +|sgcollect_info start +|sgcollect_info was started +|TRUE +|TRUE +|Global +|admin +|cid, customer, description, id, keep_zip, local, name, output_dir, real_userid, remote, ticket, timestamp, upload_host, zip_filename + +|53302 +|sgcollect_info stop +|sgcollect_info was stopped +|TRUE +|TRUE +|Global +|admin +|cid, description, id, local, name, real_userid, remote, timestamp + +|53303 +|stats requested +|stats were requested +|FALSE +|TRUE +|Global +|admin +|cid, description, id, local, name, real_userid, remote, stats_format, timestamp + +|53304 +|profiling requested +|profiling was requested +|TRUE +|TRUE +|Global +|admin +|description, id, name, profile_type, timestamp, filename + +|53350 +|Sync Gateway cluster info read +|Sync Gateway cluster info was viewed +|TRUE +|TRUE +|Global +|admin +|description, id, name, timestamp + +|=== + +=== Database Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|54000 +|Create database +|A new database was created +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, payload, real_userid, remote, timestamp + +|54001 +|Read database +|Information about this database was viewed +|FALSE +|TRUE +|Database +|user +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54002 +|Delete database +|A database was deleted +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54003 +|Read all databases +|All databases were viewed +|FALSE +|TRUE +|Global +|admin +|cid, db_names, description, id, local, name, real_userid, remote, timestamp + +|54010 +|Read database config +|Database configuration was viewed +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54011 +|Update database config +|Database configuration was updated +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, payload, real_userid, remote, timestamp + +|54020 +|Database offline +|Database was taken offline +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54021 +|Database online +|Database was brought online +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54030 +|Database compaction status +|Database compaction status was viewed +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp, type + +|54031 +|Database attachment compaction start +|Database attachment compaction was started +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp, type, dry_run, reset + +|54032 +|Database compaction stop +|Database compaction was stopped +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp, type + +|54040 +|Database resync status +|Database resync status was viewed +|FALSE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54041 +|Database resync start +|Database resync was started +|TRUE +|TRUE +|Database +|admin +|cid, collections, db, description, id, local, name, real_userid, regenerate_sequences, remote, reset, timestamp + +|54042 +|Database resync stop +|Database resync was stopped +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54043 +|Post-upgrade +|Post-upgrade was run for Sync Gateway databases +|TRUE +|TRUE +|Global +|admin +|cid, description, id, local, name, preview, real_userid, remote, timestamp + +|54044 +|Database repair +|Database repair was run +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54045 +|Database flush +|Database flush was run +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|=== + + +=== User and Role Administration Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|54100 +|Create user +|A new user was created +|TRUE +|TRUE +|Database +|admin +|channels, db, description, id, name, roles, timestamp, username + +|54101 +|Read user +|Information about this user was viewed +|TRUE +|TRUE +|Database +|admin +|db, description, id, name, timestamp, username + +|54102 +|Update user +|User was updated +|TRUE +|TRUE +|Database +|admin +|channels, db, description, id, name, roles, timestamp, username + +|54103 +|Delete user +|User was deleted +|TRUE +|TRUE +|Database +|admin +|db, description, id, name, timestamp, username + +|54104 +|Read all users +|List of all users was viewed +|TRUE +|TRUE +|Database +|admin +|db, description, id, name, name_only, timestamp, limit + +|54110 +|Create role +|A new role was created +|TRUE +|TRUE +|Database +|admin +|admin_channels, db, description, id, name, role, timestamp + +|54111 +|Read role +|Information about this role was viewed +|TRUE +|TRUE +|Database +|admin +|db, description, id, name, role, timestamp + +|54112 +|Update role +|Role was updated +|TRUE +|TRUE +|Database +|admin +|admin_channels, db, description, id, name, role, timestamp + +|54113 +|Delete role +|Role was deleted +|TRUE +|TRUE +|Database +|admin +|db, description, id, name, role, timestamp + +|54114 +|Read all roles +|List of all roles was viewed +|TRUE +|TRUE +|Database +|admin +|db, description, id, include_deleted, name, timestamp, limit + +|=== + +=== Replication Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|54200 +|Changes feed started +|Changes feed was started +|TRUE +|TRUE +|Database +|data +|cid, db, description, id, ks, local, name, real_userid, remote, since, timestamp, channels, doc_ids, feed_type, filter, include_docs + +|54300 +|Replication connect +|A replication client connected +|TRUE +|TRUE +|Database +|user +|cid, client_type, db, description, id, local, name, real_userid, remote, timestamp, client_version + +|54301 +|Replication disconnect +|A replication client disconnected +|TRUE +|TRUE +|Database +|user +|cid, client_type, db, description, id, local, name, real_userid, remote, timestamp + +|54400 +|Create Inter-Sync Gateway Replication +|A new Inter-Sync Gateway Replication was created +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, payload, real_userid, remote, replication_id, timestamp + +|54401 +|Read Inter-Sync Gateway Replication +|Information about this Inter-Sync Gateway Replication was viewed +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54402 +|Update Inter-Sync Gateway Replication +|Inter-Sync Gateway Replication was updated +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, payload, real_userid, remote, replication_id, timestamp + +|54403 +|Delete Inter-Sync Gateway Replication +|Inter-Sync Gateway Replication was deleted +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54410 +|Inter-Sync Gateway Replication status +|Inter-Sync Gateway Replication status was document viewed +|FALSE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54411 +|Inter-Sync Gateway Replication start +|Inter-Sync Gateway Replication was started +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54412 +|Inter-Sync Gateway Replication stop +|Inter-Sync Gateway Replication was stopped +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54413 +|Inter-Sync Gateway Replication reset +|Inter-Sync Gateway Replication was reset +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, replication_id, timestamp + +|54420 +|All Inter-Sync Gateway Replication status +|All Inter-Sync Gateway Replication statuses were viewed +|FALSE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|54421 +|Read all Inter-Sync Gateway Replications +|All Inter-Sync Gateway Replications were viewed +|TRUE +|TRUE +|Database +|admin +|cid, db, description, id, local, name, real_userid, remote, timestamp + +|=== + +=== Document Related Events + +[cols="8*"] +|=== +|ID |Name |Description |DefaultEnabled |Filterable |EventScope |EventType |Fields + +|55000 +|Create document +|A new document was created +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55001 +|Read document +|A document was viewed +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55002 +|Update document +|A document was updated +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55003 +|Delete document +|A document was deleted +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, id, ks, name, real_userid, timestamp, cid, doc_version, local, purged, remote + +|55004 +|Read document metadata +|Document metadata was viewed +|FALSE +|TRUE +|Database +|data +|cid, db, description, doc_id, id, ks, local, name, real_userid, remote, timestamp + +|55005 +|Import document +|A document was imported +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, timestamp + +|55006 +|Resync document +|A document was resynced +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, timestamp + +|55007 +|Revoke document +|A document revocation request was sent to a client +|FALSE +|TRUE +|Database +|data +|db, description, doc_id, doc_version, id, ks, name, timestamp + +|55010 +|Create attachment +|A new attachment was created +|FALSE +|TRUE +|Database +|data +|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55011 +|Read attachment +|An attachment was viewed +|FALSE +|TRUE +|Database +|data +|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55012 +|Update attachment +|An attachment was updated +|FALSE +|TRUE +|Database +|data +|attachment_id, db, description, doc_id, doc_version, id, ks, name, real_userid, timestamp, cid, local, remote + +|55013 +|Delete attachment +|An attachment was deleted +|FALSE +|TRUE +|Database +|data +|attachment_id, db, description, doc_id, id, ks, name, real_userid, timestamp, cid, doc_version, local, remote + +|=== + +== See Also + +* xref:security/audit-logging.adoc[] + +* xref:security/manage-audit-logs.adoc[] + +* xref:manage/sgcollect-info.adoc[] + +* xref:rest_api_admin.adoc[Admin REST API Reference] + +* xref:rest_api_admin_static.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/audit-logging.adoc b/modules/ROOT/pages/security/audit-logging.adoc similarity index 88% rename from modules/ROOT/pages/audit-logging.adoc rename to modules/ROOT/pages/security/audit-logging.adoc index 60a87bc0b..f96b04194 100644 --- a/modules/ROOT/pages/audit-logging.adoc +++ b/modules/ROOT/pages/security/audit-logging.adoc @@ -21,10 +21,10 @@ Audit logs typically include: * The user or system component that initiated the event. Logs are immutable and cannot be altered once recorded. -Viewing and managing audit logs permissions are enforced through Sync Gateway RBAC controls. +Viewing and managing audit logs permissions are enforced through Sync Gateway RBAC controls. Logs are written locally on each Sync Gateway node. -IMPORTANT: xref:sgcollect-info.adoc[SG Collect Info] does NOT collect audit log information as audit logs contain sensitive, unredacted data. +IMPORTANT: xref:manage/sgcollect-info.adoc[SG Collect Info] does NOT collect audit log information as audit logs contain sensitive, unredacted data. There is only one audit log file active at a time, which is periodically rotated based on the following properties: @@ -47,14 +47,14 @@ NOTE: Administrators must ensure the rotated logs are picked up before they are Audit events are tagged at a database level to distinguish between events coming from different databases. The fields the event was called with are also added if applicable to the optional context property of the event. -For more information, see xref:audit-log-events.adoc[audit events reference page]. +For more information, see xref:security/audit-log-events.adoc[audit events reference page]. NOTE: Event auditing occurs per Sync Gateway node, capturing its own events only. If you require a cluster-wide record, the records must be manually consolidated by an adminstrator. === Filtering Audit Logs -You can filter audit logs to customize events that are stored in the log file. +You can filter audit logs to customize events that are stored in the log file. You can alter the following to affect events stored in the log file: * Enabling and disabling users - This affects all events related to a specified user. @@ -65,11 +65,11 @@ If a given event is disabled, it will not be logged regardless of the user. Events can be enabled per database or globally. NOTE: If an audit event has `DefaultEnabled` set to `true`, it does not need to be explicitly enabled by the API. -See xref:audit-log-events.adoc[] for more information on specific audit events. +See xref:security/audit-log-events.adoc[] for more information on specific audit events. -=== Audit Fields +=== Audit Fields -The table below lists common audit event properties with corresponding descriptions. +The table below lists common audit event properties with corresponding descriptions. Different event-types generate different field-subsets. [cols="3*"] @@ -142,12 +142,12 @@ Above is a successful login by `user1` to retrieve a document named `doc`. == See Also -* xref:manage-audit-logs.adoc[] +* xref:security/manage-audit-logs.adoc[] -* xref:audit-log-events.adoc[] +* xref:security/audit-log-events.adoc[] -* xref:sgcollect-info.adoc[] +* xref:manage/sgcollect-info.adoc[] -* xref:rest-api-admin.adoc[Admin REST API] +* xref:rest-api/rest-api-admin.adoc[Admin REST API] * xref:rest_api_admin.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/authentication-certs.adoc b/modules/ROOT/pages/security/authentication-certs.adoc similarity index 100% rename from modules/ROOT/pages/authentication-certs.adoc rename to modules/ROOT/pages/security/authentication-certs.adoc diff --git a/modules/ROOT/pages/authentication-users.adoc b/modules/ROOT/pages/security/authentication-users.adoc similarity index 100% rename from modules/ROOT/pages/authentication-users.adoc rename to modules/ROOT/pages/security/authentication-users.adoc diff --git a/modules/ROOT/pages/manage-audit-logs.adoc b/modules/ROOT/pages/security/manage-audit-logs.adoc similarity index 91% rename from modules/ROOT/pages/manage-audit-logs.adoc rename to modules/ROOT/pages/security/manage-audit-logs.adoc index 970b39061..b7d2e22bc 100644 --- a/modules/ROOT/pages/manage-audit-logs.adoc +++ b/modules/ROOT/pages/security/manage-audit-logs.adoc @@ -22,9 +22,9 @@ This will affect the configuration on a per database basis. For more information, see: -* xref:configuration-schema-bootstrap.adoc[Bootstrap Configuration Schema]. +* xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap Configuration Schema]. -* xref:configuration-schema-database.adoc[Database Configuration Schema]. +* xref:configuration/configuration-schema-database.adoc[Database Configuration Schema]. * xref:rest_api_admin.adoc[Admin REST API]. @@ -48,8 +48,8 @@ NOTE: Configuration via the bootstrap config will affect your configuration glob To successfully configure audit logging, you must set a file path for your audit logs and set the `enabled` parameter to `true`. Enabling and disabling audit logging is handled by the Admin REST API at a cluster and Sync Gateway database level. -Setting enabled to true without any specified enabled events will only enable events with `DefaultEnabled` set to `true`. -To view the list of audit events, see xref:audit-log-events.adoc[] +Setting enabled to true without any specified enabled events will only enable events with `DefaultEnabled` set to `true`. +To view the list of audit events, see xref:security/audit-log-events.adoc[] To configure audit logs retention and rotation globally, you can use the following parameters below with your bootstrap configuration. @@ -80,19 +80,19 @@ a|`rotation` is an object that contains the following properties: | `audit_log_file_path` | The path to write audit log files to. -| +| | `enabled_events` | An object that contains the list of enabled global events. -| +| |=== -For further bootstrap configuration options, see xref:configuration-schema-bootstrap.adoc[]. +For further bootstrap configuration options, see xref:configuration/configuration-schema-bootstrap.adoc[]. == Database Configuration with the Admin REST API -Couchbase recommends you only use configuration at the database level if you wish to alter your settings per database. +Couchbase recommends you only use configuration at the database level if you wish to alter your settings per database. You can configure audit events at runtime without modifying the entire database configuration using the following HTTP request methods with the xref:rest_api_admin.adoc[Admin REST API]: @@ -149,8 +149,8 @@ The payload above displays the current audit configuration with non-default even === Disabled Users and Roles -You can filter audit events by specifying roles or users to be disabled. -The example above shows disabling audit events for `user1` and `role1`. +You can filter audit events by specifying roles or users to be disabled. +The example above shows disabling audit events for `user1` and `role1`. The `disabled_users` field will prevent all audit events generated by the specified users from being logged. The `disabled_roles` field will prevent all audit events generated by the specified roles from logged. @@ -159,11 +159,11 @@ A use case for these fields would be to exclude certain administrative users or Users and roles are organised into the following domains: * `sgw` - Users and Roles that are created by and operate solely within Sync Gateway. -For more information, see xref:access-control-concepts.adoc#lbl-sgw-users[Sync Gateway defined Users and Roles]. +For more information, see xref:access-control/access-control-concepts.adoc#lbl-sgw-users[Sync Gateway defined Users and Roles]. * `cbs` - Users that are are RBAC controlled. These are created on Couchbase Server. Sync Gateway's Admin and Metrics REST APIs are authenticated using Couchbase Server users. -For more information, see xref:access-control-concepts.adoc#lbl-rbac-users[RBAC Users]. +For more information, see xref:access-control/access-control-concepts.adoc#lbl-rbac-users[RBAC Users]. .Set the entire database audit configuration with simple schema ==== @@ -237,7 +237,7 @@ curl -X PUT "$BASEURL:4985/$DB/_config/audit" }' ---- -The payloads above demonstrate that the request has overwritten the previous configuration shown in example one. +The payloads above demonstrate that the request has overwritten the previous configuration shown in example one. Audit Events `54001 - Read database` and `54003 - Read all databases` will now be enabled with `user2` and `role2` disabled. Consequently, the non-default events `53270 - Public HTTP API request`, and `53271 - Admin HTTP API request` will now be disabled, and `user1` and `role1` are now enabled. @@ -294,13 +294,13 @@ curl -X POST "$BASEURL:4985/$DB/_config/audit" The request above demonstrates simultaneous disabling of the default audit event `54000 - Create database` and enabling of the non-default audit event `54003 - Read all databases`. ==== -== See Also +== See Also -* xref:audit-logging.adoc[] +* xref:security/audit-logging.adoc[] -* xref:audit-log-events.adoc[] +* xref:security/audit-log-events.adoc[] -* xref:sgcollect-info.adoc[] +* xref:manage/sgcollect-info.adoc[] * xref:rest_api_admin.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/secure-sgw-access.adoc b/modules/ROOT/pages/security/secure-sgw-access.adoc similarity index 100% rename from modules/ROOT/pages/secure-sgw-access.adoc rename to modules/ROOT/pages/security/secure-sgw-access.adoc diff --git a/modules/ROOT/pages/server-compatibility-backups.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-backups.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-backups.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-backups.adoc diff --git a/modules/ROOT/pages/server-compatibility-buckets.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-buckets.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-buckets.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-buckets.adoc diff --git a/modules/ROOT/pages/server-compatibility-collections.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-collections.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-collections.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-collections.adoc diff --git a/modules/ROOT/pages/server-compatibility-eventing.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-eventing.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-eventing.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-eventing.adoc diff --git a/modules/ROOT/pages/server-compatibility-transactions.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-transactions.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-transactions.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-transactions.adoc diff --git a/modules/ROOT/pages/server-compatibility-xdcr.adoc b/modules/ROOT/pages/server-compatibility/server-compatibility-xdcr.adoc similarity index 100% rename from modules/ROOT/pages/server-compatibility-xdcr.adoc rename to modules/ROOT/pages/server-compatibility/server-compatibility-xdcr.adoc diff --git a/modules/ROOT/pages/xdcr-active-active-eventing.adoc b/modules/ROOT/pages/server-compatibility/xdcr-active-active-eventing.adoc similarity index 100% rename from modules/ROOT/pages/xdcr-active-active-eventing.adoc rename to modules/ROOT/pages/server-compatibility/xdcr-active-active-eventing.adoc diff --git a/modules/ROOT/pages/get-started-install.adoc b/modules/ROOT/pages/start-here/get-started-install.adoc similarity index 100% rename from modules/ROOT/pages/get-started-install.adoc rename to modules/ROOT/pages/start-here/get-started-install.adoc diff --git a/modules/ROOT/pages/get-started-prepare.adoc b/modules/ROOT/pages/start-here/get-started-prepare.adoc similarity index 100% rename from modules/ROOT/pages/get-started-prepare.adoc rename to modules/ROOT/pages/start-here/get-started-prepare.adoc diff --git a/modules/ROOT/pages/get-started-verify-install.adoc b/modules/ROOT/pages/start-here/get-started-verify-install.adoc similarity index 100% rename from modules/ROOT/pages/get-started-verify-install.adoc rename to modules/ROOT/pages/start-here/get-started-verify-install.adoc diff --git a/modules/ROOT/pages/delta-sync.adoc b/modules/ROOT/pages/sync/delta-sync.adoc similarity index 97% rename from modules/ROOT/pages/delta-sync.adoc rename to modules/ROOT/pages/sync/delta-sync.adoc index ad02426d0..9c96fde32 100644 --- a/modules/ROOT/pages/delta-sync.adoc +++ b/modules/ROOT/pages/sync/delta-sync.adoc @@ -37,7 +37,7 @@ Replication does 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 `delta_sync` properties in xref:rest-api-admin.adoc[Database Configuration] -- 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 xref:rest-api/rest-api-admin.adoc[Database Configuration] -- as shown in <>: [#sample-cfg] .Sample of Database with Delta Sync diff --git a/modules/ROOT/pages/import-processing.adoc b/modules/ROOT/pages/sync/import-processing.adoc similarity index 82% rename from modules/ROOT/pages/import-processing.adoc rename to modules/ROOT/pages/sync/import-processing.adoc index a1287813c..f09317763 100644 --- a/modules/ROOT/pages/import-processing.adoc +++ b/modules/ROOT/pages/sync/import-processing.adoc @@ -11,7 +11,7 @@ image::shared-bucket-access.png[] == Operation -Any non-{sgw} change is eligible for import. For more information, refer to the xref:sync-function.adoc[Sync Function] documentation. +Any non-{sgw} change is eligible for import. For more information, refer to the xref:access-control/sync-function-api/sync-function.adoc[Sync Function] documentation. The document is first run through the Sync Function to compute read security and routing, with the following differences: @@ -20,9 +20,9 @@ This means that `requireAccess`, `requireUser` and `requireRole` calls in the Sy * During import, `oldDoc` is `nil` when the Sync Function is executed. You can specify a filter function dynamically using xref:rest_api_admin.adoc#tag/Database-Configuration/operation/get_keyspace-_config-import_filter[/{keyspace}/_config/import_filter], or you can define one when you set up a database. -Refer to the xref:configuration-schema-import-filter.adoc[Import Filter Configuration] documentation for more information. +Refer to the xref:configuration/configuration-schema-import-filter.adoc[Import Filter Configuration] documentation for more information. -TIP: Use the `logging-console-log-keys` in the xref:configuration-schema-bootstrap.adoc#lbl-schema[Bootstrap Schema] log key to troubleshoot import processing issues in the logs. +TIP: Use the `logging-console-log-keys` in the xref:configuration/configuration-schema-bootstrap.adoc#lbl-schema[Bootstrap Schema] log key to troubleshoot import processing issues in the logs. == Function Provision @@ -34,10 +34,10 @@ If you are using legacy configuration then, you need to include it in your confi == Configuration NOTE: You need Couchbase Lite 3.1+ and Sync Gateway 3.1+ to use `custom` Scopes and Collections. + -If you’re using Capella App Services or Sync Gateway releases that are older than version 3.1, you won’t be able to access `custom` Scopes and Collections. +If you’re using Capella App Services or Sync Gateway releases that are older than version 3.1, you won’t be able to access `custom` Scopes and Collections. To use Couchbase Lite 3.1+ with these older versions, you can use the `default` Collection as a backup option. -The configuration settings described here are provisioned through the xref:rest-api-admin.adoc[Database Configuration] endpoints. +The configuration settings described here are provisioned through the xref:rest-api/rest-api-admin.adoc[Database Configuration] endpoints. [source,JSON] ---- @@ -55,13 +55,13 @@ The configuration settings described here are provisioned through the xref:rest- } ---- -For more information, see xref:configuration-schema-database.adoc#_database[Sync Gateway Configuration Schema]. +For more information, see xref:configuration/configuration-schema-database.adoc#_database[Sync Gateway Configuration Schema]. [cols="2", options="header"] |=== | Property | Description -| scopename +| scopename | Represents the name of each scope | collections diff --git a/modules/ROOT/pages/sync-inter-syncgateway-conflict-resolution.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-conflict-resolution.adoc similarity index 100% rename from modules/ROOT/pages/sync-inter-syncgateway-conflict-resolution.adoc rename to modules/ROOT/pages/sync/sync-inter-syncgateway-conflict-resolution.adoc diff --git a/modules/ROOT/pages/sync-inter-syncgateway-manage.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-manage.adoc similarity index 100% rename from modules/ROOT/pages/sync-inter-syncgateway-manage.adoc rename to modules/ROOT/pages/sync/sync-inter-syncgateway-manage.adoc diff --git a/modules/ROOT/pages/sync-inter-syncgateway-monitor.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-monitor.adoc similarity index 100% rename from modules/ROOT/pages/sync-inter-syncgateway-monitor.adoc rename to modules/ROOT/pages/sync/sync-inter-syncgateway-monitor.adoc diff --git a/modules/ROOT/pages/sync-inter-syncgateway-overview.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc similarity index 98% rename from modules/ROOT/pages/sync-inter-syncgateway-overview.adoc rename to modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc index f1201f542..cfbaf97bd 100644 --- a/modules/ROOT/pages/sync-inter-syncgateway-overview.adoc +++ b/modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc @@ -157,7 +157,7 @@ Inter-Sync Gateway replication supports named collections, including: * Limit replication to specific collections. * Map local collections to differently named remote collections. -For detailed configuration of collections parameters (`collections_enabled`, `collections_local`, `collections_remote`), see xref:configuration-schema-isgr.adoc#replication[Run Inter-Sync Gateway Replication Configuration Schema]. +For detailed configuration of collections parameters (`collections_enabled`, `collections_local`, `collections_remote`), see xref:configuration/configuration-schema-isgr.adoc#replication[Run Inter-Sync Gateway Replication Configuration Schema]. ==== Collection Mapping @@ -168,7 +168,7 @@ Collection mapping allows you to replicate local collections to differently name The mapping works positionally, where the first collection in `collections_local` maps to the first collection in `collections_remote`, the second to the second, and so on. -NOTE: You must verify all specified collections exist in both source and target Sync Gateway database configurations before starting replication. +NOTE: You must verify all specified collections exist in both source and target Sync Gateway database configurations before starting replication. Sync Gateway does not automatically create missing collections or sync new collections after replication begins. This collection mapping capability adapts the mapping concept from XDCR for Sync Gateway deployments. For information about xref:server:learn:clusters-and-availability/xdcr-with-scopes-and-collections.adoc#implicit-mapping[Implicit Mapping] and xref:server:learn:clusters-and-availability/xdcr-with-scopes-and-collections.adoc#explicit-mapping[Explicit Mapping] in the XDCR documentation. diff --git a/modules/ROOT/pages/sync-inter-syncgateway-run.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-run.adoc similarity index 100% rename from modules/ROOT/pages/sync-inter-syncgateway-run.adoc rename to modules/ROOT/pages/sync/sync-inter-syncgateway-run.adoc diff --git a/modules/ROOT/pages/sync-using-app.adoc b/modules/ROOT/pages/sync/sync-using-app.adoc similarity index 100% rename from modules/ROOT/pages/sync-using-app.adoc rename to modules/ROOT/pages/sync/sync-using-app.adoc diff --git a/modules/ROOT/pages/sync-with-couchbase-server.adoc b/modules/ROOT/pages/sync/sync-with-couchbase-server.adoc similarity index 100% rename from modules/ROOT/pages/sync-with-couchbase-server.adoc rename to modules/ROOT/pages/sync/sync-with-couchbase-server.adoc diff --git a/modules/ROOT/pages/deploy-cluster-to-kubernetes.adoc b/modules/ROOT/pages/use-kubernetes/deploy-cluster-to-kubernetes.adoc similarity index 100% rename from modules/ROOT/pages/deploy-cluster-to-kubernetes.adoc rename to modules/ROOT/pages/use-kubernetes/deploy-cluster-to-kubernetes.adoc diff --git a/modules/ROOT/pages/whatsnew.adoc b/modules/ROOT/pages/whatsnew.adoc index b52f9ac00..c51275102 100644 --- a/modules/ROOT/pages/whatsnew.adoc +++ b/modules/ROOT/pages/whatsnew.adoc @@ -33,7 +33,7 @@ They may decrease performance, as each partition is queried separately and resul You should only migrate to partitioned indexes in cases where you are using memory-optimized indexes which exceed the memory capacity of a single index node, and you cannot reduce the index size using collections or database sharding. -For more information, see xref:index-partitions.adoc[]. +For more information, see xref:deploy/index-partitions.adoc[]. ==== Disable the Public All Docs Endpoint @@ -43,7 +43,7 @@ With a large number of documents, it may lead to timeouts and out-of-memory cond In any sizeable setup, it is recommended that you should instead use the xref:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`GET /{keyspace}/_changes`] operation to get all documents for a user, or the xref:rest_api_public.adoc#tag/Document/operation/post_keyspace-_bulk_docs[`POST /{keyspace}/_bulk_docs`] operation to return a specific subset of documents. -To disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API, set xref:configuration-schema-database.adoc#disable_public_all_docs[`disable_public_all_docs`] to `true` in the database configuration. +To disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API, set xref:configuration/configuration-schema-database.adoc#disable_public_all_docs[`disable_public_all_docs`] to `true` in the database configuration. This option is set to `false` by default; it will be set to `true` by default in a future release. ==== Interactive Admin Credentials for SG Collect Info @@ -54,7 +54,7 @@ Attempting to use the `--sync-gateway-password` option causes an error, with ins Alternatively, you can set credentials using the `SG_USERNAME` and `SG_PASSWORD` environment variables to avoid the prompt. -For more information, see xref:sgcollect-info.adoc[]. +For more information, see xref:manage/sgcollect-info.adoc[]. ==== Performance Improvements for Larger Deployments