8000 docs: add new workspace notifications dashboard and config by EdwardAngert · Pull Request #16548 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: add new workspace notifications dashboard and config #16548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 40 additions & 33 deletions docs/admin/monitoring/notifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,56 +14,75 @@ user(s) of the event.

Coder supports the following list of events:

### Workspace Events
### Template Events

These notifications are sent to the workspace owner:
These notifications are sent to users with **template admin** roles:

- Workspace created
- Workspace deleted
- Workspace manual build failure
- Workspace automatic build failure
- Workspace manually updated
- Workspace automatically updated
- Workspace marked as dormant
- Workspace marked for deletion
- Report: Workspace builds failed for template
- This notification is delivered as part of a weekly cron job and summarizes
the failed builds for a given template.
- Template deleted
- Template deprecated

### User Events

These notifications are sent to users with **owner** and **user admin** roles:

- User account activated
- User account created
- User account deleted
- User account suspended
- User account activated

These notifications are sent to users themselves:

- User account suspended
- User account activated
- User password reset (One-time passcode)

### Template Events
### Workspace Events

These notifications are sent to users with **template admin** roles:
These notifications are sent to the workspace owner:

- Template deleted
- Template deprecated
- Workspace automatic build failure
- Workspace created
- Workspace deleted
- Workspace manual build failure
- Workspace manually updated
- Workspace marked as dormant
- Workspace marked for deletion
- Out of memory (OOM) / Out of disk (OOD)
- [Configure](#configure-oomood-notifications) in the template `main.tf`.
- Report: Workspace builds failed for template
- This notification is delivered as part of a weekly cron job and summarizes
the failed builds for a given template.
- Template admins can [configure OOM/OOD](#configure-oomood-notifications) notifications in the template `main.tf`.
- Workspace automatically updated

## Delivery Methods

Notifications can be delivered through the Coder dashboard Inbox and by SMTP or webhook.
OOM/OOD notifications can be delivered to users in VS Code.

You can configure:

- SMTP or webhooks globally with
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
(default: `smtp`).
- Coder dashboard Inbox with
[`CODER_NOTIFICATIONS_INBOX_ENABLED`](../../../reference/cli/server.md#--notifications-inbox-enabled)
(default: `true`).

Premium customers can configure which method to use for each of the supported
[Events](#workspace-events).
See the [Preferences](#delivery-preferences) section for more details.

## Configuration

You can modify the notification delivery behavior using the following server
flags.
You can modify the notification delivery behavior in your Coder deployment's
`https://coder.example.com/settings/notifications`, or with the following server flags:

| Required | CLI | Env | Type | Description | Default |
|:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
| ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m |
| ✔️ | `--notifications-method` | `CODER_NOTIFICATIONS_METHOD` | `string` | Which delivery method to use (available options: 'smtp', 'webhook'). See [Delivery Methods](#delivery-methods) below. | smtp |
| -️ | `--notifications-max-send-attempts` | `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` | `int` | The upper limit of attempts to send a notification. | 5 |
| -️ | `--notifications-inbox-enabled` | `CODER_NOTIFICATIONS_INBOX_ENABLED` | `bool` | Enable or disable inbox notifications in the Coder dashboard. | true |

### Configure OOM/OOD notifications

Expand All @@ -75,18 +94,6 @@ This can help prevent agent disconnects due to OOM/OOD issues.
To enable OOM/OOD notifications on a template, follow the steps in the
[resource monitoring guide](../../templates/extending-templates/resource-monitoring.md).

## Delivery Methods

Notifications can currently be delivered by either SMTP or webhook. Each message
can only be delivered to one method, and this method is configured globally with
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
(default: `smtp`). When there are no delivery methods configured, notifications
will be disabled.

Premium customers can configure which method to use for each of the supported
[Events](#workspace-events); see the [Preferences](#delivery-preferences)
section below for more details.

## SMTP (Email)

Use the `smtp` method to deliver notifications by email to your users. Coder
Expand Down
6 changes: 6 additions & 0 deletions docs/images/icons/inbox-in.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,12 @@
"path": "./user-guides/workspace-management.md",
"icon_path": "./images/icons/generic.svg"
},
{
"title": "Workspace Notifications",
"description": "Manage workspace notifications",
"path": "./user-guides/inbox/index.md",
"icon_path": "./images/icons/inbox-in.svg"
},
{
"title": "Workspace Scheduling",
"description": "Cost control with workspace schedules",
Expand Down
1 change: 1 addition & 0 deletions docs/user-guides/inbox/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Workspace notifications
Loading
0