diff options
| author |   Saryu Shah <ss3917@att.com> | 2017-09-29 15:53:37 +0000 |
|---|---|---|
| committer | Saryu Shah <ss3917@att.com> | 2017-09-29 16:04:24 +0000 |
| commit | 84e9e3bf231907d816ef03cd120e574cbf3cee58 (patch) | |
| tree | e133bc9df9563df489e20d4982e2f24a4f9b9977 | |
| parent | 1a30768d96896c77237e7499fc58018eec40bf6a (diff) | |
Updates to policy documentation
Included the table of contents in api and arch doc
-------------------------------------------------------------
Change-Id: I50a977cd3c9781c1f2b5804d9043f097246e2528
Issue-Id: POLICY-241
Signed-off-by: Saryu Shah <ss3917@att.com>
| -rw-r--r-- | docs/platform/architecture.rst | 4 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst | 11 |
2 files changed, 11 insertions, 4 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index 25dd083ca..3a56c8890 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -4,6 +4,10 @@ Architecture ------------ + +.. contents:: + :depth: 3 + POLICY is a subsystem of ONAP that maintains, distributes, and operates on the set of rules that underlie ONAP’s control, orchestration, and management functions. POLICY provides a logically centralized environment for the creation and management of policies, including conditional rules. This provides the capability to **create** and **validate** policies/rules, **identify overlaps**, **resolve conflicts**, and **derive** additional policies as needed. Policies are used to **control**, **influence**, and help **ensure compliance** with goals. Policies can support infrastructure, products and services, operation automation, and security. Users, including network and service designers, operations engineers, and security experts, can easily **create**, **change**, and **manage** policy rules from the POLICY Manager in the ONAP Portal. diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst index 6f522635b..4b3c7fefb 100644 --- a/docs/platform/offeredapis.rst +++ b/docs/platform/offeredapis.rst @@ -4,6 +4,10 @@ Offered APIs ============ + +.. contents:: + :depth: 2 + The Policy subsystem of ONAP maintains, distributes, and operates on the set of rules that underlie ONAP’s control, orchestration, and management functions. Policy provides a centralized environment for the creation and management of easily-updatable conditional rules. It enables users to validate policies and rules, identify and resolve overlaps and conflicts, and derive additional policies where needed. The following operations are supported by the policy API: * Create policies on the PAP @@ -22,12 +26,9 @@ The Policy subsystem of ONAP maintains, distributes, and operates on the set of POLICY Engine Services ^^^^^^^^^^^^^^^^^^^^^^ -The figure below represents the target POLICY Architecture. - .. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2 - POLICY API Details ^^^^^^^^^^^^^^^^^^ @@ -36,8 +37,10 @@ POLICY API Details .. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2 +Additional Information +^^^^^^^^^^^^^^^^^^^^^^ -Additional information can be found at `PolicyApi link`_. +Additional information, including examples, can be found at `PolicyApi link`_. .. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API |