Skip to content

Commit 5be01a5

Browse files
committed
MB-34224 Merge branch 'spock' into vulcan
* spock: MB-34224 Correct doc for RBAC roles with multiple buckets MB-34224 Correct doc for RBAC roles with multiple buckets MB-31081 Generate missing documentation files MB-31083 Generate missing documentation files Change-Id: I6d055fca7fbd9f405c90e46c56a9855432c1ea2a
2 parents a4a1c0d + 6294649 commit 5be01a5

9 files changed

Lines changed: 393 additions & 366 deletions

docs/generated/doc/couchbase-cli/couchbase-cli-help.html

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

docs/generated/doc/couchbase-cli/couchbase-cli-master-password.html

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

docs/generated/doc/couchbase-cli/couchbase-cli-server-eshell.html

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

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

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

docs/generated/man/man1/couchbase-cli-help.1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
'\" t
22
.\" Title: couchbase-cli-help
33
.\" Author: Couchbase
4-
.\" Generator: Asciidoctor 1.5.7.1
5-
.\" Date: 2018-08-29
4+
.\" Generator: Asciidoctor 2.0.9
5+
.\" Date: 2019-06-11
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-HELP" "1" "2018-08-29" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-HELP" "1" "2019-06-11" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -31,6 +31,7 @@
3131
couchbase\-cli\-help \- Show extended couchbase\-cli help
3232
.SH "SYNOPSIS"
3333
.sp
34+
.sp
3435
.nf
3536
\fIcouchbase\-cli help\fP
3637
.fi

docs/generated/man/man1/couchbase-cli-master-password.1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
'\" t
22
.\" Title: couchbase-cli-master-password
33
.\" Author: Couchbase
4-
.\" Generator: Asciidoctor 1.5.7.1
5-
.\" Date: 2018-08-29
4+
.\" Generator: Asciidoctor 2.0.9
5+
.\" Date: 2019-06-12
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2018-08-29" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2019-06-12" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -31,6 +31,7 @@
3131
couchbase\-cli\-master\-password \- Sends the Couchbase master password
3232
.SH "SYNOPSIS"
3333
.sp
34+
.sp
3435
.nf
3536
\fIcouchbase\-cli master\-password\fP [\-\-new\-password <password>]
3637
.fi

docs/generated/man/man1/couchbase-cli-server-eshell.1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
'\" t
22
.\" Title: couchbase-cli-server-eshell
33
.\" Author: Couchbase
4-
.\" Generator: Asciidoctor 1.5.7.1
5-
.\" Date: 2018-08-29
4+
.\" Generator: Asciidoctor 2.0.9
5+
.\" Date: 2019-06-11
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-SERVER\-ESHELL" "1" "2018-08-29" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-SERVER\-ESHELL" "1" "2019-06-11" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -31,6 +31,7 @@
3131
couchbase\-cli\-server\-eshell \- Opens a shell to talk to the cluster manager process
3232
.SH "SYNOPSIS"
3333
.sp
34+
.sp
3435
.nf
3536
\fIcouchbase\-cli server\-eshell\fP [\-\-cluster <url>] [\-\-username <user>]
3637
[\-\-password <password>] [\-\-vm <vm_name>] [\-\-erl <path>]

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

