Skip to content

Commit b159bd3

Browse files
committed
docs: add PagerDuty-specific information
1 parent d5f7b40 commit b159bd3

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed

docs/opsgenie.md

Whitespace-only changes.

docs/pagerduty.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# PagerDuty to Signals
2+
3+
We support importing from PagerDuty to Signals. To get started, please set up the following environment variables:
4+
5+
```shell
6+
export FIREHYDRANT_API_KEY=your-firehydrant-api-key
7+
export PROVIDER=PagerDuty
8+
export PROVIDER_API_KEY=your-pagerduty-api-key
9+
```
10+
11+
> [!NOTE]
12+
> Read-only key for PagerDuty should be sufficient.
13+
14+
Afterwards, run `signals-migrator import` and follow the prompts.
15+
16+
## Known limitations
17+
18+
- While we support importing "PagerDuty Service" as "FireHydrant Team", we still require the Teams API to be accessible. If your account does not have access to the Teams API, please see [#27](https://github.com/firehydrant/signals-migrator/issues/27) and let us know what error you encountered.

docs/victorops.md

Whitespace-only changes.

readme.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
This can be used to import resources from legacy alerting providers into Signals.
44

5-
## Supported providers
6-
7-
### Alerting
8-
9-
- PagerDuty
10-
- VictorOps
11-
- OpsGenie
125

136
## Usage
147

@@ -42,19 +35,18 @@ On the other hand, we can't reliably match teams ourselves as they have wide var
4235

4336
Afterwards, the tool will generate the mapping appropriately, handling de-duplication and merging as necessary.
4437

45-
## Feature roadmap
38+
## Supported providers
39+
40+
We support importing from various providers. Refer to individual documentation for provider-specific instructions:
4641

4742
| | PagerDuty | Opsgenie | VictorOps |
4843
| --- | --- | --- | --- |
44+
| Docs | [PagerDuty](./docs/pagerduty.md) | [Opsgenie](./docs/opsgenie.md) | [VictorOps](./docs/victorops.md) |
4945
| Import users | :white_check_mark: | :white_check_mark: | :white_check_mark: |
5046
| Import teams and members | :white_check_mark: | :white_check_mark: | :white_check_mark: |
5147
| Import escalation policies | :white_check_mark: | :white_check_mark: | :x: |
5248
| Import scheduling strategy | :white_check_mark: | :white_check_mark: | :x: |
5349

54-
55-
- [ ] Getting transposer URLs (e.g. Datadog) to the team data resource or a Signals ingest URL data resource
56-
- [ ] Auto-run `terraform apply` for users who would not manage their organization with Terraform after importing
57-
5850
## Developing
5951

6052
A devcontainer setup has been prepared to be used in VS Code. Run `direnv allow` to auto-load `.env` file.

0 commit comments

Comments
 (0)