2e983575c1
Looking through the documentation I noticed several spelling mistakes that were likely copy-pasted to documentation for various roles. This commit attempts to update all the README's and fix trivial misspellings. Change-Id: I26096360f6b0fffd3272a52c8303f1c8e81829cd |
||
---|---|---|
.. | ||
defaults | ||
meta | ||
molecule/default | ||
tasks | ||
tests | ||
README.md |
tripleo_overcloud_image_upload
A role to run an overcloud image upload.
Requirements
None.
Role Variables
tripleo_overcloud_image_upload_architecture
: (String) Architecture type for the images being uploaded.tripleo_overcloud_image_upload_debug
: (Boolean) Flag to print out the command that is run. Default: Falsetripleo_overcloud_image_upload_generate_scripts
: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value oftripleo_generate_scripts
or False iftripleo_generate_scripts
is not defined.tripleo_overcloud_image_upload_generate_scripts_only
: (Boolean) Do not run the actual command - to be used in conjunction withtripleo_overcloud_image_upload_generate_scripts
. By default uses the value oftripleo_generate_scripts_only
or False iftripleo_generate_scripts_only
is not defined.tripleo_overcloud_image_upload_home_dir
: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}"tripleo_overcloud_image_upload_http_boot
: (String) Root directory for the ironic-python-agent-imagetripleo_overcloud_image_upload_image_path
: (String) Path to directory overcloud images. By default the command will use the images intripleo_overcloud_image_upload_home_dir
if this is not specified.tripleo_overcloud_image_upload_image_type
: (String) If specified, restrict the image type to upload. Should be one of {os,ironic-python-agent}tripleo_overcloud_image_upload_ironic_python_agent_name
: (String) OpenStack ironic-python-agent image filenametripleo_overcloud_image_upload_log_combine
: (Boolean) Flag to combine stdout and stderr in the logfile. Default: truetripleo_overcloud_image_upload_log_output
: (Boolean) Flag to log the output to a file rather than show it in the ansible output. Default: truetripleo_overcloud_image_upload_log
: (String) Install log file path. Default: "{{ tripleo_overcloud_image_upload_home_dir }}/overcloud_image_upload.log"tripleo_overcloud_image_upload_os_cloud
: (String) (String) OS_CLOUD value to use when running the command. Iftripleo_os_cloud
is defined, it will be the default. Otherwise the default is ''. This variable takes precedence overtripleo_overcloud_image_upload_rc_file
.tripleo_overcloud_image_upload_os_image_name
: (String) OpenStack disk image filenametripleo_overcloud_image_upload_platform
: (String) Platform type for the images being uploaded.tripleo_overcloud_image_upload_rc_file
: (String) (String) Path to the credential file to use. Iftripleo_rc_file
is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc"tripleo_overcloud_image_upload_update_existing
: (Boolean) Update the images if they already exist. Default: falsetripleo_overcloud_image_upload_whole_disk
: (Boolean) Overcloud image being uploaded is considered a whole disk image. Default: false
NOTE: Please note that this command should be run against the undercloud so the
OS_CLOUD or rc file variables should be set to use the 'undercloud' when
calling this role. If you are not defining tripleo_os_cloud
or tripleo_rc_file
,
stackrc will be used by default.
Output Variables
tripleo_overcloud_image_upload_output
: (String) The command standard output whentripleo_overcloud_image_upload_log_output
is set to false.tripleo_overcloud_image_upload_result
: Ansible shell execution results
Dependencies
None.
Example Playbook
Example container list execution playbook
- hosts: undercloud
gather_facts: true
tasks:
- name: Get overcloud image_upload
import_role:
name: tripleo_overcloud_image_upload
vars:
tripleo_overcloud_image_upload_update_existing: true
License
Apache-2.0