Skip to content

Commit e1efff2

Browse files
author
Carlos Gonzalez Betancort
committed
DOC-7716 Merge branch 'vulcan' into alice
* vulcan: DOC-7716 Update master-password docs synopsis Change-Id: I27261b10bdfc14adb62e815fb7833738516f6759
2 parents e547583 + c86a9b4 commit e1efff2

3 files changed

Lines changed: 22 additions & 8 deletions

File tree

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ <h2 id="_name">NAME</h2>
450450
<h2 id="_synopsis">SYNOPSIS</h2>
451451
<div class="sectionbody">
452452
<div class="verseblock">
453-
<pre class="content"><em>couchbase-cli master-password</em> [--new-password &lt;password&gt;]</pre>
453+
<pre class="content"><em>couchbase-cli master-password</em> [--new-password &lt;password&gt;] [--rotate-data-key]</pre>
454454
</div>
455455
</div>
456456
</div>
@@ -484,10 +484,15 @@ <h2 id="_options">OPTIONS</h2>
484484
<div class="sectionbody">
485485
<div class="dlist">
486486
<dl>
487-
<dt class="hdlist1">--send-password</dt>
487+
<dt class="hdlist1">--new-password</dt>
488488
<dd>
489489
<p>Sends the master password to the server that is waiting to start up.</p>
490490
</dd>
491+
<dt class="hdlist1">--rotate-data-key</dt>
492+
<dd>
493+
<p>If provided it will rotate the master password data key. This option cannot
494+
be provided together with <code>--new-password</code>.</p>
495+
</dd>
491496
</dl>
492497
</div>
493498
</div>

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
.\" Source: Couchbase CLI 1.0.0
88
.\" Language: English
99
.\"
10-
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2020-10-06" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
10+
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2021-01-29" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -33,7 +33,7 @@ couchbase\-cli\-master\-password \- Sends the Couchbase master password
3333
.sp
3434
.sp
3535
.nf
36-
\fIcouchbase\-cli master\-password\fP [\-\-new\-password <password>]
36+
\fIcouchbase\-cli master\-password\fP [\-\-new\-password <password>] [\-\-rotate\-data\-key]
3737
.fi
3838
.br
3939
.SH "DESCRIPTION"
@@ -57,10 +57,16 @@ couchbase\-cli master\-password command. This command must be run locally on the
5757
node that needs to be unlocked.
5858
.SH "OPTIONS"
5959
.sp
60-
\-\-send\-password
60+
\-\-new\-password
6161
.RS 4
6262
Sends the master password to the server that is waiting to start up.
6363
.RE
64+
.sp
65+
\-\-rotate\-data\-key
66+
.RS 4
67+
If provided it will rotate the master password data key. This option cannot
68+
be provided together with \f(CR\-\-new\-password\fP.
69+
.RE
6470
.SH "EXAMPLES"
6571
.sp
6672
To use the Secret Management feature, the first thing you need to do is set a
@@ -124,4 +130,4 @@ password are not cached in their command line history.
124130
Part of the \fBcouchbase\-cli\fP(1) suite
125131
.SH "AUTHOR"
126132
.sp
127-
Couchbase
133+
Couchbase

docs/modules/cli/pages/cbcli/couchbase-cli-master-password.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Sends the Couchbase master password
1111
== SYNOPSIS
1212

1313
[verse]
14-
_couchbase-cli master-password_ [--new-password <password>]
14+
_couchbase-cli master-password_ [--new-password <password>] [--rotate-data-key]
1515

1616
== DESCRIPTION
1717

@@ -36,9 +36,12 @@ node that needs to be unlocked.
3636
== OPTIONS
3737

3838

39-
--send-password::
39+
--new-password::
4040
Sends the master password to the server that is waiting to start up.
4141

42+
--rotate-data-key::
43+
If provided it will rotate the master password data key. This option cannot
44+
be provided together with `--new-password`.
4245

4346
== EXAMPLES
4447

0 commit comments

Comments
 (0)