This page documents all the configuration variables that can be set in a POD config, scenario, or profile_manifests.
These variables are used in and apply to the following repositories:
CIDR address for Public AddressPool
MAC address prefix for Public AddressPool
CIDR address for vSG AddressPool
MAC address prefix for vSG AddressPool
DNS name for the apt-cacher-ng server used by compute nodes and LXC containers on head node.
Port number used for apt-cacher-ng.
APT package sources are on HTTPS servers. These bypass apt-cacher-ng, which can't proxy SSL connections.
Directory on the build node that the cord directory (root directory checked out by repo) is copied to.
Tag applied to all built (and downloaded standalone) Docker images.
Domain ID prefix added to TOSCA that is used to configure the E-CORD CarrierEthernet app.
Name of the digest (aka "hash") algorithm used when creating CA SSL certificates.
Length of time in days that an Intermediate Certificate Authority cert will be valid for.
The passphrase (password) used to encrypt the Intermediate Certificate Authority's private key.
The subject (name in the certificate) of the Intermediate Certificate Authority.
Length of time in days that the Root Certificate Authority cert will be valid for.
The passphrase (password) used to encrypt the Root Certificate Authority's private key. Default is for this to be autogenerated by the password lookup in ansible and stored in credentials_dir.
The subject (name in the certificate) of the Root Certificate Authority.
Size of the keys used in generating the CA certificates, in bits.
Length of times that a standard server/client certificate will be valid for
Name of the digest (aka "hash") algorithm used when creating SSL certificates.
Size of the keys used in generating the server/client certificates, in bits.
List of Juju charms and the versions used.
List of client SSL certificates to generate
Filesystem device to use for extra space when on CloudLab
Symbolic links to create to use the extra space that is mounted when using CloudLab
List of possible VTN external interfaces on the compute node, for setting up OpenStack with the VTN ML2 plugin.
Location of the cord directory on the config node. See also build_cord_dir.
Location of the cord_profile directory on the config node.
Version of the CORD config ONOS app to use
Used to determine if this is a Cord-in-a-Box virtual pod installation
Version of the CORD VTN ONOS app to use
The location of the credentials_dir directory on the head node
Boolean value, whether or not to delete the cord_profile directory when tearing down XOS on a pod
DNS name or IP address of the Docker Registry
Tag used to identify which docker images to use when performing a deployment.
Names of OpenStack "flavors" of VM's that can be deployed.
Deployment type, used in XOS to identify the type of deployment.
Used to configure the DHCP server used in OpenCloud and other non-MaaS deployments.
Domaing to check when performing the prerequisite check.
DNS record returned when dns_check_domain is looked up for DNS resolution prerequisite check.
Which domain suffixes to search for hosts in (non-MaaS)
IP addresses of DNS servers
Time-to-live for DNS entries when using NSD (non-MaaS)
Name of the Docker APT repo to install Docker from
Options to provide to Docker to configure the
DPDK option to set which CPU cores to use. More documentation at: http://docs.openvswitch.org/en/latest/intro/install/dpdk/#setup-ovs
DPDK option concerning memory allocation.
List of GUI extensions enabled and loaded into the Web UI
Name of the blueprint to use with the M-CORD EPC service.
List of instances to wait for when testing the EPC service.
External VTN interfaces connected to the fabric switches.
Physical interfaces connected to the VTN fabric network switches.
Filename of the JSON file used to configure the Fabric ONOS.
frontend_only suppresses starting synchronzier containers as a part of the XOS container set. It is used in testing scenarios where synchronizers aren't needed.
List of gerrit
Partial URI to the API endpoint used by the GUI to contact the XOS API
Backgrund image used behind login screen when logging into XOS.
Favicon used in URL bar for XOS web UI.
Logo used in XOS web UI.
Text below the Logo in the XOS web UI.
Name of the type of POD being deployed, shown in XOS UI.
Links given in the top-level of the XOS web UI to specific objects, to feature them in the sidebar.
URI path used by XOS web UI for the websocket connection.
Port on the XOS ws container for XOS UI connections
Location on the headnode where the cord directory is copied.
Location on the headnode where the cord_profile directory is copied.
Location on the headnode where the credentials diretory is copied.
List of LXD containers (for Juju/OpenStack) to create.
Location on the headnode to create the mavenrepo directory, which contains the docker-compose.yml file for the Maven repo docker container that serves up ONOS Apps to the ONOS instances on the headnode.
Location on the headnode to create the onos_cord directory, which contains configuration and the docker-compose.yml file for starting the ONOS instance that runs the VTN app.
Location on the headnode to create the onos_fabric directory, which contains configuration and the docker-compose.yml file for starting the ONOS instance that runs the Fabric app.
Contains the XOS admin password, used for loading TOSCA into XOS. Can't use the standard xos_admin_pass as these playbooks are run from a context (like the MaaS provisioning container) where they may not have access to the same file with the password.
DNS Name of the headnode on the system, used to configure NSD DNS aliases.
Network interface on the head node that is connected to the internet. NAT is performed on this interface giving the other nodes on the network access (mainly for nodes on the management network).
DPDK setting to control memory allocation.
MAC address prefix used when creating LXD containers, to assign them DHCP addresses.
Directory to download OpenStack glance images into on the head node.
Path to Juju configuration file.
Password for OpenStack Keystone admin user.
Whether or not to perform a check for processor virtualization features required for the KVM hypervisor to work.
Port used by ONOS containers for sending log4j logging messages to ElasticStack.
Hostname (or IP) for the ElasticStack logging host machine.
CIDR for the management_hosts VTN network.
Last IP address to assign as a part of the management_hosts VTN network.
First IP address to assign as a part of the management_hosts VTN network.
CIDR of the head node management network that connects between the OpenStack LXC containers and compute nodes.
CIDR for VTN MANAGEMENT_LOCAL network
List of physical interfaces on a node connected to the management network. These are bonded together into mgmtbond.
Email address used when licensing the NG40 tester software.
Login used with the NG40 tester software.
Password used with the NG40 tester software.
First 3 octets of the IP address of the management network.
Minimum amount of memory to allow for a full virtual POD to be built with.
Minimum number of CPU's to allow for a full virtual POD to be built with.
Path to the nsd.conf file for configuring the NSD authoritative nameserver.
Group used by the NSD nameserver.
IP address of the NSD nameserver. Usually this is set to the loopback address, as Unbound runs on the external interfaces.
Port that NSD will listen on.
Configuration of DNS Zones that NSD provides authoritative DNS lookups for.
Directory where DNS Zone files are kept for NSD.
Port used for SSH connections to the ONOS CORD instance.
Names of ONOS Apps loaded to change the logging level on for debugging purposes.
The logging level (INFO, DEBUG, TRACE, etc.) to set ONOS Apps listed in onos_debug_appnames.
Name of the docker image used to bring up ONOS containers.
Default logging level ONOS should log at.
URL for the mavenrepo deployed as a part of the POD, where ONOS instances will download apps from.
List of physical nodes to set up in DNS.
Location where SSL certificates are generated on the config node. Contains subdirectories for root and intermediate CA certificates.
DPDK setting for CPU pinning.
Name of the SSH key generated to be used by the pod, specifically for logging into instance VM's that are brought up.
The name of the profile-specific onboarding TOSCA file.
DNS Name or IP of the Docker Registry to pull images from.
Tag for pulling Docker images.
Checksum of the repo download.
URL of repo to download.
URL of Gerrit manifest repository that repo fetches it's list of git repositories from.
When using python's requests module, name of the CA certificate bundle file to use to validate SSL certificates.
Whether or not to run apt-get dist-upgrrade on a system in the course of setting it up.
List of SSL certificates to generate for server use.
Human readable name to use for the CORD site.
Machine readable name to use for the CORD site. This should be one word, without spaces.
The DNS suffix applied to all machines created for this site. Must be a valid DNS name.
The passphrase used to encrypt the Root CA key when creating a SSL hierarchy.
Names of SSH Client keys to generate and sign by the SSH CA.
Names of SSH Host keys to generatte and sign by the SSH CA.
Size in bits of SSH keys to generate
The key type of the SSH keys. rsa is used currently, may change this as support for newer key algorithms is added to the underlying platform.
Directory where SSH keys are generated.
SSL certificate prefix substring to use when generating certificates.
List of OpenStack Neutron networks to check for. Currently only used in the test-mcord-base role.
List of OpenStack Neutron network ports on VM's to check for. Currently only used in the test-mcord-base role.
List of active OpenStack Nova VM instances to check for. Currently only used in the test-mcord-base role.
Java KeyStore password used for encrypting SSL certificates. This currently doesn't contain any secure certificates, just the generated CA root/intermediate certificates for validation of SSL connections.
Path for the Unbound recursive DNS resolver configuration file.
Group name used by Unbound server.
Toggle for listening on first IP address listed in the nsd_zones list.
Whether Unbound should listen on all available network interfaces.
Whether Unbound should listen on the default gateway interface (as known to Ansible).
Toggle whether to create the Public AddressPool NAT interface
Toggle whether to create the VSG AddressPool NAT interface
Enables the use of apt-cacher-ng to cache APT packages on Head/LXC/Compute nodes.
Enable DPDK in OpenStack Nova and Neutron
Start and use ONOS in a container to manage fabric switches
Use MaaS to manage compute nodes and switches.
Whether the management_hosts network type in VTN should be enabled.
Bring up and use OpenStack to manage VM's.
Use redis as a message bus inside XOS.
Use the ONOS VTN app to manage networks for virtual instances.
Whether to enable the VTN FABRIC network.
Whether to enable the VTN MANAGEMENT_HOST network.
DPDK setting to specify CPU pinning.
DNS name of the server to ping when running the vSG portion of the pod-test.
Physical interface network used for the VTN data plane.
MAC address prefix for interfaces on the VTN MANAGEMENT_HOST network.
Network interface to use on the head/compute nodes for the management_host network.
CIDR for the MANAGEMENT_HOST VTN network.
CIDR for the PUBLIC VTN network.
MAC address prefix for interfaces on the VTN PUBLIC network.
First name of the XOS Admin user
Last tname of the XOS Admin user
Password of the XOS Admin user (autogenerated by default)
Username (email) of the XOS Admin user
Port to connect to to bootstrap the XOS interface.
Port used by Chameleon in XOS.
XOS Postgres database name
XOS Postgres database password.
XOS Postgres database username.
Path of XOS directory within Docker containers.
Name of networks created in Docker for XOS containers.
Textual set of constraints that controls how the service graph is displayed in the GUI. Guide for writing constraints.
List of OpenStack Glance images in QCOW2 format that are downloaded.
List of templates to generate when creating the cord_profile directory.
List of XOS services to load, including the name, path and whether SSH keypairs should be included for the services.
List of XOS tosca templates to load that make up the service graph of a profile.
List of XOS tosca templates to load that make up the service graph of a profile. Deprecated, see: xos_tosca_config_templates
URL for the XOS TOSCA API endpoint
XOS Web UI port to use for API access.
List of additional users to create in XOS, in addition to xos_admin_user.