TrueCloudLab/distribution
13
0
Fork 3
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Rendering fixes, part 2

Browse source
This commit is contained in:
John Mulhausen 2016-10-03 16:05:09 -07:00
parent e8bd2f2c1c
commit 9204a64925
3 changed files with 54 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

113
docs/configuration.md
View file

@ -266,74 +266,63 @@ The `log` subsection configures the behavior of the logging system. The logging
system outputs everything to stdout. You can adjust the granularity and format
with this configuration section.
log:
level: debug
formatter: text
fields:
service: registry
environment: staging
```
log:
level: debug
formatter: text
fields:
service: registry
environment: staging
```
<table>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>
<code>level</code>
</td>
<td>
no
</td>
<td>
Sets the sensitivity of logging output. Permitted values are
<code>error</code>, <code>warn</code>, <code>info</code> and
<code>debug</code>. The default is <code>info</code>.
</td>
</tr>
<tr>
<td>
<code>formatter</code>
</td>
<td>
no
</td>
<td>
This selects the format of logging output. The format primarily affects how keyed
attributes for a log line are encoded. Options are <code>text</code>, <code>json</code> or
<code>logstash</code>. The default is <code>text</code>.
</td>
</tr>
<tr>
<td>
<code>fields</code>
</td>
<td>
no
</td>
<td>
A map of field names to values. These are added to every log line for
the context. This is useful for identifying log messages source after
being mixed in other systems.
</td>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td><code>level</code></td>
<td>no</td>
<td>Sets the sensitivity of logging output. Permitted values are
<code>error</code>, <code>warn</code>, <code>info</code> and
<code>debug</code>. The default is <code>info</code>.
</td>
</tr>
<tr>
<td><code>formatter</code></td>
<td>no</td>
<td>This selects the format of logging output. The format primarily affects how keyed attributes for a log line are encoded. Options are <code>text</code>, <code>json</code> or
<code>logstash</code>. The default is <code>text</code>.
</td>
</tr>
<tr>
<td>
<code>fields</code>
</td>
<td>no</td>
<td>A map of field names to values. These are added to every log line for the context. This is useful for identifying log messages source after being mixed in other systems.
</td>
</tr>
</table>
## hooks
hooks:
- type: mail
levels:
- panic
options:
smtp:
addr: smtp.sendhost.com:25
username: sendername
password: password
insecure: true
from: name@sendhost.com
to:
- name@receivehost.com
```
hooks:
- type: mail
levels:
- panic
options:
smtp:
addr: smtp.sendhost.com:25
username: sendername
password: password
insecure: true
from: name@sendhost.com
to:
- name@receivehost.com
```
The `hooks` subsection configures the logging hooks' behavior. This subsection
includes a sequence handler which you can use for sending mail, for example.

2
docs/spec/manifest-v2-2.md
View file

@ -119,6 +119,7 @@ image manifest based on the Content-Type returned in the HTTP response.
## Example Manifest List
*Example showing a simple manifest list pointing to image manifests for two platforms:*
```json
{
"schemaVersion": 2,
@ -227,6 +228,7 @@ image. It's the direct replacement for the schema-1 manifest.
## Example Image Manifest
*Example showing an image manifest:*
```json
{
"schemaVersion": 2,

1
docs/storage-drivers/s3.md
View file

@ -246,6 +246,7 @@ The CloudFront distribution must be created such that the `Origin Path` is set t
Here the `middleware` option is used. It is still important to keep the `storage` option as CloudFront will only handle `pull` actions; `push` actions are still directly written to S3.
The following example shows what you will need at minimum:
```
...
storage: