Commit 95d9d27f authored by Marcin Spiewak's avatar Marcin Spiewak Committed by Konrad Sztyber
Browse files

bdev/nvme: controller failover/multipath doc change 



Added information about implemented change of the default controller
mode, now multipath is a new default.
The consistency of configuration of controllers with the same name is
now verified - all must be configured either for multipath or failover,
it is not possible to configure e.g one for multipath and second for
failover mode.
Added information about spdk_bdev_nvme_create() API function parameter
list change.

Change-Id: I76e95c19a5b97eb5dd74485964d00d6705c0c559
Signed-off-by: default avatarMarcin Spiewak <marcin.spiewak@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/25030


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent f366dac4

CHANGELOG.md

+14 −0
Original line number Diff line number Diff line
@@ -2,6 +2,20 @@ 


## v25.01: (Upcoming Release)



### bdev_nvme



Added controller configuration consistency check, so all controllers created with the same name will

be forced to have consistent setting, either multipath or failover. No mixing of different '-x'

options will be allowed.



Changed default mode: if no '-x' option is specified in bdev_nvme_attach_controller RPC call,

the multipath mode will be assigned as a default.



Changed `spdk_bdev_nvme_create` API function, the `multipath` pramater was removed as it is redundant

to `multipath` field in spdk_bdev_nvme_ctrlr_opts structure passed as a parameter to this function.

If multipathing shall be enabled for nvme bdev, `bdev_opts.multipath` shall be set to `true`. When

`bdev_opts.multipath` is set to `false`, failover mode is enabled.



## v24.09



### accel

deprecation.md

+0 −12
Original line number Diff line number Diff line
@@ -26,18 +26,6 @@ The tags can be matched with the level 4 headers below. 
This callback is now deprecated and will be removed in the v25.01 release.  Please use the append

API (`append_crc32c`, `finish_sequence`, `reverse_sequence`, `abort_sequence`) instead.



#### `multipath_config` `failover_config`



All controllers created with the same name shall be configured either for multipath or for failover.

Otherwise we have configuration mismatch. Currently, using bdev_nvme_attach_controller RPC call, it

is possible to create multiple controllers with the same name but different '-x' options. Starting

from 25.01 we are going to perform controller configuration consistency check, and all controllers

created with the same name will be forced to have consistent setting, either '-x multipath' or

'-x failover'. No mixing of '-x' options will be allowed.

Please also note there is planned default mode change in SPDK release 25.01: if no '-x' option will

be specified in bdev_nvme_attach_controller RPC call, the multipath mode will be assigned

as a default.



### gpt



#### `old_gpt_guid`