honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Adds http to elasticsearch-certutil command reference (#51188)

This commit is contained in:
Lisa Cawley 2020-01-24 09:56:51 -08:00 committed by lcawl
parent f0d8c785e3
commit 931b22349f
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/commands/certutil.asciidoc
View File

@ -4,7 +4,7 @@
== elasticsearch-certutil == elasticsearch-certutil
The `elasticsearch-certutil` command simplifies the creation of certificates for The `elasticsearch-certutil` command simplifies the creation of certificates for
use with Transport Layer Security (TLS) in the Elastic Stack. use with Transport Layer Security (TLS) in the {stack}.
[float] [float]
=== Synopsis === Synopsis
@ -26,13 +26,16 @@ bin/elasticsearch-certutil
[-E <KeyValuePair>] [--keysize <bits>] [--out <file_path>] [-E <KeyValuePair>] [--keysize <bits>] [--out <file_path>]
[--pass <password>] [--pass <password>]
) )
| http
[-h, --help] ([-s, --silent] | [-v, --verbose]) [-h, --help] ([-s, --silent] | [-v, --verbose])
-------------------------------------------------- --------------------------------------------------
[float] [float]
=== Description === Description
You can specify one of the following modes: `ca`, `cert`, `csr`. The You can specify one of the following modes: `ca`, `cert`, `csr`, `http`. The
`elasticsearch-certutil` command also supports a silent mode of operation to `elasticsearch-certutil` command also supports a silent mode of operation to
enable easier batch operations. enable easier batch operations.
@ -108,6 +111,18 @@ private keys for each instance. Each CSR is provided as a standard PEM
encoding of a PKCS#10 CSR. Each key is provided as a PEM encoding of an RSA encoding of a PKCS#10 CSR. Each key is provided as a PEM encoding of an RSA
private key. private key.
[float]
[[certutil-http]]
==== HTTP mode
The `http` mode guides you through the process of generating certificates for
use on the HTTP (REST) interface for {es}. It asks you a number of questions in
order to generate the right set of files for your needs. For example, depending
on your choices, it might generate a zip file that contains a certificate
authority (CA), a certificate signing request (CSR), or certificates and keys
for use in {es} and {kib}. Each folder in the zip file contains a readme that
explains how to use the files.
[float] [float]
=== Parameters === Parameters
@ -120,6 +135,9 @@ This parameter cannot be used with the `csr` or `ca` parameters.
`csr`:: Specifies to generate certificate signing requests. This parameter `csr`:: Specifies to generate certificate signing requests. This parameter
cannot be used with the `ca` or `cert` parameters. cannot be used with the `ca` or `cert` parameters.
`http`:: Generates a new certificate or certificate request for the {es} HTTP
interface.
`--ca <file_path>`:: Specifies the path to an existing CA key pair `--ca <file_path>`:: Specifies the path to an existing CA key pair
(in PKCS#12 format). This parameter cannot be used with the `ca` or `csr` parameters. (in PKCS#12 format). This parameter cannot be used with the `ca` or `csr` parameters.