Skip to content

Commit aa3dafd

Browse files
committed
More docs work - should now cover the entire installation
1 parent 9396bdb commit aa3dafd

3 files changed

Lines changed: 12 additions & 9 deletions

File tree

docs/setup_alertmanager-canary.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Create the Lambda function
1212
- Description: `Checks that important web properties are working.`
1313
- Runtime: `Node.js 4.3` (or higher)
1414
- Code entry type: `Upload a .ZIP file`
15-
- Download this to your desktop and then upload to Lambda: TODO
16-
- FIXME_REMOVE: S3 link URL: `https://s3.amazonaws.com/files.function61.com/alertmanager-canary/alertmanager-canary-2017-01-14.zip`
17-
- Enable encryption helpers: leave unchecked
15+
- Download
16+
[alertmanager-canary-2017-01-16.zip](https://s3.amazonaws.com/files.function61.com/alertmanager/alertmanager-canary-2017-01-16.zip)
17+
to your desktop and then upload to Lambda
1818

1919
Now, for each property that you want to monitor, add those checks as separate ENV variables. Example:
2020

2121
- `CHECK1` = `{"url":"https://example.com/"§"find":"This domain is established to be used for illustrative examples in documents."}`
22-
- `INGEST_TOPIC` = `arn:aws:sns:us-west-2:426466625513:AlertManager-ingest` (replace your region and customer ID)
22+
- `INGEST_TOPIC` = ARN of your ingest topic (mine looked like `arn:aws:sns:us-west-2:426466625513:AlertManager-ingest`)
2323

2424
(NOTE: `,` chars in `CHECK...` JSON are replaced with `§` because the geniuses that implemented ENV variables
2525
in Lambda probably serialize the ENV list as a `,`-separated string because currently

docs/setup_alertmanager.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ Create Lambda function
1010
- Name: `AlertManager`
1111
- Description: `AlertManager main: ingestor & alerter`
1212
- Runtime: `Node.js 4.3`
13-
- FIXME Code entry type: `Upload a file from Amazon S3`
14-
- FIXME S3 link URL: `https://s3.amazonaws.com/files.function61.com/lambda-canary/2017-01-13.zip`
15-
- Paste code from `ingestor/index.js`
16-
- Enable encryption helpers: leave unchecked
13+
- Download
14+
[alertmanager-2017-01-16.zip](https://s3.amazonaws.com/files.function61.com/alertmanager/alertmanager-2017-01-16.zip)
15+
to your desktop and then upload to Lambda
1716

1817
Env variables:
1918

20-
- `ALERT_TOPIC` = `arn:aws:sns:__REGION__:__AWS_ACCOUNT_ID__:AlertManager-alert` (replace `__AWS_ACCOUNT_ID__` with your ID and `__REGION__` with your region)
19+
- `ALERT_TOPIC` = ARN of your alert topic (mine looked like `arn:aws:sns:us-west-2:426466625513:AlertManager-alert`)
2120

2221
Role config:
2322

docs/setup_sns.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ In `SNS > Topics > Create new topic`:
1212
- Topic name = `AlertManager-ingest`
1313
- Display name = (leave blank)
1414

15+
Write the `Topic ARN` down - you'll need this when setting up Lambda.
16+
1517

1618
Create topic "AlertManager-alert"
1719
---------------------------------
@@ -21,6 +23,8 @@ In `SNS > Topics > Create new topic`:
2123
- Topic name = `AlertManager-alert`
2224
- Display name = `ALERT` (this is shown in SMS message prefix etc.)
2325

26+
Write the `Topic ARN` down (for this topic as well) - you'll need this when setting up Lambda.
27+
2428

2529
Add first subscriber to alert topic
2630
-----------------------------------

0 commit comments

Comments
 (0)