Various YAML/tools documentation improvements

Change-Id: I72b10d5333284bb0652d0d509c884b9b79c1c74b
Signed-off-by: Kaspars Skels <kaspars.skels@att.com>

diff --git a/site/intel-pod17/intel-pod17.env b/site/intel-pod17/intel-pod17.env
index ba2ee20..423a869 100644 (file)
--- a/site/intel-pod17/intel-pod17.env
+++ b/site/intel-pod17/intel-pod17.env
@@ -1,7 +1,15 @@
-export OS_AUTH_URL=${OS_AUTH_URL:-http://iam-airship.intel-pod17.opnfv.org:80/v3}
-export GEN_SSH=${GEN_SSH:-intel-pod17-genesis}
-export SITE_NAME=${SITE_NAME:-intel-pod17}
-export GEN_IPMI=${GEN_IPMI:-10.10.170.11}
+# The envrionment required by the tools/deploy.sh script for automated site
+# deployment.
+# The particular values in this file match the reference lab Intel POD17
+# https://wiki.opnfv.org/display/pharos/Intel+POD17
+
+# Airship related settings
+export OS_AUTH_URL=${OS_AUTH_URL:-'http://iam-airship.intel-pod17.opnfv.org:80/v3'}
+export GEN_SSH=${GEN_SSH:-'intel-pod17-genesis'}
+export SITE_NAME=${SITE_NAME:-'intel-pod17'}
+export GEN_IPMI=${GEN_IPMI:-'10.10.170.11'}
 export NODES_IPMI=${NODES_IPMI:-'10.10.170.12 10.10.170.13 10.10.170.14 10.10.170.15'}
-export SITE_DEF=${SITE_DEF:-airship/site/intel-pod17/site-definition.yaml}
-export OS_AUTH_URL_IDENTITY=${OS_AUTH_URL_IDENTITY:-http://identity-airship.intel-pod17.opnfv.org:80/v3}
+export SITE_DEF=${SITE_DEF:-'airship/site/intel-pod17/site-definition.yaml'}
+
+# OpenStack related settings
+export OS_AUTH_URL_IDENTITY=${OS_AUTH_URL_IDENTITY:-'http://identity-airship.intel-pod17.opnfv.org:80/v3'}

diff --git a/site/intel-pod17/networks/physical/networks.yaml b/site/intel-pod17/networks/physical/networks.yaml
index 11329c3..3cebeae 100644 (file)
--- a/site/intel-pod17/networks/physical/networks.yaml
+++ b/site/intel-pod17/networks/physical/networks.yaml
@@ -4,21 +4,26 @@
 #
 # The following is reference configuration for Intel hosted POD17
 # https://wiki.opnfv.org/display/pharos/Intel+POD17
-# +--------+------------+-----------------------------------+----------+----------+----------------+
-# |        |            |                                   |          |          |                |
-# +--------+------------+-----------------------------------+----------+----------+----------------+
-# |IF0 1G  | dmz        | OoB & OAM (default route)         | VLAN 170 | untagged | 10.10.170.0/24 |
-# |IF1 1G  | admin      | PXE boot network                  | VLAN 171 | untagged | 10.10.171.0/24 |
-# |IF2 10G | private    | Underlay calico and ovs overlay   | VLAN 172 | untagged | 10.10.172.0/24 |
-# |        | management | Management (unused for now)       | VLAN 174 | tagged   | 10.10.174.0/24 |
-# |IF3 10G | storage    | Storage network                   | VLAN 173 | untagged | 10.10.173.0/24 |
-# |        | public     | Public network for VMs            | VLAN 175 | tagged   | 10.10.175.0/24 |
-# +--------+------------+-----------------------------------+----------+----------+----------------+
+# +--------+------------+-----------------------------------+-----------+----------+----------------+
+# |        |            |                                   |           |          |                |
+# +--------+------------+-----------------------------------+-----------+----------+----------------+
+# |IF0 1G  | dmz        | OoB & OAM (default route)         | VLAN  170 | untagged | 10.10.170.0/24 |
+# |IF1 1G  | admin      | PXE boot network                  | VLAN  171 | untagged | 10.10.171.0/24 |
+# |IF2 10G | private    | Underlay calico and ovs overlay   | VLAN  172 | untagged | 10.10.172.0/24 |
+# |        | management | Management (unused for now)       | VLAN  174 | tagged   | 10.10.174.0/24 |
+# |IF3 10G | storage    | Storage network                   | VLAN  173 | untagged | 10.10.173.0/24 |
+# |        | public     | Public network for VMs            | VLAN 1173 | tagged   | 10.10.175.0/24 |
+# +--------+------------+-----------------------------------+-----------+----------+----------------+
 #
-# For standard Airship deployments, you should not need to modify the number of
-# NetworkLinks and Networks in this file. Only the IP addresses and CIDRs should
-# need editing.
+# For standard Airshipi/OPNFV deployments, you should not need to modify the
+# number of NetworkLinks and Networks in this file. Only the IP addresses and
+# CIDRs should need editing.
 #
+# The general Drydock documentation contains additional details, exmaples
+# and how-tos on working with Drydock/YAMLs in more generic way and enabling
+# custom/additional features not represented here  (such as bonded networks).
+# https://airship-drydock.readthedocs.io/en/latest/topology.html#defining-networking
+
 schema: 'drydock/NetworkLink/v1'
 metadata:
   schema: 'metadata/Document/v1'