Appendix D. Base Parameters

The following is a list of base parameters used for configuring the Overcloud. These parameters are defined in the parameters section of the overcloud.yaml file in the director’s core Heat template collection.

AdminPassword

Type: string

The password for the OpenStack Identity administration account.

AdminToken

Type: string

The OpenStack Identity authentication secret.

AodhPassword

Type: string

The password for the OpenStack Telemetry Alarming services.

BlockStorageCount

Type: number

The number of Block Storage nodes in your Overcloud.

BlockStorageExtraConfig

Type: json

Block Storage specific configuration to inject into the cluster.

BlockStorageHostnameFormat

Type: string

Format for Block Storage node host names.

BlockStorageImage

Type: string

The image to use for provisioning Block Storage nodes.

BlockStorageRemovalPolicies

Type: json

List of resources to be removed from BlockStorageResourceGroup when doing an update that requires removal of specific resources.

BlockStorageSchedulerHints

Type: json

Optional scheduler hints to pass to OpenStack Compute.

CeilometerBackend

Type: string

The OpenStack Telemetry backend type. Select either mongodb or mysql.

CeilometerComputeAgent

Type: string

Indicates whether the Compute agent is present and expects nova-compute to be configured accordingly.

CeilometerMeterDispatcher

Type: string

The OpenStack Telemetry (ceilometer) service includes a new component for a time series data storage (gnocchi). It is possible in Red Hat OpenStack Platform to switch the default Ceilometer dispatcher to use this new component instead of the standard database. You accomplish this with the CeilometerMeterDispatcher, which you set to either:

  • database - Use the standard database for the Ceilometer dispatcher. This is the default option.
  • gnocchi - Use the new time series database for Ceilometer dispatcher. See Example 3 in Configuring Base Parameters for more information.
CeilometerMeteringSecret

Type: string

Secret shared by the OpenStack Telemetry services.

CeilometerPassword

Type: string

The password for the OpenStack Telemetry service account.

CephAdminKey

Type: string

The Ceph admin client key. Can be created with ceph-authtool --gen-print-key.

CephClientKey

Type: string

The Ceph client key. Can be created with ceph-authtool --gen-print-key. Currently only used for external Ceph deployments to create the OpenStack user keyring.

CephClusterFSID

Type: string

The Ceph cluster FSID. Must be a UUID.

CephExternalMonHost

Type: string

List of externally managed Ceph Monitors host IPs. Only used for external Ceph deployments.

CephMonKey

Type: string

The Ceph Monitors key. Can be created with ceph-authtool --gen-print-key.

CephStorageCount

Type: number

The number of Ceph Storage nodes in your Overcloud.

CephStorageExtraConfig

Type: json

Ceph Storage specific configuration to inject into the cluster.

CephStorageHostnameFormat

Type: string

Format for Ceph Storage node host names.

CephStorageImage

Type: string

The image to use for provisioning Ceph Storage nodes.

CephStorageRemovalPolicies

Type: json

List of resources to be removed from CephStorageResourceGroup when doing an update that requires removal of specific resources.

CephStorageSchedulerHints

Type: json

Optional scheduler hints to pass to OpenStack Compute.

CinderEnableIscsiBackend

Type: boolean

Whether to enable or not the iSCSI backend for Block Storage.

CinderEnableNfsBackend

Type: boolean

Whether to enable or not the NFS backend for Block Storage.

CinderEnableRbdBackend

Type: boolean

Whether to enable or not the Ceph Storage backend for Block Storage.

CinderISCSIHelper

Type: string

The iSCSI helper to use with Block Storage.

CinderLVMLoopDeviceSize

Type: number

The size of the loopback file used by the Block Storage LVM driver.

CinderNfsMountOptions

Type: string

Mount options for NFS mounts used by Block Storage NFS backend. Effective when CinderEnableNfsBackend is true.

CinderNfsServers

Type: comma delimited list

NFS servers used by Block Storage NFS backend. Effective when CinderEnableNfsBackend is true.

CinderPassword

Type: string

The password for the Block Storage service account.

CloudDomain

Type: string

The DNS domain used for the hosts. This should match the dhcp_domain configured in the Undercloud’s networking. Defaults to localdomain.

CloudName

Type: string

The DNS name of this cloud. For example: ci-overcloud.tripleo.org.

ComputeCount

Type: number

