Skip to content
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.

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

Merge changes from release/7.0 into dev-reorg #2248

Merged
merged 45 commits into from
Oct 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
b11895b
DOC-9119: improving description of rebalancing in abstracts and headi…
RayOffiah Sep 29, 2021
007db4d
DOC-9237: Clarify views deprecation in relnotes (#2215)
amarantha-k Sep 30, 2021
79f1fb6
DOC-9240: remove reference to query tree from query-workbench docs (#…
RayOffiah Oct 1, 2021
38f2837
Doc 9018 document charts on query workbench (#2216)
RayOffiah Oct 1, 2021
a4eaa33
DOC-6760: Added redirect (#2168)
tonyjhillman Oct 5, 2021
7711e5d
DOC-9080: added entries for Debian 11.x support (#2221)
RayOffiah Oct 5, 2021
305e6ed
DOC-8891: Added prometheus to list of managed logs (#2104)
tonyjhillman Oct 6, 2021
0aa9c58
DOC-8894: Updated bucket durability on create and edit bucket (#2105)
tonyjhillman Oct 6, 2021
a7247c0
DOC-8923: Fixed typo (#2121)
tonyjhillman Oct 6, 2021
2c19e83
DOC-8929: Updated screenshot (#2127)
tonyjhillman Oct 6, 2021
afd467a
DOC-8931: Added note on audit file deletion responsibility (#2130)
tonyjhillman Oct 6, 2021
bdf35c2
DOC-8997: Information on xdcr between pre and post 7.0 (#2155)
tonyjhillman Oct 6, 2021
1686d8c
DOC-9019: Added new metrics for analytics, data service, and cluster …
tonyjhillman Oct 6, 2021
df626b5
DOC-9099: Modified XDCR Advanced Settings and general internal settin…
tonyjhillman Oct 6, 2021
0b1fb03
DOC-9103for7.0: Updated command name (#2193)
tonyjhillman Oct 6, 2021
56213b7
DOC-9116: Updated reference to xdcr and expiration (#2197)
tonyjhillman Oct 6, 2021
93c9966
DOC-9094for7.0: Re-included cbsummary (#2195)
tonyjhillman Oct 6, 2021
2044ad0
Doc 9012 (#2158)
tonyjhillman Oct 6, 2021
7a662ab
DOC-6667for7.0: Added redirect for intra-cluster replication (#2144)
tonyjhillman Oct 6, 2021
7da2de4
Eventing REST API 7.0 updates (#2226)
jon-strabala Oct 8, 2021
dd955b2
Add page-alias for query string query page (#2228)
amarantha-k Oct 8, 2021
444f566
Doc 9222 (#2212)
tonyjhillman Oct 14, 2021
1c4e881
DOC-8540: Added information on strict value for cluster encryption-le…
tonyjhillman Oct 14, 2021
ea80a15
DOC-9021: Added statement on effect of revEpoch (#2165)
tonyjhillman Oct 14, 2021
33b8b76
DOC-9017: Standard Index Storage for Ephemeral Buckets (#2201)
tonyjhillman Oct 14, 2021
b4f670b
DOC-9016: Updated UI for create cluster (#2159)
tonyjhillman Oct 14, 2021
fea80c1
DOC-9178: Added info on new license restriction for node-count in CE …
tonyjhillman Oct 14, 2021
3dba2c8
DOC-9192: Added information on alternate address for target cluster (…
tonyjhillman Oct 14, 2021
f30aff8
DOC-9066: Added instructions to windows install (#2211)
tonyjhillman Oct 14, 2021
92c7346
DOC-9093: Added audit events (#2186)
tonyjhillman Oct 14, 2021
cad28c3
DOC-6535: Added redirect (#2178)
tonyjhillman Oct 14, 2021
ef5f2fb
Revert "Doc 9222" - Some changes needed for PHP build (#2231)
RayOffiah Oct 14, 2021
a274b85
DOC-9177: Added note on 7.0.2 IP Address Families (#2205)
tonyjhillman Oct 14, 2021
a908b05
Revert "Revert "Doc 9222" - Some changes needed for PHP build (#2231)…
RayOffiah Oct 14, 2021
e0603bf
Removed statement: "Couchbase Server supports durability for single-d…
RayOffiah Oct 14, 2021
80439d2
Fix bad line wrap (#2229)
jon-strabala Oct 14, 2021
f430fc7
Updated release note for MB-48783 (#2234)
RayOffiah Oct 15, 2021
4807464
Added note about new charts on query workbench (#2235)
RayOffiah Oct 15, 2021
08b836f
Alias fix (#2238)
RichardSmedley Oct 18, 2021
f8c250e
11.x not ready to go yet. (#2242)
RayOffiah Oct 18, 2021
20557c5
Add changes to query workbench to release note (#2236)
RayOffiah Oct 19, 2021
34160d3
DOC-9252: Capella Rebrand (#2247)
osfameron Oct 19, 2021
33b1859
Quick typo fix (#2230)
BKaneAtWork Oct 20, 2021
1117f1d
Merge branch 'couchbase:dev-reorg' into dev-reorg
simon-dew Oct 20, 2021
8c0d123
Merge branch 'dev-reorg' of https://github.com/simon-dew/docs-server …
simon-dew Oct 20, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,7 @@ include::cli:partial$cbcli/nav.adoc[]
*** xref:cli:cbstats/cbstats-vkey.adoc[vkey]
*** xref:cli:cbstats/cbstats-warmup.adoc[warmup]
*** xref:cli:cbstats/cbstats-workload.adoc[workload]
** xref:cli:cbsummary.adoc[cbsummary]
** xref:cli:cbtools/cbtransfer.adoc[cbtransfer]
** xref:cli:cbtools/cbworkloadgen.adoc[cbworkloadgen]
** xref:cli:couchbase-server.adoc[couchbase-server]
Expand All @@ -590,7 +591,7 @@ include::cli:partial$cbcli/nav.adoc[]
***** xref:rest-api:rest-get-rebalance-retry.adoc[Getting Rebalance-Retry Status]
***** xref:rest-api:rest-cancel-rebalance-retry.adoc[Canceling Rebalance Retries]
***** xref:rest-api:rest-limit-rebalance-moves.adoc[Limiting Concurrent vBucket Moves]
**** xref:rest-api:rest-get-internal-setting.adoc[Viewing Internal Settings]
**** xref:rest-api:rest-get-internal-setting.adoc[Managing Internal Settings]
**** xref:rest-api:rest-manage-cluster-connections.adoc[Managing Cluster Connections]
**** xref:rest-api:rest-get-cluster-tasks.adoc[Getting Cluster Tasks]
**** xref:rest-api:rest-statistics.adoc[Getting Cluster Statistics]
Expand Down Expand Up @@ -718,7 +719,6 @@ include::cli:partial$cbcli/nav.adoc[]
**** xref:rest-api:rest-authorization.adoc[Authorization API]
***** xref:rest-api:rbac.adoc[Role-Based Access Control (RBAC)]
**** xref:rest-api:rest-setting-security.adoc[Configure On-the-Wire Security]
**** xref:rest-api:rest-setting-security.adoc[Manage Encryption Settings]
**** xref:rest-api:rest-secret-mgmt.adoc[Secret Management API]
* xref:xdcr-reference:xdcr-reference-intro.adoc[XDCR Reference]
** xref:xdcr-reference:xdcr-advanced-settings.adoc[Advanced Settings]
Expand Down
27 changes: 26 additions & 1 deletion modules/audit-event-reference/pages/audit-event-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ The following events are generated by Couchbase Server in response to calls made
| REST API | create collection | 8261 | Collection was created | N | Data
| REST API | drop collection | 8262 | Collection was dropped | N | Data
| REST API | set manifest | 8263 | Setting bucket manifest | N | Data
| REST API | authentication failure | 8264 | REST operation failed due to authentication failure | N | Admin
| REST API | RBAC information retrieved | 8265 | RBAC information was retrieved | Y | Admin
| REST API | Admin password reset | 8266 | Admin password was reset | N | Admin
|===

[#data-service-event-list-table]
Expand Down Expand Up @@ -176,7 +179,25 @@ The following events are generated by the Query and Index Services, in response
| Query and Index Services | DROP FUNCTION statement | 28707 | A N1QL DROP FUNCTION statement was executed | Y | Admin
| Query and Index Services | EXECUTE FUNCTION statement | 28708 | A N1QL EXECUTE FUNCTION statement was executed | Y | Admin
| Query and Index Services | /admin/tasks API request | 28709 | An HTTP request was made to the API at /admin/tasks. | Y | Admin
| Query and Index Services | /admin/indexes/tasks API request | 287010 | An HTTP request was made to the API at /admin/indexes/tasks. | Y | Admin
| Query and Index Services | /admin/indexes/tasks API request | 28710 | An HTTP request was made to the API at /admin/indexes/tasks. | Y | Admin
| Query and Index Services | /admin/dictionary_cache API request | 28711 | An HTTP request was made to the API at /admin/dictionary_cache | Y | Admin
| Query and Index Services | /admin/indexes/dictionary_cache API request | 28712 | An HTTP request was made to the API at /admin/indexes/dictionary_cache | Y | Admin
| Query and Index Services | CREATE SCOPE statement | 28713 | A N1QL CREATE SCOPE statement was executed | Y | Admin
| Query and Index Services | DROP SCOPE statement | 28714 | A N1QL DROP SCOPE statement was executed | Y | Admin
| Query and Index Services | CREATE COLLECTION statement | 28715 | A N1QL CREATE COLLECTION statement was executed | Y | Admin
| Query and Index Services | DROP COLLECTION statement | 28716 | A N1QL DROP COLLECTION statement was executed | Y | Admin
| Query and Index Services | FLUSH COLLECTION statement | 28717 | A N1QL FLUSH COLLECTION statement was executed | Y | Admin
| Query and Index Services | UPDATE STATISTICS statement | 28718 | A N1QL UPDATE STATISTICS statement was executed | Y | Admin
| Query and Index Services | ADVISE statement | 28719 | A N1QL ADVISE statement was executed | Y | Admin
| Query and Index Services | START TRANSACTION statement | 28720 | A N1QL START TRANSACTION statement was executed | Y | Admin
| Query and Index Services | COMMIT TRANSACTION statement | 28721 | A N1QL COMMIT TRANSACTION statement was executed | Y | Admin
| Query and Index Services | ROLLBACK TRANSACTION statement | 28722 | A N1QL ROLLBACK TRANSACTION statement was executed | Y | Admin
| Query and Index Services | ROLLBACK TRANSACTION TO SAVEPOINT statement | 28723 | A N1QL ROLLBACK TRANSACTION TO SAVEPOINT statement was executed | Y | Admin
| Query and Index Services | SET TRANSACTION ISOLATION statement | 28724 | A N1QL SET TRANSACTION ISOLATION statement was executed | Y | Admin
| Query and Index Services | SAVEPOINT statement | 28725 | A N1QL SAVEPOINT statement was executed | Y | Admin
| Query and Index Services | /admin/transactions API request | 28726 | An HTTP request was made to the API at /admin/transactions. | Y | Admin
| Query and Index Services | /admin/indexes/transactions API request | 28727 | An HTTP request was made to the API at /admin/indexes/transactions. | Y | Admin
| Query and Index Services | N1QL backup / restore API request | 28728 | An HTTP request was made to archive or restore N1QL metadata | Y | Admin
|===

[#search-service-event-list-table]
Expand All @@ -195,6 +216,7 @@ The following events are generated by the Search Service, in response to index a
| Search Service | GC run | 24582 | GC run was triggered | N | Admin
| Search Service | CPU profile | 24583 | CPU profiling was started | N | Admin
| Search Service | Memory profile | 24584 | Memory profiling was started | N | Admin
| Search Service | Access denied | 24585 | User has been denied access due to invalid permissions/credentials | N | Admin
|===

[#eventing-service-event-list-table]
Expand Down Expand Up @@ -224,6 +246,8 @@ The following events are generated by the Eventing Service, in response to the d
| Eventing Service | Import Functions | 32784 | Import a list of functions | Y | Admin
| Eventing Service | Export Functions | 32785 | Export the list of functions | Y | Admin
| Eventing Service | List Running | 32786 | Eventing running function list was read | Y | Admin
| Eventing Service | Authentication Failure | 32787 | Authentication failed | Y | Admin
| Eventing Service | Authorization Failure | 32788 | Authorization failed | Y | Admin
|===

[#analytics-service-event-list-table]
Expand Down Expand Up @@ -273,6 +297,7 @@ The following events are generated by the Analytics Service, in response to conf
| Backup Service | Examine repository | 45071 | A document was retrieved from the repository backups | Y | Admin
| Backup Service | Delete repository | 45072 | A repository was deleted | Y | Admin
| Backup Service | Delete backup | 45073 | An active repository backup was deleted | Y | Admin
| Backup Service | Access denied | 45074 | A user has been denied access to the REST API due to invalid permissions or credentials | Y | Admin
|===

[#view-engine-event-list-table]
Expand Down
60 changes: 60 additions & 0 deletions modules/cli/pages/cbsummary.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
= cbsummary
:description: pass:q[The `cbsummary` tool connects to a set of Couchbase clusters, and generates a summary report.]
:page-topic-type: reference

[abstract]
{description}

== Description

The `cbsummary` tool connects to a set of Couchbase clusters specified in a configuration file and generates a summary report.

The config file contains JSON specifying an array of information on each cluster, giving the Couchbase credentials to login, and one or more IP addresses for cluster nodes.

The default report format includes RAM and core utilization across each specified cluster, since that information is useful in determining compliance with Couchbase licenses.
If you specify `--csv`, then the report is generated in CSV instead of JSON.
If, instead, you specify `--full`, then a much more detailed report is generated.

The summary report is sent to the file `cbsummary.out.<timestamp>`, unless a different filename is specified with the `--output` option.

== Syntax

The syntax for `cbsummary` is as follows:

----
cbsummary --config=<config file> [--output=<output file>] [--full]
----

== Options

Command options are as follows:

[cols="3,3"]
|===
| Option | Description

| `--config [config file]`
| Configuration file listing clusters and credentials to connect and generate a summary.

| `--csv`
| Generate the report in CSV format.
Note that this format is not compatible with full reports.

| `--full`
| Generate an extensive report instead of just core and RAM usage.

| `-h --help`
| Print a help message and exit.

| `--output [output file]`
| Name of the output file. The default naming convention for the report is `cbsummary.out.<timestamp>`.
|===

== Examples

An example config file giving information about 2 clusters is:

{ "clusters": [
{"login": "Administrator", "pass": "password1", "nodes": ["http://192.168.1.1:8091"]},
{"login": "Administrator", "pass": "password2", "nodes": ["http://192.166.1.1:8091","http://192.16.1.2:8091"]}
]}