Fixes readme file
This change fixes readme file. What changed: - switches order of variables and descriptions of variables. - fixed parallel advance upgrade options example. Signed-off-by: mciecierski <mciecier@redhat.com> Change-Id: Ic153bc80d77e712b513e881d8bded7e1070e4e8a
This commit is contained in:
parent
873197506d
commit
521cfb9988
74
README.rst
74
README.rst
|
@ -34,124 +34,124 @@ This role requires:
|
|||
Role Variables
|
||||
--------------
|
||||
|
||||
Available variables are listed below::
|
||||
|
||||
upgrade_noop: false
|
||||
Available variables are listed below.
|
||||
|
||||
Only create upgrade scripts without running them::
|
||||
|
||||
update_noop: false
|
||||
upgrade_noop: false
|
||||
|
||||
Only create update scripts without running them::
|
||||
|
||||
undercloud_upgrade: false
|
||||
update_noop: false
|
||||
|
||||
Run undercloud upgrade::
|
||||
|
||||
containerized_undercloud_upgrade: false
|
||||
undercloud_upgrade: false
|
||||
|
||||
Run containerized undercloud upgrade::
|
||||
|
||||
overcloud_upgrade: false
|
||||
containerized_undercloud_upgrade: false
|
||||
|
||||
Run overcloud upgrade::
|
||||
|
||||
undercloud_update: false
|
||||
overcloud_upgrade: false
|
||||
|
||||
Run undercloud update::
|
||||
|
||||
overcloud_update: false
|
||||
undercloud_update: false
|
||||
|
||||
Run overcloud update::
|
||||
|
||||
overcloud_deploy_script: "~/overcloud_deploy.sh"
|
||||
overcloud_update: false
|
||||
|
||||
Validate overcloud after update::
|
||||
|
||||
overcloud_images_validate: false
|
||||
overcloud_images_validate: false
|
||||
|
||||
Location of the initial overcloud deploy script::
|
||||
|
||||
undercloud_upgrade_script: "~/undercloud_upgrade.sh"
|
||||
overcloud_deploy_script: "~/overcloud_deploy.sh"
|
||||
|
||||
Location of the undercloud upgrade script which is going to be generated by this role::
|
||||
|
||||
overcloud_composable_upgrade_script: "~/composable_docker_upgrade.sh"
|
||||
undercloud_upgrade_script: "~/undercloud_upgrade.sh"
|
||||
|
||||
Location of the upgrade script used in the composable docker upgrade step which is going to be generated by this role::
|
||||
|
||||
overcloud_converge_upgrade_script: "~/converge_docker_upgrade.sh"
|
||||
overcloud_composable_upgrade_script: "~/composable_docker_upgrade.sh"
|
||||
|
||||
Location of the upgrade script used in the converge docker upgrade step which is going to be generated by this role::
|
||||
|
||||
undercloud_rc: "~/stackrc"
|
||||
overcloud_converge_upgrade_script: "~/converge_docker_upgrade.sh"
|
||||
|
||||
Location of the undercloud credentials file::
|
||||
|
||||
overcloud_rc: "~/overcloudrc"
|
||||
undercloud_rc: "~/stackrc"
|
||||
|
||||
Location of the overcloud credentials file::
|
||||
|
||||
upgrade_workarounds: false
|
||||
overcloud_rc: "~/overcloudrc"
|
||||
|
||||
Allows the user to apply known issues workarounds during the upgrade process. The list of patches/commands used for workarounds should be passed via --extra-vars and it should include dictionaries for undercloud/overcloud workarounds::
|
||||
|
||||
use_oooq: false
|
||||
upgrade_workarounds: false
|
||||
|
||||
Set to true when the deployment has been done by tripleo quickstart::
|
||||
|
||||
workload_launch: false
|
||||
use_oooq: false
|
||||
|
||||
Set to true to launch an instance before starting upgrade. This can be useful for running tests during upgrade such as live migration or floating IP connectivity checks::
|
||||
|
||||
workload_cleanup: false
|
||||
workload_launch: false
|
||||
|
||||
Set to true to cleanup previously launched workload when update/upgrade finishes::
|
||||
|
||||
external_network_name: "public"
|
||||
workload_cleanup: false
|
||||
|
||||
Name of the external network providing floating IPs for instance connectivity. This provides external connectivity and needs to exist beforehand, created by the user::
|
||||
|
||||
workload_image_url: "https://download.cirros-cloud.net/0.5.2/cirros-0.5.2-x86_64-disk.img"
|
||||
external_network_name: "public"
|
||||
|
||||
URL of the image used for the workload instance::
|
||||
|
||||
workload_memory: "512"
|
||||
workload_image_url: "https://download.cirros-cloud.net/0.5.2/cirros-0.5.2-x86_64-disk.img"
|
||||
|
||||
Amount of memory assigned for the workload instance::
|
||||
|
||||
workload_sriov: false
|
||||
workload_memory: "512"
|
||||
|
||||
Set to true to use an SRIOV PF port when workload is created. Notice this will not work with cirros images::
|
||||
|
||||
tripleo_ci: false
|
||||
workload_sriov: false
|
||||
|
||||
Set to true when running the role in the TripleO CI jobs. It avoids losing connectivity to the undercloud by skipping reboot and ssh kill tasks::
|
||||
|
||||
tripleo_ci: false
|
||||
|
||||
Bash commands, defines a custom upgrade init to be taken into account during overcloud upgrade::
|
||||
|
||||
upgrade_init_command: |
|
||||
sudo tripleo-repos -b pike current
|
||||
|
||||
Bash commands, defines a custom upgrade init to be taken into account during overcloud upgrade.
|
||||
Set it to true to get a multi-cell update. It changes the way the oc_roles_hosts is calculated::
|
||||
|
||||
update_cell: false
|
||||
|
||||
Set it to true to get a multi-cell update. It changes the way the oc_roles_hosts is calculated.
|
||||
When set to true add a vm with attached fip and monitor ping from the undercloud. If ping loss time is higher than `loss_threshold` seconds or `loss_threshold_percent` in percentage we fail::
|
||||
|
||||
l3_agent_connectivity_check: false
|
||||
l3_agent_connectivity_check: false
|
||||
|
||||
When set to true add a vm with attached fip and monitor ping from the undercloud. If ping loss time is higher than `loss_threshold` seconds or `loss_threshold_percent` in percentage we fail.
|
||||
For update run tasks we set a 0 seconds loss threshold by default::
|
||||
|
||||
update_loss_threshold: 0
|
||||
update_loss_threshold: 0
|
||||
|
||||
For update run tasks we set a 0 seconds loss threshold by default.
|
||||
Default time is 60 seconds for ping loss::
|
||||
|
||||
loss_threshold: 60
|
||||
loss_threshold: 60
|
||||
|
||||
Default time is second for ping loss.
|
||||
Failsafe percentage check for loss threashold in percentage::
|
||||
|
||||
loss_threshold_percent: 1
|
||||
|
||||
Failsafe percentage check for loss threashold in percentage
|
||||
loss_threshold_percent: 1
|
||||
|
||||
Set to true to enable validations::
|
||||
|
||||
|
@ -303,7 +303,7 @@ Multiple roles could be upgraded in parallel, to achieve this they should be sep
|
|||
|
||||
infrared tripleo-upgrade \
|
||||
--overcloud-upgrade yes \
|
||||
-e 'roles_upgrade_order=ControllerOpenstack;Database;Messaging'
|
||||
-e 'roles_upgrade_order=ControllerOpenstack,Database;Messaging'
|
||||
|
||||
will upgrade Controller and Database groups in parallel and then continue with Messaging.
|
||||
|
||||
|
|
Loading…
Reference in New Issue