kolla.yml

---
# Kayobe Kolla configuration.

###############################################################################
# Kolla installation.

# Type of Kolla control installation. One of 'binary' or 'source'.
#kolla_ctl_install_type:

# Path to directory for kolla source code checkout.
#kolla_source_path:

# URL of Kolla source code repository if type is 'source'.
#kolla_source_url:

# Version (branch, tag, etc.) of Kolla source code repository if type is
# 'source'. Default is {{ openstack_branch }}.
#kolla_source_version:

# Path to virtualenv in which to install kolla.
#kolla_venv:

# Path in which to generate kolla configuration.
#kolla_build_config_path:

###############################################################################
# Kolla-ansible installation.

# Type of Kolla-ansible control installation. One of 'binary' or 'source'.
# Default is 'source'.
#kolla_ansible_ctl_install_type:

# Path to directory for kolla-ansible source code checkout.
# Default is $KOLLA_SOURCE_PATH, or $PWD/src/kolla-ansible if
# $KOLLA_SOURCE_PATH is not set.
#kolla_ansible_source_path:

# URL of Kolla Ansible source code repository if type is 'source'. Default is
# https://opendev.org/openstack/kolla-ansible.
#kolla_ansible_source_url:

# Version (branch, tag, etc.) of Kolla Ansible source code repository if type
# is 'source'. Default is {{ openstack_branch }}.
#kolla_ansible_source_version:

# Path to virtualenv in which to install kolla-ansible. Default is
# $KOLLA_VENV_PATH or $PWD/venvs/kolla-ansible if $KOLLA_VENV_PATH is not set.
#kolla_ansible_venv:

# Extra requirements to install inside the kolla-ansible virtualenv.
#kolla_ansible_venv_extra_requirements:

# Pip requirement specifier for the ansible package. NOTE: This limits the
# version of ansible used by kolla-ansible to avoid new releases from breaking
# tested code. Changes to this limit should be tested.
#kolla_ansible_venv_ansible:

# Path to Kolla-ansible configuration directory. Default is $KOLLA_CONFIG_PATH
# or /etc/kolla if $KOLLA_CONFIG_PATH is not set.
#kolla_config_path:

# Path to Kolla-ansible node custom configuration directory. Default is
# {{ kolla_config_path }}/config.
#kolla_node_custom_config_path:

###############################################################################
# Kolla configuration.

# Kolla base container image distribution. Options are "centos", "debian",
# "rocky", "ubuntu". Default is {{ os_distribution }}.
#kolla_base_distro:

# Kolla base container image distribution version default map.
# Defines default versions for each distribution.
#kolla_base_distro_version_default_map:

# Kolla base container image distribution version.
# Default is kolla_base_distro_version_default_map[kolla_base_distro].
#kolla_base_distro_version:

# URL of docker registry to use for Kolla images. Default is not set, in which
# case Quay.io will be used.
#kolla_docker_registry:

# Docker namespace to use for Kolla images. Default is 'kolla'.
#kolla_docker_namespace:

# Username to use to access a docker registry. Default is not set, in which
# case the registry will be used without authentication.
#kolla_docker_registry_username:

# Password to use to access a docker registry. Default is not set, in which
# case the registry will be used without authentication.
#kolla_docker_registry_password:

# Kolla OpenStack release version. This should be a Docker image tag.
# Default is {{ openstack_release }}.
#kolla_openstack_release:

# Docker tag applied to built container images. Default is {{
# kolla_openstack_release }}-{{ kolla_base_distro }}-{{
# kolla_base_distro_version }}.
#kolla_tag:

# Dict mapping names of sources to their definitions.
# See kolla.common.config for details.
# Example:
# kolla_sources:
#   ironic-base:
#     type: git
#     location: https://github.com/openstack/ironic
#     reference: master
#kolla_sources:

###############################################################################
# Kolla image build configuration.

# Dict mapping Jinja2 block names in kolla's Docker images to their contents.
#kolla_build_blocks:

# Dict mapping image customization variable names to their values.
# Each variable takes the form:
# <image name>_<customization>_<operation>
# Hyphens in the image name must be replaced with underscores. The
# customization is most commonly packages. The operation should be one of
# override, append or remove. The value should be a list.
#kolla_build_customizations:

###############################################################################
# Kolla-ansible inventory configuration.

# Full custom seed inventory contents.
#kolla_seed_inventory_custom:

