From e6385aa203bdc2c502d0cc37e398f8091c4525a5 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Wed, 23 Aug 2017 14:28:42 -0400 Subject: [PATCH] remove REST API examples from RAID doc This removes the REST API examples from the RAID documentation. Our documentation typically only uses ironic (or openstackclient) CLI. Also, this is the only place where 'curl' is documented. It was mentioned that at least one person got confused and thought that 'curl' was packaged with our client. Change-Id: Ib43be080a450144869bbce6ba6313db8bde93751 --- doc/source/admin/raid.rst | 34 +++++++++++----------------------- 1 file changed, 11 insertions(+), 23 deletions(-) diff --git a/doc/source/admin/raid.rst b/doc/source/admin/raid.rst index 9da86dd9a9..1911f2d329 100644 --- a/doc/source/admin/raid.rst +++ b/doc/source/admin/raid.rst @@ -7,10 +7,14 @@ RAID Configuration Overview ======== Ironic supports RAID configuration for bare metal nodes. It allows operators -to specify the desired RAID configuration via Ironic CLI or REST API. -The desired RAID configuration is applied on the bare metal during manual +to specify the desired RAID configuration via the OpenStackClient CLI or REST +API. The desired RAID configuration is applied on the bare metal during manual cleaning. +The examples described here use the OpenStackClient CLI; please see the +`REST API reference `_ +for their corresponding REST API requests. + Prerequisites ============= The bare metal node needs to use a driver that supports RAID @@ -38,9 +42,10 @@ in JSON format. Target RAID configuration ------------------------- -This is the desired RAID configuration on the bare metal node. Using Ironic CLI -or REST API, the operator sets ``target_raid_config`` field of the node. -The target RAID configuration will be applied during manual cleaning. +This is the desired RAID configuration on the bare metal node. Using the +OpenStackClient CLI (or REST API), the operator sets ``target_raid_config`` +field of the node. The target RAID configuration will be applied during manual +cleaning. Target RAID configuration is a dictionary having ``logical_disks`` as the key. The value for the ``logical_disks`` is a list of JSON @@ -61,13 +66,9 @@ If the ``target_raid_config`` is an empty dictionary, it unsets the value of done on the node. Each dictionary of logical disk contains the desired properties of logical -disk supported by the driver. These properties are discoverable by using -OpenStackClient CLI or REST API:: +disk supported by the driver. These properties are discoverable by:: - OpenStackClient CLI: openstack baremetal --os-baremetal-api-version 1.15 driver raid property list - Ironic REST API: - curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: $AUTH_TOKEN" -H "X-OpenStack-Ironic-API-Version: 1.15" http:///v1/drivers//raid/logical_disk_properties The RAID feature is available in ironic API version 1.15 and above. If ``--os-baremetal-api-version`` is not used in the CLI, it will error out @@ -236,11 +237,7 @@ physical disk found on the bare metal node. To get the current RAID configuration:: - OpenStackClient CLI: openstack baremetal --os-baremetal-api-version 1.15 node show - REST API: - curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: $AUTH_TOKEN" -H "X-OpenStack-Ironic-API-Version: 1.15" http:///v1/nodes//states - Workflow ======== @@ -256,11 +253,8 @@ Workflow `Target RAID configuration`_. The target RAID configuration is set on the Ironic node:: - OpenStackClient CLI: openstack baremetal --os-baremetal-api-version 1.15 node set \ --target-raid-config - REST API: - curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: $AUTH_TOKEN" -H "X-OpenStack-Ironic-API-Version: 1.15" -d '' http:///v1/nodes//states/raid The CLI command can accept the input from standard input also: openstack baremetal --os-baremetal-api-version 1.15 node set \ @@ -288,19 +282,13 @@ Workflow * Bring the node to ``manageable`` state and do a ``clean`` action to start cleaning on the node:: - OpenStackClient CLI: openstack baremetal --os-baremetal-api-version 1.15 node clean \ --clean-steps - REST API: - curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: $AUTH_TOKEN" -H "X-OpenStack-Ironic-API-Version: 1.15" -d '{'target': 'clean', 'clean_steps': ' http:///v1/nodes//states/provision * After manual cleaning is complete, the current RAID configuration can be viewed using:: - OpenStackClient CLI: openstack baremetal --os-baremetal-api-version 1.15 node show - REST API: - curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: $AUTH_TOKEN" -H "X-OpenStack-Ironic-API-Version: 1.15" http:///v1/nodes//states Using RAID in nova flavor for scheduling ========================================