The number of Compute nodes in your Overcloud.

ComputeHostnameFormat

Type: string

Format for Compute node host names.

ComputeRemovalPolicies

Type: json

List of resources to be removed from ComputeResourceGroup when doing an update that requires removal of specific resources.

ControlFixedIPs

Type: json

A list of fixed IP addresses for Controller nodes.

ControlVirtualInterface

Type: string

Interface where virtual IPs are assigned.

ControllerCount

Type: number

The number of Controller nodes in your Overcloud.

ControllerEnableCephStorage

Type: boolean

Whether to deploy Ceph Storage (OSD) on the Controller.

ControllerEnableSwiftStorage

Type: boolean

Whether to enable Object Storage on the Controller.

controllerExtraConfig

Type: json

Controller specific configuration to inject into the cluster.

ControllerHostnameFormat

Type: string

Format for Controller node host names.

controllerImage

Type: string

The image to use for provisioning Block Storage nodes.

ControllerRemovalPolicies

Type: json

List of resources to be removed from ControllerResourceGroup when doing an update that requires removal of specific resources.

ControllerSchedulerHints

Type: json

Optional scheduler hints to pass to OpenStack Compute.

CorosyncIPv6

Type: boolean

Enable IPv6 in Corosync.

Debug

Type: string

Set to true to enable debugging on all services.

DeployIdentifier

Type: string

Set to a unique value to re-run any deployment tasks that perform configuration on a stack-update of the Overcloud.

EnableFencing

Type: boolean

Defines whether to enable fencing in Pacemaker or not.

EnableGalera

Type: boolean

Defines whether to use Galera instead of regular MariaDB.

ExtraConfig

Type: json

Additional configuration to inject into the cluster. Any role-specific ExtraConfig, such as controllerExtraConfig, takes precedence over the standard ExtraConfig.

FencingConfig

Type: json

Pacemaker fencing configuration. The JSON should have the following structure:

  {
    "devices": [
      {
        "agent": "AGENT_NAME",
        "host_mac": "HOST_MAC_ADDRESS",
        "params": {"PARAM_NAME": "PARAM_VALUE"}
      }
    ]
  }

For instance:

  {
    "devices": [
      {
        "agent": "fence_xvm",
        "host_mac": "52:54:00:aa:bb:cc",
        "params": {
          "multicast_address": "225.0.0.12",
          "port": "baremetal_0",
          "manage_fw": true,
          "manage_key_file": true,
          "key_file": "/etc/fence_xvm.key",
          "key_file_password": "abcdef"
        }
      }
    ]
  }
GlanceBackend

Type: string

The short name of the OpenStack Image backend to use. Should be one of swift, rbd, or file.

GlanceLogFile

Type: string

The path of the file to use for logging messages from OpenStack Image.

GlanceNotifierStrategy

Type: string

Strategy to use for OpenStack Image notification queue. Defaults to noop.

GlancePassword

Type: string

The password for the OpenStack Image service account, used by the OpenStack Image services.

GnocchiBackend

Type: string

The short name of the Gnocchi backend to use. Should be one of swift, rbd, or file.

GnocchiIndexerBackend

Type: string

The short name of the Gnocchi indexer backend to use.

GnocchiPassword

Type: string

The password for the Gnocchi service account.

HAProxySyslogAddress

Type: string

Syslog address where HAProxy will send its log.

HeatPassword

Type: string

The password for the Heat service account.

HeatStackDomainAdminPassword

Type: string

Password for heat_stack_domain_admin user.

HorizonAllowedHosts

Type: comma delimited list

A list of IPs/Hostnames allowed to connect to the OpenStack Dashboard.

HypervisorNeutronPhysicalBridge

Type: string

The OVS bridge to create on each hypervisor. This defaults to br-ex, which is the same as the control plane nodes, as we have a uniform configuration of the Open vSwitch agent. Typically, you should not need to change this.

HypervisorNeutronPublicInterface

Type: string

Defines what interface to add to the HypervisorNeutronPhysicalBridge.

ImageUpdatePolicy

Type: string

What policy to use when reconstructing instances. REBUILD for rebuilds and REBUILD_PRESERVE_EPHEMERAL to preserve /mnt.

InstanceNameTemplate

Type: string

Template string to be used to generate instance names.

InternalApiVirtualFixedIPs

Type: json

Control the IP allocation for the InternalApiVirtualInterface port. For example:

