History

Lance Bragstad 2e983575c1 trivial: fix spelling mistakes 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		2020-07-14 08:45:15 -05:00
..
defaults	Revert "New parameters in order to set how we want to redirect logs"	2020-07-13 15:34:30 +00:00
meta	Add container image prepare role	2020-01-20 10:48:36 -07:00
molecule/default	Allow to set log-file option for container-prepare	2020-04-08 08:27:47 +02:00
tasks	Revert "New parameters in order to set how we want to redirect logs"	2020-07-13 15:34:30 +00:00
tests	Fixed flake8 excludes and new-lines	2020-01-27 19:10:31 +00:00
README.md	trivial: fix spelling mistakes	2020-07-14 08:45:15 -05:00

README.md

tripleo_container_image_prepare

A role to perform the container image prepare action.

Requirements

None.

Role Variables

tripleo_container_image_prepare_become: (Boolean) Run the command as root. This needs to be true when uploading to the local undercloud registry. Default: true
tripleo_container_image_prepare_cleanup: (String) Cleanup behavior for local images left after upload. Can be one of full, partial, or none. Default is not set.
tripleo_container_image_prepare_debug: (Boolean) Flag to print out the prepare command. Default: False
tripleo_container_image_prepare_dry_run: (Boolean) Perform a dry run upload which will not perform any push, pull or modify operations. The environment file will still be populated. Default: false
tripleo_container_image_prepare_environment_files: (List) List of environment files. Default: []
tripleo_container_image_prepare_environment_directory: (List) Directories containing environment files. Should not be used if tripleo_container_image_prepare_environment_files is defined. Default: []
tripleo_container_image_prepare_home_dir: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}"
tripleo_container_image_prepare_output_env_file: (String) File to write heat environment file which specifies all image parameters. Default is not set.
tripleo_container_image_prepare_output_roles_file: (String) Roles file path on the remote system. Default is not set.
tripleo_container_image_prepare_timeout: (Number) Amount of time to wait for the command to conplete. Default: 1800

Output Variables

tripleo_container_image_prepare_result: Ansible shell execution results

Dependencies

None.

Example Playbook

Example container prepare execution playbook

- hosts: undercloud
  gather_facts: true
  tasks:
    - name: Run container prepare
      import_role:
        name: tripleo_container_image_prepare
      vars:
        tripleo_container_image_prepare_files:
          - /home/stack/container-image-prepare.yaml

License

Apache-2.0