Skip to content

Commit

Permalink
add documention for the MS Teams chatops service
Browse files Browse the repository at this point in the history
  • Loading branch information
tmu-sprd committed Apr 23, 2024
1 parent 0e30877 commit 319df08
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,27 @@ r10k:
verbose: true
```
### Microsoft Teams notifications
Create an "Incoming Webhook" connector in Teams at the designated channel as described in the documentation: [Create Incoming Webhooks at learn.microsoft.com](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook). Keep the URL confidential!
Configure the service in the `webhook.yaml`:
```yaml
chatops:
enabled: true
service: teams
server_uri: "<Teams Webhook URI>"
```

Notifications are colored, according to their status.
green: Success
red: Failure
orange: Warning

Press the `Details` button to get more information.

If the queue is enabled in the `server` part of `webhook.yaml`, then two notifications are emitted: First, when the request is added to the queue and second, when the request was processed.

#### Bolt authentication

Due to the inherent security risk associated with passing plain text passwords to the Bolt CLI tool, all ability to set it within the application have been removed.
Expand Down Expand Up @@ -168,7 +189,7 @@ Default: nil
#### `server_uri`

Type: string
Description: The ChatOps service API URI to send the message to.
Description: The ChatOps service API URI to send the message to. For MS Teams, this is the Webhook URL created at the channel connectors.
Default: nil

### r10k options
Expand Down

0 comments on commit 319df08

Please sign in to comment.