Skip to content

Commit

Permalink
Merge changes from release/7.0 into dev-reorg (#2248)
Browse files Browse the repository at this point in the history 
* DOC-9119: improving description of rebalancing in abstracts and headings. (#2213)

* DOC-9237: Clarify views deprecation in relnotes (#2215)

* DOC-9240: remove reference to query tree from query-workbench docs (#2217)

* DOC-9240: remove reference to query tree from query-workbench.adoc. Add note about removal to relnotes.adoc

* DOC-9240: query-workbench-result-tree.png is no longer in use.

* Doc 9018 document charts on query workbench (#2216)

* DOC-9018: Adding  Query workbench chart documentation

* Put tree stuff back in because it's handled by DOC-9240

* DOC-9018: Changed query-workbench-result-plan.png, so it looks a bit more like the callouts describing it.

* DOC-9018: Tidying up the numbers

* DOC-6760: Added redirect (#2168)

* DOC-9080: added entries for Debian 11.x support (#2221)

* DOC-8891: Added prometheus to list of managed logs (#2104)

* DOC-8894: Updated bucket durability on create and edit bucket (#2105)

* DOC-8923: Fixed typo (#2121)

* DOC-8929: Updated screenshot (#2127)

* DOC-8931: Added note on audit file deletion responsibility (#2130)

* DOC-8997: Information on xdcr between pre and post 7.0 (#2155)

* DOC-9019: Added new metrics for analytics, data service, and cluster manager (#2208)

* DOC-9099: Modified XDCR Advanced Settings and general internal settin… (#2190)

* DOC-9099: Modified XDCR Advanced Settings and general internal settingspages

* DOC-9099: Added review feedback

* DOC-9099: Updated statement on HLV

* DOC-9103for7.0: Updated command name (#2193)

* DOC-9116: Updated reference to xdcr and expiration (#2197)

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* DOC-9094for7.0: Re-included cbsummary (#2195)

* Doc 9012 (#2158)

* DOC-9012: Modified password-design advice

* DOC-9012: New password-creation advice

* DOC-6667for7.0: Added redirect for intra-cluster replication (#2144)

* Eventing REST API 7.0 updates (#2226)

* Eventing REST API 7.0 updates

Very important for 7.0 (no changes for 7.0.1 or 7.0.2) need for CONNECT

Organize and group into logical sections
Add several missing important endpoints (export, appcode, list, etc.)
Improve descriptions
Fix typos

* Add final /api/v1/list/functions filter

/api/v1/list/functions/query?function_type=sbm
/api/v1/list/functions/query?function_type=notsbm

* Add page-alias for query string query page (#2228)

* Add page-alias for query string query page

* Update fts-query-string-syntax.adoc

Corrected macro name; added extension to file

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* Doc 9222 (#2212)

* DOC-9222: Draft release notes for 7.0.2

* DOC-9222: Release Notes for 7.0.2

* DOC-9222: Additional fixed issues for release notes for 7.0.2

* DOC-9222: Fixed links

* DOC-9222: Added to new features section for release notes

* DOC-9222: Additional fixes and modifications

* DOC-9222: Incorporated review feedback

* DOC-9222: Added line on Eventing feature

* DOC-9222: Added MB-48713

* DOC-9222: Added feedback on Index Service tickets

* DOC-8540: Added information on strict value for cluster encryption-level (#2135)

* DOC-8540: Added information on strict value for cluster encryption-level

* DOC-8540: Wording change to description of strict option

* DOC-8540: Added information on consequences of strict TLS enablement

* DOC-8540: Additional information and links related to strict encryption level

* DOC-8540: Clarified server version as 7.0.2+

* DOC-9021: Added statement on effect of revEpoch (#2165)

* DOC-9017: Standard Index Storage for Ephemeral Buckets (#2201)

* DOC-9017: Standard Index Storage for Ephemeral Buckets

* DOC-9017: Added note on editions

* DOC-9016: Updated UI for create cluster (#2159)

* DOC-9016: Updated UI for create cluster

* DOC-9016: Updated address family information for CLI and REST Initialization

* DOC-9178: Added info on new license restriction for node-count in CE 7.0+ (#2207)

* DOC-9192: Added information on alternate address for target cluster (#2210)

* DOC-9192: Added information on alternate address for target cluster

* DOC-9192: Added review feedback

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* DOC-9066: Added instructions to windows install (#2211)

* DOC-9066: Added instructions to windows install

* DOC-9066: Added initial bullet on admin privileges

* DOC-9093: Added audit events (#2186)

* DOC-6535: Added redirect (#2178)

* Revert "Doc 9222" - Some changes needed for PHP build (#2231)

* Revert "Doc 9222 (#2212)"

This reverts commit 444f566.

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* DOC-9177: Added note on 7.0.2 IP Address Families (#2205)

* Revert "Revert "Doc 9222" - Some changes needed for PHP build (#2231)" (#2232)

This reverts commit ef5f2fb.

* Removed statement: "Couchbase Server supports durability for single-document writes only." (#2233)

* Fix bad line wrap (#2229)

* Fix bad line wrap

No line breaks as I intended in this example in actual formatting outside of git - so broke it up into two code blocks

* fix method on POST for /config

* Fix methods for /appcode

* Updated release note for MB-48783 (#2234)

* Updated release note

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* Added note about new charts on query workbench (#2235)

* Alias fix (#2238)

* 11.x not ready to go yet. (#2242)

* Add changes to query workbench to release note (#2236)

* Added note about new charts on query workbench

* Added QueryBench charts to new features section: relnotes.adoc

* Removed issue reference for chart addition to Query workbench: relnotes.adoc

* DOC-9252: Capella Rebrand (#2247)

* Quick typo fix (#2230)

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
Co-authored-by: Tony Hillman <tonyjhillman@gmail.com>
Co-authored-by: Jon Strabala <54073900+jon-strabala@users.noreply.github.com>
Co-authored-by: Richard Smedley <rgsmedley@gmail.com>
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Co-authored-by: Brian Kane <38470665+BKaneAtWork@users.noreply.github.com>
  • Loading branch information
@simon-dew @RayOffiah
@amarantha-k @tonyjhillman @jon-strabala @RichardSmedley @osfameron @BKaneAtWork
8 people committed Oct 20, 2021
1 parent c162a4b commit 03dfe2b
Show file tree
Hide file tree
Showing 53 changed files with 1,471 additions and 398 deletions.
4 changes: 2 additions & 2 deletions modules/ROOT/nav.adoc
View file
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
View file
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
View file
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"]}
]}

0 comments on commit 03dfe2b

Please sign in to comment.