diff options
| author |   Lukasz Rajewski <lukasz.rajewski@orange.com> | 2018-09-04 15:56:18 +0200 |
|---|---|---|
| committer |   Takamune Cho <tc012c@att.com> | 2018-09-14 12:58:23 +0000 |
| commit | d90ba5c3b7237131a47ad835ab19f42110166a73 (patch) | |
| tree | 91d67cde19f306be49ca0f2852a12949e9a7c9b3 /docs | |
| parent | a5411a8a16c13ab34733ebeea0d4222b3220f882 (diff) | |
Documentation for DistributeTraffic LCM action
This change modifies APPC LCM API Guide and APPC CDT User Guide
with descriptions for new DistributeTraffic LCM API
Change-Id: Ieb945976821369728c6a4e96437acce920a2ff1a
Issue-ID: APPC-1171
Signed-off-by: Lukasz Rajewski <lukasz.rajewski@orange.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/APPC CDT Guide/APPC CDT Guide.rst | 2 | ||||
| -rw-r--r-- | docs/APPC LCM API Guide/APPC LCM API Guide.rst | 44 |
2 files changed, 46 insertions, 0 deletions
diff --git a/docs/APPC CDT Guide/APPC CDT Guide.rst b/docs/APPC CDT Guide/APPC CDT Guide.rst index 9f8ceaa9a..3a20eb49c 100644 --- a/docs/APPC CDT Guide/APPC CDT Guide.rst +++ b/docs/APPC CDT Guide/APPC CDT Guide.rst @@ -413,6 +413,8 @@ on-boarding with the Beijing release. +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+ | **DetachVolume** | | | | | YES | | +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+ +| **DistributeTraffic** | | YES | YES | | | | ++----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+ | **Evacuate** | | | | | YES | | +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+ | **HealthCheck** | | YES | YES | YES | | | diff --git a/docs/APPC LCM API Guide/APPC LCM API Guide.rst b/docs/APPC LCM API Guide/APPC LCM API Guide.rst index 45cb04764..79a301219 100644 --- a/docs/APPC LCM API Guide/APPC LCM API Guide.rst +++ b/docs/APPC LCM API Guide/APPC LCM API Guide.rst @@ -572,6 +572,8 @@ Commands, or actions, may be currently supported on all VNF types or a limited s +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | DetachVolume | | | | Yes | Any (uses OpenStack command) | +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| DistributeTraffic | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | Evacuate | | | | Yes | Any (uses OpenStack command) | +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | HealthCheck | Yes | | | | Any (requires self-service onboarding) | @@ -1178,6 +1180,48 @@ DetachVolume Response: - itemNotFound - conflict +DistributeTraffic +----------------- + +The Distribute traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM. +Entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final +realization of request. Parameters present in configuration file specify where and how traffic should be distributed, +including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy. +Format of configuration file is specific to each VNF type. + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: + ++--------------------------+--------------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:distribute-traffic | ++--------------------------+--------------------------------------------------------------+ +| **Action** | DistributeTraffic | ++--------------------------+--------------------------------------------------------------+ +| **Action-identifiers** | vnf-id, vserver-id, vnfc-name | ++--------------------------+--------------------------------------------------------------+ +| **Payload Parameters** | ConfigFileName | ++--------------------------+--------------------------------------------------------------+ +| **Revision History** | New in Casablanca | ++--------------------------+--------------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+----------------------------------------------------------------------------------------------------+---------------------+--------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+====================================================================================================+=====================+========================================================+ +| ConfigFileName | Name of configuration file with additional parameters for Ansible playbook or Chef cookbook | | "payload": | +| | with such parameters like traffic destinations, distribution weights or rollback strategy. | Yes | "{\\"ConfigFileName\\": \\"some-config.json\\"}” | ++-----------------------+----------------------------------------------------------------------------------------------------+---------------------+--------------------------------------------------------+ + +DistributeTraffic Response +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The response does not include any payload parameters. + +**Success:** A successful distribute returns a success status code 400 after all traffic has been distributed. + +**Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. Evacuate -------- |