openstack/tripleo-upgrade
Code Issues Proposed changes

[Documentation] Migrate the format.

Browse Source 
Moved the file to README.rst for consistency with other OpenStack
project documentation.

Change-Id: I4754a085c6255f977142302d2bee135220056c4f
This commit is contained in:
Natal Ngétal 2018-11-26 10:24:05 +01:00
parent 8ac74a8177
commit e3e97beb53
2 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.md → README.rst
View File

@ -1,3 +1,4 @@
===============
tripleo-upgrade
===============
@ -14,7 +15,7 @@ This role requires:
* Repositories containing packages to be upgraded are already installed on undercloud and overcloud nodes (or, for overcloud, define an upgrade_init_command variable)
* The initial overcloud deploy command is placed in a script file located in the path set by the overcloud_deploy_script var. Each option/environment file should be placed on a separate new line, e.g:
* The initial overcloud deploy command is placed in a script file located in the path set by the overcloud_deploy_script var. Each option/environment file should be placed on a separate new line, e.g::
source ~/stackrc
export THT=/usr/share/openstack-tripleo-heat-templates/
@ -33,87 +34,87 @@ This role requires:
Role Variables
--------------
Available variables are listed below:
Available variables are listed below::
upgrade_noop: false
Only create upgrade scripts without running them
Only create upgrade scripts without running them::
update_noop: false
Only create update scripts without running them
Only create update scripts without running them::
undercloud_upgrade: false
Run undercloud upgrade
Run undercloud upgrade::
containerized_undercloud_upgrade: false
Run containerized undercloud upgrade
Run containerized undercloud upgrade::
overcloud_upgrade: false
Run overcloud upgrade
Run overcloud upgrade::
undercloud_update: false
Run undercloud update
Run undercloud update::
overcloud_update: false
Run overcloud update
Run overcloud update::
overcloud_deploy_script: "~/overcloud_deploy.sh"
Location of the initial overcloud deploy script.
Location of the initial overcloud deploy script::
undercloud_upgrade_script: "~/undercloud_upgrade.sh"
Location of the undercloud upgrade script which is going to be generated by this role.
Location of the undercloud upgrade script which is going to be generated by this role::
overcloud_composable_upgrade_script: "~/composable_docker_upgrade.sh"
Location of the upgrade script used in the composable docker upgrade step which is going to be generated by this role.
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"
Location of the upgrade script used in the converge docker upgrade step which is going to be generated by this role.
Location of the upgrade script used in the converge docker upgrade step which is going to be generated by this role::
undercloud_rc: "~/stackrc"
Location of the undercloud credentials file.
Location of the undercloud credentials file::
overcloud_rc: "~/overcloudrc"
Location of the overcloud credentials file.
Location of the overcloud credentials file::
upgrade_workarounds: false
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.
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
Set to true when the deployment has been done by tripleo quickstart.
Set to true when the deployment has been done by tripleo quickstart::
workload_launch: 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.
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::
external_network_name: "public"
Name of the external network providing floating IPs for instance connectivity. This provides external connectivity and needs to exist beforehand, created by the user.
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: "http://download.cirros-cloud.net/0.3.5/cirros-0.3.5-x86_64-disk.img"
URL of the image used for the workload instance.
URL of the image used for the workload instance::
workload_memory: "512"
Amount of memory assigned for the workload instance.
Amount of memory assigned for the workload instance::
tripleo_ci: 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.
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::
upgrade_init_command: |
sudo tripleo-repos -b pike current
@ -125,12 +126,11 @@ Dependencies
None.
Example Playbook
----------------
An example playbook is provided in tests/test.yml:
::
An example playbook is provided in tests/test.yml::
- hosts: undercloud
gather_facts: true
@ -146,9 +146,7 @@ Usage with tripleo Quickstart
After a successful deployment with OOOQ, you can create the necessary
scripts using this example playbook (duplicate from
./tests/oooq-test.yaml):
::
./tests/oooq-test.yaml)::
---
- hosts: undercloud
@ -161,7 +159,7 @@ scripts using this example playbook (duplicate from
And then you run it like this (adjust the paths to your oooq specific
one)
one)::
ANSIBLE_SSH_ARGS="-F $(pwd)/ssh.config.ansible" \
ANSIBLE_CONFIG=$PWD/ansible.cfg \
@ -178,10 +176,10 @@ This will only create the file (without running the actual upgrade):
with the correct parameters.
Usage with InfraRed
-----------------------------
-------------------
tripleo-upgrade comes preinstalled as an InfraRed plugin.
In order to install it manually, the following InfraRed command should be used:
In order to install it manually, the following InfraRed command should be used::
infrared plugin add tripleo-upgrade
# add with a specific revision / branch
@ -189,18 +187,18 @@ In order to install it manually, the following InfraRed command should be used:
After a successful InfraRed overcloud deployment you need to run the following steps to upgrade the deployment:
Symlink roles path:
Symlink roles path::
ln -s $(pwd)/plugins $(pwd)/plugins/tripleo-upgrade/infrared_plugin/roles
Set up undercloud upgrade repositories:
Set up undercloud upgrade repositories::
infrared tripleo-undercloud \
--upgrade yes \
--mirror ${mirror_location} \
--ansible-args="tags=upgrade_repos"
Set up undercloud update repositories:
Set up undercloud update repositories::
infrared tripleo-undercloud \
--update-undercloud yes \
@ -209,17 +207,17 @@ Set up undercloud update repositories:
--version 12 \
--ansible-args="tags=upgrade_repos"
Upgrade undercloud:
Upgrade undercloud::
infrared tripleo-upgrade \
--undercloud-upgrade yes
Update undercloud:
Update undercloud::
infrared tripleo-upgrade \
--undercloud-update yes
Set up overcloud upgrade repositories:
Set up overcloud upgrade repositories::
infrared tripleo-overcloud \
--deployment-files virt \
@ -227,7 +225,7 @@ Set up overcloud upgrade repositories:
--mirror ${mirror_location} \
--ansible-args="tags=upgrade_collect_info,upgrade_repos"
Set up overcloud update repositories/containers:
Set up overcloud update repositories/containers::
infrared tripleo-overcloud \
--deployment-files virt \
@ -235,15 +233,16 @@ Set up overcloud update repositories/containers:
--build latest \
--ansible-args="tags=update_collect_info,update_undercloud_validation,update_repos,update_prepare_containers"
Upgrade overcloud:
Upgrade overcloud::
infrared tripleo-upgrade \
--overcloud-upgrade yes
Update overcloud:
Update overcloud::
infrared tripleo-upgrade \
--overcloud-update yes
Running the role manually from the undercloud
---------------------------------------------
This role can be run manually from the undercloud by doing the following steps:
@ -254,21 +253,23 @@ and overcloud nodes have the repositories with upgraded packages set up
Clone this repository
git clone https://git.openstack.org/openstack/tripleo-upgrade
Set ansible roles path
Set ansible roles path::
ANSIBLE_ROLES_PATH=$(pwd)
Create inventory file
Create inventory file::
printf "[undercloud]\nlocalhost ansible_connection=local" > hosts
Run the playbook including this role
Run the playbook including this role::
ansible-playbook -i hosts tripleo-upgrade/tests/test.yml
=======
License
-------
=======
BSD
==================
Author Information
------------------
==================
An optional section for the role authors to include contact information, or a website (HTML is not allowed).

2
setup.cfg
View File

@ -2,7 +2,7 @@
name = tripleo-upgrade
summary = tripleo-upgrade - An ansible role for upgrade and update a TripleO deployment
description-file =
README.md
README.rst
author = TripleO Team
author-email = openstack-discuss@lists.openstack.org
home-page = https://git.openstack.org/cgit/openstack/tripleo-upgrade