sap_swpm: New functionality to push SUM through the manual steps

[rob0d]

This will push SUM through the manual steps in order to fully automate the installation of the system when sap_swpm_sum_start is enabled.

If SWPM is in observer mode, it will not do anything as SWPM waits for SUM to complete.

Updated code (correcting for whitespace in HTTP Response Body) from Shell script for SUM provided by @sean-freeman in #738 (comment)

[berndfinger]

@rob0d Thanks for this contribution, this looks really cool and seems to be nice additional functionality without adding too much complexity. Will soon have some time for testing.

[berndfinger]

@rob0d - I'd ran a first test but it timed out in task Checking the status of SUM after 60 retries. Can you please explain which SAP software you used and if and how you prepared the test? I will then try to use the same scenario for my next test.

[rob0d]

Hi @berndfinger,
Can you check what was the response from ansible.builtin.uri on line 8 of roles/sap_swpm/tasks/post_install/sum_push_to_finish.yml?
It couldn't connect or the response wasn't what it expected (tests on line 20)?
If it's still running or if you can restart it try connecting to the SUM URL and check what it says there.

Also did you provide stack file to SUM?
For SUM to start correctly and start executing you need to set the following (at least this is what I set:
sap_swpm_mp_stack_path:
sap_swpm_mp_stack_file_name: . #MP_Stack_{{ sap_system_sid }}.xml
sap_swpm_configure_tms: 'true'
sap_swpm_sum_prepare: 'true'
sap_swpm_sum_start: 'true'
sap_swpm_tmsadm_password:

[berndfinger]

Hi @berndfinger, Can you check what was the response from ansible.builtin.uri on line 8 of roles/sap_swpm/tasks/post_install/sum_push_to_finish.yml? It couldn't connect or the response wasn't what it expected (tests on line 20)? If it's still running or if you can restart it try connecting to the SUM URL and check what it says there.

It couldn't connect, and the reply of a wget --no-check-certificate on the URL was:

HTTP request sent, awaiting response... 404 Not Found

But it is probably related to the missing parameters for SUM to start correctly. To prepare for this, I need more time for preparing and testing with a MP stack file. Unfortunately, I also have to work on some other open issues and PRs for this collection so I cannot immediately continue with testing this PR.

But maybe someone else can jump in and test the proposed code?

@rob0d Can you please provide more details about the software you configured in Maintenance Planner (e.g. product name, version, any additional selections)?

[rob0d]

Hi @berndfinger,

It looks like the SUM wasn't started by SWPM due to the missing parameters.

The process with Maintenance Planner is something like this:

• Create maintenance transaction in MP. I am using S/4 HANA 2023 with all current patches.
• Download the XML file.
• Download all the other files (or use Ansible role to do it).
• Set the parameters above and point it at the XML file.
• Run SWPM, it should start SUM.
• SUM will run for a while until it stops for a prompt. This is the point the Ansible SUM script takes over. It keeps checking and waiting until SUM is in the correct phase then does a POST to move it to the next step.
• The next step is the main upgrade which on our systems takes 8 hours (full S/4 HANA SP1 + all patches). Again, Ansible script loops and waits until SUM reaches the end of the process.
• There is a prompt at this stage asking for SPAU processing. As this is a new install, we just tick the box and continue.
• Finally Ansible script waits for SUM to complete the processing and the swpm role finishes.

[sean-freeman]

Git diff is misbehaving in this PR, only Ansible Task SAP SWPM Post Install - Control SUM if required is appended to /tasks/post_install.yml but the diff attempts to replace the entire file.

Test has begun for 1 new task + new task file with the updated v1.5.x codeline

[sean-freeman]

@rob0d Why restriction to PAS or OneHost? Personally I'd only ever install from PAS, but it has been questioned before so unless there is a referenceable reason - restricting is not the best.

Feedback:

• sap_swpm_sum_start is a boolean, so when condition == 'true' suffix is not required / will cause the Ansible Task to be skipped.
• Checking the status of SUM Ansible Task name is duplicated, which is confusing to end-user which stage SAP SUM is at.
• Get the config XML from SUM Ansible Task name is duplicated, see above
• Get the CSRF token from SUM Ansible Task name is duplicated, see above
• Move SUM to the next step Ansible Task name is duplicated, see above
• in _sap_swpm_sum_push.content has double space after in operator
• delay: 600 # 10 minutes is inconsistent with waits throughout the Ansible Collection, this is better set to 60 for consistency - even if it increases stdout.
• I would suggest adding message before the run, informing the user to...

Check the following URLs for SAP Software Update Manager (SUM) monitoring or actions:

SUM Monitor - https://{{ ansible_fqdn }}:1129/lmsl/sumobserver/S01/monitor/index.html
SUM Admin - https://{{ ansible_fqdn }}:1129/lmsl/sumabap/S01/slui/
SUM Admin Utilities - https://{{ ansible_fqdn }}:1129/lmsl/sumabap/S01/slui_ext/

[rob0d]

Git diff is misbehaving in this PR, only Ansible Task SAP SWPM Post Install - Control SUM if required is appended to /tasks/post_install.yml but the diff attempts to replace the entire file.

Test has begun for 1 new task + new task file with the updated v1.5.x codeline

Yes. I don't understand why. It's showing a conflict even though there doesn't seem to be one. I am not able to resolve it as I don't have write access to the repo.

[berndfinger]

Git diff is misbehaving in this PR, only Ansible Task SAP SWPM Post Install - Control SUM if required is appended to /tasks/post_install.yml but the diff attempts to replace the entire file.
Test has begun for 1 new task + new task file with the updated v1.5.x codeline

Yes. I don't understand why. It's showing a conflict even though there doesn't seem to be one. I am not able to resolve it as I don't have write access to the repo.

@rob0d - I found:

• The line:

# SPDX-License-Identifier: Apache-2.0

is missing at the top.

• Changed Files shows that the when condition of the task `SAP SWPM Post Install - Firewall Setup' had:

"sap_swpm_setup_firewall | bool"

whereas the current dev tree has:

"sap_swpm_setup_firewall"

Maybe the easiest way to solve this is that you modify your files accordingly. If that doesn't help, you could of course also create a new PR based on the current dev tree (or I could do that - but I'd rather have your userid in the git commit history ;-) ).

[berndfinger]

Solves #919.

[berndfinger]

@rob0d As there was no reply from you, I will now try to resolve the conflicts using the Resolve conflicts button.

[berndfinger]

@rob0d Unfortunately, my attempt to resolve the merge conflict using the Resolve conflicts button of the web interface failed, and the result are now duplicate lines in file tasks/post_install.yml. Maybe I missed to remove one of the merge conflict indicators.
I will now try to roll back this change after cloning your repo. If this fails, can you please revert my changes?

[berndfinger]

@rob0d I failed removing my commit so I added one more commit for resolving the merge conflict. I also added one more commit for adding the missing SPDX identifier to file roles/sap_swpm/tasks/post_install/sum_push_to_finish.yml.
Now trying to fix the ansible-lint and ansible-test sanity errors.

[berndfinger]

@rob0d Fixing the ansible-lint errors requires a code change in file tasks/post_install/sum_push_to_finish.yml, likely replacing the Ansible shell module by the command module. Also this task needs a change_when: false condition. So I cannot proceed with merging at this time because I don't want to interfere more with your work, and I would like you to review and decide how to solve the ansible-lint errors.

[rob0d]

Hi @berndfinger,
Thanks for looking at it. I will have a look at the lint errors and fix them. I also have some further updates that I will add.