Skip to content

Set some default retries for url.yml in the install task #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpelisse merged 3 commits into from
Nov 15, 2024
Merged

Set some default retries for url.yml in the install task #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c51c41c
Set some default retries for url.yml in the install task
jajik Nov 5, 2024
949cde9
Add the new jws_url_download_* variables into README
jajik Nov 11, 2024
3cf240d
Add whitespaces to README to tweak formatting
jajik Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions roles/jws/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,26 @@ Role Defaults

### Download and install parameters

| Variable | Description | Default |
|:-------------------------|:-----------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|
| `jws_install_method` | Installation method, allowed values: `['zipfiles','rpm']` | `zipfiles` |
| `jws_install_dir` | Installation path for JWS/tomcat | `/opt` |
| `jws_rpm` | Installation RPM version | `jws6` |
| `jws_version` | Version of JWS to install | `6.0.0` |
| `jws_apply_patches` | Install JWS most recent cumulative patch for requested version | `False` |
| `jws_selinux_enabled` | Enable selinux policy enforcement for JWS | `True` |
| `jws_home` | Default installation path for JWS archives | `{{ jws_install_dir }}/jws-{{ jws_version.split('.')[0] }}.{{ jws_version.split('.')[1] }}/tomcat` |
| `jws_user` | posix user account for service | `tomcat` |
| `jws_uid` | posix UID user account for service | `tomcat` |
| `jws_group` | posix group for service | `tomcat` |
| `jws_gid` | posix GID user account for service | `tomcat` |
| `jws_native` | Install native bits; provide a zipfile path below with tomcat, while on JWS it will be interpolated from version | `False` |
| `jws_native_zipfile` | Tomcat native binaries archive filename | `''` |
| `jws_force_install` | Whether to stop any running tomcat process and continue installation | `false` |
| `jws_archive_repository` | Path local to controller for offline/download archive files | `{{ lookup('env', 'PWD') | default('/opt') }}` |
| `jws_offline_install` | Whether to perform a completely offline install |
`false` |

| Variable | Description | Default |
|:---------------------------|:-----------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|
| `jws_install_method` | Installation method, allowed values: `['zipfiles','rpm']` | `zipfiles` |
| `jws_install_dir` | Installation path for JWS/tomcat | `/opt` |
| `jws_rpm` | Installation RPM version | `jws6` |
| `jws_version` | Version of JWS to install | `6.0.0` |
| `jws_apply_patches` | Install JWS most recent cumulative patch for requested version | `False` |
| `jws_selinux_enabled` | Enable selinux policy enforcement for JWS | `True` |
| `jws_home` | Default installation path for JWS archives | `{{ jws_install_dir }}/jws-{{ jws_version.split('.')[0] }}.{{ jws_version.split('.')[1] }}/tomcat` |
| `jws_user` | posix user account for service | `tomcat` |
| `jws_uid` | posix UID user account for service | `tomcat` |
| `jws_group` | posix group for service | `tomcat` |
| `jws_gid` | posix GID user account for service | `tomcat` |
| `jws_native` | Install native bits; provide a zipfile path below with tomcat, while on JWS it will be interpolated from version | `False` |
| `jws_native_zipfile` | Tomcat native binaries archive filename | `''` |
| `jws_force_install` | Whether to stop any running tomcat process and continue installation | `false` |
| `jws_archive_repository` | Path local to controller for offline/download archive files | `{{ lookup('env', 'PWD') | default('/opt') }}` |
| `jws_offline_install` | Whether to perform a completely offline install |`false` |
| `jws_url_download_retries` | Number of retries in case a download fails | `5` |
| `jws_url_download_delay` | Delay among two consequent download retries | `10` |

### Service configuration

Expand Down
3 changes: 3 additions & 0 deletions roles/jws/defaults/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,11 @@
jws_install_download_archive_require_privilege_escalation: True
jws_install_unarchive_require_privilege_escalation: True

jws_url_download_retries: 5
jws_url_download_delay: 10

# Default version of Apache Tomcat to use if no version is provided
tomcat_version: 10.1.13

Check warning on line 41 in roles/jws/defaults/main.yml

View workflow job for this annotation

GitHub Actions / ci / linter (3.11, 2.15)

var-naming[no-role-prefix] 

Variables names from within roles should use jws_ as a prefix. (vars: tomcat_version)
# Switch to True if you want to also download native bits
jws_native: False
jws_native_zipfile: ''
Expand Down
8 changes: 8 additions & 0 deletions roles/jws/meta/argument_specs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,14 @@ argument_specs:
default: "{{ jws_install_dir }}/{{ jws_zipfile_rootdir }}"
description: "Home directory of jws zipfile installation"
type: "str"
jws_url_download_retries:
default: 5
description: "Number of retries in case a download fails"
type: "int"
jws_url_download_delay:
default: 10
description: "Delay among two consequent download retries"
type: "int"
uninstall:
options:
jws_skip_delete_zipfile:
Expand Down
2 changes: 2 additions & 0 deletions roles/jws/tasks/install/url.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@
mode: 0640
owner: "{{ jws.user }}"
group: "{{ jws.group }}"
retries: "{{ jws_url_download_retries }}"
delay: "{{ jws_url_download_delay }}"
Loading