Skip to content

Commit

Permalink
DOC-6897 Merge branch 'alice' into 6.5.x-docs
Browse files Browse the repository at this point in the history
* alice:
  DOC-6897 Remove incorrect master-password arguments

Change-Id: I7bf87eb48a1e36aec1c72a922be63755af1d190e
  • Loading branch information
mcpaddy committed Oct 7, 2020
2 parents 9de117a + 7cf3e25 commit a869b55
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 118 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -484,29 +484,6 @@ <h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">-c</dt>
<dt class="hdlist1">--cluster</dt>
<dd>
<p>Specifies the hostname of a node in the cluster. See the HOST FORMATS
section for more information on specifying a hostname.</p>
</dd>
<dt class="hdlist1">-u</dt>
<dt class="hdlist1">--user &lt;username&gt;</dt>
<dd>
<p>Specifies the username of the user executing the command. If you do not have
a user account with permission to execute the command then it will fail with
an unauthorized error.</p>
</dd>
<dt class="hdlist1">-p</dt>
<dt class="hdlist1">--password &lt;password&gt;</dt>
<dd>
<p>Specifies the password of the user executing the command. If you do not have
a user account with permission to execute the command then it will fail with
an unauthorized error. If this argument is specified, but no password is
given then the command will prompt the user for a password through
non-echoed stdin. You may also specify your password by using the
environment variable CB_REST_PASSWORD.</p>
</dd>
<dt class="hdlist1">--send-password</dt>
<dd>
<p>Sends the master password to the server that is waiting to start up.</p>
Expand All @@ -516,33 +493,6 @@ <h2 id="_options">OPTIONS</h2>
</div>
</div>
<div class="sect1">
<h2 id="_host_formats">HOST FORMATS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>When specifying a host for the couchbase-cli command the following formats are expected:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>couchbase://&lt;addr&gt;</code></p>
</li>
<li>
<p><code>&lt;addr&gt;:&lt;port&gt;</code></p>
</li>
<li>
<p><code>http://&lt;addr&gt;:&lt;port&gt;</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>It is recommended to use the couchbase://&lt;addr&gt; format for standard
installations. The other two formats allow an option to take a port number which
is needed for non-default installations where the admin port has been set up on
a port other that 8091.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph">
Expand Down
68 changes: 2 additions & 66 deletions docs/generated/man/man1/couchbase-cli-master-password.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: couchbase-cli-master-password
.\" Author: Couchbase
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2020-05-22
.\" Date: 2020-10-07
.\" Manual: Couchbase CLI Manual
.\" Source: Couchbase CLI 1.0.0
.\" Language: English
.\"
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2020-05-22" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
.TH "COUCHBASE\-CLI\-MASTER\-PASSWORD" "1" "2020-10-07" "Couchbase CLI 1.0.0" "Couchbase CLI Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -57,74 +57,10 @@ couchbase\-cli master\-password command. This command must be run locally on the
node that needs to be unlocked.
.SH "OPTIONS"
.sp
\-c, \-\-cluster
.RS 4
Specifies the hostname of a node in the cluster. See the HOST FORMATS
section for more information on specifying a hostname.
.RE
.sp
\-u, \-\-user <username>
.RS 4
Specifies the username of the user executing the command. If you do not have
a user account with permission to execute the command then it will fail with
an unauthorized error.
.RE
.sp
\-p, \-\-password <password>
.RS 4
Specifies the password of the user executing the command. If you do not have
a user account with permission to execute the command then it will fail with
an unauthorized error. If this argument is specified, but no password is
given then the command will prompt the user for a password through
non\-echoed stdin. You may also specify your password by using the
environment variable CB_REST_PASSWORD.
.RE
.sp
\-\-send\-password
.RS 4
Sends the master password to the server that is waiting to start up.
.RE
.SH "HOST FORMATS"
.sp
When specifying a host for the couchbase\-cli command the following formats are expected:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
\f(CRcouchbase://<addr>\fP
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
\f(CR<addr>:<port>\fP
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
\f(CRhttp://<addr>:<port>\fP
.RE
.sp
It is recommended to use the couchbase://<addr> format for standard
installations. The other two formats allow an option to take a port number which
is needed for non\-default installations where the admin port has been set up on
a port other that 8091.
.SH "EXAMPLES"
.sp
To use the Secret Management feature, the first thing you need to do is set a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ node that needs to be unlocked.

== OPTIONS

include::{partialsdir}/cbcli/part-common-options.adoc[]

--send-password::
Sends the master password to the server that is waiting to start up.

include::{partialsdir}/cbcli/part-host-formats.adoc[]

== EXAMPLES

Expand Down

0 comments on commit a869b55

Please sign in to comment.