Merge ~ubuntu-docker-images/ubuntu-docker-images/+git/templates:memcached into ~ubuntu-docker-images/ubuntu-docker-images/+git/templates:master

[Sergio Durigan Junior]

Memcached data (needed to generate the README file) and the corresponding memcached.md (generated from the data).

[Valentin Viennot (valentinviennot)]

Some issues in the debug section, I added my fix proposal as a comment on line 44 (you can simply copy paste it to fix the whole debug.text section), and comments about the issues on the related lines.

review: Needs Fixing

[Sergio Durigan Junior (sergiodj)]

On Saturday, November 21 2020, Valentin Viennot wrote:

> Review: Needs Fixing
>
> Some issues in the debug section, I added my fix proposal as a comment
> on line 44 (you can simply copy paste it to fix the whole debug.text
> section), and comments about the issues on the related lines.

Ah, good catch. I applied the fix you proposed and merged the MP.
Thanks!

--
Sergio
GPG key ID: E92F D0B3 6B14 F1F4 D8E0 EB2F 106D A1C8 C3CB BF14

diff --git a/data/memcached.yaml b/data/memcached.yaml
new file mode 100644
index 0000000..57707d3
--- /dev/null
+++ b/data/memcached.yaml
@@ -0,0 +1,70 @@
+application: Memcached
+repo: memcached
+description: >
+  Memcached is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering. It is a short-term memory for applications.
+  Memcached allows to take memory from parts of a system where you have more than you need and make it accessible to areas where you have less than you need. Read more on the [memcached website](https://memcached.org/).
+version: 1.5.22
+base: Ubuntu 20.04 LTS
+architectures:
+  - amd64
+  - arm64
+  - ppc64el
+  - s390x
+docker:
+  nothing:
+parameters:
+  - type: -e
+    value: TZ=UTC
+    description: Timezone.
+  - type: -e
+    value: MEMCACHED_CACHE_SIZE=64MB
+    description: Determines the size of the cache.
+  - type: -e
+    value: MEMCACHED_MAX_CONNECTIONS=1024
+    description: Determines the maximum number of concurrent connections.
+  - type: -e
+    value: MEMCACHED_THREADS=4
+    description: Determines the number of threads to process requests.
+  - type: -e
+    value: MEMCACHED_PASSWORD
+    description: Define the password for the `root` user if another username is provided. By default the authentication is disabled but if this option is passed it becomes enabled.
+  - type: -e
+    value: MEMCACHED_USERNAME
+    description: Define a new user. If this option is passed a password is needed to authenticate the new user.
+  - type: -p
+    value: 11211
+    description: Memcached is exposed inside the container on port `11211`.
+debug:
+  text: |
+    <details>
+    <summary>You can access the Memcached instance with telnet from another container (click to expand).</summary>
+
+    ```sh
+    # Create a dedicated network
+    $ docker network create memcached-network
+    # Connect the main container to it
+    $ docker network connect memcached-network memcached-container
+    # Run an interactive container with the latest Ubuntu
+    $ docker run -it --rm --name telnet --network memcached-network ubuntu bash
+    # Install the telnet cli from within the container
+    > apt update && apt install telnet -y
+    # Connect to the memcached instance using telnet
+    > telnet memcached-container 11211
+    Trying 172.30.0.2...
+    Connected to memcached.
+    Escape character is '^]'.
+    ```
+    From there you can run `memcached` commands, as documented in [their wiki](https://github.com/memcached/memcached/wiki/Commands).
+
+    </details>
+
+    ```sh
+    $ telnet memcached-container 11211
+    ```
+
+    There are cases where one might want to pass some memcached command line flags that are not configurable via environment variables.
+    In this case you can append the flags themselves or a shell script to the run command.
+microk8s:
+  deploy:
+    link: https://git.launchpad.net/~canonical-server/ubuntu-docker-images/+git/memcached/plain/examples/memcached-deployment.yml
+    access: Memcached will be listening on port `31211` in your host.
diff --git a/out/memcached.md b/out/memcached.md
new file mode 100644
index 0000000..6fa68db
--- /dev/null
+++ b/out/memcached.md
@@ -0,0 +1,109 @@
+# Memcached | Ubuntu
+
+
+## About Memcached
+
+Memcached is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering. It is a short-term memory for applications. Memcached allows to take memory from parts of a system where you have more than you need and make it accessible to areas where you have less than you need. Read more on the [memcached website](https://memcached.org/).
+
+
+## Tags and Architectures
+
+
+| Tag | Currently | Architectures |
+|---|---|---|
+| `1.x` &nbsp;&nbsp; ![BETA](https://assets.ubuntu.com/v1/e8ac33d1-header-beta-flag.svg) | Memcached 1.5.22 on Ubuntu 20.04 LTS | `amd64`, `arm64`, `ppc64el`, `s390x` |
+
+## Usage
+
+Launch this image locally:
+
+```sh
+docker run -d --name memcached-container -e TZ=UTC  ubuntu/memcached:1.x
+```
+
+
+#### Parameters
+
+| Parameter | Description |
+|---|---|
+| `-e TZ=UTC` | Timezone. |
+| `-e MEMCACHED_CACHE_SIZE=64MB` | Determines the size of the cache. |
+| `-e MEMCACHED_MAX_CONNECTIONS=1024` | Determines the maximum number of concurrent connections. |
+| `-e MEMCACHED_THREADS=4` | Determines the number of threads to process requests. |
+| `-e MEMCACHED_PASSWORD` | Define the password for the `root` user if another username is provided. By default the authentication is disabled but if this option is passed it becomes enabled. |
+| `-e MEMCACHED_USERNAME` | Define a new user. If this option is passed a password is needed to authenticate the new user. |
+| `-p 11211` | Memcached is exposed inside the container on port `11211`. |
+
+
+#### Testing/Debugging
+
+To debug the container:
+
+```sh
+$ docker logs -f memcached-container
+```
+
+To get an interactive shell:
+
+```sh
+$ docker exec -it memcached-container /bin/bash
+```
+
+<details>
+<summary>You can access the Memcached instance with telnet from another container (click to expand).</summary>
+
+```sh
+# Create a dedicated network
+$ docker network create memcached-network
+# Connect the main container to it
+$ docker network connect memcached-network memcached-container
+# Run an interactive container with the latest Ubuntu
+$ docker run -it --rm --name telnet --network memcached-network ubuntu bash
+# Install the telnet cli from within the container
+> apt update && apt install telnet -y
+# Connect to the memcached instance using telnet
+> telnet memcached-container 11211
+Trying 172.30.0.2...
+Connected to memcached.
+Escape character is '^]'.
+```
+From there you can run `memcached` commands, as documented in [their wiki](https://github.com/memcached/memcached/wiki/Commands).
+
+</details>
+
+```sh
+$ telnet memcached-container 11211
+```
+
+There are cases where one might want to pass some memcached command line flags that are not configurable via environment variables.
+In this case you can append the flags themselves or a shell script to the run command.
+
+
+## Deploy with Kubernetes
+
+
+
+Works with any Kubernetes; if you don't have one, we recommend you [install MicroK8s](https://microk8s.io/) and `microk8s enable dns storage` then alias `kubectl` to `microk8s.kubectl`.
+
+Download
+[memcached-deployment.yml](https://git.launchpad.net/~canonical-server/ubuntu-docker-images/+git/memcached/plain/examples/memcached-deployment.yml). Then:
+
+```sh
+$ kubectl apply -f memcached-deployment.yml
+```
+
+Memcached will be listening on port `31211` in your host.
+
+## Bugs and feature requests
+
+If you find a bug in our image or want to request a specific feature, please file a bug here:
+
+[https://bugs.launchpad.net/ubuntu-docker-images/+filebug](https://bugs.launchpad.net/ubuntu-docker-images/+filebug)
+
+Please title the bug "`memcached: <reason>`".
+
+Make sure to include the digest of the image you are using, from:
+```sh
+$ docker images --no-trunc --quiet ubuntu/memcached:<tag>
+```
+