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

[Sergio Durigan Junior]

Initial version of the template file, made mostly by Valentin.

[Sergio Durigan Junior (sergiodj)]

I will post separate MPs for the actual data.

[Sergio Durigan Junior (sergiodj)]

There is a README file in the repository which explains how to actually the renderdown tool to generate the templates.

[Richard Harding (rharding)]

ty

review: Approve

[Sergio Durigan Junior (sergiodj)]

Thanks for the review, Rick. I've just pushed the merge now, but Lucas and Valentin should feel free to review this MP and let me know if they find anything else they'd like to change.

[Valentin Viennot (valentinviennot)]

Thank you very much Sergio. I reviewed all the requests for yaml data files - few edits needed. The good thing is that I now am able to update all of them at once only by editing this template!

Great job, ty!

review: Approve

diff --git a/templates/README_DOCKERHUB.md b/templates/README_DOCKERHUB.md
new file mode 100644
index 0000000..7e7c7fd
--- /dev/null
+++ b/templates/README_DOCKERHUB.md
@@ -0,0 +1,105 @@
+# ${application} | Ubuntu
+<% baserepo='ubuntu' %>
+
+## About ${application}
+
+${description}
+
+## Tags and Architectures
+<% tag=version.split(".")[0]+'.x' %>
+
+| Tag | Currently | Architectures |
+|---|---|---|
+| `${tag}` &nbsp;&nbsp; ![BETA](https://assets.ubuntu.com/v1/e8ac33d1-header-beta-flag.svg) | ${application} ${version} on ${base} | ${", ".join(map(lambda x: "`"+x+"`", architectures))} |
+
+## Usage
+
+Launch this image locally:
+<% containername=repo+'-container' %>
+```sh
+docker run -d --name ${containername} -e TZ=UTC ${" ".join(docker['parameters'])} ${baserepo}/${repo}:${tag}
+```
+
+${docker['access']}
+
+#### Parameters
+
+| Parameter | Description |
+|---|---|
+% for param in parameters:
+| `${param['type']} ${param['value']}` | ${param['description']} |
+% endfor
+
+% if 'extraparagraph' in debug:
+${debug['extraparagraph']}
+% endif
+
+#### Testing/Debugging
+
+To debug the container:
+
+```sh
+$ docker logs -f ${containername}
+```
+
+To get an interactive shell:
+
+```sh
+$ docker exec -it ${containername} /bin/bash
+```
+
+% if 'network' in debug:
+This image also includes the `${debug['network']['client']}` client for interactive container use:
+<% networkname=repo+'-network' %>
+```sh
+$ docker network create ${networkname}
+$ docker network connect ${networkname} ${containername}
+$ docker run -it --rm --network ${networkname} ${baserepo}/${repo}:${tag} ${debug['network']['client']} ${debug['network']['args']}
+% if 'followup' in debug['network']:
+${debug['network']['followup']}
+% endif
+```
+
+% if 'helper' in debug['network']:
+${debug['network']['helper']}
+% endif
+% endif
+% if 'text' in debug:
+${debug['text']}
+% endif
+
+## Deploy with Kubernetes
+<% configmapname = repo + '-config' %>
+<% deployfilename = repo + '-deployment.yml' %>
+
+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
+% if 'configmap' in microk8s:
+${", ".join(map(lambda file: '['+file['name']+']('+file['link']+')', microk8s['configmap']['files']))}, and
+% endif
+[${deployfilename}](${microk8s['deploy']['link']}). Then:
+
+```sh
+% if 'configmap' in microk8s:
+$ kubectl create configmap ${configmapname} ${" ".join(map(lambda file: '--from-file='+file['key']+'='+file['name'], microk8s['configmap']['files']))}
+% endif
+$ kubectl apply -f ${deployfilename}
+```
+
+% if 'deploy' in microk8s and 'access' in microk8s['deploy']:
+${microk8s['deploy']['access']}
+% endif
+
+## 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 "`${repo}: <reason>`".
+
+Make sure to include the digest of the image you are using, from:
+```sh
+$ docker images --no-trunc --quiet ${baserepo}/${repo}:<tag>
+```