From 84f2754c6dfc83afb098b85b049d19d014c7b8d5 Mon Sep 17 00:00:00 2001 From: Nathan McCauley Date: Fri, 19 Jun 2015 11:26:52 -0700 Subject: [PATCH] update readme files for rename Signed-off-by: Nathan McCauley --- README.md | 10 +++++----- ROADMAP.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ccd508a5ec..220f22993a 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ## Overview -Notary manages trust metadata as a complementary service to the registry. +Notary Server manages trust metadata as a complementary service to the registry. It implements all endpoints under the `_trust` segment of the registry URLs. -Notary expects to manage TUF metadata and will do validation of one parent +Notary Server expects to manage TUF metadata and will do validation of one parent level of content for any data uploaded to ensure repositories do not become corrupted. This means either the keys in the root.json file will be used to validate the uploaded role, or the keys in the immediate delegate parent will @@ -17,16 +17,16 @@ will be sufficient to permit the uploading of a new root.json. ## Timestamping TUF requires a timestamp file be regularly generated. To achieve any ease -of use, it is necessary that Notary is responsible for generating the +of use, it is necessary that Notary Server is responsible for generating the timestamp.json based on the snapshot.json created and uploaded by the repository owner. It is bad policy to place any signing keys in frontline servers. While -Notary is capable of supporting this behaviour we recommend using a +Notary Server is capable of supporting this behaviour we recommend using a separate service and server with highly restricted permissions. Rufus is provided as a reference implementation of a remote signer. An implementation that satisfies the gRPC interface defined in Rufus will -satisfy Notary's requirements. +satisfy Notary Server's requirements. # Running diff --git a/ROADMAP.md b/ROADMAP.md index 378b199003..4862029809 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,6 +1,6 @@ # Roadmap -The Trust project consists of a number of moving parts of which Notary is one. Notary is the front line metadata service +The Trust project consists of a number of moving parts of which Notary Server is one. Notary Server is the front line metadata service that clients interact with. It manages TUF metadata and interacts with a pluggable signing service to issue new TUF timestamp files.