Skip to content

Doc 12046 enable cross cluster versioning warning #3603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 12, 2024
Merged

Doc 12046 enable cross cluster versioning warning #3603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d77c56b
* Added admonitions about the enableCrossClusterVersioning
ggray-cb Jun 10, 2024
6bb9dff
Deleted stay blank line
ggray-cb Jun 10, 2024
beec01a
Fixed include link
ggray-cb Jun 10, 2024
587786f
Updated example description to fix several issues.
ggray-cb Jun 10, 2024
89f9ba0
Update based on Hyun-Ju's feedback.
ggray-cb Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions modules/rest-api/pages/rest-bucket-create.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,15 @@ If the bucket cannot created due to a missing or incorrect parameter, a `400` re
If the URL is incorrectly specified a `404 (Object Not Found)` error is returned.
Failure to authenticate gives `401 Unauthorized`.

[#notes]
== Notes

Couchbase Server 7.6.2 added a property named `enableCrossClusterVersioning` to support a future feature.
Do not change the value of this property.

CAUTION: Once enabled, you cannot turn off the `enableCrossClusterVersioning` property.
The only way for you to undo setting this value to `true` is to backup your data, create a new bucket, and reload the data into it.

== See Also

A conceptual description of buckets is provided in xref:learn:buckets-memory-and-storage/buckets.adoc[Buckets].
Expand Down
182 changes: 16 additions & 166 deletions modules/rest-api/pages/rest-buckets-summary.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,182 +41,32 @@ If an internal error prevents successful execution, `500 Internal Server Error`
[#example]
== Example

The following example returns information on a single bucket, which is `testBucket`.
The output of the call is piped to https://stedolan.github.io/jq/[jq^], to facilitate readability.
The following example returns information on a single bucket named `travel-sample`.
The output of the call is piped to https://stedolan.github.io/jq/[jq^] to improve readability.

----
curl -X GET -u Administrator:password \
http://localhost:8091/pools/default/buckets/testBucket | jq '.'
http://localhost:8091/pools/default/buckets/travel-sample | jq '.'
----

If successful, the call returns `200 OK`, and an object such as the following.
(Note that actual console-output contains an extensive array of vBucket-information: this has been omitted from this example.)
If successful, the call returns `200 OK`, and an object similar to the one shown in the following example.

The fields `historyRetentionCollectionDefault`, `historyRetentionCollectionBytes`, and `historyRetentionCollectionSeconds` are specific to _Magma_ storage: if `magma` is not the value of `storageBackend`, these parameters are not displayed.
NOTE: The output contains an extensive array of vBucket data that is omitted from this example.

The fields `historyRetentionCollectionDefault`, `historyRetentionCollectionBytes`, and `historyRetentionCollectionSeconds` are specific to Magma storage.
When the bucket does not use Magma as its storage backend, these properties do not appear in the output.

[source, json]
----
{
"name": "testBucket",
"nodeLocator": "vbucket",
"bucketType": "membase",
"storageBackend": "magma",
"uuid": "d76bc79b761458f95d7dcf48bbe2fe92",
"uri": "/pools/default/buckets/testBucket?bucket_uuid=d76bc79b761458f95d7dcf48bbe2fe92",
"streamingUri": "/pools/default/bucketsStreaming/testBucket?bucket_uuid=d76bc79b761458f95d7dcf48bbe2fe92",
"bucketCapabilitiesVer": "",
"bucketCapabilities": [
"collections",
"durableWrite",
"tombstonedUserXAttrs",
"subdoc.ReplaceBodyWithXattr",
"subdoc.DocumentMacroSupport",
"subdoc.ReviveDocument",
"nonDedupedHistory",
"dcp",
"cbhello",
"touch",
"cccp",
"xdcrCheckpointing",
"nodesExt",
"xattr"
],
"collectionsManifestUid": "2",
"vBucketServerMap": {
"hashAlgorithm": "CRC",
"numReplicas": 1,
"serverList": [
"127.0.0.1:11210"
],
"vBucketMap": [
[
0,
-1
],
.
.
.
},
"localRandomKeyUri": "/pools/default/buckets/testBucket/localRandomKey",
"controllers": {
"compactAll": "/pools/default/buckets/testBucket/controller/compactBucket",
"compactDB": "/pools/default/buckets/testBucket/controller/compactDatabases",
"purgeDeletes": "/pools/default/buckets/testBucket/controller/unsafePurgeBucket",
"startRecovery": "/pools/default/buckets/testBucket/controller/startRecovery"
},
"nodes": [
{
"couchApiBaseHTTPS": "https://127.0.0.1:18092/testBucket%2Bd76bc79b761458f95d7dcf48bbe2fe92",
"couchApiBase": "http://127.0.0.1:8092/testBucket%2Bd76bc79b761458f95d7dcf48bbe2fe92",
"clusterMembership": "active",
"recoveryType": "none",
"status": "healthy",
"otpNode": "ns_1@127.0.0.1",
"thisNode": true,
"hostname": "127.0.0.1:8091",
"nodeUUID": "fa173ccb5d6d48648ae79cbbd278dbb5",
"clusterCompatibility": 458754,
"version": "7.2.0-5127-enterprise",
"os": "x86_64-pc-linux-gnu",
"cpuCount": 1,
"ports": {
"direct": 11210,
"httpsCAPI": 18092,
"httpsMgmt": 18091,
"distTCP": 21100,
"distTLS": 21150
},
"services": [
"backup",
"index",
"kv",
"n1ql"
],
"nodeEncryption": false,
"addressFamilyOnly": false,
"configuredHostname": "127.0.0.1:8091",
"addressFamily": "inet",
"externalListeners": [
{
"afamily": "inet",
"nodeEncryption": false
}
],
"serverGroup": "Group 1",
"replication": 0,
"nodeHash": 47731734,
"systemStats": {
"cpu_utilization_rate": 11.40536280284413,
"cpu_stolen_rate": 0,
"swap_total": 2047864832,
"swap_used": 1323008,
"mem_total": 2039574528,
"mem_free": 1229828096,
"mem_limit": 2039574528,
"cpu_cores_available": 1,
"allocstall": 2
},
"interestingStats": {
"cmd_get": 0,
"couch_docs_actual_disk_size": 34,
"couch_docs_data_size": 0,
"couch_spatial_data_size": 0,
"couch_spatial_disk_size": 0,
"couch_views_actual_disk_size": 0,
"couch_views_data_size": 0,
"curr_items": 0,
"curr_items_tot": 0,
"ep_bg_fetched": 0,
"get_hits": 0,
"mem_used": 60589912,
"ops": 0,
"vb_active_num_non_resident": 0,
"vb_replica_curr_items": 0
},
"uptime": "1170",
"memoryTotal": 2039574528,
"memoryFree": 1229828096,
"mcdMemoryReserved": 1556,
"mcdMemoryAllocated": 1556
}
],
"stats": {
"uri": "/pools/default/buckets/testBucket/stats",
"directoryURI": "/pools/default/buckets/testBucket/stats/Directory",
"nodeStatsListURI": "/pools/default/buckets/testBucket/nodes"
},
"authType": "sasl",
"autoCompactionSettings": false,
"replicaNumber": 1,
"threadsNumber": 3,
"quota": {
"ram": 1258291200,
"rawRAM": 1258291200
},
"basicStats": {
"quotaPercentUsed": 4.815253575642903,
"opsPerSec": 0,
"diskFetches": 0,
"itemCount": 0,
"diskUsed": 34,
"dataUsed": 0,
"memUsed": 60589912,
"vbActiveNumNonResident": 0
},
"evictionPolicy": "fullEviction",
"durabilityMinLevel": "none",
"pitrEnabled": false,
"pitrGranularity": 600,
"pitrMaxHistoryAge": 86400,
"storageQuotaPercentage": 50,
"historyRetentionSeconds": 0,
"historyRetentionBytes": 0,
"historyRetentionCollectionDefault": true,
"conflictResolutionType": "seqno",
"maxTTL": 0,
"compressionMode": "passive"
}
include::partial$get_bucket_travel_sample.json[]
----

NOTE: Couchbase Server version 7.6.2 added a property named `enableCrossClusterVersioning` to support a future feature.
Do not change the value of this field.
Once enabled, you cannot turn it off.
See the xref:rest-bucket-create.adoc#notes[Notes] section of xref:rest-bucket-create.adoc[] for more information.


[#see-also]
== See Also

Expand Down
Loading