summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Gu <james.gu@att.com>2019-12-18 14:43:25 -0800
committerJames Gu <james.gu@att.com>2019-12-18 14:44:28 -0800
commit1c399dffed58eda5ce3cd29bd5815ca3ed838137 (patch)
treede5a72e8305f1347597a8b56457d4ad9de2c9b66
parent64540ebf2855830df2af5b5d4ce70bd3ddebbe38 (diff)
Minor fixes for documentation in the site manifersts
Minor documentation fixes in the site yaml before Iruya release. Change-Id: I29e31bdb96fb361bbab8517ff65fb7b5ee43fc5a Signed-off-by: James Gu <james.gu@att.com>
-rw-r--r--site/intel-pod17/networks/physical/networks.yaml10
-rw-r--r--site/intel-pod17/profiles/region.yaml4
-rw-r--r--site/intel-pod17/secrets/certificates/certificates.yaml3
3 files changed, 11 insertions, 6 deletions
diff --git a/site/intel-pod17/networks/physical/networks.yaml b/site/intel-pod17/networks/physical/networks.yaml
index 3cebeae..b8e1ea8 100644
--- a/site/intel-pod17/networks/physical/networks.yaml
+++ b/site/intel-pod17/networks/physical/networks.yaml
@@ -9,20 +9,20 @@
# +--------+------------+-----------------------------------+-----------+----------+----------------+
# |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 |
+# |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 Airshipi/OPNFV deployments, you should not need to modify the
+# For standard Airship/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
+# See https://airship-drydock.readthedocs.io/en/latest/topology.html#defining-networking
schema: 'drydock/NetworkLink/v1'
metadata:
@@ -33,7 +33,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
- # MaaS doesnt own this network like it does the others,
+ # MaaS doesn't own this network like it does the others,
# so the noconfig label is specified.
labels:
noconfig: enabled
@@ -227,6 +227,7 @@ metadata:
storagePolicy: cleartext
data:
# NEWSITE-CHANGEME: Set the VLAN ID which the Private network is on
+ # use '0' if the vlan is untagged
vlan: '0'
mtu: 1500
# NEWSITE-CHANGEME: Set the CIDR for the Private network
@@ -296,6 +297,7 @@ metadata:
storagePolicy: cleartext
data:
# NEWSITE-CHANGEME: Set the VLAN ID which the Storage network is on
+ # use '0' if the vlan is untagged
vlan: '0'
# NEWSITE-CHANGEME: Ensure the network switches in the environment are
# configured for this MTU or greater.
diff --git a/site/intel-pod17/profiles/region.yaml b/site/intel-pod17/profiles/region.yaml
index 317f29a..cb68a0a 100644
--- a/site/intel-pod17/profiles/region.yaml
+++ b/site/intel-pod17/profiles/region.yaml
@@ -1,5 +1,5 @@
---
-# The purpose of this file is to define the drydock Region, which in turn drives
+# The purpose of this file is to define the Drydock Region, which in turn drives
# the MaaS region.
schema: 'drydock/Region/v1'
metadata:
@@ -17,7 +17,7 @@ metadata:
schema: pegleg/SoftwareVersions/v1
name: software-versions
path: .packages.repositories.main_archive
- # NEWSITE-CHANGEME: Substitutions from deckhand SSH public keys into the
+ # NEWSITE-CHANGEME: Substitutions from Deckhand SSH public keys into the
# list of authorized keys which MaaS will register for the build-in "ubuntu"
# account during the PXE process. Create a substitution rule for each SSH
# key that should have access to the "ubuntu" account (useful for trouble-
diff --git a/site/intel-pod17/secrets/certificates/certificates.yaml b/site/intel-pod17/secrets/certificates/certificates.yaml
index a7aed5d..de52351 100644
--- a/site/intel-pod17/secrets/certificates/certificates.yaml
+++ b/site/intel-pod17/secrets/certificates/certificates.yaml
@@ -1,4 +1,7 @@
---
+---
+# Example manifest for cert.
+# NEWSITE-CHANGEME: must be replaced with proper/valid set,
data: |
-----BEGIN CERTIFICATE-----
MIIDSDCCAjCgAwIBAgIUfRKmWCzUMEz+Qyn9PzxOdl+Oqv8wDQYJKoZIhvcNAQEL