Skip to content

Commit 1ed0cd8

Browse files
authored
Merge pull request #1076 from fabriziosestito/fix/several-typo-and-old-names
fix: several typos and old names
2 parents 2e6da17 + bbdbf85 commit 1ed0cd8

5 files changed

Lines changed: 19 additions & 5 deletions

File tree

charts/sbomscanner/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ storage:
4646
# Ignored if CNPG is enabled.
4747
#
4848
# Note: Any `sslmode` or other `ssl*` parameters in the URI are ignored.
49-
# SBOMBastic always enforces CA verification when connecting to the database,
49+
# SBOMscanner always enforces CA verification when connecting to the database,
5050
# using the CA certificate specified in the `caSecretName` secret.
5151
authSecretName: ""
5252
# Name of secret containing the CA certificate used to verify the Postgres server certificate.

docs/installation/helm-values.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ This document describes the available configuration options for the SBOMscanner
55
You can customize these values in two ways:
66

77
1. Create a custom values file (e.g., `my-values.yaml`) with your overrides and pass it to Helm:
8+
89
```bash
910
helm install sbomscanner ./chart -f my-values.yaml
1011
```
1112

1213
2. Use `--set` flags to override specific values directly:
14+
1315
```bash
1416
helm install sbomscanner ./chart --set controller.replicas=5 --set storage.postgres.cnpg.instances=5
1517
```
1618

1719
For more details on customizing Helm charts, see the [Helm documentation](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
1820

1921
## Log Levels
22+
2023
You can configure the log level for each SBOMscanner component to control the verbosity of the logs.
2124

2225
```yaml
@@ -33,9 +36,11 @@ worker:
3336
Available log levels are: `debug`, `info`, `warn`, `error`.
3437

3538
## Resource Limits and Requests
39+
3640
Each component has default resource limits and requests that you can customize based on your cluster's capacity and workload requirements.
3741

3842
### Controller
43+
3944
```yaml
4045
controller:
4146
resources:
@@ -48,6 +53,7 @@ controller:
4853
```
4954

5055
### Storage
56+
5157
```yaml
5258
storage:
5359
resources:
@@ -60,6 +66,7 @@ storage:
6066
```
6167

6268
### Worker
69+
6370
```yaml
6471
worker:
6572
resources:
@@ -76,9 +83,11 @@ Adjust these values based on your workload. The storage component typically need
7683
For more information on resource management, see the [Kubernetes documentation on resource requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
7784

7885
## PostgreSQL Configuration
86+
7987
SBOMscanner requires a PostgreSQL database to store SBOM data. You have two options: use the built-in [CloudNativePG (CNPG) operator](https://cloudnative-pg.io/) or connect to an external PostgreSQL instance.
8088

8189
### Using CloudNativePG (Default)
90+
8291
By default, SBOMscanner deploys a PostgreSQL cluster using the CloudNativePG operator. This is the easiest way to get started.
8392

8493
```yaml
@@ -95,6 +104,7 @@ storage:
95104
```
96105

97106
**Configuration options:**
107+
98108
- `instances`: Number of PostgreSQL replicas (default: 3)
99109
- `storage.size`: Size of the persistent volume. You can increase this value later, and changes will be automatically applied to existing PVCs. Size cannot be decreased. See the [CNPG documentation](https://cloudnative-pg.io/documentation/current/storage/#volume-expansion) for more details.
100110
- `storage.resizeInUseVolumes`: Automatically resize PVCs (default: true)
@@ -104,6 +114,7 @@ storage:
104114
For more configuration options, refer to the [CloudNativePG Cluster configuration documentation](https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-ClusterSpec).
105115

106116
### Using an External PostgreSQL Instance
117+
107118
If you already have a PostgreSQL instance or prefer to manage it separately, disable CNPG and provide connection details.
108119

109120
```yaml
@@ -118,6 +129,7 @@ storage:
118129
**Steps to configure external PostgreSQL:**
119130

120131
1. Create a `Secret` with the PostgreSQL connection URI:
132+
121133
```yaml
122134
apiVersion: v1
123135
kind: Secret
@@ -128,13 +140,14 @@ stringData:
128140
uri: "postgresql://user:password@postgres.example.com:5432/sbomscanner?sslmode=require"
129141
```
130142

131-
The URI format follows the [PostgreSQL connection URI specification](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS).
143+
The URI format follows the [PostgreSQL connection URI specification](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS).
132144

133145
> **Note:** Any `sslmode` or other `ssl*` parameters in the URI are ignored.
134-
> SBOMBastic always enforces CA verification when connecting to the database,
146+
> SBOMscanner always enforces CA verification when connecting to the database,
135147
> using the CA certificate specified in the `caSecretName` secret.
136148

137149
2. Create a `Secret` with the CA certificate used to verify the PostgreSQL server certificate:
150+
138151
```yaml
139152
apiVersion: v1
140153
kind: Secret
@@ -149,6 +162,7 @@ stringData:
149162
```
150163

151164
3. Reference the secrets in your Helm values:
165+
152166
```yaml
153167
storage:
154168
postgres:

docs/installation/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ sbomscanner sbomscanner-worker-d9d68c5c-tlpgm 1/1 Runn
115115

116116
### Summary
117117

118-
At this point, your SBOMBastic deployment is up and running successfully. You're now ready to begin scanning images and generating reports!
118+
At this point, your SBOMscanner deployment is up and running successfully. You're now ready to begin scanning images and generating reports!
119119

120120
---
121121

internal/handlers/utils_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const (
4949
imageDigestLinuxPpc64leMultiArch = "sha256:216cb428a7a53a75ef7806ed1120c409253e3e65bddc6ae0c21f5cd2faf92324"
5050
imageDigestLinuxS390xMultiArch = "sha256:f2475c61ab276da0882a9637b83b2a5710b289d6d80f3daedb71d4a8eaeb1686"
5151

52-
imageRefMultiArchWithUnknownPlatform = "ghcr.io/kubewarden/sbombscanner/test-assets/udash-front:v0.11.0"
52+
imageRefMultiArchWithUnknownPlatform = "ghcr.io/kubewarden/sbomscanner/test-assets/udash-front:v0.11.0"
5353
imageIndexDigestMultiArchWithUnknownPlatform = "sha256:906b299349d8a28432228e0aff6b0c3796cec9300a51e5e5161bf8e5e56e07cb"
5454
imageDigestLinuxAmd64MultiArchWithUnknownPlatform = "sha256:d2fabf8aca7ade7f2bcb63d0ef7966b697bed9482197d9906cf2578202d7f789"
5555
imageDigestLinuxArm64MultiArchWithUnknownPlatform = "sha256:6c8913ca09035b8730212b9a5b2f2ce451fe37a36b4e591e3d5af77b2eb60971"

0 commit comments

Comments
 (0)