10 files changed, 466 insertions, 0 deletions
diff --git a/docs/development/design/architecture.rst b/docs/development/design/architecture.rst
new file mode 100644
index 0000000..02d8335
--- /dev/null
+++ b/docs/development/design/architecture.rst
@@ -0,0 +1,100 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+Architecture
+============
+
+Architectural Concept
+---------------------
+The following example diagram illustrates a "relationship diagram" type view of
+an NFVI platform, in which the roles of components focused on policy management,
+services, and infrastructure are shown.
+
+This view illustrates that a large-scale deployment of NFVI may leverage multiple
+components of the same "type" (e.g. SDN Controller), which fulfill specific
+purposes for which they are optimized. For example, a global SDN controller and
+cloud orchestrator can act as directed by a service orchestrator in the
+provisioning of VNFs per intent, while various components at a local and global
+level handle policy-related events directly and/or feed them back through a
+closed-loop policy design that responds as needed, directly or through the
+service orchestrator.
+
+.. image:: ./images/policy_architecture.png
+   :width: 700 px
+   :alt: policy_architecture.png
+   :align: center
+
+(source of the diagram above:
+https://git.opnfv.org/cgit/copper/plain/design_docs/images/policy_architecture.pptx)
+
+Architectural Aspects
+---------------------
+  * Policies are reflected in two high-level goals
+
+    * Ensure resource requirements of VNFs and services are applied per VNF
+      designer, service, and tenant intent
+    * Ensure that generic policies are not violated, e.g. *networks connected to
+      VMs must either be public or owned by the VM owner*
+
+  * Policies are distributed through two main means
+
+    * As part of VNF packages, customized if needed by Service Design tools,
+      expressing intent of the VNF designer and service provider, and possibly
+      customized or supplemented by service orchestrators per the intent of
+      specific tenants
+    * As generic policies provisioned into VIMs (SDN controllers and cloud
+      orchestrators), expressing intent of the service provider re what
+      states/events need to be policy-governed independently of specific VNFs
+
+  * Policies are applied locally and in closed-loop systems per the capabilities
+    of the local policy enforcer and the impact of the related state/event conditions
+
+    * VIMs should be able to execute most policies locally
+    * VIMs may need to pass policy-related state/events to a closed-loop system,
+      where those events are relevant to other components in the architecture
+      (e.g. service orchestrator), or some additional data/arbitration is needed
+      to resolve the state/event condition
+
+  * Policies are localized as they are distributed/delegated
+
+    * High-level policies (e.g. expressing "intent") can be translated into VNF
+      package elements or generic policies, perhaps using distinct syntaxes
+    * Delegated policy syntaxes are likely VIM-specific, e.g. Datalog (Congress)
+
+  * Closed-loop policy and VNF-lifecycle event handling are //somewhat// distinct
+
+    * Closed-loop policy is mostly about resolving conditions that can't be
+      handled locally, but as above in some cases the conditions may be of
+      relevance and either delivered directly or forwarded to service orchestrators
+    * VNF-lifecycle events that can't be handled by the VIM locally are delivered
+      directly to the service orchestrator
+
+  * Some events/analytics need to be collected into a more "open-loop" system
+    which can enable other actions, e.g.
+
+    * audits and manual interventions
+    * machine-learning focused optimizations of policies (largely a future objective)
+
+Issues to be investigated as part of establishing an overall cohesive/adaptive
+policy architecture:
+
+  * For the various components which may fulfill a specific purpose, what
+    capabilities (e.g. APIs) do they have/need to
+
+    * handle events locally
+    * enable closed-loop policy handling components to subscribe/optimize
+      policy-related events that are of interest
+
+  * For global controllers and cloud orchestrators
+
+    * How do they support correlation of events impacting resources in different
+      scopes (network and cloud)
+    * What event/response flows apply to various policy use cases
+
+  * What specific policy use cases can/should fall into each overall class
+
+    * locally handled by NFVI components
+    * handled by a closed-loop policy system, either VNF/service-specific or
+      VNF-independent
diff --git a/docs/development/design/conf.py b/docs/development/design/conf.py
new file mode 100644
index 0000000..99b1ca2
--- /dev/null
+++ b/docs/development/design/conf.py
@@ -0,0 +1,50 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+#  
+# 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.
+#
+# What this is: Configuration file for OPNFV Copper project documentation
+# generation via Sphinx.
+#
+# Status: Tested and used in production of Copper project documentation.
+#
+
+import datetime
+import sys
+import os
+
+try:
+    __import__('imp').find_module('sphinx.ext.numfig')
+    extensions = ['sphinx.ext.numfig']
+except ImportError:
+    # 'pip install sphinx_numfig'
+    extensions = ['sphinx_numfig']
+
+# numfig:
+number_figures = True
+figure_caption_prefix = "Fig."
+
+source_suffix = '.rst'
+master_doc = 'index'
+pygments_style = 'sphinx'
+html_use_index = False
+html_theme = 'sphinx_rtd_theme'
+
+pdf_documents = [('index', u'OPNFV', u'OPNFV Copper Project', u'OPNFV')]
+pdf_fit_mode = "shrink"
+pdf_stylesheets = ['sphinx','kerning','a4']
+#latex_domain_indices = False
+#latex_use_modindex = False
+
+latex_elements = {
+    'printindex': '',
+}
diff --git a/docs/development/design/definitions.rst b/docs/development/design/definitions.rst
new file mode 100644
index 0000000..5552696
--- /dev/null
+++ b/docs/development/design/definitions.rst
@@ -0,0 +1,46 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+Definitions
+===========
+.. list-table:: Definitions
+   :widths: 15 85
+   :header-rows: 1
+
+   * - Term
+     - Meaning
+
+   * - State
+     - Information that can be used to convey or imply the state of something, e.g. an application, resource, entity, etc. This can include data held inside OPNFV components, "events" that have occurred (e.g. "policy violation"), etc.
+
+   * - Event
+     - An item of significance to the policy engine, for which the engine has become aware through some method of discovery e.g. polling or notification.
+
+Abbreviations
+=============
+.. list-table:: Abbreviations
+   :widths: 15 85
+   :header-rows: 1
+
+   * - Term
+     - Meaning
+
+   * - CRUD
+     - Create, Read, Update, Delete (database operation types)
+
+   * - FCAPS
+     - Fault, Configuration, Accounting, Performance, Security
+
+   * - NF
+     - Network Function
+
+   * - SFC
+     - Service Function Chaining
+
+   * - VNF
+     - Virtual Network Function
+
+   * - NFVI
+     - Network Function Virtualization Infrastructure
diff --git a/docs/development/design/images/policy_architecture.png b/docs/development/design/images/policy_architecture.png
new file mode 100644
index 0000000..eb37e36
--- /dev/null
+++ b/docs/development/design/images/policy_architecture.png
diff --git a/docs/development/design/images/policy_architecture.pptx b/docs/development/design/images/policy_architecture.pptx
new file mode 100644
index 0000000..5739f0f
--- /dev/null
+++ b/docs/development/design/images/policy_architecture.pptx
diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst
new file mode 100644
index 0000000..aa51e54
--- /dev/null
+++ b/docs/development/design/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+==========================
+OPNFV Copper Danube Design
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   definitions.rst
+   architecture.rst
+
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644
index 0000000..e9c69e0
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+============================
+OPNFV Copper Danube Overview
+============================
+
+.. toctree::
+   :maxdepth: 1
+
+   overview.rst
diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst
new file mode 100644
index 0000000..2a27e49
--- /dev/null
+++ b/docs/development/overview/overview.rst
@@ -0,0 +1,94 @@
+==============================================
+OPNFV Danube Copper Overview
+==============================================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Introduction
+------------
+
+The `OPNFV Copper <https://wiki.opnfv.org/copper>`_ project aims to help ensure
+that virtualized infrastructure and application deployments comply with goals of
+the NFV service provider or the VNF designer/user.
+
+This is the third ("Danube") release of the Copper project. The documentation
+provided here focuses on the overall goals of the Copper project and the
+specific features supported in the Colorado release.
+
+Overall Goals for Configuration Policy
+--------------------------------------
+
+As focused on by Copper, configuration policy helps ensure that the NFV service
+environment meets the requirements of the variety of stakeholders which will
+provide or use NFV platforms.
+
+These requirements can be expressed as an *intent* of the stakeholder,
+in specific terms or more abstractly, but at the highest level they express:
+
+  * what I want
+  * what I don't want
+
+Using road-based transportation as an analogy, some examples of this are shown
+below:
+
+.. list-table:: Configuration Intent Example
+   :widths: 10 45 45
+   :header-rows: 1
+
+   * - Who I Am
+     - What I Want
+     - What I Don't Want
+   * - user
+     - a van, wheelchair-accessible, electric powered
+     - someone driving off with my van
+   * - road provider
+     - keep drivers moving at an optimum safe speed
+     - four-way stops
+   * - public safety
+     - shoulder warning strips, center media barriers
+     - speeding, tractors on the freeway
+
+According to their role, service providers may apply more specific configuration
+requirements than users, since service providers are more likely to be managing
+specific types of infrastructure capabilities.
+
+Developers and users may also express their requirements more specifically,
+based upon the type of application or how the user intends to use it.
+
+For users, a high-level intent can be also translated into a more or less specific
+configuration capability by the service provider, taking into consideration
+aspects such as the type of application or its constraints.
+
+Examples of such translation are:
+
+.. list-table:: Intent Translation into Configuration Capability
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Intent
+     - Configuration Capability
+   * - network security
+     - firewall, DPI, private subnets
+   * - compute/storage security
+     - vulnerability monitoring, resource access controls
+   * - high availability
+     - clustering, auto-scaling, anti-affinity, live migration
+   * - disaster recovery
+     - geo-diverse anti-affinity
+   * - high compute/storage performance
+     - clustering, affinity
+   * - high network performance
+     - data plane acceleration
+   * - resource reclamation
+     - low-usage monitoring
+
+Although such intent-to-capability translation is conceptually useful, it is
+unclear how it can address the variety of aspects that may affect the choice of
+an applicable configuration capability.
+
+For that reason, the Copper project will initially focus on more specific
+configuration requirements as fulfilled by specific configuration capabilities,
+as well as how those requirements and capabilities are expressed in VNF and service
+design and packaging or as generic policies for the NFV Infrastructure.
diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst
new file mode 100644
index 0000000..611fbe2
--- /dev/null
+++ b/docs/development/requirements/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+================================
+OPNFV Copper Danube Requirements
+================================
+
+.. toctree::
+   :maxdepth: 1
+
+   requirements.rst
diff --git a/docs/development/requirements/requirements.rst b/docs/development/requirements/requirements.rst
new file mode 100644
index 0000000..87894cf
--- /dev/null
+++ b/docs/development/requirements/requirements.rst
@@ -0,0 +1,135 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+Requirements
+============
+This section outlines general requirements for configuration policies,
+per the two main aspects in the Copper project scope:
+
+  * Ensuring resource requirements of VNFs and services are applied per VNF
+    designer, service, and tenant intent
+  * Ensuring that generic policies are not violated,
+    e.g. *networks connected to VMs must either be public or owned by the VM owner*
+
+Resource Requirements
++++++++++++++++++++++
+Resource requirements describe the characteristics of virtual resources (compute,
+storage, network) that are needed for VNFs and services, and how those resources
+should be managed over the lifecycle of a VNF/service. Upstream projects already
+include multiple ways in which resource requirements can be expressed and fulfilled, e.g.:
+
+  * OpenStack Nova
+
+    * the Image feature, enabling "VM templates" to be defined for NFs and referenced by name as a specific NF version to be used
+    * the Flavor feature, addressing basic compute and storage requirements, with extensibility for custom attributes
+
+  * OpenStack Heat
+
+    * the `Heat Orchestration Template <http://docs.openstack.org/developer/heat/template_guide/index.html>`_
+      feature, enabling a variety of VM aspects to be defined and managed by
+      Heat throughout the VM lifecycle, notably
+
+      * alarm handling (requires `Ceilometer <https://wiki.openstack.org/wiki/Ceilometer>`_)
+      * attached volumes (requires `Cinder <https://wiki.openstack.org/wiki/Cinder>`_)
+      * domain name assignment (requires `Designate <https://wiki.openstack.org/wiki/Designate>`_)
+      * images (requires `Glance <https://wiki.openstack.org/wiki/Glance>`_)
+      * autoscaling
+      * software configuration associated with VM lifecycle hooks (CREATE,
+        UPDATE, SUSPEND, RESUME, DELETE)
+      * wait conditions and signaling for sequencing orchestration steps
+      * orchestration service user management (requires
+        `Keystone <http://docs.openstack.org/developer/keystone/>`_)
+      * shared storage (requires `Manila <https://wiki.openstack.org/wiki/Manila>`_)
+      * load balancing (requires `Neutron LBaaS <http://docs.openstack.org/admin-guide/networking.html>`_)
+      * firewalls (requires `Neutron FWaaS <http://docs.openstack.org/admin-guide/networking.html>`_)
+      * various Neutron-based network and security configuration items
+      * Nova flavors
+      * Nova server attributes including access control
+      * Nova server group affinity and anti-affinity
+      * "Data-intensive application clustering" (requires
+        `Sahara <https://wiki.openstack.org/wiki/Sahara>`_)
+      * DBaaS (requires `Trove <http://docs.openstack.org/developer/trove/>`_)
+      * "multi-tenant cloud messaging and notification service" (requires
+        `Zaqar <http://docs.openstack.org/developer/zaqar/>`_)
+
+  * `OpenStack Group-Based Policy <https://wiki.openstack.org/wiki/GroupBasedPolicy>`_
+
+    * API-based grouping of endpoints with associated contractual expectations for data flow processing and service chaining
+
+  * `OpenStack Tacker <https://wiki.openstack.org/wiki/Tacker>`_
+
+    * "a fully functional ETSI MANO based general purpose NFV Orchestrator and VNF Manager for OpenStack"
+
+  * `OpenDaylight Group-Based Policy <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)>`_
+
+    * model-based grouping of endpoints with associated contractual expectations for data flow processing
+
+  * `OpenDaylight Service Function Chaining (SFC) <https://wiki.opendaylight.org/view/Service_Function_Chaining:Main>`_
+
+    * model-based management of "service chains" and the infrastucture that enables them
+
+  * Additional projects that are commonly used for configuration management,
+    implemented as client-server frameworks using model-based, declarative, or
+    scripted configuration management data.
+
+    * `Puppet <https://puppetlabs.com/puppet/puppet-open-source>`_
+    * `Chef <https://www.chef.io/chef/>`_
+    * `Ansible <http://docs.ansible.com/ansible/index.html>`_
+    * `Salt <http://saltstack.com/community/>`_
+
+Generic Policy Requirements
++++++++++++++++++++++++++++
+Generic policy requirements address conditions related to resource state and
+events which need to be monitored for, and optionally responded to or prevented.
+These conditions are typically expected to be VNF/service-independent, as
+VNF/service-dependent condition handling (e.g. scale in/out) are considered to
+be addressed by VNFM/NFVO/VIM functions as described under Resource Requirements
+or as FCAPS related functions. However the general capabilities below can be
+applied to VNF/service-specific policy handling as well, or in particular to
+invocation of VNF/service-specific management/orchestration actions. The
+high-level required capabilities include:
+
+  * Polled monitoring: Exposure of state via request-response APIs.
+  * Notifications: Exposure of state via pub-sub APIs.
+  * Realtime/near-realtime notifications: Notifications that occur in actual or
+    near realtime.
+  * Delegated policy: CRUD operations on policies that are distributed to
+    specific components for local handling, including one/more of monitoring,
+    violation reporting, and enforcement.
+  * Violation reporting: Reporting of conditions that represent a policy violation.
+  * Reactive enforcement: Enforcement actions taken in response to policy
+    violation events.
+  * Proactive enforcement: Enforcement actions taken in advance of policy
+    violation events,
+    e.g. blocking actions that could result in a policy violation.
+  * Compliance auditing: Periodic auditing of state against policies.
+
+Upstream projects already include multiple ways in which configuration conditions
+can be monitored and responded to:
+
+  * OpenStack `Congress <http://docs.openstack.org/developer/congress/index.html>`_ provides a
+    table-based mechanism for state monitoring and proactive/reactive policy
+    enforcement, including data obtained from internal databases of OpenStack
+    core and optional services. The Congress design approach is also extensible
+    to other VIMs (e.g. SDNCs) through development of data source drivers for
+    the new monitored state information.
+  * OpenStack `Aodh <https://wiki.openstack.org/wiki/Telemetry#Aodh>`_
+    provides means to trigger alarms upon a wide variety of conditions derived
+    from its monitored OpenStack analytics.
+  * `Nagios <https://www.nagios.org/#/>`_ "offers complete monitoring and alerting for servers, switches, applications, and services".
+
+Requirements Validation Approach
+++++++++++++++++++++++++++++++++
+The Copper project will assess the completeness of the upstream project solutions
+for requirements in scope though a process of:
+
+  * developing configuration policy use cases to focus solution assessment tests
+  * integrating the projects into the OPNFV platform for testing
+  * executing functional and performance tests for the solutions
+  * assessing overall requirements coverage and gaps in the most complete
+    upstream solutions
+
+Depending upon the priority of discovered gaps, new requirements will be
+submitted to upstream projects for the next available release cycle.