[{'ip_address':'1.2.3.4'}]
KeyName

Type: string

Name of an existing OpenStack Compute key pair to enable SSH access to the instances.

KeystoneCACertificate

Type: string

OpenStack Identity self-signed certificate authority certificate.

KeystoneNotificationDriver

Type: comma delimited list

Comma-separated list of notification drivers used by OpenStack Identity.

KeystoneNotificationFormat

Type: string

The OpenStack Identity notification format.

KeystoneSSLCertificate

Type: string

OpenStack Identity certificate for verifying token validity.

KeystoneSSLCertificateKey

Type: string

OpenStack Identity key for signing tokens.

KeystoneSigningCertificate

Type: string

OpenStack Identity certificate for verifying token validity.

KeystoneSigningKey

Type: string

OpenStack Identity key for signing tokens.

ManageFirewall

Type: boolean

Defines whether to manage firewall rules.

MemcachedIPv6

Type: boolean

Enable IPv6 features in Memcached.

MongoDbIPv6

Type: boolean

Enable IPv6 if MongoDB VIP is IPv6.

MongoDbNoJournal

Type: boolean

Defines if MongoDb journaling is disabled.

MysqlInnodbBufferPoolSize

Type: number

Specifies the size of the buffer pool in megabytes. Setting to zero should be interpreted as "no value" and defers to the lower level default.

MysqlMaxConnections

Type: number

Configures MySQL max_connections setting.

NeutronAgentExtensions

Type: comma delimited list

Comma-separated list of extensions enabled for the OpenStack Networking agents.

NeutronAgentMode

Type: string

Agent mode for the neutron-l3-agent on the Controller hosts.

NeutronAllowL3AgentFailover

Type: string

Allow automatic L3 Agent failover.

NeutronBridgeMappings

Type: comma delimited list

The OVS logical-to-physical bridge mappings to use. Defaults to mapping the external bridge on hosts (br-ex) to a physical name (datacentre), which can be used to create provider networks (and we use this for the default floating network). If changing this, either use different post-install network scripts or make sure to keep datacentre as a mapping network name.

NeutronComputeAgentMode

Type: string

Agent mode for the neutron-l3-agent on the Compute nodes.

NeutronControlPlaneID

Type: string

Neutron ID or name for ctlplane network.

NeutronCorePlugin

Type: string

The core plugin for OpenStack Networking. The value should be the entry point to be loaded from neutron.core_plugins name space.

NeutronDVR

Type: string

Whether to configure OpenStack Networking Distributed Virtual Routers

NeutronDhcpAgentsPerNetwork

Type: number

The number of OpenStack Networking dhcp agents to schedule per network

NeutronDnsmasqOptions

Type: string

Dnsmasq options for neutron-dhcp-agent. The default value here forces MTU to be set to the value of NeutronTenantMtu, which should be set to account for tunnel overhead.

NeutronEnableIsolatedMetadata

Type: string

If true, DHCP provide metadata route to VM.

NeutronEnableL2Pop

Type: string

Enable/disable the L2 population feature in the OpenStack Networking agents.

NeutronEnableTunnelling

Type: string

Defines whether to enable tunneling in OpenStack Networking.

NeutronExternalNetworkBridge

Type: string

Name of bridge used for external network traffic.

NeutronFlatNetworks

Type: comma delimited list

Defines a list of flat networks to configure in OpenStack Networking plugins. Defaults to datacentre to permit external network creation.

NeutronL3HA

Type: string

If you need to disable Layer 3 High Availability (L3HA) for OpenStack Networking, set this to false in an environment file.

NeutronMechanismDrivers

Type: comma delimited list

The mechanism drivers for the OpenStack Networking tenant network.

NeutronMetadataProxySharedSecret

Type: string

Shared secret to prevent spoofing

NeutronNetworkType

Type: comma delimited list

The tenant network type for OpenStack Networking.

NeutronNetworkVLANRanges

Type: comma delimited list

The OpenStack Networking ML2 and OpenVSwitch vlan mapping range to support. See the OpenStack Networking documentation for permitted values. Defaults to permitting any VLAN on the datacentre physical network (See NeutronBridgeMappings).

NeutronPassword

Type: string

The password for the OpenStack Networking service account, used by OpenStack Networking agents.

NeutronPluginExtensions

Type: comma delimited list

