Build System Config Glossary
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:
- cord (aka "build" when checked out)
- maas
- platform-install
apt_cacher_name
DNS name for the apt-cacher-ng server used by compute nodes and LXC containers on head node.
Default value:
apt_cacher_name: apt-cache
Used in:
- platform-install/roles/apt-cacher-ng/defaults/main.yml
- platform-install/roles/lxd-finish/defaults/main.yml
apt_cacher_port
Port number used for apt-cacher-ng.
Default value:
apt_cacher_port: 3142
Used in:
apt_ssl_sites
APT package sources are on HTTPS servers. These bypass apt-cacher-ng, which can't proxy SSL connections.
Default value:
apt_ssl_sites:
- apt.dockerproject.org
- download.docker.com
- butler.opencloud.cs.arizona.edu
- deb.nodesource.com
- artifacts.elastic.co
Used in:
build_cord_dir
Directory on the build
node that the cord
directory (root directory checked
out by repo
) is copied to.
Default value:
build_cord_dir: '{{ playbook_dir ~ ''/../..'' }}'
Used in:
build_docker_tag
Tag applied to all built (and downloaded standalone) Docker images.
Default value:
build_docker_tag: candidate
Used in:
- platform-install/roles/xos-core-build/defaults/main.yml
- platform-install/roles/xos-core-publish/defaults/main.yml
ca_digest
Name of the digest (aka "hash") algorithm used when creating CA SSL certificates.
Default value:
ca_digest: sha256
Used in:
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/pki-root-ca/defaults/main.yml
ca_im_days
Length of time in days that an Intermediate Certificate Authority cert will be valid for.
Default value:
ca_im_days: 730
Used in:
ca_im_phrase
The passphrase (password) used to encrypt the Intermediate Certificate Authority's private key.
Default value:
ca_im_phrase: '{{ lookup(''password'', credentials_dir ~ ''/ca_im_phrase length=64'')
}}'
Used in:
ca_im_subj
The subject (name in the certificate) of the Intermediate Certificate Authority.
Default value:
ca_im_subj: /C=US/ST=California/L=Menlo Park/O=ON.Lab/OU=Test Deployment/CN={{ site_humanname
}} Intermediate CA
Used in:
ca_root_days
Length of time in days that the Root Certificate Authority cert will be valid for.
Default value:
ca_root_days: 3650
Used in:
ca_root_phrase
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.
Default value:
ca_root_phrase: '{{ lookup(''password'', credentials_dir ~ ''/ca_root_phrase length=64'')
}}'
Used in:
ca_root_subj
The subject (name in the certificate) of the Root Certificate Authority.
Default value:
ca_root_subj: /C=US/ST=California/L=Menlo Park/O=ON.Lab/OU=Test Deployment/CN=CORD
Test Deployment Root CA
Used in:
ca_size
Size of the keys used in generating the CA certificates, in bits.
Default value:
ca_size: 4096
Used in:
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/pki-root-ca/defaults/main.yml
carrierethernet_domainid_prefix
Domain ID prefix added to TOSCA that is used to configure the E-CORD CarrierEthernet app.
Default value:
carrierethernet_domainid_prefix: '{{ site_name }}'
Used in:
cert_days
Length of times that a standard server/client certificate will be valid for
Default value:
cert_days: 365
Used in:
cert_digest
Name of the digest (aka "hash") algorithm used when creating SSL certificates.
Default value:
cert_digest: sha256
Used in:
cert_size
Size of the keys used in generating the server/client certificates, in bits.
Default value:
cert_size: 2048
Used in:
charm_versions
List of Juju charms and the versions used.
Default value:
charm_versions: {}
Used in:
- platform-install/roles/juju-compute-setup/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
client_certs
List of client SSL certificates to generate
Default value:
client_certs: []
Used in:
cloudlab_extrafs
Filesystem device to use for extra space when on CloudLab
Default value:
cloudlab_extrafs:
- dev: /dev/sdb
mount: /mnt/extra
Used in:
cloudlab_links
Symbolic links to create to use the extra space that is mounted when using CloudLab
Default value:
cloudlab_links:
- dest: /var/lib/lxc
src: /mnt/extra/lxc
- dest: /var/lib/lxd
src: /mnt/extra/lxd
- dest: /var/lib/nova
src: /mnt/extra/nova
- dest: /var/lib/juju
src: /mnt/extra/juju
Used in:
compute_external_interfaces
List of possible VTN external interfaces on the compute node, for setting up OpenStack with the VTN ML2 plugin.
Default value:
compute_external_interfaces:
- fabric
- br-int
Used in:
config_cord_dir
Location of the cord
directory on the config node. See also
build_cord_dir.
Default value:
config_cord_dir: /opt/cord
Used in:
- platform-install/roles/api-tests/defaults/main.yml
- platform-install/roles/copy-cord/defaults/main.yml
- platform-install/roles/monitoringservice-config/defaults/main.yml
- platform-install/roles/repo/defaults/main.yml
config_cord_profile_dir
Location of the cord_profile
directory on the config node.
Default value:
config_cord_profile_dir: /opt/cord_profile
Used in:
- platform-install/roles/copy-profile/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-configdirs-become/defaults/main.yml
cord_config_app_version
Version of the CORD config ONOS app to use
Default value:
cord_config_app_version: 1.3.0
Used in:
cord_in_a_box
Used to determine if this is a Cord-in-a-Box virtual pod installation
Default value:
cord_in_a_box: false
Used in:
cord_vtn_app_version
Version of the CORD VTN ONOS app to use
Default value:
cord_vtn_app_version: 1.3.0
Used in:
credentials_dir
The location of the credentials_dir
directory on the head node
Default value:
credentials_dir: '{{ playbook_dir }}/credentials'
Used in:
- platform-install/roles/copy-credentials/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-configdirs-become/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/pki-root-ca/defaults/main.yml
- platform-install/roles/ssh-pki/defaults/main.yml
- platform-install/roles/vtn-refresh/defaults/main.yml
delete_cord_profile_dir
Boolean value, whether or not to delete the cord_profile
directory when
tearing down XOS on a pod
Default value:
delete_cord_profile_dir: false
Used in:
deploy_docker_registry
DNS name or IP address of the Docker Registry
Default value:
deploy_docker_registry: ''
Used in:
deploy_docker_tag
Tag used to identify which docker images to use when performing a deployment.
Default value:
deploy_docker_tag: candidate
Used in:
- platform-install/roles/pull-xos-docker-images/defaults/main.yml
- platform-install/roles/xos-core-publish/defaults/main.yml
deployment_flavors
Names of OpenStack "flavors" of VM's that can be deployed.
Default value:
deployment_flavors:
- m1.small
- m1.medium
- m1.large
- m1.xlarge
Used in:
deployment_type
Deployment type, used in XOS to identify the type of deployment.
Default value:
deployment_type: placeholder-deploymenttype
Used in:
- platform-install/roles/compute-node-config/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
dhcpd_subnets
Used to configure the DHCP server used in OpenCloud and other non-MaaS deployments.
Default value:
dhcpd_subnets:
- cidr: '{{ mgmt_ipv4_first_octets }}.1/24'
dhcp_first: 129
dhcp_last: 254
interface: mgmtbr
other_static:
- physical_node_list
- head_lxd_list
Used in:
dns_check_domain
Domaing to check when performing the prerequisite check.
Default value:
dns_check_domain: corddnscheck.opencord.org
Used in:
dns_check_record
DNS record returned when dns_check_domain is looked up for DNS resolution prerequisite check.
Default value:
dns_check_record: wiki.opencord.org.
Used in:
dns_search
Which domain suffixes to search for hosts in (non-MaaS)
Default value:
dns_search:
- '{{ site_suffix }}'
Used in:
dns_servers
IP addresses of DNS servers
Default value:
dns_servers:
- '{{ mgmt_ipv4_first_octets }}.1'
Used in:
dns_ttl
Time-to-live for DNS entries when using NSD (non-MaaS)
Default value:
dns_ttl: 3600
Used in:
docker_apt_repo
Name of the Docker APT repo to install Docker from
Default value:
docker_apt_repo: deb [arch=amd64] https://download.docker.com/linux/ubuntu {{ ansible_distribution_release
}} stable
Used in:
docker_opts
Options to provide to Docker to configure the
Default value:
docker_opts: ''
Used in:
dpdk_lcore_mask
DPDK option to set which CPU cores to use. More documentation at: http://docs.openvswitch.org/en/latest/intro/install/dpdk/#setup-ovs
Default value:
dpdk_lcore_mask: '0x1'
Used in:
dpdk_socket_memory
DPDK option concerning memory allocation.
Default value:
dpdk_socket_memory: 1024,0
Used in:
enabled_gui_extensions
List of GUI extensions enabled and loaded into the Web UI
Default value:
enabled_gui_extensions: []
Used in:
epc_blueprint
Default value:
epc_blueprint: build
Used in:
epc_sync_objects
Default value:
epc_sync_objects: []
Used in:
fabric_interfaces
External VTN interface connected to the fabric switches.
Default value:
fabric_interfaces: eth2
Used in:
fabric_network_cfg_json
Filename of the JSON file used to configure the Fabric ONOS.
Default value:
fabric_network_cfg_json: /opt/cord_profile/fabric-network-cfg.json
Used in:
frontend_only
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.
Default value:
frontend_only: false
Used in:
frontmatter
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:
- cord (aka "build" when checked out)
- maas
- platform-install
Default value:
Used in:
gerrit_changesets
List of gerrit
Default value:
gerrit_changesets: []
Used in:
gui_api_endpoint
Partial URI to the API endpoint used by the GUI to contact the XOS API
Default value:
gui_api_endpoint: /xosapi/v1
Used in:
gui_background
Backgrund image used behind login screen when logging into XOS.
Default value:
gui_background: cord-bg.jpg
Used in:
gui_favicon
Favicon used in URL bar for XOS web UI.
Default value:
gui_favicon: cord-favicon.png
Used in:
gui_logo
Logo used in XOS web UI.
Default value:
gui_logo: cord-logo.png
Used in:
gui_payoff
Text below the Logo in the XOS web UI.
Default value:
gui_payoff: Your VNF orchestrator
Used in:
gui_project_name
Name of the type of POD being deployed, shown in XOS UI.
Default value:
gui_project_name: R-CORD
Used in:
gui_routes
Links given in the top-level of the XOS web UI to specific objects, to feature them in the sidebar.
Default value:
gui_routes:
- label: Slices
state: xos.core.slice
- label: Nodes
state: xos.core.node
- label: Instances
state: xos.core.instance
Used in:
gui_websocket
URI path used by XOS web UI for the websocket connection.
Default value:
gui_websocket: /
Used in:
gw_port
Port on the XOS ws container for XOS UI connections
Default value:
gw_port: 3000
Used in:
head_cord_dir
Location on the headnode where the cord
directory is copied.
Default value:
head_cord_dir: /opt/cord
Used in:
- platform-install/roles/automation-integration/defaults/main.yml
- platform-install/roles/copy-cord/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/exampleservice-config/defaults/main.yml
- platform-install/roles/monitoringservice-config/defaults/main.yml
head_cord_profile_dir
Location on the headnode where the cord_profile
directory is copied.
Default value:
head_cord_profile_dir: /opt/cord_profile
Used in:
- platform-install/roles/compute-node-config/defaults/main.yml
- platform-install/roles/compute-node-enable-maas/defaults/main.yml
- platform-install/roles/compute-node-enable/defaults/main.yml
- platform-install/roles/copy-profile/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/exampleservice-config/defaults/main.yml
- platform-install/roles/monitoringservice-config/defaults/main.yml
- platform-install/roles/monitoringservice-onboard/defaults/main.yml
- platform-install/roles/teardown-xos/defaults/main.yml
- platform-install/roles/test-ecord-subscriber-config/defaults/main.yml
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/test-mcord-base/defaults/main.yml
- platform-install/roles/test-subscriber-config/defaults/main.yml
- platform-install/roles/xos-bootstrap-hosts/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
- platform-install/roles/xos-onboard-hosts/defaults/main.yml
- platform-install/roles/xos-onboard-test-hosts/defaults/main.yml
- platform-install/roles/xos-up/defaults/main.yml
head_credentials_dir
Location on the headnode where the credentials
diretory is copied.
Default value:
head_credentials_dir: /opt/credentials
Used in:
- platform-install/roles/copy-credentials/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
head_lxd_list
List of LXD containers (for Juju/OpenStack) to create.
Default value:
head_lxd_list: []
Used in:
- platform-install/roles/create-lxd/defaults/main.yml
- platform-install/roles/dhcpd/defaults/main.yml
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
head_mavenrepo_dir
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.
Default value:
head_mavenrepo_dir: /opt/mavenrepo
Used in:
head_onos_cord_dir
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.
Default value:
head_onos_cord_dir: /opt/onos_cord
Used in:
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/teardown-onos/defaults/main.yml
head_onos_fabric_dir
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.
Default value:
head_onos_fabric_dir: /opt/onos_fabric
Used in:
- platform-install/roles/onos-fabric-install/defaults/main.yml
- platform-install/roles/teardown-onos/defaults/main.yml
headnode_dns
DNS Name of the headnode on the system, used to configure NSD DNS aliases.
Default value:
headnode_dns: head1
Used in:
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
hugepages
DPDK setting to control memory allocation.
Default value:
hugepages: 60%
Used in:
hwaddr_prefix
MAC address prefix used when creating LXD containers, to assign them DHCP addresses.
Default value:
hwaddr_prefix: c2a4
Used in:
image_dir
Directory to download OpenStack glance images into on the head node.
Default value:
image_dir: /opt/images
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/glance-images/defaults/main.yml
juju_config_path
Path to Juju configuration file.
Default value:
juju_config_path: /usr/local/src/juju_config.yml
Used in:
- platform-install/roles/juju-compute-setup/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
keystone_admin_password
Password for OpenStack Keystone admin
user.
Default value:
keystone_admin_password: '{{ lookup(''password'', credentials_dir ~ ''/cord_keystone_admin
chars=ascii_letters,digits'') }}'
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
- platform-install/roles/setup-nova-dpdk/defaults/main.yml
- platform-install/roles/vtn-refresh/defaults/main.yml
kvm_check
Whether or not to perform a check for processor virtualization features required for the KVM hypervisor to work.
Default value:
kvm_check: true
Used in:
log4j_port
Port used by ONOS containers for sending log4j logging messages to ElasticStack.
Default value:
log4j_port: 4560
Used in:
logging_host
Hostname (or IP) for the ElasticStack logging host machine.
Default value:
logging_host: cordloghost
Used in:
maas_xos_admin_pass
Contains the XOS admin password, used for loading TOSCA with up MaaS. Can't use the standard xos_admin_pass as these playbooks are run from the MaaS provisioner container.
Default value:
maas_xos_admin_pass: '{{ lookup(''file'', ''/opt/credentials/xosadmin@opencord.org'')
}}'
Used in:
- platform-install/roles/compute-node-enable-maas/defaults/main.yml
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/test-mcord-base/defaults/main.yml
management_hosts_net_cidr
CIDR for the management_hosts VTN network.
Default value:
management_hosts_net_cidr: 10.1.0.1/24
Used in:
management_hosts_net_range_xos_high
Last IP address to assign as a part of the management_hosts VTN network.
Default value:
management_hosts_net_range_xos_high: 10.1.0.254
Used in:
management_hosts_net_range_xos_low
First IP address to assign as a part of the management_hosts VTN network.
Default value:
management_hosts_net_range_xos_low: 10.1.0.128
Used in:
management_network_cidr
CIDR of the head node management network that connects between the OpenStack LXC containers and compute nodes.
Default value:
management_network_cidr: 172.27.0.0/24
Used in:
mcord_ng40_license_email
Default value:
mcord_ng40_license_email: do.not.distribute@opennetworking.org
Used in:
mcord_ng40_login
Default value:
mcord_ng40_login: ng40
Used in:
mcord_ng40_password
Default value:
mcord_ng40_password: ng40
Used in:
mgmt_interface
Physical management network interface on head node.
Default value:
mgmt_interface: eth1
Used in:
mgmt_ipv4_first_octets
First 3 octets of the IP address of the management network.
Default value:
mgmt_ipv4_first_octets: 192.168.200
Used in:
- platform-install/roles/create-lxd/defaults/main.yml
- platform-install/roles/dhcpd/defaults/main.yml
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
- platform-install/roles/interface-config/defaults/main.yml
mgmt_name_reverse_unbound
The same value as mgmt_ipv4_first_octets but formatted for Unbound for use as a reverse DNS lookup zone.
Default value:
mgmt_name_reverse_unbound: 168.192.in-addr.arpa
Used in:
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
mgmtbr_ext_interface
Network interface on head node to add to the mgmtbr
bridge.
Default value:
mgmtbr_ext_interface: eth1
Used in:
mgmtbr_nat_interface
Network interface connected to the internet that NAT is performed on for
nodes that use the mgmtbr
bridge.
Default value:
mgmtbr_nat_interface: eth0
Used in:
min_memtotal_mb
Minimum amount of memory to allow for a full virtual POD to be built with.
Default value:
min_memtotal_mb: 48000
Used in:
min_processor_vcpus
Minimum number of CPU's to allow for a full virtual POD to be built with.
Default value:
min_processor_vcpus: 12
Used in:
nsd_conf
Path to the nsd.conf
file for configuring the NSD authoritative nameserver.
Default value:
nsd_conf: /etc/nsd/nsd.conf
Used in:
nsd_group
Group used by the NSD nameserver.
Default value:
nsd_group: nsd
Used in:
nsd_ip
IP address of the NSD nameserver. Usually this is set to the loopback address, as Unbound runs on the external interfaces.
Default value:
nsd_ip: 127.0.0.1
Used in:
nsd_zones
Configuration of DNS Zones that NSD provides authoritative DNS lookups for.
Default value:
nsd_zones:
- aliases:
- dest: '{{ headnode_dns }}'
name: apt-cache
- dest: '{{ headnode_dns }}'
name: cordloghost
- dest: '{{ headnode_dns }}'
name: consul
- dest: '{{ headnode_dns }}'
name: docker
- dest: '{{ headnode_dns }}'
name: mavenrepo
- dest: '{{ headnode_dns }}'
name: ns
- dest: '{{ headnode_dns }}'
name: ns1
- dest: '{{ headnode_dns }}'
name: onos-cord
- dest: '{{ headnode_dns }}'
name: onos-fabric
- dest: '{{ headnode_dns }}'
name: xos
- dest: '{{ headnode_dns }}'
name: xos-chameleon
- dest: '{{ headnode_dns }}'
name: xos-consul
- dest: '{{ headnode_dns }}'
name: xos-core
- dest: '{{ headnode_dns }}'
name: xos-gui
- dest: '{{ headnode_dns }}'
name: xos-tosca
- dest: '{{ headnode_dns }}'
name: xos-ws
ipv4_first_octets: '{{ mgmt_ipv4_first_octets }}'
name: '{{ site_suffix }}'
name_reverse_unbound: '{{ mgmt_name_reverse_unbound }}'
nodelists:
- head_lxd_list
- physical_node_list
ns:
- name: ns1
soa: ns1
Used in:
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
nsd_zonesdir
Directory where DNS Zone files are kept for NSD.
Default value:
nsd_zonesdir: /var/lib/nsd/zones
Used in:
onos_cord_port
Port used for SSH connections to the ONOS CORD
instance.
Default value:
onos_cord_port: 8102
Used in:
onos_debug_appnames
Names of ONOS Apps loaded to change the logging level on for debugging purposes.
Default value:
onos_debug_appnames:
- org.opencord.vtn
Used in:
onos_debug_level
The logging level (INFO
, DEBUG
, TRACE
, etc.) to set ONOS Apps listed in
onos_debug_appnames.
Default value:
onos_debug_level: TRACE
Used in:
onos_docker_image
Name of the docker image used to bring up ONOS containers.
Default value:
onos_docker_image: '{{ pull_docker_registry }}onosproject/onos:{{ pull_docker_tag
}}'
Used in:
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/onos-fabric-install/defaults/main.yml
onos_log_level
Default logging level ONOS should log at.
Default value:
onos_log_level: INFO
Used in:
onos_mavenrepo_url
URL for the mavenrepo deployed as a part of the POD, where ONOS instances will download apps from.
Default value:
onos_mavenrepo_url: '{{ ''http://mavenrepo.'' ~ site_suffix ~ '':8080'' }}'
Used in:
physical_node_list
List of physical nodes to set up in DNS.
Default value:
physical_node_list: []
Used in:
- platform-install/roles/dhcpd/defaults/main.yml
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
- platform-install/roles/interface-config/defaults/main.yml
pki_dir
Location where SSL certificates are generated on the config
node. Contains
subdirectories for root and intermediate CA certificates.
Default value:
pki_dir: '{{ playbook_dir }}/pki'
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-configdirs-become/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/pki-cert/defaults/main.yml
- platform-install/roles/pki-install/defaults/main.yml
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/pki-root-ca/defaults/main.yml
pmd_cpu_mask
DPDK setting for CPU pinning.
Default value:
pmd_cpu_mask: '0x2'
Used in:
pod_sshkey_name
Name of the SSH key generated to be used by the pod, specifically for logging into instance VM's that are brought up.
Default value:
pod_sshkey_name: headnode
Used in:
- platform-install/roles/ansible-install/defaults/main.yml
- platform-install/roles/compute-prep/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-lxd/defaults/main.yml
- platform-install/roles/head-prep/defaults/main.yml
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/ssh-install-maas/defaults/main.yml
- platform-install/roles/ssh-install/defaults/main.yml
- platform-install/roles/ssh-pki/defaults/main.yml
profile_library
The name of the profile-specific onboarding TOSCA file.
Default value:
profile_library: ''
Used in:
pull_docker_registry
DNS Name or IP of the Docker Registry to pull images from.
Default value:
pull_docker_registry: ''
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/mavenrepo-install/defaults/main.yml
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/onos-fabric-install/defaults/main.yml
pull_docker_tag
Tag for pulling Docker images.
Default value:
pull_docker_tag: candidate
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/mavenrepo-install/defaults/main.yml
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/onos-fabric-install/defaults/main.yml
repo_checksum
Checksum of the repo download.
Default value:
repo_checksum: sha256:e147f0392686c40cfd7d5e6f332c6ee74c4eab4d24e2694b3b0a0c037bf51dc5
Used in:
repo_dl_url
URL of repo
to download.
Default value:
repo_dl_url: https://storage.googleapis.com/git-repo-downloads/repo
Used in:
repo_manifest_url
URL of Gerrit manifest repository that repo
fetches it's list of git
repositories from.
Default value:
repo_manifest_url: https://gerrit.opencord.org/manifest
Used in:
requests_ca_bundle
When using python's requests module, name of the CA certificate bundle file to use to validate SSL certificates.
Default value:
requests_ca_bundle: /etc/ssl/certs/ca-certificates.crt
Used in:
run_dist_upgrade
Whether or not to run apt-get dist-upgrrade
on a system in the course of
setting it up.
Default value:
run_dist_upgrade: false
Used in:
- platform-install/roles/common-prep/defaults/main.yml
- platform-install/roles/lxd-finish/defaults/main.yml
server_certs
List of SSL certificates to generate for server use.
Default value:
server_certs:
- altnames:
- DNS:keystone.{{ site_suffix }}
- DNS:keystone
cn: keystone.{{ site_suffix }}
subj: '{{ ssl_cert_subj_prefix }}/CN=keystone.{{ site_suffix }}'
- altnames:
- DNS:xos-core.{{ site_suffix }}
- DNS:xos-core
cn: xos-core.{{ site_suffix }}
subj: '{{ ssl_cert_subj_prefix }}/CN=xos-core.{{ site_suffix }}'
Used in:
site_humanname
Human readable name to use for the CORD site.
Default value:
site_humanname: Placeholder Site HumanName
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/pki-cert/defaults/main.yml
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
site_name
Machine readable name to use for the CORD site. This should be one word, without spaces.
Default value:
site_name: placeholder-sitename
Used in:
- platform-install/roles/compute-node-config/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-configdirs-become/defaults/main.yml
- platform-install/roles/dhcpd/defaults/main.yml
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
- platform-install/roles/pki-cert/defaults/main.yml
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/setup-nova-dpdk/defaults/main.yml
site_suffix
The DNS suffix applied to all machines created for this site. Must be a valid DNS name.
Default value:
site_suffix: '{{ site_name }}.test'
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/dhcpd/defaults/main.yml
- platform-install/roles/dns-nsd/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
- platform-install/roles/juju-setup/defaults/main.yml
- platform-install/roles/pki-cert/defaults/main.yml
- platform-install/roles/pki-intermediate-ca/defaults/main.yml
- platform-install/roles/setup-nova-dpdk/defaults/main.yml
ssh_ca_phrase
The passphrase used to encrypt the Root CA key when creating a SSL hierarchy.
Default value:
ssh_ca_phrase: '{{ lookup(''password'', credentials_dir ~ ''/ssh_ca_phrase length=64'')
}}'
Used in:
ssh_client_genkeys
Names of SSH Client keys to generate and sign by the SSH CA.
Default value:
ssh_client_genkeys:
- name: '{{ pod_sshkey_name }}'
Used in:
ssh_host_genkeys
Names of SSH Host keys to generatte and sign by the SSH CA.
Default value:
ssh_host_genkeys: []
Used in:
ssh_keysize
Size in bits of SSH keys to generate
Default value:
ssh_keysize: 4096
Used in:
ssh_keytype
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.
Default value:
ssh_keytype: rsa
Used in:
- platform-install/roles/ansible-install/defaults/main.yml
- platform-install/roles/head-prep/defaults/main.yml
- platform-install/roles/ssh-install-maas/defaults/main.yml
- platform-install/roles/ssh-install/defaults/main.yml
- platform-install/roles/ssh-pki/defaults/main.yml
ssh_pki_dir
Directory where SSH keys are generated.
Default value:
ssh_pki_dir: '{{ playbook_dir }}/ssh_pki'
Used in:
- platform-install/roles/ansible-install/defaults/main.yml
- platform-install/roles/compute-prep/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-configdirs-become/defaults/main.yml
- platform-install/roles/create-lxd/defaults/main.yml
- platform-install/roles/head-prep/defaults/main.yml
- platform-install/roles/onos-cord-install/defaults/main.yml
- platform-install/roles/ssh-install-maas/defaults/main.yml
- platform-install/roles/ssh-install/defaults/main.yml
- platform-install/roles/ssh-pki/defaults/main.yml
ssl_cert_subj_prefix
SSL certificate prefix substring to use when generating certificates.
Default value:
ssl_cert_subj_prefix: /C=US/ST=California/L=Menlo Park/O=ON.Lab/OU={{ site_humanname
}} Deployment
Used in:
test_networks
List of OpenStack Neutron networks to check for. Currently only used in the
test-mcord-base
role.
Default value:
test_networks:
- management
- sgi_network
- s11_network
- s1mme_network
- sbi_network
- nbi_network
Used in:
test_ports
List of OpenStack Neutron network ports on VM's to check for. Currently only
used in the test-mcord-base
role.
Default value:
test_ports:
- network: management
vm: vmme
- network: s11_network
vm: vmme
- network: s1mme_network
vm: vmme
- network: management
vm: vspgwc
- network: s11_network
vm: vspgwc
- network: nbi_network
vm: vspgwc
- network: management
vm: sdncontroller
- network: nbi_network
vm: sdncontroller
- network: sbi_network
vm: sdncontroller
- network: management
vm: vspgwu
- network: s1u_network
vm: vspgwu
- network: sgi_network
vm: vspgwu
- network: sbi_network
vm: vspgwu
- network: management
vm: internetemulator
- network: sgi_network
vm: internetemulator
Used in:
test_services
List of active OpenStack Nova VM instances to check for. Currently only used
in the test-mcord-base
role.
Default value:
test_services:
- internetemulator
- vmme
- vspgwc
- sdncontroller
- vspgwu
Used in:
trust_store_pw
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.
Default value:
trust_store_pw: changeit
Used in:
unbound_conf
Path for the Unbound recursive DNS resolver configuration file.
Default value:
unbound_conf: /etc/unbound/unbound.conf
Used in:
unbound_group
Group name used by Unbound server.
Default value:
unbound_group: unbound
Used in:
unbound_interfaces
List of network interfaces that Unbound should listen on.
Default value:
unbound_interfaces:
- '{{ mgmt_ipv4_first_octets }}.1/24'
Used in:
unbound_listen_all
Whether Unbound should listen on all available network interfaces.
Default value:
unbound_listen_all: true
Used in:
unbound_listen_on_default
Whether Unbound should listen on the default gateway interface (as known to Ansible).
Default value:
unbound_listen_on_default: false
Used in:
- platform-install/roles/dns-configure/defaults/main.yml
- platform-install/roles/dns-unbound/defaults/main.yml
use_apt_cache
Enables the use of apt-cacher-ng
to cache APT packages on Head/LXC/Compute nodes.
Default value:
use_apt_cache: true
Used in:
use_dpdk
Enable DPDK in OpenStack Nova and Neutron
Default value:
use_dpdk: false
Used in:
use_fabric
Start and use ONOS in a container to manage fabric switches
Default value:
use_fabric: false
Used in:
- platform-install/roles/compute-node-config/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
use_maas
Use MaaS to manage compute nodes and switches.
Default value:
use_maas: false
Used in:
- platform-install/roles/ansible-install/defaults/main.yml
- platform-install/roles/compute-prep/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-lxd/defaults/main.yml
- platform-install/roles/head-prep/defaults/main.yml
- platform-install/roles/ssh-install-maas/defaults/main.yml
- platform-install/roles/ssh-install/defaults/main.yml
use_management_hosts
Whether the management_hosts network type in VTN should be enabled.
Default value:
use_management_hosts: false
Used in:
- platform-install/roles/compute-node-config/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
use_openstack
Bring up and use OpenStack to manage VM's.
Default value:
use_openstack: true
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/glance-images/defaults/main.yml
- platform-install/roles/pki-install/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
- platform-install/roles/xos-config/defaults/main.yml
use_redis
Use redis as a message bus inside XOS.
Default value:
use_redis: true
Used in:
use_vtn
Use the ONOS VTN app to manage networks for virtual instances.
Default value:
use_vtn: true
Used in:
vcpu_pin_set
DPDK setting to specify CPU pinning.
Default value:
vcpu_pin_set: ^0,^2
Used in:
vsg_test_ping_target
System to try to ping during the VSG test.
Default value:
vsg_test_ping_target: opennetworking.org.
Used in:
vtn_management_host_net_interface
Network interface to use on the head/compute nodes for the management_host network.
Default value:
vtn_management_host_net_interface: veth3
Used in:
xos_admin_first
First name of the XOS Admin user
Default value:
xos_admin_first: XOS
Used in:
xos_admin_last
Last tname of the XOS Admin user
Default value:
xos_admin_last: Admin
Used in:
xos_admin_pass
Password of the XOS Admin user (autogenerated by default)
Default value:
xos_admin_pass: '{{ lookup(''password'', ''/opt/credentials/xosadmin@opencord.org'')
}}'
Used in:
- platform-install/roles/create-epc/defaults/main.yml
- platform-install/roles/epc-synced/defaults/main.yml
xos_admin_user
Username (email) of the XOS Admin user
Default value:
xos_admin_user: xosadmin@opencord.org
Used in:
- platform-install/roles/compute-node-enable-maas/defaults/main.yml
- platform-install/roles/compute-node-enable/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/create-epc/defaults/main.yml
- platform-install/roles/epc-synced/defaults/main.yml
- platform-install/roles/monitoringservice-config/defaults/main.yml
- platform-install/roles/monitoringservice-onboard/defaults/main.yml
- platform-install/roles/test-ecord-subscriber-enable/defaults/main.yml
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/test-mcord-base/defaults/main.yml
- platform-install/roles/test-subscriber-enable/defaults/main.yml
- platform-install/roles/vtn-refresh/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
- platform-install/roles/xos-config/defaults/main.yml
- platform-install/roles/xos-test-restore-db/defaults/main.yml
xos_bootstrap_ui_port
Port to connect to to bootstrap the XOS interface.
Default value:
xos_bootstrap_ui_port: 9001
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/monitoringservice-onboard/defaults/main.yml
xos_chameleon_port
Port used by Chameleon in XOS.
Default value:
xos_chameleon_port: 9101
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/xos-ready/defaults/main.yml
xos_db_name
XOS Postgres database name
Default value:
xos_db_name: xos
Used in:
xos_db_password
XOS Postgres database password.
Default value:
xos_db_password: password
Used in:
xos_db_username
XOS Postgres database username.
Default value:
xos_db_username: postgres
Used in:
xos_dir
Path of XOS directory within Docker containers.
Default value:
xos_dir: /opt/xos
Used in:
xos_docker_networks
Name of networks created in Docker for XOS containers.
Default value:
xos_docker_networks:
- xos
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/teardown-xos/defaults/main.yml
- platform-install/roles/xos-up/defaults/main.yml
xos_grpc_insecure_port
Insecure (non-SSL) port used for GRPC connections to the XOS API.
Default value:
xos_grpc_insecure_port: 50055
Used in:
xos_grpc_secure_port
Secure (SSL) port used for GRPC connections to the XOS API.
Default value:
xos_grpc_secure_port: 50051
Used in:
xos_gui_service_graph_constraints
Textual set of constraints that controls how the service graph is displayed in the GUI. Guide for writing constraints.
Default value:
xos_gui_service_graph_constraints: []
Used in:
xos_images
List of OpenStack Glance images in QCOW2 format that are downloaded.
Default value:
xos_images: []
Used in:
xos_new_tosca_config_templates
List of XOS tosca templates to load that make up the service graph of a profile.
Default value:
xos_new_tosca_config_templates: []
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
xos_other_templates
List of templates to generate when creating the cord_profile
directory.
Default value:
xos_other_templates: []
Used in:
xos_services
List of XOS services to load, including the name, path and whether SSH keypairs should be included for the services.
Default value:
xos_services: []
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/xos-core-build/defaults/main.yml
xos_tosca_config_templates
List of XOS tosca templates to load that make up the service graph of a profile. Deprecated, see: xos_new_tosca_config_templates
Default value:
xos_tosca_config_templates: []
Used in:
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
- platform-install/roles/xos-config/defaults/main.yml
xos_tosca_url
URL for the XOS TOSCA API endpoint
Default value:
xos_tosca_url: http://xos-tosca/xos-tosca
Used in:
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/xos-config-new-tosca/defaults/main.yml
xos_ui_port
XOS Web UI port to use for API access.
Default value:
xos_ui_port: 9000
Used in:
- platform-install/roles/compute-node-enable-maas/defaults/main.yml
- platform-install/roles/cord-profile/defaults/main.yml
- platform-install/roles/test-exampleservice/defaults/main.yml
- platform-install/roles/test-mcord-base/defaults/main.yml
- platform-install/roles/xos-ready/defaults/main.yml
xos_users
List of additional users to create in XOS, in addition to xos_admin_user.
Default value:
xos_users: []
Used in: