Skip to content

Commit 9904b43

Browse files
rao-shwerao-shwe
authored
added-changes-from-doc-12539 (#3872)
1 parent 3392f27 commit 9904b43

3 files changed

Lines changed: 156 additions & 14 deletions

File tree

‎modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,7 @@ include::cli:partial$cbcli/nav.adoc[]
317317
** xref:cli:couchbase-server.adoc[couchbase-server]
318318
** xref:cli:mctimings.adoc[mctimings]
319319
** xref:cli:mcstat.adoc[mcstat]
320+
** xref:cli:mctestauth.adoc[mctestauth]
320321
* xref:rest-api:rest-intro.adoc[REST API Reference]
321322
322323
** xref:rest-api:rest-cluster-intro.adoc[Nodes and Clusters API]

‎modules/cli/pages/cli-intro.adoc‎

Lines changed: 62 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= CLI Reference
22
:description: The command-line interface (CLI) tools let you manage and monitor your Couchbase Server installation including clusters, servers, vBuckets, and XDCR.
3-
:tools-ver: 7.6.2
3+
:tools-ver: 8.0.0
44

55
[abstract]
66
{description}
@@ -39,46 +39,94 @@ You can collect diagnostics through the command-line interface by using the xref
3939
[#server-tools-packages]
4040
== Server Tools Packages
4141

42-
For convenience, Couchbase provides a tools package that contains the following utilities:
42+
For convenience, Couchbase provides the Server developer tools package and the Server admin tools package.
43+
44+
=== Server Developer Tools Package
45+
46+
The Server developer tools package lets you install the following EE Server utilities on the systems where you have not installed Couchbase Server:
4347

4448
* xref:tools:cbimport.adoc[`cbimport`]
4549
* xref:tools:cbexport.adoc[`cbexport`]
4650
* xref:cli:cbq-tool.adoc[`cbq`]
4751
* xref:backup-restore:cbbackupmgr.adoc[`cbbackupmgr`]
4852

49-
This package lets you install these tools on systems where you have not installed Couchbase Server.
50-
5153
Download the command line tools package for your platform from the following links:
5254

53-
* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz[]
54-
* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_aarch64.tar.gz[]
55-
* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_x86_64.zip[]
56-
* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_arm64.zip[]
57-
* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-windows_amd64.zip[]
55+
* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz[]
56+
* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_aarch64.tar.gz[]
57+
* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-macos_x86_64.zip[]
58+
* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-macos_arm64.zip[]
59+
* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-windows_amd64.zip[]
5860

5961
Unzip or untar the packages, and the binaries are ready to run.
6062
For example:
6163

6264
[source,console,subs="attributes+"]
6365
----
64-
wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz
66+
wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz
6567
66-
tar -xf couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz
68+
tar -xf couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz
6769
----
6870

6971
Each package also contains a `README` file and a copy of the software license.
7072

7173
NOTE: On Windows, you must have a recent version of the Microsoft Visual {cpp} Redistributable runtime libraries installed.
7274
If you do not have these libraries installed, download them from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170[Microsoft Visual {cpp} Redistributable latest supported downloads].
7375

76+
=== Server Admin Tools Package
77+
78+
The Server admin tools package lets you install the following Server utilities on the systems where you have not installed Couchbase Server:
79+
80+
* xref:backup-restore:cbbackupmgr.adoc[`cbbackupmgr`]
81+
* https://docs.couchbase.com/sdk-api/couchbase-c-client/md_doc_2cbc.html[`cbc`]
82+
* xref:tools:cbdatarecovery.adoc[`cbdatarecovery`]
83+
* xref:tools:cbexport.adoc[`cbexport`]
84+
* xref:tools:cbimport.adoc[`cbimport`]
85+
* xref:cli:cbq-tool.adoc[`cbq`]
86+
* xref:cli:cbstats-intro.adoc[`cbstats`]
87+
* xref:cli:cbcli/couchbase-cli.adoc[`couchbase-cli`]
88+
* xref:cli:mcstat.adoc[`mcstat`]
89+
* xref:cli:mctimings.adoc[`mctimings`]
90+
* xref:cli:mctestauth.adoc[`mctestauth`]
91+
92+
Download the command line tools package for your platform from the following links:
93+
94+
* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz[]
95+
* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_aarch64.tar.gz[]
96+
* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-macos_x86_64.zip[]
97+
* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-macos_arm64.zip[]
98+
* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-windows_amd64.zip[]
99+
100+
Unzip or untar the packages, and the binaries are ready to run.
101+
For example:
102+
103+
[source,console,subs="attributes+"]
104+
----
105+
wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz
106+
tar -xf couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz
107+
----
108+
109+
Each package also contains a `README` file and a copy of the software license.
110+
111+
NOTE: On Windows, you must have a recent version of the Microsoft Visual {cpp} Redistributable runtime libraries installed.
112+
If you do not have these libraries installed, download them from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist[Microsoft Visual {cpp} Redistributable latest supported downloads].
113+
74114
[#version-compatibility]
75115
== Version Compatibility
76116

77117
The versions of the utilities installed by the tools package are the same as the corresponding Couchbase Server installation package.
78118

79-
The {tools-ver} `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
119+
For Server developer tools package, the {tools-ver} version of `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
80120

81-
* 7.6.0, 7.6.1
121+
* 8.0.x
122+
* 7.6.x
82123
* 7.2.x
83124
* 7.1.x
84-
* 7.0.x
125+
126+
You can download and use the latest version of the utilities (`cbimport`, `cbexport`, `cbbackupmgr`, and `cbq`) with earlier Couchbase Server versions.
127+
128+
For Server admin tools package, do the following:
129+
130+
* Use the `--version` option to get the version of the utility. However, for the `cbc` utility, use the `cbc version` option.
131+
* `couchbase-cli` is a utility for administering the Couchbase cluster. Make sure that the versions of `couchbase-cli` and the Couchbase cluster match.
132+
* For all utilities, a feature that exists in a latest Server version only is not supported by an earlier version utility.

‎modules/cli/pages/mctestauth.adoc‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
= mctestauth
2+
:description: pass:q[The mctestauth tool allows you to troubleshoot authentication issues in data services.]
3+
:page-topic-type: reference
4+
5+
[abstract]
6+
{description}
7+
8+
== Description
9+
10+
The `mctestauth` tool allows you to troubleshoot the authentication issues in data services. Data services use the https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer[Simple Authentication and Security Layer] (SASL) framework for authentication and provide you access to use the underlying mechanisms. For example, SCRAM-SHA512 or PLAIN.
11+
12+
The tool is located as follows:
13+
14+
[cols="2,3"]
15+
|===
16+
| Platform | Location
17+
18+
| Linux
19+
| [.path]_/opt/couchbase/bin/mctestauth_
20+
21+
| Windows
22+
| [.path]_C:\Program Files\Couchbase\Server\bin\mctestauth.exe_
23+
24+
| Mac OS X
25+
| [.path]_/Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/mctestauth_
26+
|===
27+
28+
== Syntax
29+
30+
----
31+
mctestauth [options]
32+
----
33+
34+
[#options]
35+
The `options` are as follows:
36+
37+
[cols="1,2"]
38+
|===
39+
| Options | Description
40+
41+
| `--host` with parameter `<hostname[:port]>`
42+
| The name of the host (with an optional port) to connect to. For IPv6, use `[address]:port` if you need to specify the port.
43+
44+
| `--user <username>`
45+
| The username to be used in authentication.
46+
47+
| `--password <password>`
48+
| The password to be used in authentication.
49+
50+
| `--tls`
51+
| Optionally, use TLS to authenticate.
52+
53+
| `--ipv4`
54+
| Connect over IPv4.
55+
56+
| `--ipv6`
57+
| Connect over IPv6.
58+
59+
| `--version`
60+
| Find program version.
61+
62+
| `--no-color`
63+
| Print output without any colors.
64+
65+
| `--help`
66+
| Display help text.
67+
|===
68+
69+
== Example
70+
71+
The following call tries to connect to the data server running on the host `192.168.86.101`. The call then tries the various authentication mechanisms supported by the server and prints out the result of each mechanism. The call succeeds only if you provide the correct credentials.
72+
73+
----
74+
./mctestauth --host 192.168.86.101 --user jones --password password
75+
----
76+
77+
If successful, the command returns output as follows:
78+
79+
----
80+
SCRAM-SHA512: OK
81+
SCRAM-SHA256: OK
82+
SCRAM-SHA1: OK
83+
PLAIN: OK
84+
----
85+
86+
If `jones` was defined as an external user in LDAP, the output is as follows:
87+
88+
----
89+
SCRAM-SHA512: FAILED
90+
SCRAM-SHA256: FAILED
91+
SCRAM-SHA1: FAILED
92+
PLAIN: OK
93+
----

0 commit comments

Comments
 (0)