diff options
author | Bill Nottingham <notting@splat.cc> | 2021-04-30 20:14:38 +0200 |
---|---|---|
committer | Bill Nottingham <notting@splat.cc> | 2021-04-30 20:32:05 +0200 |
commit | c8cf28f266f674ea4cd0096886a0827f629cffac (patch) | |
tree | fc36dfa4e54af3a88e92b5cd71e708d47926a241 /docs/notification_system.md | |
parent | Merge pull request #10062 from shanemcd/fix-ee-cg (diff) | |
download | awx-c8cf28f266f674ea4cd0096886a0827f629cffac.tar.xz awx-c8cf28f266f674ea4cd0096886a0827f629cffac.zip |
Assorted renaming and string changes
Diffstat (limited to 'docs/notification_system.md')
-rw-r--r-- | docs/notification_system.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/notification_system.md b/docs/notification_system.md index bd60bd73b0..edd64275fe 100644 --- a/docs/notification_system.md +++ b/docs/notification_system.md @@ -14,7 +14,7 @@ At a high level, the typical notification task flow is: ## Templated notification messages -When creating a notification template, the user can optionally provide their own custom messages for each notification event (start, success, error). If a message is not provided, the default message generated by Tower will be used. +When creating a notification template, the user can optionally provide their own custom messages for each notification event (start, success, error). If a message is not provided, the default message generated by AWX will be used. The notification message can include templated fields written using Jinja templates. The templates may reference a set of white-listed fields found in the associated job's serialization. @@ -115,7 +115,7 @@ The following should be performed for good acceptance: ## Mattermost -The Mattermost notification integration uses Incoming Webhooks. A password is not required because the webhook URL itself is the secret. Webhooks must be enabled in the System Console of Mattermost. If the user wishes to allow Ansible Tower notifications to modify the Icon URL and username of the notification, then they must enable these options as well. +The Mattermost notification integration uses Incoming Webhooks. A password is not required because the webhook URL itself is the secret. Webhooks must be enabled in the System Console of Mattermost. If the user wishes to allow AWX notifications to modify the Icon URL and username of the notification, then they must enable these options as well. In order to enable these settings in Mattermost: 1. Go to System Console > Integrations > Custom Integrations. Check "Enable Incoming Webhooks". @@ -160,9 +160,9 @@ The following fields are available for the Rocket.Chat notification type: ## Pagerduty -Pagerduty is a fairly straightforward integration. The user will create an API Key in the Pagerduty system (this will be the token that is given to Tower) and then create a "Service" which will provide an "Integration Key" that will also be given to Tower. The other options of note are: +Pagerduty is a fairly straightforward integration. The user will create an API Key in the Pagerduty system (this will be the token that is given to AWX) and then create a "Service" which will provide an "Integration Key" that will also be given to AWX. The other options of note are: -* `subdomain`: When you sign up for the Pagerduty account, you will get a unique subdomain to communicate with. For instance, if you signed up as "towertest", the web dashboard will be at *towertest.pagerduty.com* and you will give the Tower API "towertest" as the subdomain (not the full domain). +* `subdomain`: When you sign up for the Pagerduty account, you will get a unique subdomain to communicate with. For instance, if you signed up as "towertest", the web dashboard will be at *towertest.pagerduty.com* and you will give the AWX API "towertest" as the subdomain (not the full domain). * `client_name`: This will be sent along with the alert content to the Pagerduty service to help identify the service that is using the API key/service. This is helpful if multiple integrations are using the same API key and service. ### Testing considerations @@ -178,7 +178,7 @@ Pagerduty allows you to sign up for a free trial with the service. Twilio is a Voice and SMS automation service. Once you are signed in, you'll need to create a phone number from which the message will be sent. You'll then define a "Messaging Service" under Programmable SMS and associate the number (the one you created for this purpose) with it. Note that you may need to verify this number or some other information before you are allowed to use it to send to any numbers. The Messaging Service does not need a status callback URL nor does it need the ability to process inbound messages. -Under your individual (or sub) account settings, you will have API credentials. The Account SID and AuthToken are what will be given to Tower. There are a couple of other important fields: +Under your individual (or sub) account settings, you will have API credentials. The Account SID and AuthToken are what will be given to AWX. There are a couple of other important fields: * `from_number`: This is the number associated with the messaging service above and must be given in the form of "+15556667777". * `to_numbers`: This will be the list of numbers to receive the SMS and should be the 10-digit phone number. @@ -194,7 +194,7 @@ Twilio is fairly straightforward to sign up for but there may not be a free tria ## IRC -The Tower IRC notification takes the form of an IRC bot that will connect, deliver its messages to channel(s) or individual user(s), and then disconnect. The Tower notification bot also supports SSL authentication. The Tower bot does not currently support Nickserv identification. If a channel or user does not exist or is not online, then the Notification will not fail; the failure scenario is reserved specifically for connectivity. +The AWX IRC notification takes the form of an IRC bot that will connect, deliver its messages to channel(s) or individual user(s), and then disconnect. The AWX notification bot also supports SSL authentication. The AWX bot does not currently support Nickserv identification. If a channel or user does not exist or is not online, then the Notification will not fail; the failure scenario is reserved specifically for connectivity. Connectivity information is straightforward: @@ -216,7 +216,7 @@ There are a few modern IRC servers to choose from. [InspIRCd](http://www.inspirc ## Webhook -The webhook notification type in Ansible Tower provides a simple interface for sending `POST`s to a predefined web service. Tower will `POST` to this address using `application/json` content type with the data payload containing all relevant details in JSON format. +The webhook notification type in AWX provides a simple interface for sending `POST`s to a predefined web service. AWX will `POST` to this address using `application/json` content type with the data payload containing all relevant details in JSON format. The parameters are fairly straightforward: @@ -256,7 +256,7 @@ This will create an `httpbin` service reachable from the AWX container at `http: ## Grafana -The Grafana notification type allows you to create Grafana annotations. Details about this feature of Grafana are available at http://docs.grafana.org/reference/annotations/. In order to allow Tower to add annotations, an API Key needs to be created in Grafana. Note that the created annotations are region events with start and endtime of the associated Tower Job. The annotation description is also provided by the subject of the associated Tower Job, for example: +The Grafana notification type allows you to create Grafana annotations. Details about this feature of Grafana are available at http://docs.grafana.org/reference/annotations/. In order to allow AWX to add annotations, an API Key needs to be created in Grafana. Note that the created annotations are region events with start and endtime of the associated AWX Job. The annotation description is also provided by the subject of the associated AWX Job, for example: ``` Job #1 'Ping Macbook' succeeded: https://towerhost/#/jobs/playbook/1 |