Lines changed: 19 additions & 17 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 1.5.7.1
5-
.\" Date: 2018-07-31
4+
.\" Generator: Asciidoctor 2.0.9
5+
.\" Date: 2019-06-12
66
.\" Manual: Couchbase CLI Manual
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-USER\-MANAGE" "1" "2018-07-31" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-USER\-MANAGE" "1" "2019-06-12" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -31,6 +31,7 @@
3131
couchbase\-cli\-user\-manage \- Manage RBAC users
3232
.SH "SYNOPSIS"
3333
.sp
34+
.sp
3435
.nf
3536
\fIcouchbase\-cli user\-manage\fP [\-\-cluster <url>] [\-\-username <user>]
3637
[\-\-password <password>] [\-\-delete] [\-\-list] [\-\-my\-roles] [\-\-set]
@@ -190,7 +191,7 @@ a user the ability to manage all bucket settings set their role to
190191
bucket_admin[*]. To give the user permission to manage bucket settings on a
191192
single bucket named \fIdefault\fP then specify the role as
192193
bucket_admin[default]. If the user needs to be manage multiple buckets, for
193-
example \fIdefault\fP and \fIapp\fP, then set the role as bucket[default,app].
194+
example \fIdefault\fP and \fIapp\fP, then set the role as bucket[default],bucket[app].
194195
.RE
195196
.sp
196197
cluster_admin
@@ -222,7 +223,7 @@ all buckets set their role to views_admin[*]. To give the user permission to
222223
manage views on a single bucket named \fIdefault\fP then specify the role as
223224
views_admin[default]. If the user needs to be manage views for multiple
224225
buckets, for example \fIdefault\fP and \fIapp\fP, then set the role as
225-
views_admin[default,app].
226+
views_admin[default],views_admin[app].
226227
.RE
227228
.sp
228229
.B Data Service Roles:
@@ -235,7 +236,8 @@ To give a user read\-only access for all buckets set their role to
235236
data_reader[*]. To give the user read\-only access to data on a single
236237
bucket named \fIdefault\fP then specify their role as data_reader[default].
237238
If the user needs read\-only access to data for multiple buckets, for example
238-
\fIdefault\fP and \fIapp\fP, then set their role as data_reader[default,app].
239+
\fIdefault\fP and \fIapp\fP, then set their role as
240+
data_reader[default],data_reader[app].
239241
.RE
240242
.sp
241243
data_writer[...]
@@ -258,7 +260,7 @@ data_dcp_reader[*]. To give the user the ability to create DCP connections
258260
on a single bucket named \fIdefault\fP then specify their role as
259261
data_dcp_reader[default]. If the user needs to be able to create DCP
260262
connections for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set
261-
their role as data_dcp_reader[default,app].
263+
their role as data_dcp_reader[default],data_dcp_reader[app].
262264
.RE
263265
.sp
264266
data_backup[...]
@@ -269,7 +271,7 @@ to data_backup[*]. To give the user the ability to backup and restore data
269271
on a single bucket named \fIdefault\fP then specify their role as
270272
data_backup[default]. If the user needs to be able to backup and restore
271273
data for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their
272-
role as data_backup[default,app].
274+
role as data_backup[default],data_backup[app].
273275
.RE
274276
.sp
275277
data_monitoring[...]
@@ -280,7 +282,7 @@ buckets set their role to data_monitoring[*]. To give the user the ability
280282
to monitor data on a single bucket named \fIdefault\fP then specify their role
281283
as data_monitoring[default]. If the user needs to be able to monitor data
282284
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
283-
as data_monitoring[default,app].
285+
as data_monitoring[default],data_monitoring[app].
284286
.RE
285287
.sp
286288
.B Full Text Service Roles:
@@ -294,7 +296,7 @@ on all buckets set their role to fts_admin[*]. To give the user full
294296
administrator access for FTS on a single bucket named \fIdefault\fP then specify
295297
their role as fts_admin[default]. If the user needs full administrator
296298
access for FTS for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then
297-
set their role as fts_admin[default,app].
299+
set their role as fts_admin[default],fts_admin[app].
298300
.RE
299301
.sp
300302
fts_searcher[...]
@@ -305,7 +307,7 @@ role to fts_searcher[*]. To give the ability to query FTS indexes on a
305307
single bucket named \fIdefault\fP then specify their role as
306308
fts_searcher[default]. If the user needs to query FTS indexes on multiple
307309
multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role as
308-
fts_searcher[default,app].
310+
fts_searcher[default],fts_searcher[app].
309311
.RE
310312
.sp
311313
.B Query Service Roles:
@@ -319,7 +321,7 @@ their role to manage_index[*]. To give the user permission to create and
319321
delete indexes on a single bucket named \fIdefault\fP then specify their role
320322
as manage_index[default]. If the user needs to be create and delete indexes
321323
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
322-
as manage_index[default,app].
324+
as manage_index[default],manage_index[app].
323325
.RE
324326
.sp
325327
query_delete[...]
@@ -330,7 +332,7 @@ their role to query_delete[*]. To give the user permission to execute
330332
DELETE statements on a single bucket named \fIdefault\fP then specify their role
331333
as query_delete[default]. If the user needs to be execute DELETE statements
332334
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
333-
as query_delete[default,app].
335+
as query_delete[default],query_delete[app].
334336
.RE
335337
.sp
336338
query_insert[...]
@@ -341,7 +343,7 @@ their role to query_insert[*]. To give the user permission to execute
341343
INSERT statements on a single bucket named \fIdefault\fP then specify their role
342344
as query_insert[default]. If the user needs to be execute INSERT statements
343345
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
344-
as query_insert[default,app].
346+
as query_insert[default],query_insert[app].
345347
.RE
346348
.sp
347349
query_select[...]
@@ -352,7 +354,7 @@ their role to query_select[*]. To give the user permission to execute
352354
SELECT statements on a single bucket named \fIdefault\fP then specify their role
353355
as query_select[default]. If the user needs to be execute SELECT statements
354356
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
355-
as query_select[default,app].
357+
as query_select[default],query_select[app].
356358
.RE
357359
.sp
358360
query_update[...]
@@ -363,7 +365,7 @@ their role to query_update[*]. To give the user permission to execute
363365
UPDATE statements on a single bucket named \fIdefault\fP then specify their role
364366
as query_update[default]. If the user needs to be execute UPDATE statements
365367
for multiple buckets, for example \fIdefault\fP and \fIapp\fP, then set their role
366-
as query_update[default,app].
368+
as query_update[default],query_update[app].
367369
.RE
368370
.sp
369371
system_catalog[...]
@@ -375,7 +377,7 @@ permission to run queries against the system catalog on a single bucket
375377
named \fIdefault\fP then specify their role as system_catalog[default]. If the
376378
user needs to be run queries against the system catalog for multiple
377379
buckets, for example \fIdefault\fP and \fIapp\fP, then set their role as
378-
system_catalog[default,app].
380+
system_catalog[default],system_catalog[app].
379381
.RE
380382
.SH "EXAMPLES"
381383
.sp

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

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ bucket_admin[...]::
8888
bucket_admin[*]. To give the user permission to manage bucket settings on a
8989
single bucket named _default_ then specify the role as
9090
bucket_admin[default]. If the user needs to be manage multiple buckets, for
91-
example _default_ and _app_, then set the role as bucket[default,app].
91+
example _default_ and _app_, then set the role as bucket[default],bucket[app].
9292

