Merge ~valentinviennot/ubuntu-docker-images:update-prometheus-alertmanager-readme into ~ubuntu-docker-images/ubuntu-docker-images/+git/prometheus-alertmanager:edge

Proposed by Valentin Viennot
Status: Merged
Merged at revision: 1119ed00e0f5942f5905a64da24d030ca16540eb
Proposed branch: ~valentinviennot/ubuntu-docker-images:update-prometheus-alertmanager-readme
Merge into: ~ubuntu-docker-images/ubuntu-docker-images/+git/prometheus-alertmanager:edge
Diff against target: 52 lines (+7/-12)
1 file modified
oci/README.md (+7/-12)
Reviewer Review Type Date Requested Status
Lucas Kanashiro Approve
Richard Harding (community) Needs Fixing
Sergio Durigan Junior Pending
Review via email: mp+394059@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Lucas Kanashiro (lucaskanashiro) wrote :

Minor fix needed.

review: Needs Fixing
Revision history for this message
Richard Harding (rharding) wrote :

Just a partial review as it looks like Sergio has this, but -1 on any non-UTC timezone config if we have to have it.

review: Needs Fixing
Revision history for this message
Lucas Kanashiro (lucaskanashiro) wrote :

The TZ config is on our radar. I am approving this MP.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/oci/README.md b/oci/README.md
2index 8367dc5..3f3324a 100644
3--- a/oci/README.md
4+++ b/oci/README.md
5@@ -6,7 +6,7 @@ The Alertmanager handles alerts sent by client applications such as the Promethe
6
7 ## Tags
8
9-* `0.21.0`, `0.21`, `beta` - **/!\ this is a beta release**
10+* `0.21.0-focal`, `0.21.0`, `0.21-focal`, `0.21`, `focal`, `beta` - **/!\ this is a beta release**
11
12 ## Architectures supported
13
14@@ -17,24 +17,19 @@ The Alertmanager handles alerts sent by client applications such as the Promethe
15 ### Docker CLI
16
17 ```sh
18-$ docker run --name alertmanager -e TZ=UTC -d squeakywheel/prometheus-alertmanager:edge
19+$ docker run -d --name alertmanager -p 30093:9093 -e TZ=Europe/London squeakywheel/prometheus-alertmanager:edge
20 ```
21
22-Since containers are ephemeral, you may want to use persistent data rather than initializing a new database for each newly launched container. To do this, you can use docker volumes:
23-
24-```sh
25-$ docker run --name alertmanager -v /path/to/persisted/data:/alertmanager -e TZ=UTC -d squeakywheel/prometheus-alertmanager:edge
26-```
27-
28-**Important note**: the directory you will be using to persist the data needs to belong to `nogroup:nobody`. You can run `chown nogroup:nobody <path_to_persist_data>` before launching your container.
29+Access your Prometheus Alertmanager instance at `localhost:30093`.
30
31 #### Parameters
32
33 | Parameter | Description |
34 |---|---|
35 | `-e TZ=UTC` | Timezone. |
36-| `-v /path/to/persisted/data:/alertmanager` | Pass the directory used to persist the data. |
37-| `-v /path/to/alertmanager/config/file/alertmanager.yml:/etc/prometheus/alertmanger.yml` | Pass a custom config file. |
38+| `-p 30093:9093` | Expose Prometheus Alertmanager server on `localhost:30093`. |
39+| `-v /path/to/persisted/data:/alertmanager` | Persist data instead of initializing a new database for each newly launched container. **Important note**: the directory you will be using to persist the data needs to belong to `nogroup:nobody`. You can run `chown nogroup:nobody <path_to_persist_data>` before launching your container.|
40+| `-v /path/to/alertmanager/config/file/alertmanager.yml:/etc/prometheus/alertmanger.yml` | Pass a custom config file (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/prometheus-alertmanager/plain/oci/examples/config/alertmanager.yml)). |
41
42 #### Testing/Debugging
43
44@@ -53,7 +48,7 @@ With microk8s running, enable the `dns` and `storage` add-ons:
45 $ microk8s enable dns storage
46 ```
47
48-Create a configmap for the configuration file (check the upstream documentation [here](https://prometheus.io/docs/alerting/latest/configuration/)):
49+Create a configmap for the configuration file (check the [Prometheus documentation](https://prometheus.io/docs/alerting/latest/configuration/)):
50
51 ```sh
52 $ microk8s kubectl create configmap alertmanager-config --from-file=alertmanager=config/alertmanager.yml

Subscribers

People subscribed via source and target branches