tripleo-upgrade/defaults/main.yml

332 lines
10 KiB
YAML

---
# defaults file for tripleo-upgrade
# main vars:
working_dir: "{{ (ansible_env|default({})).HOME|default('/home/stack') }}"
# undercloud.conf
undercloud_conf: "{{ working_dir }}/undercloud.conf"
# overcloud stack name
overcloud_stack_name: "overcloud"
# TODO: those variable can be changed for the explicit keyword in tag
# when https://github.com/ansible/ansible/issues/11045 is merged.
# enable update/upgrade
upgrade_noop: false
update_noop: false
undercloud_upgrade: false
undercloud_os_upgrade: false
containerized_undercloud_upgrade: true
overcloud_upgrade: false
undercloud_update: false
overcloud_update: false
overcloud_images_validate: false
overcloud_batch_update: false
# enable ffu upgrade
ffu_undercloud_upgrade: false
ffu_undercloud_os_upgrade: false
ffu_overcloud_upgrade: false
ffu_noop: false
ffu_bulk: true
ffu_computes_rolling: false
# enable all at once FFWD upgrade.
# This procedure will pause ceph and upgrade the whole overcloud
# at once.
fast_and_furious: false
# enable cells update
update_cell: false
# the role isn't run agains a valid OpenStack
# environment. This option (as well as the noop ones)
# are used when testing role's code.
mock_environment: "{{ upgrade_noop or update_noop or ffu_noop }}"
# enable upgrade workarounds
upgrade_workarounds: false
# enable update workarounds
updates_workarounds: false
# enable group validations execution
run_validations: false
# comma separated list of skipped validations
skiplist_validations: ''
# Validation Ansible inventory for Upgrade
upgrade_validation_inventory: "{{ working_dir }}/overcloud-deploy/{{ overcloud_stack_name }}/config-download/{{ overcloud_stack_name }}/tripleo-ansible-inventory.yaml"
# extra arguments to pass in the validations group
# execution.
# Example: validations_extra_args: "--extra-vars min_undercloud_ram_gb=5"
validations_extra_args: ''
# validations groups for updates to be
# executed if updates_validations is true.
updates_validations_groups:
- pre-update
- pre-update-prepare
- pre-update-run
- post-update
# validations groups for updates to be
# executed if updates_validations is true.
upgrades_validations_groups:
- pre-upgrade
- pre-system-upgrade
- pre-undercloud-upgrade
- pre-overcloud-prepare
- pre-overcloud-upgrade
- pre-overcloud-converge
- post-upgrade
# enable ffu workarounds
ffu_upgrade_workarounds: false
# use oooq
use_oooq: false
# Running in tripleo ci
tripleo_ci: false
# rc files:
undercloud_rc: "{{ working_dir }}/stackrc"
overcloud_rc: "{{ working_dir }}/{{ overcloud_stack_name }}rc"
# required for logstash indexing
timestamper_cmd: >-
| awk '{ print strftime("%Y-%m-%d %H:%M:%S |"), $0; fflush(); }'
launch_sanity_workload: true
# launch workload before update/upgrade
workload_launch: false
workload_cleanup: false
external_network_name: "public"
workload_image_url: "https://download.cirros-cloud.net/0.6.0/cirros-0.6.0-x86_64-disk.img"
workload_memory: "512"
workload_user: "cirros"
workload_disk: 5
workload_vcpu: 1
workload_swap: 512
workload_sriov: false
# upgrade scripts name:
undercloud_upgrade_script: "{{ working_dir }}/undercloud_upgrade.sh"
undercloud_update_script: "{{ working_dir }}/undercloud_update.sh"
overcloud_deploy_script: "{{ working_dir }}/overcloud_deploy.sh"
overcloud_upgrade_prepare_script: "{{ working_dir }}/overcloud_upgrade_prepare.sh"
overcloud_system_upgrade_script_base: "{{ working_dir }}/overcloud_system_upgrade"
overcloud_upgrade_run_script_base: "{{ working_dir }}/overcloud_upgrade_run"
overcloud_upgrade_converge_script: "{{ working_dir }}/overcloud_upgrade_converge.sh"
workload_launch_script: "{{ working_dir }}/workload_launch.sh"
# overcloud update scripts
overcloud_update_prepare_script: "{{ working_dir }}/overcloud_update_prepare.sh"
overcloud_update_run_script_base: "{{ working_dir }}/overcloud_update_run"
overcloud_validate_images_script: "{{ working_dir }}/validate_docker_images_versions.sh"
overcloud_validate_ap_services: openstack-cinder-volume openstack-cinder-backup openstack-manila-share
# container registry file for overcloud
container_registry_file: "docker-images.yaml"
# container prepare params env file
uc_containers_prepare_file: "containers-prepare-parameter.yaml"
# url of the remote docker registry to be used
docker_registry_url: 'registry.example.local'
# use upstream or downstream container images
upstream_container_images: true
# tripleo-heat-templates directory
tht_directory: "/usr/share/openstack-tripleo-heat-templates"
# default roles_data.yaml
default_roles_data: "{{ tht_directory }}/roles_data.yaml"
# default network_data.yaml
default_network_data: "{{ tht_directory }}/network_data.yaml"
# local registry environment file location
containers_default_parameters: "{{ working_dir }}/docker-osp12.yaml"
# container_images.yaml file location
container_images_location: "{{ working_dir }}/container_images.yaml"
# comma seperated list of container names that are expected to be not updated before container test
# Exclude nova_virtlogd by default, because container iamge test happens before overcloud reboot
# https://opendev.org/openstack/tripleo-heat-templates/src/commit/64a52f31507f464a0437aac0a53f65250845324b/releasenotes/notes/nova_virtlogd_wrapper-120fcfcfa0787b2b.yaml
excluded_containers_from_check: "nova_virtlogd"
# undercloud_hiera.yaml file location
undercloud_hiera: "{{ working_dir }}/undercloud_hiera.yaml"
# reboot nodes post upgrade
undercloud_reboot: false
controller_reboot: false
force_reboot: false
# time to wait for nodes to reboot in seconds
node_reboot_timeout: 300
# enable l3 agent connectivity check during upgrade
l3_agent_connectivity_check: false
l3_agent_connectivity_check_start_script: "{{ working_dir }}/l3_agent_start_ping.sh"
l3_agent_connectivity_check_wait_script: "{{ working_dir }}/l3_agent_wait_ping.sh"
l3_agent_connectivity_check_stop_script: "{{ working_dir }}/l3_agent_stop_ping.sh"
l3_agent_failover_check: false
# logs
log_playbook: "{{ working_dir }}/collect_log.yaml"
log_playbook_script: "{{ working_dir }}/collect_log"
log_stages: true
# enable web load test
fip_http_check: false
# migrate instances between compute nodes during upgrade
compute_evacuate: false
compute_cold_evacuate: false
compute_migration_timeout: 120
# workload exist prior to upgrade
workload_external: false
# enable post upgrade checks
controller_upgrade_post: false
# Provide a custom ssh-config file
need_ssh_config: true
# Extra environment files to pass into upgrade prepare command appending them
# in a list.
# Format: ['env_file1', 'env_file2', 'env_file3']
# It will be rendered joining each file with ' -e ' when running the command
# 'openstack overcloud upgrade prepare', so it will be possible to add
# extra parameters in a flexible way
upgrade_prepare_extra_params: []
# No upgrade_init_command by default
upgrade_init_command_dest: "{{working_dir}}/UpgradeInitCommand.yaml"
upgrade_init_command: false
# ffu undercloud upgrade
ffu_undercloud_releases: ['rocky', 'stein', 'train']
ffu_undercloud_repo_type: tripleo-repos
ffu_undercloud_repo_args:
tripleo_repos:
rocky: "-b rocky current"
stein: "-b stein current"
train: "-b train current"
# Tripleo OOOQ variables.
composable_scenario: ""
upgrade_composable_scenario: ""
## ffu overcloud upgrade
ffu_overcloud_releases: ['rocky', 'stein', 'train']
## ffu overcloud to use custom scripts instead of tripleo-repos
ffu_overcloud_repo_type: tripleo-repos
## overcloud ssh user
overcloud_ssh_user: ''
# when set to True it allows running most of the
# openstack overcloud commands with the --debug flag
tripleo_upgrade_debug: false
# when set to True it will append the flag --validation-errors-nonfatal
# into the "overcloud <action> prepare" and "overcloud <action> converge"
# commands. This means that the execution of the command will continue
# independently in spite of validation errors.
tripleo_upgrade_validations_non_fatal: false
# When set to true, the converge operations (upgrade, ffwd)
# will run with --update-plan-only. This does not provide full
# verification of the process, but might be necessary to fit within a
# reasonable job run time for gating.
tripleo_upgrade_converge_plan_only: false
## If set to true, overcloud upgrade will be run for each of the
# playbooks defined in 'overcloud_upgrade_playbooks', otherwise
# 'all' will be passed into --playbooks option.
overcloud_upgrade_multibooks: false
## If set to true, overcloud update will be run for each of the
# playbooks defined in 'overcloud_update_playbooks', otherwise
# 'all' will be passed into --playbooks option.
overcloud_update_multibooks: false
# Ansible playbooks executed during "overcloud upgrade run"
overcloud_upgrade_playbooks: ['upgrade_steps_playbook.yaml', 'deploy_steps_playbook.yaml', 'post_upgrade_steps_playbook.yaml']
# Ansible playbooks executed during "overcloud update run"
overcloud_update_playbooks: ['update_steps_playbook.yaml', 'deploy_steps_playbook.yaml']
# Post upgrade/update nova actions tests
nova_actions_check: false
# Enabled services yaml structure
enabled_services: {}
# Ceph OSD service present in overcloud
ceph_osd_enabled: false
# time to wait for cephadm to complete update in minutes
ceph_update_timeout: 20
# Remove unused RPMs
upgrade_remove_rpm: false
# List of roles deployed in overcloud
oc_roles: []
# Dictionary with roles and hosts per role
# oc_roles_hosts: {
# 'Controller' : ["controller-0", "controller-1", "controller-2"],
# 'Compute' : ["compute-0"]
# }
oc_roles_hosts: {}
# Roles upgrade order
roles_upgrade_order: '__undefined__'
# Packet loss threshold for a ping test in seconds.
loss_threshold: 60
# and in %
loss_threshold_percent: 1
# default for update run tasks
update_loss_threshold: 0
# Leapp OS upgrade variables
#
# Run leapp upgrade without RHSM subscription
# Requires workarounds being applied.
leapp_unsubscribed: false
leapp_unregister: true
leapp_skip_release_check: false
# Avoid Rhel Enforcement policies.
enforce_rhel: false
# Compact system upgrade prepare and
# system upgrade run into a single step
system_upgrade_compact: true
# rhsm overcloud environment location with subscription details
rhsm_overcloud_env: ''
# ephemeral heat enabled
ephemeral_heat: true
# extra args for update prepare and update converge
extra_args: ''