9393
cluster_admin::
9494
Gives the user permissions to read, write and manage all cluster-level
@@ -112,7 +112,7 @@ view_admin[...]::
112112
manage views on a single bucket named _default_ then specify the role as
113113
views_admin[default]. If the user needs to be manage views for multiple
114114
buckets, for example _default_ and _app_, then set the role as
115-
views_admin[default,app].
115+
views_admin[default],views_admin[app].
116116

117117
.Data Service Roles:
118118

@@ -122,7 +122,8 @@ data_reader[...]::
122122
data_reader[*]. To give the user read-only access to data on a single
123123
bucket named _default_ then specify their role as data_reader[default].
124124
If the user needs read-only access to data for multiple buckets, for example
125-
_default_ and _app_, then set their role as data_reader[default,app].
125+
_default_ and _app_, then set their role as
126+
data_reader[default],data_reader[app].
126127

127128
data_writer[...]::
128129
Gives the user permission to read and write data through Couchbases
@@ -141,7 +142,7 @@ data_dcp_reader[...]::
141142
on a single bucket named _default_ then specify their role as
142143
data_dcp_reader[default]. If the user needs to be able to create DCP
143144
connections for multiple buckets, for example _default_ and _app_, then set
144-
their role as data_dcp_reader[default,app].
145+
their role as data_dcp_reader[default],data_dcp_reader[app].
145146

146147
data_backup[...]::
147148
Gives the user permission to backup and restore data in Couchbase. To give a
@@ -150,7 +151,7 @@ data_backup[...]::
150151
on a single bucket named _default_ then specify their role as
151152
data_backup[default]. If the user needs to be able to backup and restore
152153
data for multiple buckets, for example _default_ and _app_, then set their
153-
role as data_backup[default,app].
154+
role as data_backup[default],data_backup[app].
154155

