centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-04-12 06:19:22 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #681 from docker/doc-version-note

Browse Source 
Add note about versioning
This commit is contained in:
David Lawrence
2016-04-14 17:10:04 -07:00
parent 2968fa7407 d49544587b
commit 6c524b2500
3 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -42,6 +42,7 @@ Any security vulnerabilities can be reported to security@docker.com.
# Getting started with the Notary CLI
Please get the Notary Client CLI binary from [the official releases page](https://github.com/docker/notary/releases) or you can [build one yourself](#building-notary).
The version of Notary server and signer should be greater than or equal to Notary CLI's version to ensure feature compatibility (ex: CLI version 0.2, server/signer version >= 0.2), and all official releases are associated with GitHub tags.
To use the Notary CLI with Docker hub images, please have a look at our
[getting started docs](docs/getting_started.md).

5
docs/getting_started.md
View File

@@ -64,7 +64,10 @@ are located. So, you must provide the `-s` (or long form `--server`) flag to
tell the client which repository server it should communicate with.
The official Docker Hub Notary servers are located at
`https://notary.docker.io`. Additionally, Notary stores your own signing keys,
`https://notary.docker.io`. If you would like to use your own Notary server,
it is important to use the same or a newer <a href="https://github.com/docker/notary/releases">Notary version</a>
as the client for feature compatibility (ex: client version 0.2, server/signer version >= 0.2).
Additionally, Notary stores your own signing keys,
and a cache of previously downloaded trust metadata in a directory, provided
with the `-d` flag. When interacting with Docker Hub repositories, you must
instruct the client to use the associated trust directory, which by default is

7
docs/running_a_service.md
View File

@@ -48,7 +48,10 @@ $ openssl s_client -connect <docker host>:4443 -CAfile fixtures/root-ca.crt -no_
```
To connect using the Notary Client CLI, please see [Getting Started](getting_started.md)
documentation.
documentation. Please note that the version of Notary server and signer
should be greater than or equal to that of the Notary Client CLI to ensure feature compatibility,
i.e. if you are using Notary Client CLI 0.2, ensure you are using a server and signer tagged with
an equal or higher version than 0.2 from the <a href="https://github.com/docker/notary/releases">releases page</a>.
The self-signed certificate's subject name and subject alternative names are
`notary-server`, `notaryserver`, and `localhost`, so if your Docker host is not
@@ -225,7 +228,7 @@ look like the below diagram:
![Notary server Deployment Diagram](images/service-deployment.svg)
In the diagram, a load balancer routes external traffic to a cluster of Notary server
instances. These may make requests to Notary signer instaces if either a) signing
instances. These may make requests to Notary signer instances if either a) signing
is required, or b) key generation is required. The requests from a Notary server
to a Notary signer cluster are router via an internal load balancer.