From 4aca68f37c5e8ba0a1c035433e021afeb7409cea Mon Sep 17 00:00:00 2001 From: akhiljain23 Date: Fri, 27 Apr 2018 10:55:53 +0530 Subject: [PATCH] Refactoring readme doc This commit separates valence feature highlights from project overview doc. Change-Id: I88fc95e444f27561842193c71707a0d868a2d3a8 --- README.rst | 55 -------------------------------- doc/source/features.rst | 70 +++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 3 files changed, 71 insertions(+), 55 deletions(-) create mode 100644 doc/source/features.rst diff --git a/README.rst b/README.rst index ca6f483..0fb06ec 100644 --- a/README.rst +++ b/README.rst @@ -23,58 +23,3 @@ using their respective drivers other than Redfish. :Wiki: https://wiki.openstack.org/wiki/Valence :Source: http://git.openstack.org/cgit/openstack/valence :Bugs: https://bugs.launchpad.net/openstack-valence - -.. _valence-features: - -****************** -Feature Highlights -****************** - -Valence provides the following capabilities for managing disaggregated hardware resources. - -.. _multi-podm-support: - -Multiple Podmanager Support ---------------------------- - -Valence provides the capability to manage multiple podmanagers. -Each podmanager can be configured to use different driver. By default, -``redfishv1`` driver is used. - -Currently supported drivers in Valence are: - #. :ref:`redfishv1-driver` - #. :ref:`expether-driver` - -Future work include redfish v2 driver support. Other vendors also could implement -their own driver to manage their hardware. - -This provides uniform interface to manage all the disaggregated hardware in datacentre -supporting different protocols. - -.. _device-orchestration: - -Device Orchestration framework ------------------------------- - -Valence provides support for the dynamic management of pooled resources like storage, -network and other pci devices which can be connected on demand to a composed node, -giving user the ability to attach or detach the devices dynamically based on workload. - -.. _ironic-provision-driver: - -Ironic provision driver ------------------------ - -Valence supports ``ironic`` provision driver to be able to register the valence composed -node to ironic. Once the node is registered further operations of provisioning/managing -could be directly performed using Ironic_. - -For more details on Ironic usage: -`Ironic API guide `_. - - -For more features please refer the Valence blueprints_ for supported and -in-the-pipeline features. - -.. _blueprints: https://blueprints.launchpad.net/openstack-valence -.. _Ironic: https://docs.openstack.org/ironic/latest/ diff --git a/doc/source/features.rst b/doc/source/features.rst new file mode 100644 index 0000000..42d0d10 --- /dev/null +++ b/doc/source/features.rst @@ -0,0 +1,70 @@ +.. + Copyright (c) 2018 NEC, Corp. + All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +.. _valence-features: + +****************** +Feature Highlights +****************** + +Valence provides the following capabilities for managing disaggregated hardware resources. + +.. _multi-podm-support: + +Multiple Podmanager Support +--------------------------- + +Valence provides the capability to manage multiple podmanagers. +Each podmanager can be configured to use different driver. By default, +``redfishv1`` driver is used. + +Currently supported drivers in Valence are: + #. :ref:`redfishv1-driver` + #. :ref:`expether-driver` + +Future work include redfish v2 driver support. Other vendors also could implement +their own driver to manage their hardware. + +This provides uniform interface to manage all the disaggregated hardware in datacentre +supporting different protocols. + +.. _device-orchestration: + +Device Orchestration framework +------------------------------ + +Valence provides support for the dynamic management of pooled resources like storage, +network and other pci devices which can be connected on demand to a composed node, +giving user the ability to attach or detach the devices dynamically based on workload. + +.. _ironic-provision-driver: + +Ironic provision driver +----------------------- + +Valence supports ``ironic`` provision driver to be able to register the valence composed +node to ironic. Once the node is registered further operations of provisioning/managing +could be directly performed using Ironic_. + +For more details on Ironic usage: +`Ironic API guide `_. + + +For more features please refer the Valence blueprints_ for supported and +in-the-pipeline features. + +.. _blueprints: https://blueprints.launchpad.net/openstack-valence +.. _Ironic: https://docs.openstack.org/ironic/latest/ diff --git a/doc/source/index.rst b/doc/source/index.rst index 619b7e4..fd1d698 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Introduction to Valence :maxdepth: 2 readme + features Operators Guide ===============