cekit/cekit/templates/help.jinja at develop · cekit/cekit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# `{{ name }}:{{ version }}`

Image help page for the `{{ name }}:{{ version }}` container image.

> This file contains autogenerated content based on the image descriptor.

This image is based on the `{{ from }}` image.

## Description

{{ description }}

## Environment variables

{% if helper.all_envs(image)|count > 0 %}
Environment variables can be divided into two categories:

1. **Configuration environment variables**

    Configuration environment variables are used to configure services inside running container. These
    **do not have** default values in the container image and are supposed to be set at container runtime.

    Environment variables listed below without the *value* section are configuration environment variables.
2. **Environment variables with default values**

    Environment variables with default values are already set in the container image byt he image author.
    Depending on the environment variable it may be possible to customize it, but in many cases
    these are not meant to be modified.

    Environment variables listed below containing the *value* section are configuration environment variables.

{% for env in helper.all_envs(image)|sort(attribute='name', case_sensitive=True) %}
### `{{ env.name }}`

{% if env.description %}
**Description**

{{ env.description }}

{% endif %}
{% if env.value %}
**Value**

    {{ env.value }}

{% endif %}
{% if env.example %}
**Example**

    {{ env.example }}

{% endif %}
{% endfor %}
{% else %}
There are no environment variables defined in the image descriptor or modules.
{% endif %}

## Labels

{% if helper.all_labels(image)|count > 0 %}
{% for label in helper.all_labels(image)|sort(attribute='name', case_sensitive=True) %}
### `{{ label.name }}`

**Value**

    {{ label.value }}

{% if label.description %}
**Description**

{{ label.description }}

{% endif %}
{% endfor %}
{% else %}
There are no labels defined in the image descriptor or modules.
{% endif %}

## Args

{% if helper.all_args(image)|count > 0 %}
{% for args in helper.all_args(image)|sort(attribute='name', case_sensitive=True) %}
### `{{ args.name }}`

{% if args.description %}
**Description**

{{ args.description }}

{% endif %}
{% if args.value %}
**Value**

    {{ args.value }}

{% endif %}
{% if args.example %}
**Example**

    {{ args.example }}

{% endif %}
{% endfor %}
{% else %}
    There are no args defined in the image descriptor or modules.
{% endif %}

## Container runtime

Container will run as `{{ run.get('user') }}` user.

{% if run.get('entrypoint') %}
Defined entrypoint:

{{ run.entrypoint }}
{% else %}
There is no entrypoint specified for the container.
{% endif %}

{% if run.get('cmd') %}
Command to execute when the container starts:

    {{ run.cmd|join(' ') }}
{% else %}
There is no command specified to run when the container starts.
{% endif %}

{% if run.get('workdir') %}
Defined working directory:

    {{ run.workdir }}
{% else %}
There is no working directory specified.
{% endif %}

### Published ports

{% if ports %}
Following ports are defined in the image:

{% for port in ports %}
* `{{ port.value }}`
    {% if not port.get('expose', True) %}
    > This port **is not** exposed in the container image. Following information is a suggestion
    > to the container user that port `{{ port.value }}` may be used in the container by some service.
    {% endif %}
    {% if port.get('description') %}

    {{ port.description }}
    {% endif %}
    {% if port.get('service') %}

    * Used by {{ port.service }} service
    {% endif %}
    {% if port.get('protocol') %}

    * Using {{ port.protocol }} protocol
    {% endif %}
{%- endfor -%}
{% else %}
There are no defined ports.
{% endif %}

### Volumes

{% if volumes %}
Following volumes are defined in the image:

{% for volume in volumes %}
 * `{{ volume.path }}`
{% endfor %}
{% else %}
There are no volumes defined.
{% endif %}