[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #5721: Refactor riak trafficvault interface

[GitBox <gi...@apache.org>]

zrhoffman commented on a change in pull request #5721:
URL: https://github.com/apache/trafficcontrol/pull/5721#discussion_r608968122



##########
File path: lib/go-tc/deliveryservice_ssl_keys.go
##########
@@ -211,7 +222,9 @@ type DNSSECKeys map[string]DNSSECKeySet
 
 // DNSSECKeysV11 is the DNSSEC keys object stored in Riak. The map key strings are both DeliveryServiceNames and CDNNames.

Review comment:
       I know the PR does not cause this, but this is a good time to move this Godoc to the `DNSSECKeysV11` type: https://github.com/apache/trafficcontrol/blob/6cfb7042084fb755ef14c0ff1df62d55bc3961e9/lib/go-tc/deliveryservice_ssl_keys.go#L229

##########
File path: lib/go-tc/deliveryservice_ssl_keys.go
##########
@@ -201,7 +203,16 @@ func checkNilOrEmpty(s *string) bool {
 	return s == nil || *s == ""
 }
 
-type RiakPingResp struct {
+// URISignerKeyset is the container for the CDN URI signing keys.
+type URISignerKeyset struct {
+	RenewalKid *string               `json:"renewal_kid"`
+	Keys       []jwk.EssentialHeader `json:"keys"`
+}

Review comment:
       Since the `URISignerKeyset` is now part of the `tc` package, its fields should be documented.

##########
File path: docs/source/development/traffic_ops.rst
##########
@@ -161,7 +161,7 @@ Traffic Ops Project Tree Overview
 		- config/ - Defines configuration structures and methods for reading them in from files
 		- dbhelpers/ - Assorted utilities that provide functionality for common database tasks, e.g. "Get a user by email"
 		- plugin/ - The Traffic Ops plugin system, with examples
-		- riaksvc/ - In addition to handling routes that deal with storing secrets in or retrieving secrets from Traffic Vault, this package provides a library of functions for interacting with Traffic Vault for other handlers to use.
+		- trafficvault/ - This package provides the Traffic Vault interface and associated backend implementations for other handlers to interact with Traffic Vault.

Review comment:
       If we're going to have a package name `trafficvault`, the contents of the `vault` package should be moved there, too.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org