# List of names of default host variables to pass through from kayobe hosts to
# the kolla-ansible seed host, if set. See also
# kolla_seed_inventory_pass_through_host_vars_map.
#kolla_seed_inventory_pass_through_host_vars_default:

# List of names of additional host variables to pass through from kayobe hosts
# to the kolla-ansible seed host, if set. See also
# kolla_seed_inventory_pass_through_host_vars_map.
#kolla_seed_inventory_pass_through_host_vars_extra:

# List of names of host variables to pass through from kayobe hosts to
# the kolla-ansible seed host, if set. See also
# kolla_seed_inventory_pass_through_host_vars_map.
#kolla_seed_inventory_pass_through_host_vars:

# Dict mapping names of default variables in
# kolla_seed_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_seed_inventory_pass_through_host_vars_map_default:

# Dict mapping names of extra variables in
# kolla_seed_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_seed_inventory_pass_through_host_vars_map_extra:

# Dict mapping names of variables in
# kolla_seed_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_seed_inventory_pass_through_host_vars_map:

# Custom overcloud inventory containing a mapping from top level groups to
# hosts.
#kolla_overcloud_inventory_custom_top_level:

# Custom overcloud inventory containing a mapping from components to top level
# groups.
#kolla_overcloud_inventory_custom_components:

# Custom overcloud inventory containing a mapping from services to components.
#kolla_overcloud_inventory_custom_services:

# Full custom overcloud inventory contents. By default this will be the
# concatenation of the top level, component, and service inventories.
#kolla_overcloud_inventory_custom:

# Dict mapping from kolla-ansible groups to kayobe groups and variables. Each
# item is a dict with the following items:
# * groups: A list of kayobe ansible groups to map to this kolla-ansible group.
# * vars: A dict mapping variable names to values for hosts in this
#         kolla-ansible group.
#kolla_overcloud_inventory_top_level_group_map:

# List of names of top level kolla-ansible groups. Any of these groups which
# have no hosts mapped to them will be provided with an empty group definition.
#kolla_overcloud_inventory_kolla_top_level_groups:

# List of names of default host variables to pass through from kayobe hosts to
# kolla-ansible hosts, if set. See also
# kolla_overcloud_inventory_pass_through_host_vars_map.
#kolla_overcloud_inventory_pass_through_host_vars_default:

# List of names of additional host variables to pass through from kayobe hosts
# to kolla-ansible hosts, if set. See also
# kolla_overcloud_inventory_pass_through_host_vars_map.
#kolla_overcloud_inventory_pass_through_host_vars_extra:

# List of names of host variables to pass through from kayobe hosts to
# kolla-ansible hosts, if set. See also
# kolla_overcloud_inventory_pass_through_host_vars_map.
#kolla_overcloud_inventory_pass_through_host_vars:

# Dict mapping names of default variables in
# kolla_overcloud_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_overcloud_inventory_pass_through_host_vars_map_default:

# Dict mapping names of additional variables in
# kolla_overcloud_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_overcloud_inventory_pass_through_host_vars_map_extra:

# Dict mapping names of variables in
# kolla_overcloud_inventory_pass_through_host_vars to the variable to use in
# kolla-ansible. If a variable name is not in this mapping the kayobe name is
# used.
#kolla_overcloud_inventory_pass_through_host_vars_map:

###############################################################################
# Kolla-ansible configuration.

# Virtualenv directory where Kolla-ansible's ansible modules will execute
# remotely on the target nodes. If None, no virtualenv will be used.
#kolla_ansible_target_venv:

# Password to use to encrypt the kolla-ansible passwords.yml file.
#kolla_ansible_vault_password:

# Hashi Vault
#kolla_ansible_vault_addr:
#kolla_ansible_vault_mount_point:
#kolla_ansible_vault_kv_path:
#kolla_ansible_vault_namespace:
#kolla_ansible_vault_role_id:
#kolla_ansible_vault_secret_id:
#kolla_ansible_vault_token:
#kolla_ansible_vault_cacert:

# Whether TLS is enabled for the external API endpoints. Default is 'no'.
#kolla_enable_tls_external:

# Whether TLS is enabled for the internal API endpoints. Default is 'no'.
#kolla_enable_tls_internal:

# Whether debug logging is enabled. Default is 'false'.
#kolla_openstack_logging_debug:

# Upper constraints file for installation of Kolla.
# Default value is {{ pip_upper_constraints_file }}.
#kolla_upper_constraints_file:

# User account to use for Kolla SSH access. Default is 'kolla'.
#kolla_ansible_user:

# Primary group of Kolla SSH user. Default is 'kolla'.
#kolla_ansible_group:

# Whether to use privilege escalation for all operations performed via Kolla
# Ansible. Default is 'false'.
#kolla_ansible_become:

# Whether to create a user account, configure passwordless sudo and authorise
# an SSH key for Kolla Ansible. Default is 'true'.
#kolla_ansible_create_user:

###############################################################################
# Kolla feature flag configuration.

#kolla_enable_aodh:
#kolla_enable_barbican:
#kolla_enable_blazar:
#kolla_enable_ceilometer:
#kolla_enable_ceilometer_horizon_policy_file:
#kolla_enable_ceilometer_ipmi:
#kolla_enable_ceilometer_prometheus_pushgateway:
#kolla_enable_cells:
#kolla_enable_central_logging:
#kolla_enable_ceph_rgw:
#kolla_enable_ceph_rgw_loadbalancer:
#kolla_enable_cinder:
#kolla_enable_cinder_backend_hnas_nfs:
#kolla_enable_cinder_backend_iscsi:
#kolla_enable_cinder_backend_lvm:
#kolla_enable_cinder_backend_nfs:
#kolla_enable_cinder_backend_pure_fc:
#kolla_enable_cinder_backend_pure_iscsi:
#kolla_enable_cinder_backend_pure_roce:
#kolla_enable_cinder_backend_quobyte:
#kolla_enable_cinder_backup:
#kolla_enable_cinder_horizon_policy_file:
#kolla_enable_cloudkitty:
#kolla_enable_collectd:
#kolla_enable_container_healthchecks:
#kolla_enable_cyborg:
#kolla_enable_designate:
#kolla_enable_destroy_images:
#kolla_enable_etcd:
#kolla_enable_external_api_firewalld:
#kolla_enable_external_mariadb_load_balancer:
#kolla_enable_fluentd:
#kolla_enable_fluentd_systemd:
#kolla_enable_glance:
#kolla_enable_glance_horizon_policy_file:
#kolla_enable_glance_image_cache:
#kolla_enable_gnocchi:
#kolla_enable_gnocchi_statsd:
#kolla_enable_grafana:
#kolla_enable_grafana_external:
#kolla_enable_hacluster:
#kolla_enable_haproxy:
#kolla_enable_haproxy_memcached:
#kolla_enable_heat:
#kolla_enable_heat_horizon_policy_file:
#kolla_enable_horizon:
#kolla_enable_horizon_blazar:
#kolla_enable_horizon_cloudkitty:
#kolla_enable_horizon_designate:
#kolla_enable_horizon_fwaas:
#kolla_enable_horizon_heat:
#kolla_enable_horizon_ironic:
#kolla_enable_horizon_magnum:
#kolla_enable_horizon_manila:
#kolla_enable_horizon_masakari:
#kolla_enable_horizon_mistral:
#kolla_enable_horizon_neutron_vpnaas:
#kolla_enable_horizon_octavia:
#kolla_enable_horizon_tacker:
#kolla_enable_horizon_trove:
#kolla_enable_horizon_watcher:
#kolla_enable_horizon_zun:
#kolla_enable_influxdb:
#kolla_enable_ironic:
#kolla_enable_ironic_neutron_agent:
#kolla_enable_ironic_prometheus_exporter:
#kolla_enable_iscsid:
#kolla_enable_keepalived:
#kolla_enable_keystone:
#kolla_enable_keystone_federation:
#kolla_enable_keystone_horizon_policy_file:
#kolla_enable_kuryr:
#kolla_enable_letsencrypt:
#kolla_enable_loadbalancer:
#kolla_enable_magnum:
#kolla_enable_manila:
#kolla_enable_manila_backend_cephfs_native:
#kolla_enable_manila_backend_cephfs_nfs:
#kolla_enable_manila_backend_generic:
#kolla_enable_manila_backend_glusterfs_nfs:
#kolla_enable_manila_backend_hnas:
#kolla_enable_mariabackup:
#kolla_enable_mariadb:
#kolla_enable_masakari:
#kolla_enable_masakari_hostmonitor:
#kolla_enable_masakari_instancemonitor:
#kolla_enable_memcached:
#kolla_enable_mistral:
#kolla_enable_multipathd:
#kolla_enable_neutron:
#kolla_enable_neutron_agent_ha:
#kolla_enable_neutron_bgp_dragent:
#kolla_enable_neutron_dvr:
#kolla_enable_neutron_fwaas:
#kolla_enable_neutron_horizon_policy_file:
#kolla_enable_neutron_infoblox_ipam_agent:
#kolla_enable_neutron_metering:
#kolla_enable_neutron_mlnx:
#kolla_enable_neutron_packet_logging:
#kolla_enable_neutron_port_forwarding:
#kolla_enable_neutron_provider_networks:
#kolla_enable_neutron_qos:
#kolla_enable_neutron_segments:
#kolla_enable_neutron_sfc:
#kolla_enable_neutron_sriov:
#kolla_enable_neutron_taas:
#kolla_enable_neutron_trunk:
#kolla_enable_neutron_vpnaas:
#kolla_enable_nova:
#kolla_enable_nova_fake:
#kolla_enable_nova_horizon_policy_file:
#kolla_enable_nova_libvirt_container:
#kolla_enable_nova_serialconsole_proxy:
#kolla_enable_nova_ssh:
#kolla_enable_octavia:
#kolla_enable_octavia_driver_agent:
#kolla_enable_octavia_jobboard:
#kolla_enable_opensearch:
#kolla_enable_opensearch_dashboards:
#kolla_enable_opensearch_dashboards_external:
#kolla_enable_openstack_core:
#kolla_enable_openvswitch:
#kolla_enable_osprofiler:
#kolla_enable_ovn:
#kolla_enable_ovs_dpdk:
#kolla_enable_placement:
#kolla_enable_prometheus:
#kolla_enable_prometheus_alertmanager:
#kolla_enable_prometheus_alertmanager_external:
#kolla_enable_prometheus_blackbox_exporter:
#kolla_enable_prometheus_cadvisor:
#kolla_enable_prometheus_ceph_mgr_exporter:
#kolla_enable_prometheus_elasticsearch_exporter:
#kolla_enable_prometheus_etcd_integration:
#kolla_enable_prometheus_fluentd_integration:
#kolla_enable_prometheus_haproxy_exporter:
#kolla_enable_prometheus_libvirt_exporter:
#kolla_enable_prometheus_memcached_exporter:
#kolla_enable_prometheus_msteams:
#kolla_enable_prometheus_mysqld_exporter:
#kolla_enable_prometheus_node_exporter:
#kolla_enable_prometheus_openstack_exporter:
#kolla_enable_prometheus_openstack_exporter_external:
#kolla_enable_prometheus_rabbitmq_exporter:
#kolla_enable_prometheus_server:
#kolla_enable_proxysql:
#kolla_enable_rabbitmq:
#kolla_enable_redis:
#kolla_enable_skyline:
#kolla_enable_swift:
#kolla_enable_swift_recon:
#kolla_enable_swift_s3api:
#kolla_enable_tacker:
#kolla_enable_telegraf:
#kolla_enable_trove:
#kolla_enable_trove_singletenant:
#kolla_enable_venus:
#kolla_enable_watcher:
#kolla_enable_zun:

