Bug 1386105 - Ask users to remove hooks before upgrade
Summary: Ask users to remove hooks before upgrade
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Install Guide
Version: 6.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified vote
Target Milestone: Unspecified
Assignee: Stephen Wadeley
QA Contact: Lucie Jirakova
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-10-18 07:54 UTC by Lukas Zapletal
Modified: 2019-09-26 14:43 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-10-20 10:17:38 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Lukas Zapletal 2016-10-18 07:54:26 UTC
Satellite 6 is shipped with Foreman Hooks plugin:

https://github.com/theforeman/foreman_hooks

Documented here:

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/server-administration-guide/102-using-foreman-hooks

When upgrading Satellite, these custom hooks often gets obsolete or not working as they are provided from third party sources. Even hook scripts provided by Red Hat or by Consultants wont work across all versions.

Therefore please add a note in our UPGRADE instructions to BACKUP AND REMOVE all hooks before upgrading. Ask the user to put hooks back only after Satellite is known to be working after upgrade.

Also please add a box in the Using foreman hooks section about the fact that hooks can modify workflows in Satellite and users may be requested to remove all hooks in order to get support from Red Hat.

Thanks

Comment 5 Stephen Wadeley 2016-10-20 09:55:36 UTC
Hello


Changes are now live on the customer portal.

For the Installation Guide, see [1]


For the Server Administration Guide, see [2]

[1] https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/installation-guide/chapter-6-upgrading-satellite-server-and-capsule-server#upgrading_satellite_server


[2] https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/server-administration-guide/102-using-foreman-hooks


However I should have also updated the paragraph with heading "Foreman Hooks' Report Class Renamed to ConfigReport" [3] as it might be irritating to not mention the need to remove hooks before upgrade while explaining about the need to move hooks.

Will improve that now.

[3] https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/installation-guide/chapter-6-upgrading-satellite-server-and-capsule-server





Thank you

Comment 7 Stephen Wadeley 2016-10-20 10:17:38 UTC
Re comment 5

The paragraph with heading "Foreman Hooks' Report Class Renamed to ConfigReport" has been update to take into account the need to remove hooks before upgrading.


Thank you


Note You need to log in before you can comment on or make changes to this bug.