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

Proposed by Valentin Viennot
Status: Merged
Merge reported by: Sergio Durigan Junior
Merged at revision: ea164036ba991b333283cecc4a79767ae46efb0b
Proposed branch: ~valentinviennot/ubuntu-docker-images:update-redis-readme
Merge into: ~ubuntu-docker-images/ubuntu-docker-images/+git/redis:edge
Diff against target: 44 lines (+12/-8)
1 file modified
README.md (+12/-8)
Reviewer Review Type Date Requested Status
Valentin Viennot (community) Approve
Sergio Durigan Junior Approve
Review via email: mp+393885@code.launchpad.net

Description of the change

Fixed link + small changes to reflect latest README template.

To post a comment you must log in.
Revision history for this message
Sergio Durigan Junior (sergiodj) wrote :

Thanks, I'm approving the MP, but I left one small comment. Feel free to address it if you think it makes sense.

review: Approve
Revision history for this message
Valentin Viennot (valentinviennot) :
review: Approve
Revision history for this message
Sergio Durigan Junior (sergiodj) wrote :

I merged this one.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index ef2ca35..879dc33 100644
3--- a/README.md
4+++ b/README.md
5@@ -18,20 +18,20 @@
6
7 ```sh
8 $ docker network create --driver bridge redis-network
9-$ docker run --name redis-container --network redis-network -e TZ=Europe/London -e REDIS_PASSWORD=mypassword squeakywheel/redis:edge
10+$ docker run -d --name redis-container --network redis-network -e TZ=Europe/London -e REDIS_PASSWORD=mypassword squeakywheel/redis:edge
11 ```
12
13 #### Parameters
14 | Parameter | Description |
15 |---|---|
16-| `-e TZ` | Timezone, e.g. `Europe/London` |
17+| `-e TZ=UTC` | Timezone |
18 | `-e ALLOW_EMPTY_PASSWORD` | Set to `yes` to allow connections to `redis-server` without a password. **This setting is not recommended in production environments**. |
19-| `-e REDIS_PASSWORD` | Set the desired password to be used |
20-| `-e REDIS_RANDOM_PASSWORD` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`) |
21-| `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only)
22-| `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it |
23-| `-p 6079:6379` | Expose redis on `localhost:6079` |
24-| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Mount local [configuration file](https://redis.io/topics/config) `redis.conf` (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/memcached/plain/examples/redis.conf)) |
25+| `-e REDIS_PASSWORD` | Set the desired password to be used. |
26+| `-e REDIS_RANDOM_PASSWORD` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`). |
27+| `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only.) |
28+| `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it. |
29+| `-p 6079:6379` | Expose redis on `localhost:6079`. |
30+| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Mount local [configuration file](https://redis.io/topics/config) `redis.conf` (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/redis/plain/examples/config/redis.conf)). |
31
32
33 #### Testing/Debugging
34@@ -64,6 +64,10 @@ With microk8s running, enable the `dns` and `storage` add-ons:
35 $ microk8s enable dns storage
36 ```
37
38+```sh
39+$ microk8s kubectl create configmap redis-config --from-file=redis=config/redis.conf
40+```
41+
42 Use the sample deployment yaml provided [here](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/redis/plain/examples/redis-deployment.yml).
43
44 <details>

Subscribers

People subscribed via source and target branches