opt-descriptions.json

{"DEFAULT": {"clean_nodes": "Whether to clean overcloud nodes (wipe the hard drive) between deployments and after the introspection.", "dhcp_start": "Start of DHCP allocation range for PXE and DHCP of Overcloud instances.", "undercloud_update_packages": "Whether to update packages during the Undercloud install.", "local_mtu": "MTU to use for the local_interface.", "local_interface": "Network interface on the Undercloud that will be handling the PXE boots and DHCP for Overcloud instances.", "inspection_interface": "Network interface on which inspection dnsmasq will listen.  If in doubt, use the default value.", "undercloud_public_host": "Virtual IP or DNS address to use for the public endpoints of Undercloud services. Only used with SSL.", "undercloud_admin_host": "Virtual IP or DNS address to use for the admin endpoints of Undercloud services. Only used with SSL.", "ipa_otp": "One Time Password to register Undercloud node with an IPA server.  Required when enable_novajoin = True.", "certificate_generation_ca": "The certmonger nickname of the CA from which the certificate will be requested. This is used only if the generate_service_certificate option is set. Note that if the \"local\" CA is selected the certmonger's local CA certificate will be extracted to /etc/pki/ca-trust/source/anchors/cm-local-ca.pem and subsequently added to the trust chain.", "hieradata_override": "Path to hieradata override file. If set, the file will be copied under /etc/puppet/hieradata and set as the first file in the hiera hierarchy. This can be used to custom configure services beyond what undercloud.conf provides", "enable_ui": "Whether to install the TripleO UI.", "ipxe_enabled": "Whether to use iPXE for deploy and inspection.", "undercloud_ntp_servers": "List of ntp servers to use.", "discovery_default_driver": "The default driver or hardware type to use for newly discovered nodes (requires enable_node_discovery set to True). It is automatically added to enabled_drivers or enabled_hardware_types accordingly.", "enabled_drivers": "List of enabled bare metal drivers.", "service_principal": "The kerberos principal for the service that will use the certificate. This is only needed if your CA requires a kerberos principal. e.g. with FreeIPA.", "inspection_enable_uefi": "Whether to support introspection of nodes that have UEFI-only firmware.", "enabled_hardware_types": "List of enabled bare metal hardware types (next generation drivers).", "enable_novajoin": "Whether to install novajoin metadata service in the Undercloud.", "overcloud_domain_name": "DNS domain name to use when deploying the overcloud. The overcloud parameter \"CloudDomain\" must be set to a matching value.", "enable_tempest": "Whether to install Tempest in the Undercloud.", "enable_telemetry": "Whether to install Telemetry services (ceilometer, gnocchi, aodh, panko ) in the Undercloud.", "dhcp_end": "End of DHCP allocation range for PXE and DHCP of Overcloud instances.", "enable_cinder": "Whether to install the Volume service. It is not currently used in the undercloud.", "undercloud_debug": "Whether to enable the debug log level for Undercloud OpenStack services.", "undercloud_hostname": "Fully qualified hostname (including domain) to set on the Undercloud. If left unset, the current hostname will be used, but the user is responsible for configuring all system hostname settings appropriately.  If set, the undercloud install will configure all system hostname settings.", "net_config_override": "Path to network config override template. If set, this template will be used to configure the networking via os-net-config. Must be in json format. Templated tags can be used within the template, see instack-undercloud/elements/undercloud-stack-config/net-config.json.template for example tags", "scheduler_max_attempts": "Maximum number of attempts the scheduler will make when deploying the instance. You should keep it greater or equal to the number of bare metal nodes you expect to deploy at once to work around potential race condition when scheduling.", "network_cidr": "Network CIDR for the Neutron-managed network for Overcloud instances. This should be the subnet used for PXE booting.", "enable_validations": "Whether to install requirements to run the TripleO validations.", "undercloud_service_certificate": "Certificate file to use for OpenStack service SSL connections.  Setting this enables SSL for the OpenStack API endpoints, leaving it unset disables SSL.", "local_ip": "IP information for the interface on the Undercloud that will be handling the PXE boots and DHCP for Overcloud instances.  The IP portion of the value will be assigned to the network interface defined by local_interface, with the netmask defined by the prefix portion of the value.", "inspection_extras": "Whether to enable extra hardware collection during the inspection process. Requires python-hardware or python-hardware-detect package on the introspection image.", "docker_registry_mirror": "An optional docker 'registry-mirror' that will beconfigured in /etc/docker/daemon.json.", "undercloud_nameservers": "DNS nameserver(s) to use for the undercloud node.", "enable_container_images_build": "Whether to enable docker container images to be build on the undercloud.", "masquerade_network": "Network that will be masqueraded for external access, if required. This should be the subnet used for PXE booting.", "generate_service_certificate": "When set to True, an SSL certificate will be generated as part of the undercloud install and this certificate will be used in place of the value for undercloud_service_certificate.  The resulting certificate will be written to /etc/pki/tls/certs/undercloud-[undercloud_public_host].pem.  This certificate is signed by CA selected by the \"certificate_generation_ca\" option.", "network_gateway": "Network gateway for the Neutron-managed network for Overcloud instances. This should match the local_ip above when using masquerading.", "inspection_runbench": "Whether to run benchmarks when inspecting nodes. Requires inspection_extras set to True.", "inspection_iprange": "Temporary IP range that will be given to nodes during the inspection process.  Should not overlap with the range defined by dhcp_start and dhcp_end, but should be in the same network.", "enable_node_discovery": "Makes ironic-inspector enroll any unknown node that PXE-boots introspection ramdisk in Ironic. By default, the \"fake\" driver is used for new nodes (it is automatically enabled when this option is set to True). Set discovery_default_driver to override. Introspection rules can also be used to specify driver information for newly enrolled nodes."}, "auth": {"undercloud_mistral_password": "Mistral service password. If left unset, one will be automatically generated.", "undercloud_gnocchi_password": "Gnocchi service password. If left unset, one will be automatically generated.", "undercloud_heat_encryption_key": "Heat db encryption key(must be 16, 24, or 32 characters. If left unset, one will be automatically generated.", "undercloud_panko_password": "Panko service password. If left unset, one will be automatically generated.", "undercloud_heat_cfn_password": "Heat cfn service password. If left unset, one will be automatically generated.", "undercloud_glance_password": "Glance service password. If left unset, one will be automatically generated.", "undercloud_admin_password": "Keystone admin password. If left unset, one will be automatically generated.", "undercloud_swift_password": "Swift service password. If left unset, one will be automatically generated.", "undercloud_ceilometer_snmpd_password": "Ceilometer snmpd password. If left unset, one will be automatically generated.", "undercloud_aodh_password": "Aodh service password. If left unset, one will be automatically generated.", "undercloud_rabbit_username": "Rabbitmq username. If left unset, one will be automatically generated.", "undercloud_swift_hash_suffix": "Swift hash suffix. If left unset, one will be automatically generated.", "undercloud_horizon_secret_key": "Horizon secret key. If left unset, one will be automatically generated.", "undercloud_heat_password": "Heat service password. If left unset, one will be automatically generated.", "undercloud_ironic_password": "Ironic service password. If left unset, one will be automatically generated.", "undercloud_zaqar_password": "Zaqar password. If left unset, one will be automatically generated.", "undercloud_ceilometer_password": "Ceilometer service password. If left unset, one will be automatically generated.", "undercloud_haproxy_stats_password": "HAProxy stats password. If left unset, one will be automatically generated.", "undercloud_heat_stack_domain_admin_password": "Heat stack domain admin password. If left unset, one will be automatically generated.", "undercloud_ceilometer_snmpd_user": "Ceilometer snmpd read-only user. If this value is changed from the default, the new value must be passed in the overcloud environment as the parameter SnmpdReadonlyUserName. This value must be between 1 and 32 characters long.", "undercloud_rabbit_password": "Rabbitmq password. If left unset, one will be automatically generated.", "undercloud_nova_password": "Nova service password. If left unset, one will be automatically generated.", "undercloud_neutron_password": "Neutron service password. If left unset, one will be automatically generated.", "undercloud_rabbit_cookie": "Rabbitmq cookie. If left unset, one will be automatically generated.", "undercloud_novajoin_password": "Novajoin vendordata plugin service password. If left unset, one will be automatically generated.", "undercloud_admin_token": "Keystone admin token. If left unset, one will be automatically generated.", "undercloud_db_password": "Password used for MySQL root user. If left unset, one will be automatically generated.", "undercloud_ceilometer_metering_secret": "Ceilometer metering secret. If left unset, one will be automatically generated.", "undercloud_cinder_password": "Cinder service password. If left unset, one will be automatically generated."}}