phracek reported a new issue against the project: `atomic-wg` that you are following:
``
I thinks each container should provide to user some help page.
Fedora has requirement for providing such file
https://fedoraproject.org/wiki/Container:Guidelines#Help_File
The help.md file should contain some required fields like:
- image name
- maintainer
- name
- description
- usage
- if container uses environment variables then section ENVIRONMENT VARIABLES
- if container exposes ports then also section SECURITY IMPLICATION
e.g. memcached help.md
~~~
% MEMCACHED(1) Container Image Pages
% Petr Hracek
% February 6, 2017
# NAME
memcached - Memcached is a high-performance, distributed memory object caching system
# DESCRIPTION
Memcached is a high-performance, distributed memory object caching system, generic in
nature, but intended for use in speeding up dynamic web applications by alleviating
database load.
The container itself consists of:
- fedora/f26 base image
- memcached RPM package
Files added to the container during docker build include: /files/memcached.sh
# USAGE
To get the memcached container image on your local system, run the following:
docker pull docker.io/modularitycontainers/memcached
# ENVIRONMENT VARIABLES
The image recognizes the following environment variables that you can set
during initialization be passing `-e VAR=VALUE` to the Docker run command.
| Variable name | Description
|
| :----------------------- | -----------------------------------------------------------
|
| `MEMCACHED_DEBUG_MODE` | Increases verbosity for server and client. Parameter is -vv
|
| `MEMCACHED_CACHE_SIZE` | Sets the size of RAM to use for item storage (in megabytes)
|
| `MEMCACHED_CONNECTIONS` | The max simultaneous connections; default is 1024
|
| `MEMCACHED_THREADS` | Sets number of threads to use to process incoming requests
|
# SECURITY IMPLICATIONS
Lists of security-related attributes that are opened to the host.
-p 11211:11211
Opens container port 11211 and maps it to the same port on the host.
# SEE ALSO
Memcached page
<
https://memcached.org/>
~~~
``
To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/354