tripleo-upgrade/infrared_plugin/plugin.spec

206 lines
8.8 KiB
Ruby

---
plugin_type: install
subparsers:
tripleo-upgrade:
description: Upgrade or update TripleO deployment
include_groups: ["Ansible options", "Inventory", "Common options", "Answers file"]
groups:
- title: TripleO Upgrade
options:
overcloud-upgrade:
type: Bool
help: |
Upgrade Overcloud.
NOTE: Upgrade require overcloud deployment script to be available in home directory of undercloud
user at undercloud node
default: false
undercloud-upgrade:
type: Bool
help: |
Upgrade Undercloud
default: false
upgrade-workarounds:
type: Bool
help: |
Apply upgrade workarounds
default: false
upstream-container-images:
type: Bool
help: |
Use upstream or downstream container images during upgrade
default: false
undercloud-reboot:
type: Bool
help: |
Reboot undercloud post upgrade when ovs or kernel get upgraded
default: false
upgrade-floatingip-check:
type: Bool
help: |
Check floating ip connectivity during upgrade.
Note: This requires a running instance with attached floating ip and allowed icmp traffic.
default: false
upgrade-workload:
type: Bool
help: |
Launch workload before starting upgrade
default: false
upgrade-workloadimage:
type: Value
help: |
Image URL to be used for spawning instance before upgrade.
default: http://download.cirros-cloud.net/0.3.5/cirros-0.3.5-x86_64-disk.img
upgrade-workloadmemory:
type: Value
help: |
Memory assigned to the instance spawned before upgrade
default: 512
upgrade-workloaduser:
type: Value
help: |
User used for conecting to workload instance via SSH
default: cirros
upgrade-compute-evacuate:
type: Bool
help: |
Migrate instances between compute nodes during upgrade.
default: true
upgrade-controller-reboot:
type: Bool
help: |
Reboot controller nodes post upgrade
default: true
upgrade-controller-post:
type: Bool
help: |
Run controller post upgrade checks
default: true
upgrade-reboot-force:
type: Bool
help: |
Hard reboot nodes during upgrade
default: false
upgrade-docker-local-registry:
type: Bool
help: Use local docker registry on the undercloud
default: false
upgrade-docker-registry-url:
type: Value
help: The alternative docker registry to use for deployment.
default: 'registry.example.local'
upgrade-remove-rpm:
type: Bool
help: Remove packages which get migrated to containers during upgrade
default: false
upgrade-hci:
type: Bool
help: |
The upgrade workflow for HCI deployments is slightly different.
This option accomdates HCI upgrade.
default: false
upgrade-postcomposable-workload:
type: Bool
help: |
Launch workload after major composable upgrade step
default: false
upgrade-l3agent-failover-check:
type: Bool
help: |
Check l3 agent does not failover during upgrade.
Existing neutron router is required.
default: false
upgrade-nova-actions-check:
type: Bool
help: |
Check Nova actions can be performed to an already existing
instance post upgrade.
default: false
- title: TripleO Update
options:
overcloud-update:
type: Bool
help: |
Update Overcloud.
default: false
undercloud-update:
type: Bool
help: |
Update Undercloud
default: false
updates-workarounds:
type: Bool
help: |
Apply updates workarounds
default: false
deployment-files:
type: Value
help: |
Directory containing the templates of the overcloud deployment.
default: virt
- title: TripleO Options
options:
overcloud-stack:
type: Value
help: Overcloud stack name
default: "overcloud"
overcloud-ssh-user:
type: Value
help: Overcloud ssh user name name
default: ''
- title: TripleO Fast Forward Upgrade
options:
overcloud-ffu-upgrade:
type: Bool
help: |
Fast Forward Upgrade Overcloud
NOTE: Upgrade require overcloud deployment script to be available in home directory of undercloud
user at undercloud node
default: false
undercloud-ffu-upgrade:
type: Bool
help: |
Fast Forward Upgrade Undercloud
default: false
undercloud-ffu-releases:
type: ListValue
help: |
Undercloud FFU upgrade releases
default: 11,12,13
undercloud-ffu-repo:
type: Value
help: |
Undercloud FFU upgrade repository method
default: 'rhos-release'
upgrade-ffu-workarounds:
type: Bool
help: |
Apply FFU upgrade workarounds
default: false
overcloud-ffu-releases:
type: ListValue
help: |
Overcloud FFU upgrade releases
default: 11,12,13
overcloud-ffu-repo:
type: Value
help: |
Overcloud FFU upgrade repository method
default: 'rhos-release'
overcloud-ffu-bulk:
type: Bool
help: |
Fast Forward Upgrade all overcloud nodes at once
default: false
overcloud-ffu-compute-rolling:
type: Bool
help: |
Fast Forward Upgrade compute nodes one by one
default: false
- title: Set up FFU packages
options:
mirror:
type: Value
help: |
Enable usage of specified mirror (for rpm, pip etc) [brq,qeos,tlv - or hostname].
(Specified mirror needs to proxy multiple rpm source hosts and pypi packages.)