Skip to content

Commit 6289175

Browse files
committed
📚 v13 Documentation improvements
1 parent 0568f1a commit 6289175

File tree

6 files changed

+245
-19
lines changed

6 files changed

+245
-19
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Install the operator in a central management cluster and scan remote clusters vi
7474
│ └──────────┬──────────────────┘ │
7575
└─────────────┼───────────────────────┘
7676
77-
│ kubeconfig / WIF / SPIFFE
77+
│ kubeconfig / WIF* / SPIFFE*
7878
7979
┌─────────┴─────────┬─────────────────┐
8080
▼ ▼ ▼
@@ -84,13 +84,15 @@ Install the operator in a central management cluster and scan remote clusters vi
8484
└─────────┘ └─────────┘ └─────────┘
8585
```
8686

87+
_*WIF and SPIFFE authentication are experimental features._
88+
8789
**Use when:** You want centralized scanning, cannot install operators in target clusters, or want to reduce operational overhead.
8890

8991
**Authentication methods:**
9092

9193
- **Kubeconfig**: Use a kubeconfig file stored in a Secret
92-
- **Workload Identity (WIF)**: Native cloud provider authentication for GKE, EKS, AKS
93-
- **SPIFFE**: Use SPIFFE/SPIRE for cross-cluster authentication
94+
- **Workload Identity (WIF)** _(Experimental)_: Native cloud provider authentication for GKE, EKS, AKS
95+
- **SPIFFE** _(Experimental)_: Use SPIFFE/SPIRE for cross-cluster authentication
9496

9597
```yaml
9698
# External cluster scanning with kubeconfig
@@ -130,17 +132,23 @@ spec:
130132
131133
## Features
132134
133-
| Feature | Self-Cluster | External Cluster |
134-
| ------------------------------- | :----------: | :--------------: |
135-
| Kubernetes Resources Scanning | ✅ | ✅ |
136-
| Node Scanning | ✅ | ❌ |
137-
| Container Image Scanning | ✅ | ✅ |
138-
| Namespace Filtering | ✅ | ✅ |
139-
| Kubeconfig Auth | - | ✅ |
140-
| Workload Identity (GKE/EKS/AKS) | - | ✅ |
141-
| SPIFFE Auth | - | ✅ |
142-
143-
![Architecture](docs/img/architecture.svg)
135+
| Feature | Self-Cluster | External Cluster |
136+
| -------------------------------- | :----------: | :---------------------: |
137+
| Kubernetes Resources Scanning | ✅ | ✅ |
138+
| Node Scanning | ✅ | ❌ |
139+
| Container Image Scanning | ✅ | ✅ |
140+
| Namespace Filtering | ✅ | ✅ |
141+
| Kubeconfig Auth | - | ✅ |
142+
| Workload Identity (GKE/EKS/AKS) | - | ✅ ⚠️ Experimental |
143+
| SPIFFE Auth | - | ✅ ⚠️ Experimental |
144+
145+
### Self-Cluster Scanning Architecture
146+
147+
![Self-Cluster Scanning](docs/img/architecture-self-cluster.svg)
148+
149+
### External Cluster Scanning Architecture
150+
151+
![External Cluster Scanning](docs/img/architecture-external-cluster.svg)
144152
145153
## Getting Started
146154

docs/img/architecture-external-cluster.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/img/architecture-self-cluster.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)