-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat OpenStack Platform
Overcloud Parameters
Parameters for customizing the core template collection for a Red Hat OpenStack Platform overcloud
OpenStack Documentation Team
rhos-docs@redhat.com
Abstract
Chapter 1. Core Overcloud Parameters
Parameter | Description |
---|---|
|
The DNS domain used for the hosts. This should match the |
|
The DNS name of this cloud. The default value is: |
|
The DNS name of this cloud’s control plane endpoint. The default value is: |
|
The DNS name of this cloud’s internal API endpoint. The default value is: |
|
The DNS name of this cloud’s storage endpoint. E.g. ci-overcloud.storage.tripleo.org. The default value is: |
|
The DNS name of this cloud’s storage management endpoint. The default value is: |
|
Defines a fixed VIP for the Control Plane. Value uses the following format: |
|
Setting this to a unique value will re-run any deployment tasks that perform configuration on a Heat |
|
An Open vSwitch bridge to create on each hypervisor. This defaults to |
|
What interface to add to the |
|
Control the IP allocation for the InternalApiVirtualInterface port. Value uses the following format: |
|
ID or name for Control Plane ctlplane network. The default value is: |
|
The interface to attach to the external bridge. The default value is: |
|
Control the IP allocation for the PublicVirtualInterface port. Value uses the following format: |
|
Salt for the RabbitMQ cookie. Change to force the randomly generated RabbitMQ cookie to change. The default value is: |
|
Control the IP allocation for the virtual IP used by Redis. Value uses the following format: |
| Extra properties or metadata passed to Nova for the created nodes in the overcloud. Accessible through the Nova metadata API. |
|
Control the IP allocation for the StorageMgmgVirtualInterface port. Value uses the following format: |
|
Control the IP allocation for the StorageVirtualInterface port. Value uses the following format: |
|
Set to a previously unused value during |
Chapter 2. Role-Based Parameters
Substitute _ROLE_ with the name of the role. For example, for _ROLE_Count
use ControllerCount
.
Parameter | Description |
---|---|
| The number of nodes to deploy in a role. |
|
Format for node hostnames. Note that |
|
List of resources to be removed from the role’s |
| Optional scheduler hints to pass to OpenStack Compute (nova). |
| A list of service resources (configured in the OpenStack Orchestration (heat) resource_registry) which represent nested stacks for each service that should get installed on the ROLE role. |
Chapter 3. Ceph Storage Parameters
Parameter | Description |
---|---|
|
The Ceph admin client key. Can be created with: |
|
The Ceph client key. Currently only used for external Ceph deployments to create the openstack user keyring. Can be created with: |
| The Ceph cluster FSID. Must be a UUID. |
|
Enables Ceph daemons to bind to IPv6 addresses. The default is: |
|
The Ceph monitors key. Can be created with: |
|
Default minimum replication for RBD copies. The default value is: |
|
Override settings for one of the predefined pools or to create additional ones. Example: |
|
Pool to use if Block Storage (cinder) Backup is enabled. The default is: |
|
Pool to use for Block Storage (cinder) service. The default is: |
|
Whether to deploy Ceph Storage (OSD) on the Controller. The default value is: |
|
The short name of the Glance backend to use. Set to |
|
Pool to use for Image Storage (glance) service. The default is: |
|
Pool to use for Telemetry storage. The default is: |
|
Whether to enable the Ceph backend for Compute (nova). The default value is: |
|
Pool to use for Compute storage. The default is: |
Chapter 4. Ceph RadosGW Parameters
Parameter | Description |
---|---|
|
The cephx key for the radosgw client. Can be created with: |
Chapter 5. Block Storage (cinder) Parameters
Parameter | Description |
---|---|
|
Cron to move deleted instances to another table - Age. The default value is: |
|
Cron to move deleted instances to another table - Log destination. The default value is: |
|
Cron to move deleted instances to another table - Hour. The default value is: |
|
Cron to move deleted instances to another table - Minute. The default value is: |
|
Cron to move deleted instances to another table - Month. The default value is: |
|
Cron to move deleted instances to another table - Month Day. The default value is: |
|
Cron to move deleted instances to another table - User. The default value is: |
|
Cron to move deleted instances to another table - Week Day. The default value is: |
|
Whether to create cron job for purging soft deleted rows in OpenStack Block Storage (cinder) database. The default value is: |
| The password for the cinder service account, used by cinder-api. |
| The password for the OpenStack Compute (nova) service and db account. |
Chapter 6. Image Storage (glance) Parameters
Parameter | Description |
---|---|
|
The short name of the backend to use. Should be one of |
| The filepath of the file to use for logging messages from OpenStack Image Storage (glance). |
|
When using |
|
NFS mount options for image storage when |
|
NFS share to mount for image storage when |
|
Strategy to use for OpenStack Image Storage (glance) notification queue. The default value is: |
| The password for the image storage service and database account. |
| Set the number of workers for the image storage service. The default value is equal to the number of CPU cores on the node. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. |
Chapter 7. Orchestration (heat) Parameters
Parameter | Description |
---|---|
| Auth encryption key for heat-engine. |
|
Whether to create cron job for purging soft deleted rows in the OpenStack Orchestration (heat) database. The default value is: |
| The password for the Orchestration service and database account. |
| The admin password for the OpenStack Orchestration (heat) domain in OpenStack Identity (keystone). |
| Number of workers for Heat service. The default value is: 0. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. |
Chapter 8. Dashboard (horizon) Parameters
Parameter | Description |
---|---|
|
A list of IP/Hostname allowed to connect to horizon. The default value is: |
| OpenStack Dashboard (horizon) has a global overrides mechanism available to perform customizations. |
| Secret key for the webserver. |
|
Extra parameters for OpenStack Dashboard (horizon) vhost configuration. The default value is: |
|
Enable IPv6 features in Memcached. The default value is: |
|
The mechanism drivers for the OpenStack Networking (neutron) tenant network. The default value is: |
Chapter 9. Bare Metal (ironic) Parameters
Parameter | Description |
---|---|
|
Type of disk cleaning before and between deployments. |
|
Enabled OpenStack Bare Metal (ironic) drivers. The default value is: |
|
Whether to use iPXE instead of PXE for deployment. The default value is: |
|
Port to use for serving images when iPXE is used. The default value is: |
| The password for the Bare Metal service and database account. |
Chapter 10. Identity (keystone) Parameters
Parameter | Description |
---|---|
|
The email for the OpenStack Identity (keystone) admin account. The default value is: |
| The password for the OpenStack Identity (keystone) admin account. |
| The OpenStack Identity (keystone) secret and database password. |
| The first OpenStack Identity (keystone) credential key. Must be a valid key. |
| The second OpenStack Identity (keystone) credential key. Must be a valid key. |
|
Cron to purge expired tokens - Log destination. The default value is: |
|
Cron to purge expired tokens - Ensure. The default value is: |
|
Cron to purge expired tokens - Hour. The default value is: |
|
Cron to purge expired tokens - Max Delay. The default value is: |
|
Cron to purge expired tokens - Minute. The default value is: |
|
Cron to purge expired tokens - Month. The default value is: |
|
Cron to purge expired tokens - Month Day. The default value is: |
|
Cron to purge expired tokens - User. The default value is: |
|
Cron to purge expired tokens - Week Day. The default value is: |
|
Whether to create cron job for purging soft deleted rows in OpenStack Identity (keystone) database. The default value is: |
|
Comma-separated list of Oslo notification drivers used by Keystone. The default value is: |
|
The OpenStack Identity (keystone) notification format. The default value is: |
| Keystone certificate for verifying token validity. |
| Keystone key for signing tokens. |
| Set the number of workers for the OpenStack Identity (keystone) service. The default value is equal to the number of CPU cores on the node. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. |
Chapter 11. Shared File Service (manila) Parameters
Parameter | Description |
---|---|
| The password for the shared file service account. |
Chapter 12. Networking (neutron) Parameters
Parameter | Description |
---|---|
|
Remove configuration that is not generated by the director. Used to avoid configuration remnants after upgrades. The default value is: |
|
Comma-separated list of extensions enabled for the OpenStack Networking (neutron) agents. The default value is: |
|
Allow automatic l3-agent failover. The default value is: |
|
The logical to physical bridge mappings to use. The default ( |
|
The core plugin for networking. The value should be the entrypoint to be loaded from |
|
String of extra command line parameters to append to the |
|
The number of DHCP agents to schedule per network. The default value is: |
|
Enable ARP responder feature in the OVS Agent. The default value is: |
|
Enable Distributed Virtual Router. The default value is: |
|
If True, DHCP always provides metadata route to VM. The default value is: |
|
If True, DHCP allows metadata support on isolated networks. The default value is: |
|
Enable/disable the L2 population feature in the OpenStack Networking (neutron) agents. The default value is: |
|
If True, DHCP provides metadata network. Requires either |
|
Name of bridge used for external network traffic. The default value is: |
|
Firewall driver for realizing OpenStack Networking (neutron) security group function. The default value is: |
|
Sets the flat network name to configure in plugins. The default value is: |
|
MTU of the underlying physical network. OpenStack Networking (neutron) uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, OpenStack Networking uses this value without modification. For overlay networks such as VXLAN, OpenStack Networking automatically subtracts the overlay protocol overhead from this value. The default value is: |
|
Agent mode for L3 agent. Must be |
|
The mechanism drivers for the tenant network. The default value is: |
| Shared secret to prevent spoofing. |
|
The tenant network type. The default value is: |
|
The Neutron ML2 and Open vSwitch VLAN mapping range to support. Defaults to permitting any VLAN on the |
|
Configure the classname of the firewall driver to use for implementing security groups. Possible values depend on system configuration. Some examples are: |
| The password for the OpenStack Networking (neutron) service and database account. |
|
Comma-separated list of enabled extension plugins. The default value is: |
|
Comma-separated list of service plugin entrypoints. The default value is: |
|
List of supported pci vendor devices in the format VendorID:ProductID. By default Intel & Mellanox SR-IOV capable NICs are supported. The default value is: |
|
Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation. The default value is: |
|
The tunnel types for the tenant network. The default value is: |
|
Comma-separated list of network type driver entrypoints to be loaded. The default value is: |
|
Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation. The default value is: |
| Sets the number of API and RPC workers for the OpenStack Networking service. The default value is equal to the number of CPU cores on the node. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. |
Chapter 13. Compute (nova) Parameters
Parameter | Description |
---|---|
|
Remove configuration that is not generated by the director. Used to avoid configuration remnants after upgrades. The default value is: |
|
Template string to be used to generate instance names. The default value is: |
| SSH key for migration. Expects a dictionary with keys public_key and private_key. Values should be identical to SSH public/private key files. |
| Shared secret to prevent spoofing. |
| Libvirt domain type. Defaults to kvm. |
| Libvirt VIF driver configuration for the network. |
|
Whether to create cron job for purging soft deleted rows in OpenStack Compute (nova) database. The default value is: |
|
Enable IPv6 features for OpenStack Compute (nova). The default is: |
|
Virtio-net RX queue size. Valid values are 256, 512, 1024. The default value is: |
|
Virtio-net TX queue size. Valid values are 256, 512, 1024. The default value is: |
|
Name of integration bridge used by Open vSwitch. The default value is: |
| YAML list of PCI passthrough whitelist parameters. |
| The password for the OpenStack Compute (nova) service and database account. |
|
Reserved RAM for host processes. The default value is: |
| List of available filters for OpenStack Compute (nova) to use to filter nodes. |
| An array of filters OpenStack Compute (nova) uses to filter a node. OpenStack Compute applies these filters in the order they are listed. Place your most restrictive filters first to make the filtering process more efficient. |
|
A list or range of physical CPU cores to reserve for virtual machine processes. For example, |
|
Number of workers for the Compute’s Conductor service. The default value is: |
|
OpenStack Compute upgrade level. The default value is: |
Chapter 14. Clustering (sahara) Parameters
Parameter | Description |
---|---|
| The password for the clusting service and database account. |
|
Set the number of workers for the clustering service. The default value is: |
Chapter 15. Object Storage (swift) Parameters
Parameter | Description |
---|---|
|
Whether to enable object storage on Controller nodes. The default value is: |
|
Comma-separated list of project names to ignore. The default value is: |
| A random string to be used as a salt when hashing to determine mappings in the ring. |
|
The minimum time (in hours) before a partition in a ring can be moved following a rebalance. The default value is: |
|
Check if the devices are mounted to prevent accidentally writing to the root device. The default value is: |
|
Partition power to use when building object storage rings. The default value is: |
| The password for the object storage service account. |
|
Timeout for requests going from |
|
Additional raw devices to use for the object storage backend. For example: |
|
Number of replicas to use in the object storage rings. The default value is: |
|
Whether to manage object storage rings or not. The default value is: |
| A temporary OpenStack Object Storage (swift) URL to download rings from. |
| A temporary OpenStack Object Storage (swift) URL to upload rings to. |
|
Use a local directory for object storage services when building rings. The default value is: |
|
Number of workers for object storage service. The default value is: |
Chapter 16. Telemetry (ceilometer, gnocchi, aodh) Parameters
Parameter | Description |
---|---|
| The password for the OpenStack Telemetry Alarming (aodh) services. |
|
The Telemetry backend type. The default value is: |
|
Comma-separated list of Dispatchers to process events data. The default value is: |
|
Number of seconds before database can expire the events data. The default value is: |
|
Dispatcher to process meter data. The default value is: |
| Secret shared by the Telemetry services. |
| The password for the Telemetry service account. |
|
Whether to store events in ceilometer. The default value is: |
|
Number of workers for the Telemetry service. The default value is: |
|
Combination alarms are deprecated in Newton, hence disabled by default. To enable, set this parameter to true. The default value is: |
|
The short name of the OpenStack Telemetry Metrics (gnocchi) backend to use. Should be one of |
|
Path to use when file driver is used. This could be NFS or a flat file. The default value is: |
|
The short name of the OpenStack Telemetry Metrics (gnocchi) indexer backend to use. The default value is: |
| Number of workers for OpenStack Telemetry Metrics (gnocchi). The default value is equal to the number of CPU cores on the node. Note that more workers creates a larger number of processes on systems, which results in excess memory consumption. It is recommended to choose a suitable non-default value on systems with high CPU core counts. |
| The password for the OpenStack Telemetry Metrics (gnocchi) service and database account. |
|
Delay between processing metrics. The default value is: |
|
Enable IPv6 if MongoDB VIP is IPv6. The default value is: |
|
Should MongoDb journaling be disabled. The default value is: |
Chapter 17. Time Parameters
Parameter | Description |
---|---|
|
NTP servers list. The default value is: |
|
The timezone to be set on the overcloud. The default value is: |
Chapter 18. Deprecated parameters from the previous version
appendix
The following parameters are deprecated from the previous version of Red Hat OpenStack Platform. In most cases, new parameters specific to composable services have replaced these deprecated parameters.
Parameter | Description |
---|---|
|
Indicates whether the Compute agent is present and expects |
| Contains parameters to configure OpenStack Block Storage (cinder) backends. |
|
Number of workers for OpenStack Block Storage (cinder) service. The default value is: |
|
Whether to deploy Ceph Storage (OSD) on the Controller. The default value is: |
|
Whether to enable OpenStack Object Storage (swift) on the Controller. The default value is: |
| A random string to be used as a salt when hashing to determine mappings in the OpenStack Object Storage (swift) ring. |
|
Configures |
| OpenStack Identity (keystone) self-signed certificate authority certificate. |
| OpenStack Identity (keystone) certificate for verifying token validity. |
| OpenStack Identity (keystone) key for signing tokens. |
|
The minimum time (in hours) before a partition in a ring can be moved following a rebalance. The default value is: |
|
Value of |
|
A unique identifier of the MySQL cluster the controller is in. The default value is: |
|
Specifies the size of the buffer pool in megabytes. Setting to zero should be interpreted as "no value" and will defer to the lower level default. The default value is: |
|
Agent mode for the |
|
Agent mode for the |
|
Whether to configure OpenStack Networking (neutron) Distributed Virtual Routers. The default value is: |
|
Allows configuration options to be passed to the |
|
Option to enable/disable DHCP Agent. The default value is: |
|
Option to enable/disable L3 agent. The default value is: |
|
Option to enable/disable Metadata agent. The default value is: |
|
Option to enable/disable OVS Agent. The default value is: |
| Option to enable/disable tunnelling in OpenStack Networking (neutron). |
| A custom default route for the NeutronPublicInterface. |
| A custom IP address to put onto the NeutronPublicInterface. |
| If set, the public interface is a VLAN with this device as the raw device. |
| 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 that port will be given the IP address returned by OpenStack Networking (neutron) from the public network. |
|
This value sets the OpenStack Networking (neutron) |
|
The OpenStack Compute (nova) driver to use. The default is: |
|
SSH migration has replaced this option. See https://access.redhat.com/solutions/3022771 for additional details. The default value is: |
| Public IP address to pass to OpenStack Compute (nova). |
|
The full class name of the security API class. The default value is: |
|
Partition Power to use when building OpenStack Object Storage (swift) rings. The default value is: |
|
How many replicas to use in the OpenStack Object Storage (swift) rings. The default value is: |
|
Whether to manage OpenStack Object Storage (swift) rings or not. The default value is: |
| Optional scheduler hints to pass to nova. |
| An array of SNMP config. |