From 5c30318660eebc882326d87eec39b4fbe4cc85d7 Mon Sep 17 00:00:00 2001 From: Mike Christie Date: Sat, 20 Jan 2018 16:06:42 -0600 Subject: [PATCH] doc: add ceph iscsi test kernel info Signed-off-by: Mike Christie --- doc/rbd/iscsi-target-ansible.rst | 2 +- doc/rbd/iscsi-target-cli-manual-install.rst | 12 +++++++++--- doc/rbd/iscsi-target-cli.rst | 4 ++-- doc/rbd/iscsi-targets.rst | 2 +- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/rbd/iscsi-target-ansible.rst b/doc/rbd/iscsi-target-ansible.rst index f8f77ab8c78eb..f57f22bafc67c 100644 --- a/doc/rbd/iscsi-target-ansible.rst +++ b/doc/rbd/iscsi-target-ansible.rst @@ -11,7 +11,7 @@ install, and configure the Ceph iSCSI gateway for basic operation. - A running Ceph Luminous (12.2.x) cluster or newer -- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client kernel `_ +- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client test kernel `_ - The ``ceph-iscsi-config`` package installed on all the iSCSI gateway nodes diff --git a/doc/rbd/iscsi-target-cli-manual-install.rst b/doc/rbd/iscsi-target-cli-manual-install.rst index d5e0bc097c0b3..4427b8696f61b 100644 --- a/doc/rbd/iscsi-target-cli-manual-install.rst +++ b/doc/rbd/iscsi-target-cli-manual-install.rst @@ -34,13 +34,19 @@ on each machine that will be a iSCSI gateway: - Linux Kernel If not using a distro kernel that contains the required Ceph iSCSI patches, - then Linux kernel v4.17 or newer or the ceph-client ceph-iscsi-stable - branch must be used. To get the ceph-iscsi-stable branch run: + then Linux kernel v4.17 or newer or the ceph-client ceph-iscsi-test + branch must be used. To get the branch run: :: > git clone https://github.com/ceph/ceph-client.git - > git checkout ceph-iscsi-stable + > git checkout ceph-iscsi-test + + .. warning:: + ceph-iscsi-test is not for production use. It should only be used + for proof of concept setups and testing. The kernel is only updated + with Ceph iSCSI patches. General security and bug fixes from upstream + are not applied. Check your distro's docs for specific instructions on how to build a kernel. The only Ceph iSCSI specific requirements are the following diff --git a/doc/rbd/iscsi-target-cli.rst b/doc/rbd/iscsi-target-cli.rst index 3a312cade5f34..2bc0dfc2621b1 100644 --- a/doc/rbd/iscsi-target-cli.rst +++ b/doc/rbd/iscsi-target-cli.rst @@ -11,7 +11,7 @@ install, and configure the Ceph iSCSI gateway for basic operation. - A running Ceph Luminous or later storage cluster -- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client kernel `_ +- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client test kernel `_ - The following packages must be installed from your Linux distribution's software repository: @@ -183,7 +183,7 @@ to create a iSCSI target and export a RBD image as LUN 0. > /iscsi-target...-igw/gateways> create ceph-gw-1 10.172.19.21 > /iscsi-target...-igw/gateways> create ceph-gw-2 10.172.19.22 - If not using RHEL/CentOS or using an upstream or ceph-iscsi-stable kernel, + If not using RHEL/CentOS or using an upstream or ceph-iscsi-test kernel, the skipchecks=true argument must be used. This will avoid the Red Hat kernel and rpm checks: diff --git a/doc/rbd/iscsi-targets.rst b/doc/rbd/iscsi-targets.rst index 265996599d541..573655611dba5 100644 --- a/doc/rbd/iscsi-targets.rst +++ b/doc/rbd/iscsi-targets.rst @@ -8,7 +8,7 @@ within OpenStack environments. Starting with the Ceph Luminous release, block-level access is expanding to offer standard iSCSI support allowing wider platform usage, and potentially opening new use cases. -- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client kernel `_ +- RHEL/CentOS 7.5; Linux kernel v4.17 or newer; or the `Ceph iSCSI client test kernel `_ - A working Ceph Storage cluster, deployed with ``ceph-ansible`` or using the command-line interface -- 2.39.5