From f58b29784a03a0ed09a0cc377df046af902a37dc Mon Sep 17 00:00:00 2001 From: Tomasz Zawadzki Date: Thu, 28 Jan 2021 12:41:44 -0500 Subject: [PATCH] doc: list methods to convert from legacy config Signed-off-by: Tomasz Zawadzki Change-Id: Iccc272ddaeefad3d02b9d63607173bd2b76bd112 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6154 Tested-by: SPDK CI Jenkins Reviewed-by: Aleksey Marchuk Reviewed-by: Jim Harris --- doc/jsonrpc.md | 14 +++++++++++++- doc/nvmf.md | 4 ---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index e4f65ecf3..8e1810df6 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -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 ~~~ -### 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. 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 ~~~ +### 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} ## spdk_kill_instance {#rpc_spdk_kill_instance} diff --git a/doc/nvmf.md b/doc/nvmf.md index 25b0697d3..d093b1d73 100644 --- a/doc/nvmf.md +++ b/doc/nvmf.md @@ -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 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} To build nvmf_tgt with the FC transport, there is an additional FC LLD (Low Level Driver) code dependency.