quay · jsoref · Sep 23, 2021 · Sep 23, 2021 · Sep 23, 2021 · Sep 23, 2021
@@ -19,7 +19,7 @@
 ### Httputil
 - [ed8ffc5](https://github.com/quay/clair/commit/ed8ffc50b56c9b11873f00bb2deb4fba9107ec95): create package and RateLimiter
 ### Initialize
-- [5df82e1](https://github.com/quay/clair/commit/5df82e19e971c67ebdecf3f92682d4ae897db53a): update call to Libindex contstructor
+- [5df82e1](https://github.com/quay/clair/commit/5df82e19e971c67ebdecf3f92682d4ae897db53a): update call to Libindex constructor
 ### Introspection
 - [ec59a43](https://github.com/quay/clair/commit/ec59a431032713654e2eb7a29ad7c446dd16a490): enable readiness endpoint
 
@@ -111,7 +111,7 @@
 - [1ece08f](https://github.com/quay/clair/commit/1ece08f49434828c8c672f08ec45844b99187983): database metrics for notifier
 - [84ba35f](https://github.com/quay/clair/commit/84ba35f29ee81849cb2f424b3624895f9bd05a79): implement prometheus http
 ### Local-Dev
-- [1c85589](https://github.com/quay/clair/commit/1c85589abdef98b5af8d4f6e2cd9eb5db6a723a0): remove unintented change in config.yaml
+- [1c85589](https://github.com/quay/clair/commit/1c85589abdef98b5af8d4f6e2cd9eb5db6a723a0): remove unintended change in config.yaml
 ### Logging
 - [9f3d167](https://github.com/quay/clair/commit/9f3d167d5d85d345c7d0ee666be075a545a553f4): move to zlog throughout
 ### Matcher
@@ -200,7 +200,7 @@
 ### Clairctl
 - [835af27](https://github.com/quay/clair/commit/835af272fad49342f51adb4633ff639de3cc14a1): fix and codify import arguments
 - [b9ef107](https://github.com/quay/clair/commit/b9ef1073ca48ed5ed7caaa3e0fbad03a7d83592c): update import and export online help
-- [9883e80](https://github.com/quay/clair/commit/9883e80f331190e60de711b0705e9b37017fc5b1): unifiy config, client handling
+- [9883e80](https://github.com/quay/clair/commit/9883e80f331190e60de711b0705e9b37017fc5b1): unify config, client handling
 ### Config
 - [dc8ba89](https://github.com/quay/clair/commit/dc8ba8912fa482378ef393aa51b4e9528d2877f2): expose notification summary toggle
 - [bb3cd66](https://github.com/quay/clair/commit/bb3cd669f66345aaa0fc5df6f502f34922cc069e): add 'omitempty' to 'updaters' config struct for correct marshalling
@@ -443,7 +443,7 @@
 ### Config
 - [3ccc6e0](https://github.com/quay/clair/commit/3ccc6e03be0ce1b6c439d5c0649ee785dc7c559f): add support for per-scanner configuration
 ### Dockerfile
-- [5a73cb4](https://github.com/quay/clair/commit/5a73cb49d64e839d7675979b5e3f348d94dd26a5): make -mod=vendor opportunisitic ([#999](https://github.com/quay/clair/issues/999))
+- [5a73cb4](https://github.com/quay/clair/commit/5a73cb49d64e839d7675979b5e3f348d94dd26a5): make -mod=vendor opportunistic ([#999](https://github.com/quay/clair/issues/999))
  -  [#999](https://github.com/quay/clair/issues/999)### Dockerfile: Update To Alpine
 - [de32b07](https://github.com/quay/clair/commit/de32b0728ccdbafb85988e2f87618c9d576fc87e): 3.11 for newest rpm
 ### Go.Mod
@@ -480,7 +480,7 @@
 ### Config
 - [b2666e5](https://github.com/quay/clair/commit/b2666e57202d7c690a40d7c86975c13e0b3db56e): set a canonical default port
 ### Dockerfile
-- [33da12a](https://github.com/quay/clair/commit/33da12a3bb9a28fdbcc6302caa4212d38a2acbbb): run as unprivledged user by default
+- [33da12a](https://github.com/quay/clair/commit/33da12a3bb9a28fdbcc6302caa4212d38a2acbbb): run as unprivileged user by default
 ### Documentation
 - [fe324a5](https://github.com/quay/clair/commit/fe324a58e6be8c36da74afcd5487d0da4a547d5b): start writing v4-specific docs
 ### Httptransport
@@ -647,7 +647,7 @@
 - [162e8cd](https://github.com/quay/clair/commit/162e8cdafc66be28b021f83da736a2b612ddda99): enable suse updater
 - [0609ed9](https://github.com/quay/clair/commit/0609ed964b0673806462a24147e6028da85d8a38): removed worker config
 - [af2c688](https://github.com/quay/clair/commit/af2c68863482ae9f93a2db1533be260468a6ea2d): not properly loaded error ([#140](https://github.com/quay/clair/issues/140))
- -  [#140](https://github.com/quay/clair/issues/140) - fixes [#134](https://github.com/quay/clair/issues/134)- [30055af](https://github.com/quay/clair/commit/30055af03e357b44cfbacb3088eab337a94e51e8): fallover correctly to default config
+ -  [#140](https://github.com/quay/clair/issues/140) - fixes [#134](https://github.com/quay/clair/issues/134)- [30055af](https://github.com/quay/clair/commit/30055af03e357b44cfbacb3088eab337a94e51e8): failover correctly to default config
 - [20af787](https://github.com/quay/clair/commit/20af78743774b18795cbf5210cc97cc172b1880d): fix default fallback
 - [4fc32d2](https://github.com/quay/clair/commit/4fc32d22713a47eabf5b12b81897fdd34d59935b): add top-level YAML namespace 'clair'
  - Fixes [#95](https://github.com/quay/clair/issues/95)- [bb7745f](https://github.com/quay/clair/commit/bb7745f3fe21e85b5fe37919e11d6d121e08b9a1): better document example
@@ -773,7 +773,7 @@
 - [627b98e](https://github.com/quay/clair/commit/627b98ef3126d517d3e80aef4c2ab9ed3d14b893): fix SQL error reporting
 ### Db/Pgsql/Migration
 - [8df8170](https://github.com/quay/clair/commit/8df8170ba54d945cf2e2ad201bcdb8cc09fddc06): convert to pure SQL
-### Dckerfile
+### Dockerfile
 - [80f150f](https://github.com/quay/clair/commit/80f150f93bf3b12e6c9bcea2d71ccfa956bd50c9): Add docker-compose.yml
 ### Detectors/Feature
 - [fc908e6](https://github.com/quay/clair/commit/fc908e65ba6c0ad3edb344cfb263adff8efe6f4e): add apk feature detector
@@ -984,7 +984,7 @@
 - [eeb13a0](https://github.com/quay/clair/commit/eeb13a02baa5db60b997454af8f059a6381f42da): add index on Vulnerability_Notification.deleted_at
 - [7cff31a](https://github.com/quay/clair/commit/7cff31a058230a94838b7fd8493380d444c31f5a): add ldfv compound index
 ### Pkg
-- [c3904c9](https://github.com/quay/clair/commit/c3904c9696bddc20a27db9b4142ae704350bbe3f): Add fsutil to contian file system utility functions
+- [c3904c9](https://github.com/quay/clair/commit/c3904c9696bddc20a27db9b4142ae704350bbe3f): Add fsutil to contain file system utility functions
 - [78cef02](https://github.com/quay/clair/commit/78cef02fdad4afd12a2a00df51d457c796278bfa): cerrors -> commonerr
 - [03bac0f](https://github.com/quay/clair/commit/03bac0f1b6f504a416937e309a62fdfc308dc397): utils/tar.go -> pkg/tarutil
 ### Pkg/Gitutil

@@ -11,14 +11,14 @@ Further information and usage is an effort left to the reader.
 ## Updates Diffs
 
 The `update_diff/` endpoint exposes the api for diffing two update operations. 
-This is used by the notifier to determine the added and removed vulnerabilities on security databsae update.
+This is used by the notifier to determine the added and removed vulnerabilities on security database update.
 
 ## Update Operation
 
 The `update_operation` endpoint exposes the api for viewing updaters' activity. 
-This is used by the notifier to determine if new updates have occured and triggers an update diff to see what has changed.
+This is used by the notifier to determine if new updates have occurred and triggers an update diff to see what has changed.
 
 ## AffectedManifest
 
-The `affected_manifest` endpoint exposes the api for retreiving affected manifests given a list of Vulnerabilities.
+The `affected_manifest` endpoint exposes the api for retrieving affected manifests given a list of Vulnerabilities.
 This is used by the notifier to determine the manifests that need to have a notification generated.
@@ -1,6 +1,6 @@
 # Indexing
 
-The [Indexer](../reference/indexer.md) service is responsble for "indexing a manifest".
+The [Indexer](../reference/indexer.md) service is responsible for "indexing a manifest".
 
 Indexing involves taking a manifest representing a container image and computing its constituent parts. The indexer is trying to discover what packages exist in the image, what distribution the image is derived from, and what package repositories are used within the image. Once this information is computed it is persisted in an IndexReport.
 

@@ -2,7 +2,7 @@
 
 ClairV4 implements a notification system.
 
-The notifier service will keep track of new security database updates and inform an interested client if new or removed vulnerabilites affect an indexed manifest.
+The notifier service will keep track of new security database updates and inform an interested client if new or removed vulnerabilities affect an indexed manifest.
 
 The interested client can subscribe to notifications via several mechanisms:
 * Webhook delivery
@@ -58,7 +58,7 @@ When you configure notifier for webhook delivery you provide the service with th
 When the notifier has determined an updated security database has changed the affected status of an indexed manifest, it will deliver the following JSON body to the configured target:
 ```json
 {
-  "notifiction_id": {uuid_string},
+  "notification_id": {uuid_string},
   "callback": {url_to_notifications}
 }
 ```

@@ -1,4 +1,4 @@
-# Contribuion
+# Contribution
 The following sections provides information on how to contribute to Clair.
 
 - [Commit Style](./contribution/commit_style.md)

@@ -14,7 +14,7 @@ In a combined deployment, all the Clair processes run in a single OS process. Th
 
 A load balancer is still recommended if you plan on performing TLS termination. Typically this will be a OpenShift route or a Kubernetes ingress.
 
-![combo mode single db deployment diagran](./clairv4_combo_single_db.png)
+![combo mode single db deployment diagram](./clairv4_combo_single_db.png)
 
 In the above diagram, Clair is running in combo mode and talking to a single database. To configure this model you will provide all node types the same database and start Clair in **combo** mode.
 
@@ -33,7 +33,7 @@ In this mode, any configuration informing Clair how to talk to other nodes is ig
 
 For added flexibility, it's also supported to split the databases while in combo mode.
 
-![combo mode multiple db deployment diagran](./clairv4_combo_multi_db.png)
+![combo mode multiple db deployment diagram](./clairv4_combo_multi_db.png)
 
 In the above diagram, Clair is running in combo mode but database load is split between multiple databases. Since Clair is conceptually a set of micro-services, its processes do not share database tables even when combined into the same OS process.
 
@@ -58,7 +58,7 @@ In a distributed deployment, each Clair process runs in its own OS process. Typi
 
 A load balancer **must** be setup in this deployment model. The load balancer will route traffic between Clair nodes along with routing API requests via [path based routing](https://devcentral.f5.com/s/articles/the-three-http-routing-patterns-you-should-know-30764) to the correct services. In a Kubernetes or OpenShift deployment this is usually handled with the Service and Routes abstractions. If deploying on bare metal, a load balancer will need to be configured appropriately. 
 
-![distributed mode multiple db deployment diagran](./clairv4_distributed_multi_db.png)
+![distributed mode multiple db deployment diagram](./clairv4_distributed_multi_db.png)
 
 In the above diagram, a load balancer is configured to route traffic coming from the client to the correct service. This routing is path based routing and requires a layer 7 load balancer. Traefik, Nginx, and HAProxy are all capable of this. As mentioned above, this functionality is native to OpenShift and Kubernetes.
 

@@ -3,7 +3,7 @@ title: ClairV4 v0.1
 language_tabs:
   - python: Python
   - go: Golang
-  - javascript: Javascript
+  - javascript: JavaScript
 language_clients:
   - python: ""
   - go: ""
@@ -1184,7 +1184,7 @@ Notification
 |---|---|---|---|---|
 |id|string|false|none|a unique identifier for this notification|
 |manifest|string|false|none|The hash of the manifest affected by the provided vulnerability.|
-|reason|string|false|none|the reason for the notifcation, [added | removed]|
+|reason|string|false|none|the reason for the notification, [added | removed]|
 |vulnerability|[VulnSummary](#schemavulnsummary)|false|none|A summary of a vulnerability|
 
 <h2 id="tocS_Environment">Environment</h2>
@@ -1285,7 +1285,7 @@ IndexReport
 |» **additionalProperties**|[Distribution](#schemadistribution)|false|none|An indexed distribution discovered in a layer. See<br>https://www.freedesktop.org/software/systemd/man/os-release.html<br>for explanations and example of fields.|
 |environments|object|true|none|A map of lists containing Environment objects keyed by the<br>associated Package.id.|
 |» **additionalProperties**|[[Environment](#schemaenvironment)]|false|none|[The environment a particular package was discovered in.]|
-|success|boolean|true|none|A bool indicating succcessful index|
+|success|boolean|true|none|A bool indicating successful index|
 |err|string|true|none|An error message on event of unsuccessful index|
 
 <h2 id="tocS_VulnerabilityReport">VulnerabilityReport</h2>

@@ -564,7 +564,7 @@ An address in `<host>:<post>` syntax where traces can be submitted.
 #### `$.trace.jaeger.collector.username`
 a string value
 
-#### `$.trace.jaeger.collector.passwordd`
+#### `$.trace.jaeger.collector.password`
 a string value
 
 #### `$.trace.jaeger.service_name`

@@ -25,7 +25,7 @@ goimports-local:
 # you'll need to have npx to run this gen.
 .PHONY: gen-api-reference
 gen-api-reference:
-	npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
+	npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:JavaScript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
 
 # start a local development environment. 
 # each services runs in it's own container to test service->service communication.

@@ -16,7 +16,7 @@ func (e *ErrRequestFail) Error() string {
 	return fmt.Sprintf("code: %v status %v", e.Code, e.Status)
 }
 
-// ErrBadManifest inidcates a manifest could not be parsed
+// ErrBadManifest indicates a manifest could not be parsed
 type ErrBadManifest struct {
 	E error
 }
@@ -29,7 +29,7 @@ func (e *ErrBadManifest) Unwrap() error {
 	return e.E
 }
 
-// ErrBadManifest inidcates a manifest could not be parsed
+// ErrBadManifest indicates a manifest could not be parsed
 type ErrBadIndexReport struct {
 	E error
 }

@@ -6,7 +6,7 @@ import (
 	"github.com/google/uuid"
 )
 
-// ErrNoUpdateOperation inidcates that the queried updater has no
+// ErrNoUpdateOperation indicates that the queried updater has no
 // update operations associated.
 type ErrNoUpdateOperation struct {
 	Updater string
@@ -31,7 +31,7 @@ func (e ErrBadNotification) Unwrap() error {
 	return e.E
 }
 
-// ErrDeleteNotification indicates an error while deleting notifcations.
+// ErrDeleteNotification indicates an error while deleting notifications.
 // The wrapped error will contain further details.
 type ErrDeleteNotification struct {
 	NotificationID uuid.UUID
@@ -55,7 +55,7 @@ func (e ErrNoReceipt) Error() string {
 	return fmt.Sprintf("no receipt exists for notification id %s", e.NotificationID)
 }
 
-// ErrReceipt indicates an error retreiving a receipt for referenced notification id.
+// ErrReceipt indicates an error retrieving a receipt for referenced notification id.
 type ErrReceipt struct {
 	NotificationID uuid.UUID
 	E              error
@@ -69,7 +69,7 @@ func (e ErrReceipt) Unwrap() error {
 	return e.E
 }
 
-// ErrCreated indicates an error occured when retrieving created notification ids.
+// ErrCreated indicates an error occurred when retrieving created notification ids.
 type ErrCreated struct {
 	E error
 }
@@ -82,7 +82,7 @@ func (e ErrCreated) Unwrap() error {
 	return e.E
 }
 
-// ErrFailed indicates an error occured when retrieving created notification ids.
+// ErrFailed indicates an error occurred when retrieving created notification ids.
 type ErrFailed struct {
 	E error
 }
@@ -95,7 +95,7 @@ func (e ErrFailed) Unwrap() error {
 	return e.E
 }
 
-// ErrPutNotifications indicates an issues occured when persisting a slice of
+// ErrPutNotifications indicates an issues occurred when persisting a slice of
 // computed notifications.
 // The wrapped error will contain further details.
 type ErrPutNotifications struct {

@@ -76,19 +76,19 @@ notifier:
     callback: "http://clair-notifier/notifier/api/v1/notifications"
     tls:
      root_ca: "optional/path/to/rootca"
-     cert: "madatory/path/to/cert"
-     key: "madatory/path/to/key"
+     cert: "mandatory/path/to/cert"
+     key: "mandatory/path/to/key"
   stomp:
-    desitnation: "notifications"
+    destination: "notifications"
     direct: false
     callback: "http://clair-notifier/notifier/api/v1/notifications"
     login:
       login: "username"
       passcode: "passcode"
     tls:
      root_ca: "optional/path/to/rootca"
-     cert: "madatory/path/to/cert"
-     key: "madatory/path/to/key"
+     cert: "mandatory/path/to/cert"
+     key: "mandatory/path/to/key"
 
 
 

@@ -70,7 +70,7 @@ func Test_Config_Validate_Failure(t *testing.T) {
 	}
 }
 
-func TestConfigUpateRetention(t *testing.T) {
+func TestConfigUpdateRetention(t *testing.T) {
 	var table = []struct {
 		name              string
 		conf              config.Config

@@ -21,7 +21,7 @@ type Indexer struct {
 	// This value tunes how often a waiting Indexer will poll for the lock.
 	// TODO: Move to async operating mode
 	ScanLockRetry int `yaml:"scanlock_retry" json:"scanlock_retry"`
-	// A positive values represeting quantity.
+	// A positive values representing quantity.
 	//
 	// Indexers will index a Manifest's layers concurrently.
 	// This value tunes the number of layers an Indexer will scan in parallel.

@@ -178,7 +178,7 @@ func (c *HTTP) LatestUpdateOperations(ctx context.Context, k driver.UpdateKind)
 // updateOperations is a private method implementing the common bits for retrieving UpdateOperations
 //
 // an ouCache is passed in by the caller to cache any responses providing an etag.
-// if a subsequent response provides a StatusNotModified status, the map of UpdateOprations is served from cache.
+// if a subsequent response provides a StatusNotModified status, the map of UpdateOperations is served from cache.
 func (c *HTTP) updateOperations(ctx context.Context, req *http.Request, cache *uoCache) (map[string][]driver.UpdateOperation, error) {
 	res, err := c.c.Do(req)
 	if err != nil {

@@ -43,7 +43,7 @@ func TestDiscoveryEndpoint(t *testing.T) {
 	if _, ok := m["openapi"]; !ok {
 		t.Fatalf("returned json did not container openapi key at the root")
 	}
-	t.Logf("openapi verion: %v", m["openapi"])
+	t.Logf("openapi version: %v", m["openapi"])
 }
 
 func TestDiscoveryFailure(t *testing.T) {

@@ -10,7 +10,7 @@ import (
 )
 
 // IndexStateHandler utilizes a Stater to report the
-// curent runtime state of an Indexer.
+// current runtime state of an Indexer.
 //
 // Indexers running with different scanner versions
 // will produce unique states and indicate to clients

@@ -137,7 +137,7 @@ func (t *Server) configureDiscovery(_ context.Context) error {
 func (t *Server) configureComboMode(ctx context.Context) error {
 	// requires both indexer and matcher services
 	if t.indexer == nil || t.matcher == nil {
-		return clairerror.ErrNotInitialized{Msg: "Combo mode requires both indexer and macher services"}
+		return clairerror.ErrNotInitialized{Msg: "Combo mode requires both indexer and matcher services"}
 	}
 
 	err := t.configureIndexerMode(ctx)

@@ -22,7 +22,7 @@ func TestUpdateOperationHandler(t *testing.T) {
 	t.Run("Errors", testUpdateOperationHandlerErrors)
 }
 
-// testUpdateOperationHandlerErrors confirms the handler perfoms the correct
+// testUpdateOperationHandlerErrors confirms the handler performs the correct
 // actions when a matcher.Differ is failing.
 func testUpdateOperationHandlerErrors(t *testing.T) {
 	t.Parallel()

@@ -59,7 +59,7 @@ func (h *VulnerabilityReportHandler) ServeHTTP(w http.ResponseWriter, r *http.Re
 		return
 	}
 
-	initd, err := h.Matcher.Initialized(ctx)
+	inited, err := h.Matcher.Initialized(ctx)
 	if err != nil {
 		resp := &je.Response{
 			Code:    "internal-server-error",
@@ -68,7 +68,7 @@ func (h *VulnerabilityReportHandler) ServeHTTP(w http.ResponseWriter, r *http.Re
 		je.Error(w, resp, http.StatusInternalServerError)
 		return
 	}
-	if !initd {
+	if !inited {
 		w.WriteHeader(http.StatusAccepted)
 		return
 	}