Skip to content

Commit 95d2c77

Browse files
jamesl33jamesl33
committed
DOC-8666 Merge branch '6.5.x-docs' into mad-hatter
* 6.5.x-docs: DOC-8666 Document that setting-saslauthd is a GNU/Linux only DOC-9312 Fix typo in user-manage example Change-Id: Ia22535bcf670b7ed99a9be1c0ee41cde4c7f098c
2 parents ed1c25f + fa382c5 commit 95d2c77

6 files changed

Lines changed: 200 additions & 166 deletions

File tree

‎docs/generated/doc/couchbase-cli/couchbase-cli-setting-saslauthd.html‎

Lines changed: 78 additions & 74 deletions
Large diffs are not rendered by default.

‎docs/generated/doc/couchbase-cli/couchbase-cli-user-manage.html‎

Lines changed: 76 additions & 76 deletions
Large diffs are not rendered by default.

‎docs/generated/man/man1/couchbase-cli-setting-saslauthd.1‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
'\" t
22
.\" Title: couchbase-cli-setting-saslauthd
33
.\" Author: Couchbase
4-
.\" Generator: Asciidoctor 2.0.10
5-
.\" Date: 2021-04-22
4+
.\" Generator: Asciidoctor 2.0.16
5+
.\" Date: 2021-12-07
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-SETTING\-SASLAUTHD" "1" "2021-04-22" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-SETTING\-SASLAUTHD" "1" "2021-12-07" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -28,10 +28,9 @@
2828
. LINKSTYLE blue R < >
2929
.\}
3030
.SH "NAME"
31-
couchbase\-cli\-setting\-saslauthd \- Modifies saslauthd settings
31+
couchbase-cli-setting-saslauthd \- Modifies saslauthd settings
3232
.SH "SYNOPSIS"
3333
.sp
34-
.sp
3534
.nf
3635
\fIcouchbase\-cli setting\-saslauthd\fP [\-\-cluster <url>] [\-\-username <user>]
3736
[\-\-password <password>] [\-\-admins <admins_list>]
@@ -41,6 +40,9 @@ couchbase\-cli\-setting\-saslauthd \- Modifies saslauthd settings
4140
.br
4241
.SH "DESCRIPTION"
4342
.sp
43+
This command is only available for clusters running Enterprise Edition on
44+
GNU/Linux.
45+
.sp
4446
This command allows users to enable SASL on their cluster as well as add
4547
administrator and read\-only administrator SASL users to their cluster.
4648
.SH "OPTIONS"
@@ -146,8 +148,10 @@ To enable SASL on a cluster run the following command.
146148
.sp
147149
.if n .RS 4
148150
.nf
151+
.fam C
149152
$ couchbase\-cli setting\-saslauthd \-c 192.168.1.5 \-\-username Administrator \(rs
150153
\-\-password password \-\-enabled 1
154+
.fam
151155
.fi
152156
.if n .RE
153157
.sp
@@ -156,9 +160,11 @@ Read\-Only Administrators run the following command.
156160
.sp
157161
.if n .RS 4
158162
.nf
163+
.fam C
159164
$ couchbase\-cli setting\-saslauthd \-c 192.168.1.5 \-\-username Administrator \(rs
160165
\-\-password password \-\-enabled 1 \-\-admins alice,barry \(rs
161166
\-\-roadmins clair,daniel
167+
.fam
162168
.fi
163169
.if n .RE
164170
.sp
@@ -167,8 +173,10 @@ following command.
167173
.sp
168174
.if n .RS 4
169175
.nf
176+
.fam C
170177
$ couchbase\-cli setting\-saslauthd \-c 192.168.1.5 \-\-username Administrator \(rs
171178
\-\-password password \-\-enabled 1 \-\-default admins
179+
.fam
172180
.fi
173181
.if n .RE
174182
.SH "ENVIRONMENT AND CONFIGURATION VARIABLES"
@@ -196,4 +204,4 @@ password are not cached in their command line history.
196204
Part of the \fBcouchbase\-cli\fP(1) suite
197205
.SH "AUTHOR"
198206
.sp
199-
Couchbase
207+
Couchbase

‎docs/generated/man/man1/couchbase-cli-user-manage.1‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
'\" t
22
.\" Title: couchbase-cli-user-manage
33
.\" Author: Couchbase
4-
.\" Generator: Asciidoctor 2.0.10
5-
.\" Date: 2021-04-22
4+
.\" Generator: Asciidoctor 2.0.16
5+
.\" Date: 2021-10-22
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-USER\-MANAGE" "1" "2021-04-22" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-USER\-MANAGE" "1" "2021-10-22" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -28,10 +28,9 @@
2828
. LINKSTYLE blue R < >
2929
.\}
3030
.SH "NAME"
31-
couchbase\-cli\-user\-manage \- Manage RBAC users
31+
couchbase-cli-user-manage \- Manage RBAC users
3232
.SH "SYNOPSIS"
3333
.sp
34-
.sp
3534
.nf
3635
\fIcouchbase\-cli user\-manage\fP [\-\-cluster <url>] [\-\-username <user>]
3736
[\-\-password <password>] [\-\-delete] [\-\-list] [\-\-my\-roles] [\-\-set]
@@ -266,7 +265,7 @@ the ability to create or view documents), XDCR cluster references, XDCR
266265
replications, and cluster settings.
267266
.RE
268267
.sp
269-
view_admin[...]
268+
views_admin[...]
270269
.RS 4
271270
Gives the user privileges to define views and then run these views on data
272271
to ensure that views are defined properly. This applies both to the
@@ -439,10 +438,12 @@ XDCR replication run the following command
439438
.sp
440439
.if n .RS 4
441440
.nf
441+
.fam C
442442
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
443443
\-p password \-\-set \-\-rbac\-username jdoe \-\-rbac\-password cbpass \(rs
444444
\-\-rbac\-name "John Doe" \-\-roles bucket_admin[default],replication_admin \(rs
445445
\-\-auth\-domain local
446+
.fam
446447
.fi
447448
.if n .RE
448449
.sp
@@ -452,36 +453,44 @@ views for all bucket run the following command
452453
.sp
453454
.if n .RS 4
454455
.nf
456+
.fam C
455457
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
456458
\-p password \-\-set \-\-rbac\-username jdoe \-\-rbac\-name "John Doe" \(rs
457-
\-\-roles view_admin[*] \-\-auth\-domain external
459+
\-\-roles views_admin[*] \-\-auth\-domain external
460+
.fam
458461
.fi
459462
.if n .RE
460463
.sp
461464
To list the current RBAC user profiles run the following command.
462465
.sp
463466
.if n .RS 4
464467
.nf
468+
.fam C
465469
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
466470
\-p password \-\-list
471+
.fam
467472
.fi
468473
.if n .RE
469474
.sp
470475
To delete an external user named \f(CRjdoe\fP run the following command.
471476
.sp
472477
.if n .RS 4
473478
.nf
479+
.fam C
474480
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
475481
\-p password \-\-delete \-\-rbac\-username jdoe \-\-auth\-domain external
482+
.fam
476483
.fi
477484
.if n .RE
478485
.sp
479486
To delete a local user named \f(CRjdoe\fP run the following command.
480487
.sp
481488
.if n .RS 4
482489
.nf
490+
.fam C
483491
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
484492
\-p password \-\-delete \-\-rbac\-username jdoe \-\-auth\-domain local
493+
.fam
485494
.fi
486495
.if n .RE
487496
.sp
@@ -490,8 +499,10 @@ run the following command.
490499
.sp
491500
.if n .RS 4
492501
.nf
502+
.fam C
493503
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u jdoe \-p cbpass \(rs
494504
\-\-my\-roles
505+
.fam
495506
.fi
496507
.if n .RE
497508
.sp
@@ -500,18 +511,22 @@ LDAP group reference \f(CRadmins\fP run the following command.
500511
.sp
501512
.if n .RS 4
502513
.nf
514+
.fam C
503515
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
504516
\-p password \-\-set\-group \-\-group\-name admins \-\-roles admin \(rs
505517
\-\-group\-description "CB admins" \-\-ldap\-ref admins
518+
.fam
506519
.fi
507520
.if n .RE
508521
.sp
509522
To delete a user group \f(CRadmins\fP you have to run the following command.
510523
.sp
511524
.if n .RS 4
512525
.nf
526+
.fam C
513527
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
514528
\-p password \-\-delete\-group \-\-group\-name admins
529+
.fam
515530
.fi
516531
.if n .RE
517532
.sp
@@ -520,8 +535,10 @@ will show the associated roles.
520535
.sp
521536
.if n .RS 4
522537
.nf
538+
.fam C
523539
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
524540
\-p password \-\-get\-group \-\-group\-name admins
541+
.fam
525542
.fi
526543
.if n .RE
527544
.sp
@@ -531,9 +548,11 @@ an amended version of the roles.
531548
.sp
532549
.if n .RS 4
533550
.nf
551+
.fam C
534552
$ couchbase\-cli user\-manage \-c 127.0.0.1:8091 \-u Administrator \(rs
535553
\-p password \-\-set\-group \-\-group\-name admins \-\-roles admin \(rs
536554
\-\-group\-description "CB admins" \-\-ldap\-ref ro_admin
555+
.fam
537556
.fi
538557
.if n .RE
539558
.SH "ENVIRONMENT AND CONFIGURATION VARIABLES"
@@ -560,4 +579,4 @@ password are not cached in their command line history.
560579
Part of the \fBcouchbase\-cli\fP(1) suite
561580
.SH "AUTHOR"
562581
.sp
563-
Couchbase
582+
Couchbase

‎docs/modules/cli/pages/cbcli/couchbase-cli-setting-saslauthd.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ _couchbase-cli setting-saslauthd_ [--cluster <url>] [--username <user>]
1919

2020
== DESCRIPTION
2121

22+
This command is only available for clusters running Enterprise Edition on
23+
GNU/Linux.
24+
2225
This command allows users to enable SASL on their cluster as well as add
2326
administrator and read-only administrator SASL users to their cluster.
2427

‎docs/modules/cli/pages/cbcli/couchbase-cli-user-manage.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ ro_admin::
140140
the ability to create or view documents), XDCR cluster references, XDCR
141141
replications, and cluster settings.
142142

143-
view_admin[...]::
143+
views_admin[...]::
144144
Gives the user privileges to define views and then run these views on data
145145
to ensure that views are defined properly. This applies both to the
146146
map-reduce and spatial views. To give a user the ability to manage views on
@@ -292,7 +292,7 @@ views for all bucket run the following command
292292
----
293293
$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
294294
-p password --set --rbac-username jdoe --rbac-name "John Doe" \
295-
--roles view_admin[*] --auth-domain external
295+
--roles views_admin[*] --auth-domain external
296296
----
297297
To list the current RBAC user profiles run the following command.
298298
----

0 commit comments

Comments
 (0)