Skip to content

Commit 0882626

Browse files
authored
Verify spelling fixes pass check-spelling
2 parents 25c4e10 + e698321 commit 0882626

40 files changed

+116
-116
lines changed

CHANGELOG.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
### Httputil
2020
- [ed8ffc5](https://github.com/quay/clair/commit/ed8ffc50b56c9b11873f00bb2deb4fba9107ec95): create package and RateLimiter
2121
### Initialize
22-
- [5df82e1](https://github.com/quay/clair/commit/5df82e19e971c67ebdecf3f92682d4ae897db53a): update call to Libindex contstructor
22+
- [5df82e1](https://github.com/quay/clair/commit/5df82e19e971c67ebdecf3f92682d4ae897db53a): update call to Libindex constructor
2323
### Introspection
2424
- [ec59a43](https://github.com/quay/clair/commit/ec59a431032713654e2eb7a29ad7c446dd16a490): enable readiness endpoint
2525

@@ -111,7 +111,7 @@
111111
- [1ece08f](https://github.com/quay/clair/commit/1ece08f49434828c8c672f08ec45844b99187983): database metrics for notifier
112112
- [84ba35f](https://github.com/quay/clair/commit/84ba35f29ee81849cb2f424b3624895f9bd05a79): implement prometheus http
113113
### Local-Dev
114-
- [1c85589](https://github.com/quay/clair/commit/1c85589abdef98b5af8d4f6e2cd9eb5db6a723a0): remove unintented change in config.yaml
114+
- [1c85589](https://github.com/quay/clair/commit/1c85589abdef98b5af8d4f6e2cd9eb5db6a723a0): remove unintended change in config.yaml
115115
### Logging
116116
- [9f3d167](https://github.com/quay/clair/commit/9f3d167d5d85d345c7d0ee666be075a545a553f4): move to zlog throughout
117117
### Matcher
@@ -200,7 +200,7 @@
200200
### Clairctl
201201
- [835af27](https://github.com/quay/clair/commit/835af272fad49342f51adb4633ff639de3cc14a1): fix and codify import arguments
202202
- [b9ef107](https://github.com/quay/clair/commit/b9ef1073ca48ed5ed7caaa3e0fbad03a7d83592c): update import and export online help
203-
- [9883e80](https://github.com/quay/clair/commit/9883e80f331190e60de711b0705e9b37017fc5b1): unifiy config, client handling
203+
- [9883e80](https://github.com/quay/clair/commit/9883e80f331190e60de711b0705e9b37017fc5b1): unify config, client handling
204204
### Config
205205
- [dc8ba89](https://github.com/quay/clair/commit/dc8ba8912fa482378ef393aa51b4e9528d2877f2): expose notification summary toggle
206206
- [bb3cd66](https://github.com/quay/clair/commit/bb3cd669f66345aaa0fc5df6f502f34922cc069e): add 'omitempty' to 'updaters' config struct for correct marshalling
@@ -443,7 +443,7 @@
443443
### Config
444444
- [3ccc6e0](https://github.com/quay/clair/commit/3ccc6e03be0ce1b6c439d5c0649ee785dc7c559f): add support for per-scanner configuration
445445
### Dockerfile
446-
- [5a73cb4](https://github.com/quay/clair/commit/5a73cb49d64e839d7675979b5e3f348d94dd26a5): make -mod=vendor opportunisitic ([#999](https://github.com/quay/clair/issues/999))
446+
- [5a73cb4](https://github.com/quay/clair/commit/5a73cb49d64e839d7675979b5e3f348d94dd26a5): make -mod=vendor opportunistic ([#999](https://github.com/quay/clair/issues/999))
447447
- [#999](https://github.com/quay/clair/issues/999)### Dockerfile: Update To Alpine
448448
- [de32b07](https://github.com/quay/clair/commit/de32b0728ccdbafb85988e2f87618c9d576fc87e): 3.11 for newest rpm
449449
### Go.Mod
@@ -480,7 +480,7 @@
480480
### Config
481481
- [b2666e5](https://github.com/quay/clair/commit/b2666e57202d7c690a40d7c86975c13e0b3db56e): set a canonical default port
482482
### Dockerfile
483-
- [33da12a](https://github.com/quay/clair/commit/33da12a3bb9a28fdbcc6302caa4212d38a2acbbb): run as unprivledged user by default
483+
- [33da12a](https://github.com/quay/clair/commit/33da12a3bb9a28fdbcc6302caa4212d38a2acbbb): run as unprivileged user by default
484484
### Documentation
485485
- [fe324a5](https://github.com/quay/clair/commit/fe324a58e6be8c36da74afcd5487d0da4a547d5b): start writing v4-specific docs
486486
### Httptransport
@@ -647,7 +647,7 @@
647647
- [162e8cd](https://github.com/quay/clair/commit/162e8cdafc66be28b021f83da736a2b612ddda99): enable suse updater
648648
- [0609ed9](https://github.com/quay/clair/commit/0609ed964b0673806462a24147e6028da85d8a38): removed worker config
649649
- [af2c688](https://github.com/quay/clair/commit/af2c68863482ae9f93a2db1533be260468a6ea2d): not properly loaded error ([#140](https://github.com/quay/clair/issues/140))
650-
- [#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
650+
- [#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
651651
- [20af787](https://github.com/quay/clair/commit/20af78743774b18795cbf5210cc97cc172b1880d): fix default fallback
652652
- [4fc32d2](https://github.com/quay/clair/commit/4fc32d22713a47eabf5b12b81897fdd34d59935b): add top-level YAML namespace 'clair'
653653
- Fixes [#95](https://github.com/quay/clair/issues/95)- [bb7745f](https://github.com/quay/clair/commit/bb7745f3fe21e85b5fe37919e11d6d121e08b9a1): better document example
@@ -773,7 +773,7 @@
773773
- [627b98e](https://github.com/quay/clair/commit/627b98ef3126d517d3e80aef4c2ab9ed3d14b893): fix SQL error reporting
774774
### Db/Pgsql/Migration
775775
- [8df8170](https://github.com/quay/clair/commit/8df8170ba54d945cf2e2ad201bcdb8cc09fddc06): convert to pure SQL
776-
### Dckerfile
776+
### Dockerfile
777777
- [80f150f](https://github.com/quay/clair/commit/80f150f93bf3b12e6c9bcea2d71ccfa956bd50c9): Add docker-compose.yml
778778
### Detectors/Feature
779779
- [fc908e6](https://github.com/quay/clair/commit/fc908e65ba6c0ad3edb344cfb263adff8efe6f4e): add apk feature detector
@@ -984,7 +984,7 @@
984984
- [eeb13a0](https://github.com/quay/clair/commit/eeb13a02baa5db60b997454af8f059a6381f42da): add index on Vulnerability_Notification.deleted_at
985985
- [7cff31a](https://github.com/quay/clair/commit/7cff31a058230a94838b7fd8493380d444c31f5a): add ldfv compound index
986986
### Pkg
987-
- [c3904c9](https://github.com/quay/clair/commit/c3904c9696bddc20a27db9b4142ae704350bbe3f): Add fsutil to contian file system utility functions
987+
- [c3904c9](https://github.com/quay/clair/commit/c3904c9696bddc20a27db9b4142ae704350bbe3f): Add fsutil to contain file system utility functions
988988
- [78cef02](https://github.com/quay/clair/commit/78cef02fdad4afd12a2a00df51d457c796278bfa): cerrors -> commonerr
989989
- [03bac0f](https://github.com/quay/clair/commit/03bac0f1b6f504a416937e309a62fdfc308dc397): utils/tar.go -> pkg/tarutil
990990
### Pkg/Gitutil

Documentation/concepts/api_internal.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Further information and usage is an effort left to the reader.
1111
## Updates Diffs
1212

1313
The `update_diff/` endpoint exposes the api for diffing two update operations.
14-
This is used by the notifier to determine the added and removed vulnerabilities on security databsae update.
14+
This is used by the notifier to determine the added and removed vulnerabilities on security database update.
1515

1616
## Update Operation
1717

1818
The `update_operation` endpoint exposes the api for viewing updaters' activity.
19-
This is used by the notifier to determine if new updates have occured and triggers an update diff to see what has changed.
19+
This is used by the notifier to determine if new updates have occurred and triggers an update diff to see what has changed.
2020

2121
## AffectedManifest
2222

23-
The `affected_manifest` endpoint exposes the api for retreiving affected manifests given a list of Vulnerabilities.
23+
The `affected_manifest` endpoint exposes the api for retrieving affected manifests given a list of Vulnerabilities.
2424
This is used by the notifier to determine the manifests that need to have a notification generated.

Documentation/concepts/indexing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Indexing
22

3-
The [Indexer](../reference/indexer.md) service is responsble for "indexing a manifest".
3+
The [Indexer](../reference/indexer.md) service is responsible for "indexing a manifest".
44

55
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.
66

Documentation/concepts/notifications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
ClairV4 implements a notification system.
44

5-
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.
5+
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.
66

77
The interested client can subscribe to notifications via several mechanisms:
88
* Webhook delivery
@@ -58,7 +58,7 @@ When you configure notifier for webhook delivery you provide the service with th
5858
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:
5959
```json
6060
{
61-
"notifiction_id": {uuid_string},
61+
"notification_id": {uuid_string},
6262
"callback": {url_to_notifications}
6363
}
6464
```

Documentation/contribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contribuion
1+
# Contribution
22
The following sections provides information on how to contribute to Clair.
33

44
- [Commit Style](./contribution/commit_style.md)

Documentation/howto/deployment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In a combined deployment, all the Clair processes run in a single OS process. Th
1414

1515
A load balancer is still recommended if you plan on performing TLS termination. Typically this will be a OpenShift route or a Kubernetes ingress.
1616

17-
![combo mode single db deployment diagran](./clairv4_combo_single_db.png)
17+
![combo mode single db deployment diagram](./clairv4_combo_single_db.png)
1818

1919
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.
2020

@@ -33,7 +33,7 @@ In this mode, any configuration informing Clair how to talk to other nodes is ig
3333

3434
For added flexibility, it's also supported to split the databases while in combo mode.
3535

36-
![combo mode multiple db deployment diagran](./clairv4_combo_multi_db.png)
36+
![combo mode multiple db deployment diagram](./clairv4_combo_multi_db.png)
3737

3838
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.
3939

@@ -58,7 +58,7 @@ In a distributed deployment, each Clair process runs in its own OS process. Typi
5858

5959
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.
6060

61-
![distributed mode multiple db deployment diagran](./clairv4_distributed_multi_db.png)
61+
![distributed mode multiple db deployment diagram](./clairv4_distributed_multi_db.png)
6262

6363
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.
6464

Documentation/reference/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: ClairV4 v0.1
33
language_tabs:
44
- python: Python
55
- go: Golang
6-
- javascript: Javascript
6+
- javascript: JavaScript
77
language_clients:
88
- python: ""
99
- go: ""
@@ -1184,7 +1184,7 @@ Notification
11841184
|---|---|---|---|---|
11851185
|id|string|false|none|a unique identifier for this notification|
11861186
|manifest|string|false|none|The hash of the manifest affected by the provided vulnerability.|
1187-
|reason|string|false|none|the reason for the notifcation, [added | removed]|
1187+
|reason|string|false|none|the reason for the notification, [added | removed]|
11881188
|vulnerability|[VulnSummary](#schemavulnsummary)|false|none|A summary of a vulnerability|
11891189

11901190
<h2 id="tocS_Environment">Environment</h2>
@@ -1285,7 +1285,7 @@ IndexReport
12851285
|» **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.|
12861286
|environments|object|true|none|A map of lists containing Environment objects keyed by the<br>associated Package.id.|
12871287
|» **additionalProperties**|[[Environment](#schemaenvironment)]|false|none|[The environment a particular package was discovered in.]|
1288-
|success|boolean|true|none|A bool indicating succcessful index|
1288+
|success|boolean|true|none|A bool indicating successful index|
12891289
|err|string|true|none|An error message on event of unsuccessful index|
12901290

12911291
<h2 id="tocS_VulnerabilityReport">VulnerabilityReport</h2>

Documentation/reference/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,7 @@ An address in `<host>:<post>` syntax where traces can be submitted.
564564
#### `$.trace.jaeger.collector.username`
565565
a string value
566566

567-
#### `$.trace.jaeger.collector.passwordd`
567+
#### `$.trace.jaeger.collector.password`
568568
a string value
569569

570570
#### `$.trace.jaeger.service_name`

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ goimports-local:
2525
# you'll need to have npx to run this gen.
2626
.PHONY: gen-api-reference
2727
gen-api-reference:
28-
npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
28+
npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:JavaScript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
2929

3030
# start a local development environment.
3131
# each services runs in it's own container to test service->service communication.

clair-error/errors.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ func (e *ErrRequestFail) Error() string {
1616
return fmt.Sprintf("code: %v status %v", e.Code, e.Status)
1717
}
1818

19-
// ErrBadManifest inidcates a manifest could not be parsed
19+
// ErrBadManifest indicates a manifest could not be parsed
2020
type ErrBadManifest struct {
2121
E error
2222
}
@@ -29,7 +29,7 @@ func (e *ErrBadManifest) Unwrap() error {
2929
return e.E
3030
}
3131

32-
// ErrBadManifest inidcates a manifest could not be parsed
32+
// ErrBadManifest indicates a manifest could not be parsed
3333
type ErrBadIndexReport struct {
3434
E error
3535
}

0 commit comments

Comments
 (0)