Comma-separated list of extensions enabled for the OpenStack Networking plugin.

NeutronPublicInterface

Type: string

What interface to bridge on to br-ex for network nodes.

NeutronPublicInterfaceDefaultRoute

Type: string

A custom default route for the NeutronPublicInterface.

NeutronPublicInterfaceIP

Type: string

A custom IP address to put onto the NeutronPublicInterface.

NeutronPublicInterfaceRawDevice

Type: string

If this is set, the public interface will be a VLAN which uses this device as the raw device.

NeutronPublicInterfaceTag

Type: string

VLAN tag for creating a public VLAN. The tag will be used to create an access port on the exterior bridge for each control plane node and gives that port the IP address returned from the OpenStack Networking public network.

NeutronServicePlugins

Type: comma delimited list

Comma-separated list of service plugin entry points to be loaded from the neutron.service_plugins name space.

NeutronTenantMtu

Type: string

The default MTU for tenant networks. For VXLAN/GRE tunneling, this should be at least 50 bytes smaller than the MTU on the physical network. This value will be used to set the MTU on the virtual Ethernet device. This value will be used to construct the NeutronDnsmasqOptions, since that will determine the MTU that is assigned to the VM host through DHCP.

NeutronTunnelIdRanges

Type: comma delimited list

Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation.

NeutronTunnelTypes

Type: comma delimited list

The tunnel types for the OpenStack Networking tenant network.

NeutronTypeDrivers

Type: comma delimited list

Comma-separated list of network type driver entry points to be loaded.

NeutronVniRanges

Type: comma delimited list

Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation

NovaComputeDriver

Type: string

The OpenStack Compute driver to use for managing instances. Defaults to the libvirt.LibvirtDriver driver.

NovaComputeExtraConfig

Type: json

Compute node specific configuration to inject into the cluster.

NovaComputeLibvirtType

Type: string

Defines the Libvirt type to use. Defaults to kvm.

NovaComputeLibvirtVifDriver

Type: string

Libvirt VIF driver configuration for the network.

NovaComputeSchedulerHints

Type: json

Optional scheduler hints to pass to OpenStack Compute.

NovaEnableRbdBackend

Type: boolean

Whether to enable or not the Ceph backend for Nova.

NovaIPv6

Type: boolean

Enable IPv6 features in Nova.

NovaImage

Type: string

The image to use for provisioning Compute nodes.

NovaOVSBridge

Type: string

Name of integration bridge used by Open vSwitch.

NovaPassword

Type: string

The password for the OpenStack Compute service account.

NovaSecurityGroupAPI

Type: string

The full class name of the security API class.

NtpServer

Type: comma delimited list

Comma-separated list of NTP servers.

ObjectStorageCount

Type: number

The number of Object Storage nodes in your Overcloud.

ObjectStorageExtraConfig

Type: json

ObjectStorage specific configuration to inject into the cluster.

ObjectStorageHostnameFormat

Type: string

Format for Object Storage node host names.

ObjectStorageRemovalPolicies

Type: json

List of resources to be removed from ObjectStorageResourceGroup when doing an update that requires removal of specific resources.

ObjectStorageSchedulerHints

Type: json

Optional scheduler hints to pass to OpenStack Compute.

OvercloudBlockStorageFlavor

Type: string

Flavor for Block Storage nodes to request when deploying.

OvercloudCephStorageFlavor

Type: string

Flavor for Ceph Storage nodes to request when deploying.

OvercloudComputeFlavor

Type: string

Flavor for Compute nodes to request when deploying.

OvercloudControlFlavor

Type: string

Flavor for Controller nodes to request when deploying.

OvercloudSwiftStorageFlavor

Type: string

Flavor for Object Storage nodes to request when deploying.

PublicVirtualFixedIPs

Type: json

Control the IP allocation for the PublicVirtualInterface port. For example:

[{'ip_address':'1.2.3.4'}]
PublicVirtualInterface

Type: string

Specifies the interface where the public-facing virtual IP will be assigned. This should be int_public when a VLAN is being used.

PurgeFirewallRules

Type: boolean

Defines whether to purge firewall rules before setting up new ones.

RabbitClientPort

Type: number

Set RabbitMQ subscriber port.

RabbitClientUseSSL

Type: string

RabbitMQ client subscriber parameter to specify an SSL connection to the RabbitMQ host.

