Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/go: avoid term "notary" to avoid confusion with CNCF Notary #30835

Closed
rsc opened this issue Mar 14, 2019 · 18 comments

Comments

@rsc
Copy link
Contributor

commented Mar 14, 2019

#25530 proposes securing releases with a transparent log served by a service called a notary.
I adopted both the term and the behavior (publish observations of the internet) from the CMU Perspectives system.

It's been pointed out to me that CNCF has a project called Notary, which turns out to be written Go, but of course is different from our notary.

This issue is to rename the Go notary service to avoid confusion with the CNCF Notary system. Because the notary is basically a giant go.sum database server, I am currently inclined toward “summary.” We would s/notary/summary service/ when talking about a server and s/notary/summary/ or s/notary/sum/ elsewhere (something like $GOROOT/lib/sum/sum.cfg, GET /sum/supported; https://summary.golang.org/; and so on).

This probably won't happen for a few weeks at least. Happy bikeshedding!

@rsc rsc added this to the Go1.13 milestone Mar 14, 2019

@bcmills

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

Because the notary is basically a giant go.sum database server, I am currently inclined toward “summary.”

“module summary” carries connotations of documentation for me. Perhaps “summator”, as in “one who summates”?

@ericlagergren

This comment has been minimized.

Copy link
Contributor

commented Mar 14, 2019

Summary—and derivatives—do not have the same connotations as notary.

At the very least it could be changed to a synonym of notary:

  • registrar
  • witness
  • recorder

Or services that are similar to notaries:

  • signatory
  • medallion

etc.

@FiloSottile

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

I am still fond of "clerk", as it keeps the receipts.

(I think it came from @bcmills originally? I did not come up with it.)

@agnivade

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

Late to the party, but here goes -

  • ledger
  • auditor
@bcmills

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

Ooh, “ledger” is nice. It even carries that nice “repository of sums” connotation!

@FiloSottile

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

Please not "ledger". It will lead to endless confusion as to whether we are using a blockchain or even issued a token (which should sound ludicrous, but look up how Namecoin works), and we don't have two columns and a balance anyway.

Auditors are third-party entities in a transparency log ecosystem, they are the ones that follow the log and make sure it's operated honestly.

@mvdan

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

I agree with "clerk", if anything because it seems to mean "they who keep records/notes/history".

We also have other words in that vicinity, like "scribe", "bookkeeper", "registrar", or "notetaker". Or perhaps even "historian", since it keeps a history of published modules.

@jimmyfrasche

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

Grandmaster Hash

@komuw

This comment has been minimized.

Copy link
Contributor

commented Mar 15, 2019

  • notaio
@kybin

This comment has been minimized.

Copy link
Contributor

commented Mar 16, 2019

  • summer
  • grandsum
@AlexRouSg

This comment has been minimized.

Copy link
Contributor

commented Mar 16, 2019

Kinda surprised no one said NoteyMcNoterface yet

@oiooj

This comment has been minimized.

Copy link
Member

commented Apr 6, 2019

sum.golang.org? Since we have a go.sum.

@rsc

This comment has been minimized.

Copy link
Contributor Author

commented Apr 10, 2019

This service is an implementation detail - an important one - but not something anyone should be focusing on. The cute name gives it more focus than it arguably should have. We don't have a cute name for, say, the go command build cache.

The hostname will be sum.golang.org instead of notary.golang.org, as @oiooj suggested, but beyond that, I think we'll try just not using any other name at all. If you need to refer to the service-without-a-short-name, call it the "Go module checksum service" (or just sum.golang.org).

@rsc rsc closed this Apr 10, 2019

@rsc rsc reopened this Apr 10, 2019

@rsc

This comment has been minimized.

Copy link
Contributor Author

commented Apr 10, 2019

Reopening because we need to excise the term "notary" from various docs and code. Then this can be closed.

@rsc rsc changed the title cmd/go: rename Go Notary to avoid confusion with CNCF Notary cmd/go: avoid term "notary" to avoid confusion with CNCF Notary Apr 10, 2019

@gopherbot

This comment has been minimized.

Copy link

commented Apr 12, 2019

Change https://golang.org/cl/171977 mentions this issue: notary/internal/tlog: remove use of 'notary'

@gopherbot

This comment has been minimized.

Copy link

commented Apr 12, 2019

Change https://golang.org/cl/171978 mentions this issue: notary/internal/note: remove use of 'notary'

gopherbot pushed a commit to golang/exp that referenced this issue Apr 17, 2019

notary/internal/tlog: remove use of 'notary'
We are avoiding the term 'notary' to avoid confusion
with the CNCF Notary project.

For golang/go#30835.

Change-Id: Iebc053302128406f54bdb056c3b13fa208cff7bc
Reviewed-on: https://go-review.googlesource.com/c/exp/+/171977
Run-TryBot: Russ Cox <rsc@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Filippo Valsorda <filippo@golang.org>

gopherbot pushed a commit to golang/exp that referenced this issue Apr 17, 2019

notary/internal/note: remove use of 'notary'
We are avoiding the term 'notary' to avoid confusion
with the CNCF Notary project.

For golang/go#30835.

Change-Id: I4524247ef357d692b8f9592801c5b480cbfb6a3d
Reviewed-on: https://go-review.googlesource.com/c/exp/+/171978
Reviewed-by: Filippo Valsorda <filippo@golang.org>
@gopherbot

This comment has been minimized.

Copy link

commented Apr 24, 2019

Change https://golang.org/cl/173737 mentions this issue: sumdb: mv notary sumdb

gopherbot pushed a commit to golang/exp that referenced this issue Apr 26, 2019

sumdb: mv notary sumdb
We are changing the name "Go notary" to "Go checksum database"
to avoid confusion with the CNCF Notary.

This CL renames the x/exp/notary tree to x/exp/sumdb.

For golang/go#30835.

Change-Id: I348d31050e760a08335882b640edca4f89d86920
Reviewed-on: https://go-review.googlesource.com/c/exp/+/173737
Run-TryBot: Russ Cox <rsc@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Filippo Valsorda <filippo@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
@rsc

This comment has been minimized.

Copy link
Contributor Author

commented Apr 30, 2019

This is done. (The new term is Go checksum database, or sumdb for short.)

@rsc rsc closed this Apr 30, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
You can’t perform that action at this time.