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

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

There is a small fix needed. Check the inline comment.

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

Another fix needed.

Revision history for this message
Richard Harding (rharding) :
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 5679e90..80794c6 100644
3--- a/oci/README.md
4+++ b/oci/README.md
5@@ -6,7 +6,7 @@ Prometheus is a systems and service monitoring system. It collects metrics from
6
7 ## Tags
8
9-* `2.20.1`, `2.20`, `2`, `beta` - **/!\ this is a beta release**
10+* `2.20.1-focal`, `2.20.1`, `2.20-focal`, `2.20`, `2-focal`, `2`, `focal`, `beta` - **/!\ this is a beta release**
11
12 ## Architectures supported
13
14@@ -17,25 +17,20 @@ Prometheus is a systems and service monitoring system. It collects metrics from
15 ### Docker CLI
16
17 ```sh
18-$ docker run --name prometheus -e TZ=UTC -d squeakywheel/prometheus:edge
19+$ docker run -d --name prometheus -p 30090:9090 -e TZ=Europe/London squeakywheel/prometheus: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 prometheus -v /path/to/persisted/data:/prometheus -e TZ=UTC -d squeakywheel/prometheus: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 instance at [`localhost:30090`](http://localhost:30090/).
30
31 #### Parameters
32
33 | Parameter | Description |
34 |---|---|
35 | `-e TZ=UTC` | Timezone. |
36-| `-v /path/to/persisted/data:/prometheus` | Pass the directory used to persist the data. |
37-| `-v /path/to/prometheus/config/file/prometheus.yml:/etc/prometheus/prometheus.yml` | Pass a custom config file. |
38-| `-v /path/to/prometheus/config/file/alerts.yml:/etc/prometheus/alerts.yml` | Pass a custom alerts config file. |
39+| `-p 30090:9090` | Expose Prometheus server on `localhost:30090`. |
40+| `-v /path/to/persisted/data:/prometheus` | 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. |
41+| `-v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml` | Pass a custom config file (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/prometheus/plain/oci/examples/config/prometheus.yml)). |
42+| `-v /path/to/alerts.yml:/etc/prometheus/alerts.yml` | Pass a custom alerts config file (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/prometheus/plain/oci/examples/config/alerts.yml)). |
43
44
45 #### Testing/Debugging
46@@ -146,7 +141,7 @@ spec:
47 $ microk8s kubectl apply -f prometheus-deployment.yml
48 ```
49
50-You will now be able to connect to the Prometheus on `http://localhost:30090`.
51+You will now be able to connect to the Prometheus on [`http://localhost:30090`](http://localhost:30090).
52
53 ## Bugs and Features request
54

Subscribers

People subscribed via source and target branches