RabbitCookieSalt

Type: string

Salt for the RabbitMQ cookie. Change this to force the randomly generated RabbitMQ cookie to change.

RabbitFDLimit

Type: string

Configures RabbitMQ file descriptor limit.

RabbitIPv6

Type: boolean

Enable IPv6 in RabbitMQ.

RabbitPassword

Type: string

The password for RabbitMQ.

RabbitUserName

Type: string

The username for RabbitMQ

RedisPassword

Type: string

The password for Redis

SaharaPassword

Type: string

The password for the OpenStack Clustering service account.

ServerMetadata

Type: json

Extra properties or metadata passed to OpenStack Compute for the created nodes in the Overcloud.

ServiceNetMap

Type: json

Mapping of service names to network names. Typically set in the parameter_defaults of the resource registry.

SnmpdReadonlyUserName

Type: string

The user name for SNMPd with read-only rights running on all Overcloud nodes.

SnmpdReadonlyUserPassword

Type: string

The user password for SNMPd with read-only rights running on all Overcloud nodes.

StorageMgmtVirtualFixedIPs

Type: json

Control the IP allocation for the StorageMgmgVirtualInterface port. For example:

[{'ip_address':'1.2.3.4'}]
StorageVirtualFixedIPs

Type: json

Control the IP allocation for the StorageVirtualInterface port. For example:

[{'ip_address':'1.2.3.4'}]
SwiftHashSuffix

Type: string

A random string to be used as a salt when hashing to determine mappings in the ring.

SwiftMinPartHours

Type: number

The minimum time (in hours) before a partition in a ring can be moved following a rebalance.

SwiftMountCheck

Type: boolean

Value of mount_check in Object Storage account/container/object-server.conf.

SwiftPartPower

Type: number

Partition power to use when building Object Storage rings.

SwiftPassword

Type: string

The password for the Object Storage service account, used by the Object Storage proxy services.

SwiftReplicas

Type: number

How many replicas to use in the Object Storage rings.

SwiftStorageImage

Type: string

The image to use for provisioning Object Storage nodes.

TimeZone

Type: string

Sets the time zone of your Overcloud deployment. If you leave the TimeZone parameter blank, the Overcloud will default to UTC time. Director recognizes the standard timezone names defined in the timezone database /usr/share/zoneinfo/. For example, if you wanted to set your time zone to Japan, you would examine the contents of /usr/share/zoneinfo to locate a suitable entry:

$ ls /usr/share/zoneinfo/
Africa      Asia       Canada   Cuba   EST      GB       GMT-0      HST      iso3166.tab  Kwajalein  MST      NZ-CHAT   posix       right      Turkey     UTC       Zulu
America     Atlantic   CET      EET    EST5EDT  GB-Eire  GMT+0      Iceland  Israel       Libya      MST7MDT  Pacific   posixrules  ROC        UCT        WET
Antarctica  Australia  Chile    Egypt  Etc      GMT      Greenwich  Indian   Jamaica      MET        Navajo   Poland    PRC         ROK        Universal  W-SU
Arctic      Brazil     CST6CDT  Eire   Europe   GMT0     Hongkong   Iran     Japan        Mexico     NZ       Portugal  PST8PDT     Singapore  US         zone.tab

The output listed above includes time zone files, and directories containing additional time zone files. For example, Japan is an individual time zone file in this result, but Africa is a directory containing additional time zone files:

$ ls /usr/share/zoneinfo/Africa/
Abidjan      Algiers  Bamako  Bissau       Bujumbura   Ceuta    Dar_es_Salaam  El_Aaiun  Harare        Kampala   Kinshasa    Lome        Lusaka  Maseru     Monrovia  Niamey       Porto-Novo  Tripoli
Accra        Asmara   Bangui  Blantyre     Cairo       Conakry  Djibouti       Freetown  Johannesburg  Khartoum  Lagos       Luanda      Malabo  Mbabane    Nairobi   Nouakchott   Sao_Tome    Tunis
Addis_Ababa  Asmera   Banjul  Brazzaville  Casablanca  Dakar    Douala         Gaborone  Juba          Kigali    Libreville  Lubumbashi  Maputo  Mogadishu  Ndjamena  Ouagadougou  Timbuktu    Windhoek
UpdateIdentifier

Type: string

Setting to a previously unused value during stack-update triggers a package update on all nodes.