155156
data_monitoring[...]::
156157
Gives the user permission to read monitoring data related to the data
@@ -159,7 +160,7 @@ data_monitoring[...]::
159160
to monitor data on a single bucket named _default_ then specify their role
160161
as data_monitoring[default]. If the user needs to be able to monitor data
161162
for multiple buckets, for example _default_ and _app_, then set their role
162-
as data_monitoring[default,app].
163+
as data_monitoring[default],data_monitoring[app].
163164

164165
.Full Text Service Roles:
165166

@@ -170,7 +171,7 @@ fts_admin[...]::
170171
administrator access for FTS on a single bucket named _default_ then specify
171172
their role as fts_admin[default]. If the user needs full administrator
172173
access for FTS for multiple buckets, for example _default_ and _app_, then
173-
set their role as fts_admin[default,app].
174+
set their role as fts_admin[default],fts_admin[app].
174175

175176
fts_searcher[...]::
176177
Allows the user to query full text indexes for the specified buckets. To
@@ -179,7 +180,7 @@ fts_searcher[...]::
179180
single bucket named _default_ then specify their role as
180181
fts_searcher[default]. If the user needs to query FTS indexes on multiple
181182
multiple buckets, for example _default_ and _app_, then set their role as
182-
fts_searcher[default,app].
183+
fts_searcher[default],fts_searcher[app].
183184

184185
.Query Service Roles:
185186

@@ -190,7 +191,7 @@ manage_index[...]::
190191
delete indexes on a single bucket named _default_ then specify their role
191192
as manage_index[default]. If the user needs to be create and delete indexes
192193
for multiple buckets, for example _default_ and _app_, then set their role
193-
as manage_index[default,app].
194+
as manage_index[default],manage_index[app].
194195

195196
query_delete[...]::
196197
Allows the user to execute DELETE query statements on the specified buckets.
@@ -199,7 +200,7 @@ query_delete[...]::
199200
DELETE statements on a single bucket named _default_ then specify their role
200201
as query_delete[default]. If the user needs to be execute DELETE statements
201202
for multiple buckets, for example _default_ and _app_, then set their role
202-
as query_delete[default,app].
203+
as query_delete[default],query_delete[app].
203204

204205
query_insert[...]::
205206
Allows the user to execute INSERT query statements on the specified buckets.
@@ -208,7 +209,7 @@ query_insert[...]::
208209
INSERT statements on a single bucket named _default_ then specify their role
209210
as query_insert[default]. If the user needs to be execute INSERT statements
210211
for multiple buckets, for example _default_ and _app_, then set their role
211-
as query_insert[default,app].
212+
as query_insert[default],query_insert[app].
212213

213214
query_select[...]::
214215
Allows the user to execute SELECT query statements on the specified buckets.
@@ -217,7 +218,7 @@ query_select[...]::
217218
SELECT statements on a single bucket named _default_ then specify their role
218219
as query_select[default]. If the user needs to be execute SELECT statements
219220
for multiple buckets, for example _default_ and _app_, then set their role
220-
as query_select[default,app].
221+
as query_select[default],query_select[app].
221222

222223
query_update[...]::
223224
Allows the user to execute UPDATE query statements on the specified buckets.
@@ -226,7 +227,7 @@ query_update[...]::
226227
UPDATE statements on a single bucket named _default_ then specify their role
227228
as query_update[default]. If the user needs to be execute UPDATE statements
228229
for multiple buckets, for example _default_ and _app_, then set their role
229-
as query_update[default,app].
230+
as query_update[default],query_update[app].
230231

231232
system_catalog[...]::
232233
Allows the users to run queries against the system catalog on the specified
@@ -236,7 +237,7 @@ system_catalog[...]::
236237
named _default_ then specify their role as system_catalog[default]. If the
237238
user needs to be run queries against the system catalog for multiple
238239
buckets, for example _default_ and _app_, then set their role as
239-
system_catalog[default,app].
240+
system_catalog[default],system_catalog[app].
240241

241242
== EXAMPLES
242243

0 commit comments

Comments
 (0)