###############################################################################
# Kolla custom config generation.

# Feature flag to add $KAYOBE_CONFIG_PATH to the list of search paths used
# when searching for Kolla custom service configuration. Only has an effect in
# a multiple environments setup. This allows you to configure merging between
# your environment and the base layer. Defaults to true. Set to false to for
# backwards compatability.
#kolla_openstack_custom_config_environment_merging_enabled:

# Default value for kolla_openstack_custom_config_include_globs.
#kolla_openstack_custom_config_include_globs_default:

# Extra items to add to kolla_openstack_custom_config_include_globs_default
# to produce kolla_openstack_custom_config_include_globs.
#kolla_openstack_custom_config_include_globs_extra:

# List of dictionaries with the following keys:
#   glob: a glob pattern. Any files matching this pattern will be copied to the
#         the kolla custom config directory
#   enabled: boolean to disable the glob.
# This determines the list of files to copy to the generated kolla config
# directory.
#kolla_openstack_custom_config_include_globs:

# Kolla config generation rules. These operate on the list of files produced by
# applying kolla_openstack_custom_config_include_globs. Each of the paths in
# kolla_openstack_custom_config_paths is searched for files matching one of the
# globs. If a match is found, any files with the same relative path are grouped
# together. The rules determine what to do with these matching files e.g copy
# the most specific file without templating, merge the files with
# merge_configs, etc.
# List of dictionaries with the following keys:
#   glob: A glob matching files for this rule to match on (relative to the
#     search path)
#   priority: The rules are processed in increasing priority order with the
#     first rule matching taking effect.
#   strategy: How to process the matched file. One of copy, concat, template,
#      merge_configs, merge_yaml
#   params: List of params to pass to module enacting the strategy
# Strategies:
#   copy: Copy most specific file to kolla config without templating
#   template: Template most specific file to kolla config
#   concat: Concatenate files and copy the result to generated kolla config
#   merge_configs: Use the merge_configs module to merge an ini file, before
#     copying to the generated kolla-config.
#   merge_yaml: Use the merge_yaml module to merge a file, before copying to
#     the generated kolla-config.
#kolla_openstack_custom_config_rules:

