summaryrefslogtreecommitdiffstats
path: root/docs/sections/example.rst
diff options
context:
space:
mode:
authorfsandoval <frank.sandoval@oamtechnologies.com>2018-05-30 14:22:03 -0600
committerfsandoval <frank.sandoval@oamtechnologies.com>2018-05-30 18:04:27 -0600
commit84ad836b25024835dc3abbb42832dfd36bcb23ce (patch)
tree83cba4ad0888031557151518b7d889cd82fefd1f /docs/sections/example.rst
parent6808592a9533c02d58981c3a4317ceb5dd056899 (diff)
update has docs
Issue-ID: OPTFRA-242 Change-Id: I9d89ef313018c3a0c25c48a4e0cecabba75db2fd Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
Diffstat (limited to 'docs/sections/example.rst')
-rw-r--r--docs/sections/example.rst144
1 files changed, 144 insertions, 0 deletions
diff --git a/docs/sections/example.rst b/docs/sections/example.rst
new file mode 100644
index 0000000..b1a5313
--- /dev/null
+++ b/docs/sections/example.rst
@@ -0,0 +1,144 @@
+Example Conductor Templates
+===========================
+
+Example 1
+---------
+
+.. code:: yaml
+
+ name: yyy-yyy-yyyy
+ files: {}
+ timeout: 600
+ limit: 1
+ template:
+ homing_template_version: '2018-02-01'
+ parameters:
+ service_name: ''
+ service_id: d61b2543-5914-4b8f-8e81-81e38575b8ec
+ customer_lat: 32.89748
+ customer_long: -97.040443
+ locations:
+ customer_loc:
+ latitude:
+ get_param: customer_lat
+ longitude:
+ get_param: customer_long
+ demands:
+ vGMuxInfra:
+ - inventory_provider: aai
+ inventory_type: service
+ service_type: vGMuxInfra-xx
+ attributes:
+ customer-id: ''
+ orchestration-status: ''
+ model-invariant-id: b3dc6465-942c-42af-8464-2bf85b6e504b
+ model-version-id: ba3b8981-9a9c-4945-92aa-486234ec321f
+ service-type: vGMuxInfra-xx
+ equipment-role: ''
+ global-customer-id: SDN-ETHERNET-INTERNET
+ vG:
+ - inventory_provider: aai
+ inventory_type: cloud
+ service_type: 71d563e8-e714-4393-8f99-cc480144a05e
+ constraints:
+ affinity_vCPE:
+ type: zone
+ demands:
+ - vGMuxInfra
+ - vG
+ properties:
+ category: complex
+ qualifier: same
+ optimization:
+ minimize:
+ sum:
+ - product:
+ - '1'
+ - distance_between:
+ - customer_loc
+ - vGMuxInfra
+ - product:
+ - '1'
+ - distance_between:
+ - customer_loc
+ - vG
+Example 1
+---------
+
+.. code:: yaml
+
+ files: {}
+ limit: 1
+ name: a2e3e0cc-3a97-44fc-8a08-1b86143fbdd3
+ template:
+ constraints:
+ affinity_vCPE:
+ demands:
+ - vgMuxAR
+ - vGW
+ properties:
+ category: complex
+ qualifier: same
+ type: zone
+ distance-vGMuxAR:
+ demands:
+ - vgMuxAR
+ properties:
+ distance: "< 500 km"
+ location: customer_loc
+ type: distance_to_location
+ distance-vGW:
+ demands:
+ - vGW
+ properties:
+ distance: "< 1500 km"
+ location: customer_loc
+ type: distance_to_location
+ demands:
+ vGW:
+ - attributes:
+ model-invariant-id: 782c87a6-b712-47d1-9c5b-1ea2cd9a2dd5
+ model-version-id: 9877dbbe-8ada-40a2-8adb-f6f26f1ad9ab
+ inventory_provider: aai
+ inventory_type: cloud
+ service_type: c3e0e82b-3367-48ce-ab00-27dc2e91a34a
+ vgMuxAR:
+ - attributes:
+ global-customer-id: SDN-ETHERNET-INTERNET
+ model-invariant-id: 565d5b75-11b8-41be-9991-ee03a0049159
+ model-version-id: 61414c6c-6082-4e03-9824-bf53c3582b78
+ inventory_provider: aai
+ inventory_type: service
+ service_type: 46b29078-8442-4ea3-bea6-9199a7d514d4
+ homing_template_version: '2017-10-10'
+ locations:
+ customer_loc:
+ latitude:
+ get_param: customer_lat
+ longitude:
+ get_param: customer_long
+ optimization:
+ minimize:
+ sum:
+ - product:
+ - '1'
+ - distance_between:
+ - customer_loc
+ - vgMuxAR
+ - product:
+ - '1'
+ - distance_between:
+ - customer_loc
+ - vGW
+ parameters:
+ customer_lat: 32.89748
+ customer_long: 97.040443
+ service_id: 0dbb9d5f-27d9-429b-bc36-293e9fab7731
+ service_name: ''
+ timeout: 600
+
+Contact
+-------
+
+Shankar Narayanan shankarpnsn@gmail.com
+a \ No newline at end of file