Commit 11026cee authored by Konrad Sztyber's avatar Konrad Sztyber
Browse files

doc: mention that host key is required if ctrlr is present 



For DH-HMAC-CHAP authentication, the controller key is optional, but the
host key is always required, so mention that fact in the docs.

Signed-off-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Change-Id: I652394059f576188181695f6319a7b0234fc81d2
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24227


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarKrzysztof Karas <krzysztof.karas@intel.com>
Reviewed-by: default avatarBen Walker <ben@nvidia.com>
parent 8a4b7226

doc/jsonrpc.md

+2 −2
Original line number Diff line number Diff line
@@ -4155,7 +4155,7 @@ reconnect_delay_sec | Optional | number | Time to delay a reconnect 
fast_io_fail_timeout_sec   | Optional | number      | Time to wait until ctrlr is reconnected before failing I/O to ctrlr. 0 means no such timeout.

psk                        | Optional | string      | Name of the pre-shared key to be used for TLS (Enables SSL socket implementation for TCP)

max_bdevs                  | Optional | number      | The size of the name array for newly created bdevs. Default is 128.

dhchap_key                 | Optional | string      | DH-HMAC-CHAP key name.

dhchap_key                 | Optional | string      | DH-HMAC-CHAP key name (required if controller key is specified)

dhchap_ctrlr_key           | Optional | string      | DH-HMAC-CHAP controller key name.

allow_unrecognized_csi     | Optional | bool        | Allow attaching namespaces with unrecognized command set identifiers. These will only support NVMe passthrough.
@@ -8638,7 +8638,7 @@ nqn | Required | string | Subsystem NQN 
host                    | Required | string      | Host NQN to add to the list of allowed host NQNs

tgt_name                | Optional | string      | Parent NVMe-oF target name.

psk                     | Optional | string      | Path to a file containing PSK for TLS connection

dhchap_key              | Optional | string      | DH-HMAC-CHAP key name.

dhchap_key              | Optional | string      | DH-HMAC-CHAP key name (required if controller key is specified)

dhchap_ctrlr_key        | Optional | string      | DH-HMAC-CHAP controller key name.



#### Example