docker/docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-11-05 00:14:17 +03:00
Code Activity

Remove extra tables, add links in full server/signer/client configuration files to the relevant sections

Browse Source 
Signed-off-by: Ying Li <ying.li@docker.com>
This commit is contained in:
Ying Li
2016-02-29 23:29:33 -05:00
committed by Riyaz Faizullabhoy
parent 2e331971de
commit 9e6ead4f57
5 changed files with 39 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/reference/client-config.md
View File

@@ -11,9 +11,8 @@ weight=4
# Notary client configuration file
This document is for power users of the [Notary client](../advanced_usage.md),
or for those who are [running their own service](../running_a_service.md) who
want to facilitate CLI interaction or specify custom options.
This document is for power users of the [Notary client](../advanced_usage.md)
who want to facilitate CLI interaction or specify custom options.
The configuration file for Notary client normally resides at `~/.notary/config.json`,
but the path to a different configuration file can be specified using the
@@ -21,38 +20,25 @@ but the path to a different configuration file can be specified using the
## Overview of the file
A configuration file consists of the following sections:
In addition to the configuration file format, please see the optional password
[environment variables](#environment-variables-optional) that the Notary client
can take for ease of use.
<table>
<tr>
<td><a href="#trust-dir-section-optional">trust_dir</a></td>
<td>TUF key and metadata directory</td>
<td>(optional)</td>
</tr>
<tr>
<td><a href="#remote-server-section-optional">remote_server</a></td>
<td>remote Notary Server configuration</td>
<td>(optional)</td>
</tr>
</table>
Here is a full client configuration file example; please click on the top level
JSON keys to learn more about the configuration section corresponding to that key:
In addition please see the optional password [environment
variables](#environment-variables-optional) that the Notary client can take for
ease of use.
An example (full) client configuration file.
```json
<pre><code class="language-json">
{
"trust_dir" : "~/.docker/trust",
"remote_server": {
<a href="#trust-dir-section-optional">"trust_dir"</a> : "~/.docker/trust",
<a href="#remote-server-section-optional">"remote_server"</a>: {
"url": "https://my-notary-server.my-private-registry.com",
"root-ca": "./fixtures/root-ca.crt",
"tls_client_cert": "./fixtures/secure.example.com.crt",
"tls_client_key": "./fixtures/secure.example.com.crt"
}
}
```
</code></pre>
## trust_dir section (optional)
@@ -142,9 +128,3 @@ passphrase.
|`NOTARY_ROOT_PASSPHRASE` | The root/offline key passphrase |
|`NOTARY_TARGETS_PASSPHRASE` | The targets (an online) key passphrase |
|`NOTARY_SNAPSHOT_PASSPHRASE` | The snapshot (an online) key passphrase |
## Related information
* [Notary Server Configuration File](server-config.md)
* [Notary Signer Configuration File](signer-config.md)
* [Configuration sections common to the Notary Server and Signer](common-configs.md)

1
docs/reference/common-configs.md
View File

@@ -96,5 +96,4 @@ required parameters below, to configure it.
## Related information
* [Notary Server Configuration File](server-config.md)
* [Notary Client Configuration File](client-config.md)
* [Notary Signer Configuration File](signer-config.md)

2
docs/reference/index.md
View File

@@ -18,7 +18,7 @@ want to facilitate CLI interaction or specify custom options.
You can configure the following aspects of Notary:
* [Notary Server Configuration File](server-config.md)
* [Notary Client Configuration File](client-config.md)
* [Notary Server Configuration File](server-config.md)
* [Notary Signer Configuration File](signer-config.md)
* [Configuration sections common to the Notary Server and Signer](common-configs.md)

69
docs/reference/server-config.md
View File

@@ -10,11 +10,8 @@ parent="mn_notary_config"
# Notary server configuration file
This document is for those who are [running their own service](../running_a_service.md) who
want to facilitate CLI interaction or specify custom options.
For full specific configuration information, see the [common configuration
file](common-configs.md) for the Notary server and signer.
This document is for those who are [running their own Notary service](../running_a_service.md) who
want to specify custom options.
## Overview
@@ -22,51 +19,16 @@ A configuration file is required by Notary server, and the path to the
configuration file must be specified using the `-config` option on the command
line.
The configuration file consists of the following sections:
Here is a full server configuration file example; please click on the top level JSON keys to
learn more about the configuration section corresponding to that key:
<table>
<tr>
<td><a href="#server-section-required">server</a></td>
<td>HTTPS configuration</td>
<td>(required)</td>
</tr>
<tr>
<td><a href="#trust-service-section-required">trust_service</a></td>
<td>signing service configuration</td>
<td>(required)</td>
</tr>
<tr>
<td><a href="#storage-section-required">storage</a></td>
<td>TUF metadata storage configuration</td>
<td>(required)</td>
</tr>
<tr>
<td><a href="#auth-section-optional">auth</a></td>
<td>server authentication configuration</td>
<td>(optional)</td>
</tr>
<tr>
<td><a href="../common-configs/#logging-section-optional">logging</a></td>
<td>logging configuration</td>
<td>(optional)</td>
</tr>
<tr>
<td><a href="../common-configs/#reporting-section-optional">reporting</a></td>
<td>ops/reporting configuration</td>
<td>(optional)</td>
</tr>
</table>
An example (full) server configuration file.
```json
{
"server": {
<pre><code class="language-json">{
<a href="#server-section-required">"server"</a>: {
"http_addr": ":4443",
"tls_key_file": "./fixtures/notary-server.key",
"tls_cert_file": "./fixtures/notary-server.crt"
},
"trust_service": {
<a href="#trust-service-section-required">"trust_service"</a>: {
"type": "remote",
"hostname": "notarysigner",
"port": "7899",
@@ -75,11 +37,11 @@ An example (full) server configuration file.
"tls_client_cert": "./fixtures/notary-server.crt",
"tls_client_key": "./fixtures/notary-server.key"
},
"storage": {
<a href="#storage-section-required">"storage"</a>: {
"backend": "mysql",
"db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true"
},
"auth": {
<a href="#auth-section-optional">"auth"</a>: {
"type": "token",
"options": {
"realm": "https://auth.docker.io/token",
@@ -88,17 +50,17 @@ An example (full) server configuration file.
"rootcertbundle": "/path/to/auth.docker.io/cert"
}
},
"logging": {
<a href="../common-configs/#logging-section-optional">"logging"</a>: {
"level": "debug"
},
"reporting": {
<a href="../common-configs/#reporting-section-optional">"reporting"</a>: {
"bugsnag": {
"api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8",
"release_stage": "production"
}
}
}
```
</code></pre>
## server section (required)
@@ -157,7 +119,7 @@ Example:
## trust_service section (required)
This section configures either a remote trust service, such as
[Notary signer](#notary-signer-configuration-file) or a local in-memory
[Notary signer](signer-config.md) or a local in-memory
ED25519 trust service.
Remote trust service example:
@@ -298,8 +260,8 @@ configure it.
**Token authentication:**
This is an implementation of the same authentication used by
[docker registry](https://github.com/docker/distribution). (JWT token-based
This is an implementation of the same authentication used by version 2 of the
[Docker registry](https://github.com/docker/distribution). (JWT token-based
authentication post login.)
<table>
@@ -326,6 +288,5 @@ authentication post login.)
## Related information
* [Notary Client Configuration File](client-config.md)
* [Notary Signer Configuration File](signer-config.md)
* [Configuration sections common to the Notary Server and Signer](common-configs.md)

54
docs/reference/signer-config.md
View File

@@ -11,71 +11,42 @@ parent="mn_notary_config"
# Notary signer configuration file
This document is for those who are [running their own service](../running_a_service.md) who
want to facilitate CLI interaction or specify custom options.
This document is for those who are [running their own Notary service](../running_a_service.md) who
want to specify custom options.
## Overview
Notary signer [requires environment
variables](#environment-variables-required-if-using-mysql) to encrypt private
keys at rest. It also requires a configuration file, the path to which is
Notary signer [requires environment variables](#environment-variables-required-if-using-mysql)
to encrypt private keys at rest. It also requires a configuration file, the path to which is
specified on the command line using the `-config` flag.
A Notary signer configuration file consists of the following sections:
Here is a full signer configuration file example; please click on the top level JSON keys to
learn more about the configuration section corresponding to that key:
<table>
<tr>
<td><a href="#server-section-required">server</a></td>
<td>HTTPS and GRPC configuration</td>
<td>(required)</td>
</tr>
<tr>
<td><a href="#storage-section-required">storage</a></td>
<td>TUF metadata storage configuration</td>
<td>(required)</td>
</tr>
<tr>
<td><a href="../common-configs/#logging-section-optional">logging</a></td>
<td>logging configuration</td>
<td>(optional)</td>
</tr>
<tr>
<td><a href="../common-configs/#reporting-section-optional">reporting</a></td>
<td>ops/reporting configuration</td>
<td>(optional)</td>
</tr>
</table>
See the [environment variables](#environment-variables-required-if-using-mysql)
to encrypt private keys at rest.
An example (full) server configuration file.
```json
{
"server": {
<pre><code class="language-json">{
<a href="#server-section-required">"server"</a>: {
"http_addr": ":4444",
"grpc_addr": ":7899",
"tls_cert_file": "./fixtures/notary-signer.crt",
"tls_key_file": "./fixtures/notary-signer.key",
"client_ca_file": "./fixtures/notary-server.crt"
},
"logging": {
<a href="../common-configs/#logging-section-optional">"logging"</a>: {
"level": 2
},
"storage": {
<a href="#storage-section-required">"storage"</a>: {
"backend": "mysql",
"db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true",
"default_alias": "passwordalias1"
},
"reporting": {
<a href="../common-configs/#reporting-section-optional">"reporting"</a>: {
"bugsnag": {
"api_key": "c9d60ae4c7e70c4b6c4ebd3e8056d2b8",
"release_stage": "production"
}
}
}
```
</code></pre>
## server section (required)
@@ -261,5 +232,4 @@ attempts to sign data using those keys will fail.
## Related information
* [Notary Server Configuration File](server-config.md)
* [Notary Client Configuration File](client-config.md)
* [Configuration sections common to the Notary server and signer](common-configs.md)