summaryrefslogtreecommitdiffstats
path: root/docs/design/usecases.rst
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-08 21:12:10 +0900
committerBryan Sullivan <bs3131@att.com>2016-02-25 01:03:14 +0000
commitf033459b5fbb9c354ba61682a462c7a95f999421 (patch)
tree21dc125ef663bd86658ccf909f23f16bf3709a30 /docs/design/usecases.rst
parent273bfc4054be51ed61369b5c7b926cf57e409707 (diff)
fix docs
- doc8 violations - use latest index.rst format - move userguide.rst to featureusage.rst Change-Id: I73e0a8a45418e197b973537d4f2856bd98c9a06c Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit 7dee5427d770340526afc7ffa642d223b53cfdf1)
Diffstat (limited to 'docs/design/usecases.rst')
-rw-r--r--docs/design/usecases.rst46
1 files changed, 35 insertions, 11 deletions
diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
index e37aa17..ef9e82d 100644
--- a/docs/design/usecases.rst
+++ b/docs/design/usecases.rst
@@ -10,7 +10,12 @@ Workload Placement
Affinity
........
-Ensures that the VM instance is launched "with affinity to" specific resources, e.g. within a compute or storage cluster. This is analogous to the affinity rules in `VMWare vSphere DRS <https://pubs.vmware.com/vsphere-50/topic/com.vmware.vsphere.resmgmt.doc_50/GUID-FF28F29C-8B67-4EFF-A2EF-63B3537E6934.html>`_. Examples include: "Same Host Filter", i.e. place on the same compute node as a given set of instances, e.g. as defined in a scheduler hint list.
+Ensures that the VM instance is launched "with affinity to" specific resources,
+e.g. within a compute or storage cluster.
+This is analogous to the affinity rules in
+`VMWare vSphere DRS <https://pubs.vmware.com/vsphere-50/topic/com.vmware.vsphere.resmgmt.doc_50/GUID-FF28F29C-8B67-4EFF-A2EF-63B3537E6934.html>`_.
+Examples include: "Same Host Filter", i.e. place on the same compute node as a given set of instances,
+e.g. as defined in a scheduler hint list.
As implemented by OpenStack Heat using server groups:
@@ -42,7 +47,11 @@ As implemented by OpenStack Heat using server groups:
Anti-Affinity
.............
-Ensures that the VM instance is launched "with anti-affinity to" specific resources, e.g. outside a compute or storage cluster, or geographic location. This filter is analogous to the anti-affinity rules in vSphere DRS. Examples include: "Different Host Filter", i.e. ensures that the VM instance is launched on a different compute node from a given set of instances, as defined in a scheduler hint list.
+Ensures that the VM instance is launched "with anti-affinity to" specific resources,
+e.g. outside a compute or storage cluster, or geographic location.
+This filter is analogous to the anti-affinity rules in vSphere DRS.
+Examples include: "Different Host Filter", i.e. ensures that the VM instance is launched
+on a different compute node from a given set of instances, as defined in a scheduler hint list.
As implemented by OpenStack Heat using scheduler hints:
@@ -81,12 +90,16 @@ As implemented by OpenStack Heat using scheduler hints:
DMZ Deployment
..............
-As a service provider, I need to ensure that applications which have not been designed for exposure in a DMZ zone, are not attached to DMZ networks.
+As a service provider,
+I need to ensure that applications which have not been designed for exposure in a DMZ zone,
+are not attached to DMZ networks.
Configuration Auditing
----------------------
-As a service provider or tenant, I need to periodically verify that resource configuration requirements have not been violated, as a backup means to proactive or reactive policy enforcement.
+As a service provider or tenant,
+I need to periodically verify that resource configuration requirements have not been violated,
+as a backup means to proactive or reactive policy enforcement.
Generic Policy Requirements
+++++++++++++++++++++++++++
@@ -94,7 +107,9 @@ Generic Policy Requirements
NFVI Self-Service Constraints
-----------------------------
-As an NFVI provider, I need to ensure that my self-service tenants are not able to configure their VNFs in ways that would impact other tenants or the reliability, security, etc of the NFVI.
+As an NFVI provider,
+I need to ensure that my self-service tenants are not able to configure their VNFs in ways
+that would impact other tenants or the reliability, security, etc of the NFVI.
Network Access Control
......................
@@ -103,10 +118,16 @@ Networks connected to VMs must be public, or owned by someone in the VM owner's
This use case captures the intent of the following sub-use-cases:
- * Link Mirroring: As a troubleshooter, I need to mirror traffic from physical or virtual network ports so that I can investigate trouble reports.
- * Link Mirroring: As a NFVaaS tenant, I need to be able to mirror traffic on my virtual network ports so that I can investigate trouble reports.
- * Unauthorized Link Mirroring Prevention: As a NFVaaS tenant, I need to be able to prevent other tenants from mirroring traffic on my virtual network ports so that I can protect the privacy of my service users.
- * Link Mirroring Delegation: As a NFVaaS tenant, I need to be able to allow my NFVaaS SP customer support to mirror traffic on my virtual network ports so that they can assist in investigating trouble reports.
+ * Link Mirroring: As a troubleshooter,
+ I need to mirror traffic from physical or virtual network ports so that I can investigate trouble reports.
+ * Link Mirroring: As a NFVaaS tenant,
+ I need to be able to mirror traffic on my virtual network ports so that I can investigate trouble reports.
+ * Unauthorized Link Mirroring Prevention: As a NFVaaS tenant,
+ I need to be able to prevent other tenants from mirroring traffic on my virtual network ports
+ so that I can protect the privacy of my service users.
+ * Link Mirroring Delegation: As a NFVaaS tenant,
+ I need to be able to allow my NFVaaS SP customer support to mirror traffic on my virtual network ports
+ so that they can assist in investigating trouble reports.
As implemented through OpenStack Congress:
@@ -157,7 +178,9 @@ Resource Management
Resource Reclamation
....................
-As a service provider or tenant, I need to be informed of VMs that are under-utilized so that I can reclaim the VI resources. (example from `RuleYourCloud blog <http://ruleyourcloud.com/2015/03/12/scaling-up-congress.html>`_)
+As a service provider or tenant,
+I need to be informed of VMs that are under-utilized so that I can reclaim the VI resources.
+(example from `RuleYourCloud blog <http://ruleyourcloud.com/2015/03/12/scaling-up-congress.html>`_)
As implemented through OpenStack Congress:
@@ -175,7 +198,8 @@ As implemented through OpenStack Congress:
Resource Use Limits
...................
-As a tenant or service provider, I need to be automatically terminate an instance that has run for a pre-agreed maximum duration.
+As a tenant or service provider,
+I need to be automatically terminate an instance that has run for a pre-agreed maximum duration.
As implemented through OpenStack Congress: