Skip to content

Commit 33206cf

Browse files
committed
review-changes
1 parent c927268 commit 33206cf

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed
143 KB
Loading

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ KubViz offers a seamless integration with Git repositories, empowering you to ef
5050

5151
KubViz also monitors changes in your container registry, providing visibility into image updates. By tracking these changes, KubViz helps you proactively manage container security and compliance.
5252

53-
It comprehensively scans the kubernetes containers for the security flaws such as vulnerabilities and misconfigurations and creates SBOM.
53+
It comprehensively scans Kubernetes containers for security flaws, such as vulnerabilities and misconfigurations, and creates an SBOM (Software Bill of Materials).
5454

5555
## Architecture diagram
5656

@@ -86,6 +86,10 @@ token=$(openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
8686
```bash
8787
helm upgrade -i kubviz-client kubviz/client -n kubviz --set "nats.auth.token=$token"
8888
```
89+
90+
**NOTE:**
91+
- If you want to get a token from a secret, use a secret reference with the secret's name and key.
92+
8993
**NOTE:**
9094
- If you want to enable Grafana with the client deployment, add `--set grafana.enabled=true` to the helm upgrade command.
9195

@@ -123,6 +127,10 @@ helm upgrade -i kubviz-agent kubviz/agent -n kubviz \
123127
--set container_bridge.enabled=true \
124128
--set "container_bridge.ingress.hosts[0].host=<INGRESS HOSTNAME>",container_bridge.ingress.hosts[0].paths[0].path=/,container_bridge.ingress.hosts[0].paths[0].pathType=Prefix,container_bridge.ingress.tls[0].secretName=<SECRET-NAME>,container_bridge.ingress.tls[0].hosts[0]=<INGRESS HOSTNAME>
125129
```
130+
131+
**NOTE:**
132+
If you want to get a token from a secret, use a secret reference with the secret's name and key.
133+
126134
3. Replace "INGRESS HOSTNAME" with the desired hostname for the Git Bridge and Container Bridge Ingress configurations.
127135
4. Replace "SECRET-NAME" with the desired secretname for the Git Bridge and Container Bridge Ingress configurations.
128136

@@ -254,7 +262,7 @@ Use KubViz to monitor your cluster events, including:
254262

255263
### Container Registry Events Tracking
256264

257-
<img src=".readme_assets/containerBridgeDocker.jpeg" alt="Container Registry Events Tracking" width="525" align="right">
265+
<img src=".readme_assets/gitcontainerNew.jpeg" alt="Container Registry Events Tracking" width="525" align="right">
258266

259267
<br>
260268

@@ -285,7 +293,7 @@ Use KubViz to monitor your cluster events, including:
285293

286294
<br>
287295

288-
- You can generate Software Bill of Materials (SBOM) reports for images within a Kubernetes cluster using KubViz in the CycloneDX format, which will be presented as JSON reports.
296+
- Generate reports for Software Bill of Materials (SBOM) from images within your Kubernetes cluster using KubViz in the CycloneDX format. These reports will be available in JSON format.
289297

290298
<br>
291299

0 commit comments

Comments
 (0)