Allow webhooks in containerized deployments - #5094
Conversation
github-actions
Bot
added
Needs tech review
|
The PR preview for 276a553 is available at theforeman-foreman-documentation-preview-pr-5094.surge.sh The following output files are affected by this PR: |
a7618cd to
fb12e1e
Compare
| When creating a webhook in the {ProjectWebUI}, you can customize events, payloads, HTTP authentication, content type, and headers. | ||
|
|
||
| TODO: Fact check - is this relevant in containers? | ||
| ifndef::foreman-deb,orcharhino[] |
There was a problem hiding this comment.
On a side note, why is this hidden for orcharhino? Doesn't orcharhino still run on selinux-enabled el*?
There was a problem hiding this comment.
I hid this in the past because in orcharhino downstream, we use a different installation guide -> I could not get the link to work. Thanks for the hint, I will look into this eventually. For now, it could stay as is.
| [role="_abstract"] | ||
| When creating a webhook in the {ProjectWebUI}, you can customize events, payloads, HTTP authentication, content type, and headers. | ||
|
|
||
| TODO: Fact check - is this relevant in containers? |
There was a problem hiding this comment.
Checking on my instance, this doesn't seem to be needed.
| A list of available types is provided in the following table. | ||
| Some events are marked as *custom*, in that case, the payload is an object object but a Ruby hash (key-value data structure) so syntax is different. | ||
|
|
||
| TODO: What to do with this, considering some plugins providing events are not containerized yet? Be diligent or just wait it out? |
| @@ -10,6 +10,13 @@ Then, you can configure {ProjectServer} to send webhook requests. | |||
| .Procedure | |||
| . On your {ProjectServer}, install the webhooks plugin: | |||
There was a problem hiding this comment.
For containerized builds, this would result in a list with a single ordered item. -> Should be unordered for containerized and ordered for all others.
| When creating a webhook in the {ProjectWebUI}, you can customize events, payloads, HTTP authentication, content type, and headers. | ||
|
|
||
| TODO: Fact check - is this relevant in containers? | ||
| ifndef::foreman-deb,orcharhino[] |
There was a problem hiding this comment.
I hid this in the past because in orcharhino downstream, we use a different installation guide -> I could not get the link to work. Thanks for the hint, I will look into this eventually. For now, it could stay as is.
| |Actions Remote Execution Run Host Job Katello Group Update Succeeded |Update package group using the Katello interface.|Actions::RemoteExecution::RunHostJob | ||
| |Actions Remote Execution Run Host Job Katello Package Update Succeeded |Update package using the Katello interface.|Actions::RemoteExecution::RunHostJob | ||
| endif::[] | ||
| ifndef::containerized[] |
There was a problem hiding this comment.
note: openscap and ansible are not in yet
| ifdef::katello,orcharhino,satellite[] | ||
| |Actions Remote Execution Run Host Job Katello Module Stream Action Succeeded |Perform a module stream action using the Katello interface.|Actions::RemoteExecution::RunHostJob | ||
| endif::[] | ||
| ifndef::containerized[] |
There was a problem hiding this comment.
note: leapp is not in yet
2 participants
https://redhat.atlassian.net/browse/SAT-47668
What changes are you introducing?
Once theforeman/foremanctl#694 goes in, webhooks (without shellhooks) will be available in containerized deployments. This change enables the relevant parts of documentation.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
See above.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
See the TODOs in the changes.
Contributor checklists
Please cherry-pick my commits into: