Skip to content

Commit 4c6be72

Browse files
authored
Merge pull request #248 from intelops/release-sep25
newrelease readme
2 parents 28f61ef + 33206cf commit 4c6be72

File tree

9 files changed

+37
-7
lines changed

9 files changed

+37
-7
lines changed

.readme_assets/GitBridgeNew.jpeg

134 KB
Loading
160 KB
Loading
143 KB
Loading

.readme_assets/kubeDataNew.jpeg

137 KB
Loading

.readme_assets/sbom.jpeg

93.1 KB
Loading

.readme_assets/trivyk8sNew.jpeg

130 KB
Loading

.readme_assets/vul-misconfig.jpeg

164 KB
Loading

README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
## KubViz
2828

29-
Visualize Kubernetes & DevSecOps Workflows. Tracks changes/events real-time across your entire K8s clusters, git repos, container registries, etc. , analyzing their effects and providing you with the context you need to troubleshoot efficiently. Get the Observability you need, easily.
29+
Visualize Kubernetes & DevSecOps Workflows. Tracks changes/events real-time across your entire K8s clusters, git repos, container registries, Container image Vulnerability scanning, misconfiguration, SBOM etc. , analyzing their effects and providing you with the context you need to troubleshoot efficiently. Get the Observability you need, easily.
3030

3131
## Table of Contents
3232
- [How KubViz works](#how-kubviz-works)
@@ -50,7 +50,8 @@ 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.
53+
It comprehensively scans Kubernetes containers for security flaws, such as vulnerabilities and misconfigurations, and creates an SBOM (Software Bill of Materials).
54+
5455
## Architecture diagram
5556

5657
![Arch. Diagram](.readme_assets/kubviz.png)
@@ -85,6 +86,10 @@ token=$(openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
8586
```bash
8687
helm upgrade -i kubviz-client kubviz/client -n kubviz --set "nats.auth.token=$token"
8788
```
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+
8893
**NOTE:**
8994
- If you want to enable Grafana with the client deployment, add `--set grafana.enabled=true` to the helm upgrade command.
9095

@@ -122,6 +127,10 @@ helm upgrade -i kubviz-agent kubviz/agent -n kubviz \
122127
--set container_bridge.enabled=true \
123128
--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>
124129
```
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+
125134
3. Replace "INGRESS HOSTNAME" with the desired hostname for the Git Bridge and Container Bridge Ingress configurations.
126135
4. Replace "SECRET-NAME" with the desired secretname for the Git Bridge and Container Bridge Ingress configurations.
127136

@@ -168,6 +177,10 @@ helm upgrade -i kubviz-agent kubviz/agent -n kubviz --set nats.host=<NATS IP Add
168177
```
169178
2. Replace "<NATS IP Address>" with the IP address of your NATS service **kubviz-client-nats-external**.
170179

180+
**NOTE:**
181+
182+
A time-based job scheduler is added for each plugins. They allow you to schedule and automate the execution of plugins at specific times, intervals. Each plugin execution can be configured to run at a precise time or at regular intervals.
183+
171184
#### How to Verify if Everything is Up and Running
172185

173186
After completing the installation of both the client and agent, you can use the following command to verify if they are up and running.
@@ -207,7 +220,7 @@ kubectl --namespace kubviz port-forward $POD_NAME 3000
207220

208221
### Cluster Event Tracking
209222

210-
<img src=".readme_assets/kubedata.jpeg" alt="Cluster Events" width="525" align="right">
223+
<img src=".readme_assets/kubeDataNew.jpeg" alt="Cluster Events" width="525" align="right">
211224

212225
<br>
213226

@@ -221,7 +234,7 @@ Use KubViz to monitor your cluster events, including:
221234

222235
<br clear="all">
223236

224-
<img src=".readme_assets/deleted_apis.png" alt="Deprecated Kubernetes APIs" width="525" align="right">
237+
<img src=".readme_assets/depricatedAPINew.jpeg" alt="Deprecated Kubernetes APIs" width="525" align="right">
225238

226239
<br>
227240

@@ -235,7 +248,7 @@ Use KubViz to monitor your cluster events, including:
235248

236249
### Git Repository Events Tracking
237250

238-
<img src=".readme_assets/newGitBridge.jpeg" alt="gitBridge" width="525" align="right">
251+
<img src=".readme_assets/GitBridgeNew.jpeg" alt="gitBridge" width="525" align="right">
239252

240253
<br>
241254

@@ -249,7 +262,7 @@ Use KubViz to monitor your cluster events, including:
249262

250263
### Container Registry Events Tracking
251264

252-
<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">
253266

254267
<br>
255268

@@ -261,7 +274,7 @@ Use KubViz to monitor your cluster events, including:
261274

262275
### Kubernetes Container Security Tracking
263276

264-
<img src=".readme_assets/TrivyK8s.jpeg" alt="Kubernetes Container Security Tracking" width="525" align="right">
277+
<img src=".readme_assets/trivyk8sNew.jpeg" alt="Kubernetes Container Security Tracking" width="525" align="right">
265278

266279
<br>
267280

@@ -270,6 +283,20 @@ Use KubViz to monitor your cluster events, including:
270283
- Detects configuration issues in Kubernetes cluster
271284
<br>
272285

286+
<img src=".readme_assets/vul-misconfig.jpeg" alt="Kubernetes Container Security Tracking" width="525" align="right">
287+
288+
<br clear="all">
289+
290+
### SBOM
291+
292+
<img src=".readme_assets/sbom.jpeg" alt="sbom" width="525" align="right">
293+
294+
<br>
295+
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.
297+
298+
<br>
299+
273300
<br clear="all">
274301

275302
## Contributing

docs/CONFIGURATION.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Possible values are:
3434
Values | Platform |
3535
------ | -------- |
3636
`/event/docker/hub` | DockerHub |
37+
`/event/azure/container` | Azure |
38+
`/event/jfrog/container` | JFrog |
39+
`/event/quay/container` | Quay |
3740

3841

3942

0 commit comments

Comments
 (0)