# Whether to enable ini merging rules in
# kolla_openstack_custom_config_rules_default. Default is true.
#kolla_openstack_custom_config_merge_configs_enabled:

# Whether to enable yaml merging rules in
# kolla_openstack_custom_config_rules_default. Default is true.
#kolla_openstack_custom_config_merge_yaml_enabled:

# Default merge strategy for ini files in
# kolla_openstack_custom_config_rules_default. Default is concat.
#kolla_openstack_custom_config_ini_merge_strategy_default:

# Default value for kolla_openstack_custom_config_rules.
#kolla_openstack_custom_config_rules_default:

# List of globs to filter from kolla_openstack_custom_config_rules_default.
# Default is an empty list.
#kolla_openstack_custom_config_rules_default_remove:

# Extra items to add to kolla_openstack_custom_config_rules_default
# to produce kolla_openstack_custom_config_rules.
#kolla_openstack_custom_config_rules_extra:

###############################################################################
# Passwords and credentials.

# Dictionary containing default custom passwords to add or override in the
# Kolla passwords file.
#kolla_ansible_default_custom_passwords:

# Dictionary containing extra custom passwords to add or override in the Kolla
# passwords file.
#kolla_ansible_extra_custom_passwords:

# Dictionary containing custom passwords to add or override in the Kolla
# passwords file.
#kolla_ansible_custom_passwords:

###############################################################################
# OpenStack API addresses.

# Virtual IP address of OpenStack internal API. Default is the vip_address
# attribute of the internal network.
#kolla_internal_vip_address:

# Fully Qualified Domain Name (FQDN) of OpenStack internal API. Default is the
# fqdn attribute of the internal network if set, otherwise
# kolla_internal_vip_address.
#kolla_internal_fqdn:

# Virtual IP address of OpenStack external API. Default is the vip_address
# attribute of the external network.
#kolla_external_vip_address:

# Fully Qualified Domain Name (FQDN) of OpenStack external API. Default is the
# fqdn attribute of the external network if set, otherwise
# kolla_external_vip_address.
#kolla_external_fqdn:

###############################################################################
# TLS certificate bundle management

# External API certificate bundle.
#
# When kolla_enable_tls_external is true, this should contain an X.509
# certificate bundle for the external API.
#
# Note that this should be formatted as a literal style block scalar.
#kolla_external_tls_cert:

# Path to a CA certificate file to use for the OS_CACERT environment variable
# in public-openrc.sh file when TLS is enabled, instead of Kolla-Ansible's
# default.
#kolla_public_openrc_cacert:

# Internal API certificate bundle.
#
# When kolla_enable_tls_internal is true, this should contain an X.509
# certificate bundle for the internal API.
#
# Note that this should be formatted as a literal style block scalar.
#kolla_internal_tls_cert:

# Path to a CA certificate file to use for the OS_CACERT environment variable
# in admin-openrc.sh file when TLS is enabled, instead of Kolla-Ansible's
# default.
#kolla_admin_openrc_cacert:

###############################################################################
# Proxy configuration

# HTTP proxy URL (format: http(s)://[user:password@]proxy_name:port) used by
# Kolla. Default value is "{{ http_proxy }}".
#kolla_http_proxy:

# HTTPS proxy URL (format: http(s)://[user:password@]proxy_name:port) used by
# Kolla. Default value is "{{ https_proxy }}".
#kolla_https_proxy:

# List of domains, hostnames, IP addresses and networks for which no proxy is
# used. Default value is "{{ no_proxy }}".
#kolla_no_proxy:

###############################################################################
# Dummy variable to allow Ansible to accept this file.
workaround_ansible_issue_8743: yes