[CORD-1924]
Documentation followup patch
Change-Id: I4387182ca58fa3fbb6ebda12f94f46e1a847e68f
(cherry picked from commit 144027fe2249450b7a95b2171e0dcf8540703789)
diff --git a/podconfig/rcord-physical-example.yml b/podconfig/rcord-physical-example.yml
index d7d1d6d..2a63216 100644
--- a/podconfig/rcord-physical-example.yml
+++ b/podconfig/rcord-physical-example.yml
@@ -24,6 +24,9 @@
vagrant_vms:
- 'corddev'
+# NOTE: Many of these items are described in more detail in the Build System
+# Variable Glossary: https://guide.opencord.org/build_glossary.html
+
# Location of the cord_profile directory to be mounted in the `corddev` VM by
# Vagrant.
#
@@ -31,22 +34,32 @@
# Set these directory paths if the defaults aren't suitable, or if deploying
# multiple pods from the same source tree where the credentials, keys, and
-# profile should differ.
+# profile should differ. These are paths on the config node.
#
# credentials_dir: '/path_to/credentials'
# pki_dir: '/path_to/pki'
# ssh_pki_dir: '/path_to/ssh_pki'
-# Variables
-# IP address used for the ONOS Fabric
-fabric_ip: '10.6.1.1/24'
+# Variables. Default values are specified here
-# IP and range of the management network, which MaaS serves DHCP
-management_ip: '10.6.0.1/24'
-management_network: '10.6.0.0/24'
+# IP address used for the ONOS fabric interface on the head node
+#
+# fabric_ip: '10.6.1.0/24'
-# External gateway IP address and range that the head node is on
-external_ip: '10.80.1.1/24'
+# Low and high addresses to assign to on the fabric
+#
+# fabric_range_low: '10.6.1.2'
+# fabric_range_high: '10.6.1.100'
+
+# IP and range of the management network, which MaaS serves DHCP.
+#
+# management_ip: '10.6.0.0/24'
+# management_network: '10.6.0.0/24'
+
+# Low and high addresses to assign to on the management network
+#
+# management_range_low: '10.6.0.2'
+# management_range_high: '10.6.0.127'
# name or IP of the POD head node, used to SSH to the head node. You can also
# specify the head node user here in user@hostname format. This could also be
@@ -54,27 +67,47 @@
# external DNS is set up.
headnode: 'cord@10.80.1.200'
-# the external IP on the head node and docker registry (on the head node)
-external_gw: '10.80.1.200'
+# External interface device name on head node
+external_iface: 'eth2'
+
+# External interface ip/range on head node
+external_ip: '10.80.1.200/24'
+
+# Gateway IP address
+external_gw: '10.80.1.1'
+
+# address and port of docker registry (on the head node)
deploy_docker_registry: "10.80.1.200:5000"
-# Makefile targets
-# primary build target (the final MaaS build step in this case)
-build_targets:
- - 'setup-automation'
+# Additional network config documentation can be found here:
+# https://guide.opencord.org/appendix_network_settings.html
-copy_cord_prereqs:
- - 'config-ssh-key'
+# Additional makefile targets
+# key-based SSH auth is required for some portions of the build, specifically
+# the 'synchronize' task. Enable this to generate a SSH key on the config node
+# and have the head node trust it.
+# copy_cord_prereqs:
+# - 'config-ssh-key'
+
+# skipTags is used in MaaS options allow various part of the deployment to be skipped
+#
+# switch_support - does not deploy switch boot images to the PXE server
+#
+# reboot - will not reboot the head node after updating its network configuration
+# this may mean the network configuration will not take effect, but will
+# also prevent you from being locked out of the server if there is a
+# network configuration error.
+#
+# interface_config - will not modify the network configuration of the head node,
+# including the consistent naming of the network interfaces
skipTags:
- - 'set_compute_node_password'
-
-# Wait until headnode prepped before building containers, for consistent DNS
-docker_images_prereqs:
- - 'prep-headnode'
+# - 'switch_support'
+# - 'reboot'
+# - 'interface_config'
# Inventory for ansible, used to generate inventory.ini
-# There must be a config, build, head, and compute sections
+# There must be config, build, head, and compute sections
inventory_groups:
config:
@@ -86,10 +119,17 @@
head:
headnode.site1.opencord.org:
- ansible_host: 10.80.1.200
- ansible_port: 22
- ansible_user: cord
- ansible_ssh_pass: cordpass
+# If you do not have DNS set up that will resolve the headnode address, you can
+# specify the IP address here.
+#
+# ansible_host: 10.80.1.200
+#
+# Set these if you don't have SSH keys set up between the config node (where
+# make runs) and the head node. Also, make sure to enable the 'config-ssh-key'
+# further up in the file to create these.
+#
+# ansible_user: cord
+# ansible_ssh_pass: cordpass
compute:
diff --git a/podconfig/rcord-physical.yml b/podconfig/rcord-physical.yml
deleted file mode 100644
index dba8023..0000000
--- a/podconfig/rcord-physical.yml
+++ /dev/null
@@ -1,83 +0,0 @@
----
-
-# Copyright 2017-present Open Networking Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-# rcord-physical-example Pod Config
-# Example configuration for a physical R-CORD pod
-
-cord_scenario: cord
-cord_profile: rcord
-
-
-vagrant_vms:
- - corddev
-
-# Variables
-credentials_dir: '/opt/credentials'
-pki_dir: '/opt/pki'
-ssh_pki_dir: '/opt/ssh_pki'
-
-fabric_ip: '10.6.1.1/24'
-management_ip: '10.6.0.1/24'
-external_ip: '10.90.0.252/16'
-external_gw: '10.90.0.1'
-external_iface: 'eth0'
-management_network: 10.6.0.0/24
-
-deploy_docker_registry: "10.90.0.252:5000"
-
-headnode: cord@10.90.0.252
-
-# NOTE: The `host_cord_profile_dir` variable below is the path to the cord_profile dir that
-# gets mounted to corddev VM.This `cord_profile` dir typically lives in a directory
-# one level up from the `cord` directory
-host_cord_profile_dir: "~/dev/cord_profile"
-
-skipTags:
- - 'set_compute_node_password'
- - 'switch_support'
-
-# Wait until headnode prepped before building containers, for consistent DNS
-docker_images_prereqs:
- - prep-headnode
-
-copy_cord_prereqs:
- - config-ssh-key
-
-# node topology
-physical_node_list:
- - name: head1
- aliases:
- - head
-
-# Inventory for ansible, used to generate inventory.ini
-inventory_groups:
-
- config:
- localhost:
- ansible_connection: local
-
- build:
- corddev:
-
- head:
- head1:
- ansible_host: 10.90.0.252
- ansible_port: 22
- ansible_user: cord
- ansible_ssh_pass: cord
-
- compute:
diff --git a/podconfig/rcord-virtual-buildlocal.yml b/podconfig/rcord-virtual-buildlocal.yml
deleted file mode 100755
index cb0e1bd..0000000
--- a/podconfig/rcord-virtual-buildlocal.yml
+++ /dev/null
@@ -1,72 +0,0 @@
-
-# Copyright 2017-present Open Networking Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
----
-# rcord-virtual Pod Config
-# Creates a virtual multi-node R-CORD pod, aka "rcord-in-a-box"
-# Uses the local server as the "build host", assumes Ubuntu 14.04 server
-
-cord_scenario: cord
-cord_profile: rcord
-
-buildnode: localhost
-
-prep_buildnode_prereqs:
- - build-local-bootstrap
-
-vagrant_up_prereqs:
- - prereqs-check
- - ciab-ovs
-
-# Override setting in scenarios/cord/config.yml with noop
-docker_image_prereqs:
- - prep-buildnode
-
-deploy_docker_registry: "10.100.198.201:5000"
-
-external_iface: 'eth0'
-
-build_targets:
- - compute1-up
-
-skipTags:
- - 'set_compute_node_password'
- - 'switch_support'
- - 'reboot'
- - 'interface_config'
-
-# Other old config carried over
-cord_in_a_box: True # what is this for?
-fabric_include_names: eth2
-fabric_include_module_types: omit
-fabric_exclude_names: eth0,eth1
-management_include_names: eth1
-management_exclude_names: eth0,eth2
-
-inventory_groups:
-
- config:
- localhost:
- ansible_connection: local
-
- build:
- localhost:
- ansible_connection: local
-
- head:
- head1:
-
- compute: