ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: list methods to convert from legacy config

Browse Source 
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6154 (master)

(cherry picked from commit f58b29784a)
Change-Id: Iccc272ddaeefad3d02b9d63607173bd2b76bd112
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6180
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Tomasz Zawadzki 2021-01-28 12:41:44 -05:00
parent 2a1fe02d98
commit d53d7a5723
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/jsonrpc.md
View File

@ -78,7 +78,7 @@ A detailed description of each RPC method and its parameters is also available.
scripts/rpc.py bdev_nvme_attach_controller --help scripts/rpc.py bdev_nvme_attach_controller --help
~~~ ~~~
### Generate JSON-RPC methods for current configuration ### Generate JSON-RPC methods for current configuration {#jsonrpc_generate}
An initial configuration can be specified for an SPDK application via the '-c' command line parameter. An initial configuration can be specified for an SPDK application via the '-c' command line parameter.
The configuration file is a JSON file containing all of the JSON-RPC method invocations necessary The configuration file is a JSON file containing all of the JSON-RPC method invocations necessary
@ -206,6 +206,18 @@ Finally, call the rpc.py script with '--plugin' parameter to provide above pytho
./scripts/rpc.py --plugin rpc_plugin bdev_example_create 10 4096 ./scripts/rpc.py --plugin rpc_plugin bdev_example_create 10 4096
~~~ ~~~
### Converting from legacy configuration {#jsonrpc_convert}
Starting with SPDK 20.10, legacy configuration file support has been removed.
Users with extensive configuration files already running in SPDK application,
can [generate JSON-RPC for current configuration](@ref jsonrpc_generate).
If binary for deploying the application is unavailable, the legacy configuration
file can be converted to JSON-RPC using python tool:
~~~
./scripts/config_converter.py < config.ini > config.json
~~~
# App Framework {#jsonrpc_components_app} # App Framework {#jsonrpc_components_app}
## spdk_kill_instance {#rpc_spdk_kill_instance} ## spdk_kill_instance {#rpc_spdk_kill_instance}

4
doc/nvmf.md
View File

@ -116,10 +116,6 @@ An NVMe over Fabrics target can be configured using JSON RPCs.
The basic RPCs needed to configure the NVMe-oF subsystem are detailed below. More information about The basic RPCs needed to configure the NVMe-oF subsystem are detailed below. More information about
working with NVMe over Fabrics specific RPCs can be found on the @ref jsonrpc_components_nvmf_tgt RPC page. working with NVMe over Fabrics specific RPCs can be found on the @ref jsonrpc_components_nvmf_tgt RPC page.
Using .ini style configuration files for configuration of the NVMe-oF target is deprecated and should
be replaced with JSON based RPCs. .ini style configuration files can be converted to json format by way
of the new script `scripts/config_converter.py`.
## FC transport support {#nvmf_fc_transport} ## FC transport support {#nvmf_fc_transport}
To build nvmf_tgt with the FC transport, there is an additional FC LLD (Low Level Driver) code dependency. To build nvmf_tgt with the FC transport, there is an additional FC LLD (Low Level Driver) code dependency.