Skip to content

Commit 6a38234

Browse files
committed
Allow webhooks in containerized deployments
1 parent 095fb8a commit 6a38234

6 files changed

Lines changed: 19 additions & 0 deletions

guides/common/assembly_using-foreman-webhooks.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ include::modules/proc_creating-a-webhook.adoc[leveloffset=+1]
1414

1515
include::modules/ref_webhooks-available-events.adoc[leveloffset=+1]
1616

17+
ifndef::containerized[]
1718
include::modules/con_shellhooks-plugin-for-smartproxy.adoc[leveloffset=+1]
1819

1920
include::modules/proc_installing-shellhooks-plugin.adoc[leveloffset=+1]
@@ -23,6 +24,7 @@ include::modules/proc_passing-arguments-to-shellhook-script-using-webhooks.adoc[
2324
include::modules/proc_passing-arguments-to-shellhook-script-using-curl.adoc[leveloffset=+1]
2425

2526
include::modules/proc_creating-a-shellhook-to-print-arguments.adoc[leveloffset=+1]
27+
endif::[]
2628

2729
ifdef::parent-context[:context: {parent-context}]
2830
ifndef::parent-context[:!context:]

guides/common/modules/con_webhooks-behavior-and-integration.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ The application sending the request does not wait for the response, or ignores i
1515
Because webhooks use HTTP, no new infrastructure needs be added to existing web services.
1616
Webhooks are useful where the action you want to perform in the external system can be achieved through its API.
1717

18+
ifndef::containerized[]
1819
Where it is necessary to run additional commands or edit files, the shellhooks plugin for {SmartProxies} is available.
1920
The shellhooks plugin enables you to define a shell script on the {SmartProxy} that can be executed through the API.
2021

2122
You can use webhooks successfully without installing the shellhooks plugin.
23+
endif::[]
2224

2325
Payload of a webhook is created from webhook templates.
2426
Webhook templates use the same ERB syntax as Provisioning templates.

guides/common/modules/proc_creating-a-webhook.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@
77
When creating a webhook in the {ProjectWebUI}, you can customize events, payloads, HTTP authentication, content type, and headers.
88

99
ifndef::foreman-deb,orcharhino[]
10+
ifndef::containerized[]
1011
[NOTE]
1112
====
1213
When configuring webhooks with endpoints with non-standard HTTP or HTTPS ports, an SELinux port must be assigned, see {InstallingServerDocURL}configuring-selinux-to-ensure-access-on-custom-ports_{project-context}[Configuring SELinux to ensure access to {Project} on custom ports] in _{InstallingServerDocTitle}_.
1314
====
1415
endif::[]
16+
endif::[]
1517

1618
.Procedure
1719
. In the {ProjectWebUI}, navigate to *Administer* > *Webhook* > *Webhooks*.

guides/common/modules/proc_installing-webhooks-plugin.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ Use the following procedure to install the webhooks plugin.
88
Then, you can configure {ProjectServer} to send webhook requests.
99

1010
.Procedure
11+
ifdef::containerized[]
12+
* On your {ProjectServer}, install the webhooks plugin:
13+
+
14+
[options="nowrap" subs="+quotes,attributes"]
15+
----
16+
# {foremanctl} --add-feature webhooks
17+
----
18+
endif::[]
19+
ifndef::containerized[]
1120
. On your {ProjectServer}, install the webhooks plugin:
1221
+
1322
[options="nowrap" subs="+quotes,attributes"]
@@ -20,3 +29,4 @@ Then, you can configure {ProjectServer} to send webhook requests.
2029
----
2130
# {foreman-installer} --enable-foreman-cli-webhooks
2231
----
32+
endif::[]

guides/common/modules/ref_webhooks-available-events.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ For more information about payload, go to *Administer* > *About* > *Support* > *
1212
A list of available types is provided in the following table.
1313
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.
1414

15+
TODO: What to do with this, considering some plugins providing events are not containerized yet? Be diligent or just wait it out?
1516
[cols="40%,30%,30%",options="header"]
1617
|====
1718
|Event name |Description|Payload

guides/doc-Administering_Project/master.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,11 @@ include::common/assembly_monitoring-project-resources.adoc[leveloffset=+1]
9494
ifndef::satellite[]
9595
include::common/assembly_limiting-host-resources.adoc[leveloffset=+1]
9696
endif::[]
97+
endif::[]
9798

9899
include::common/assembly_using-foreman-webhooks.adoc[leveloffset=+1]
99100

101+
ifndef::satellite[]
100102
include::common/assembly_working-efficiently-with-web-ui.adoc[leveloffset=+1]
101103

102104
[appendix]

0 commit comments

Comments
 (0)