Skip to content

Commit e47893d

Browse files
committed
docs: add documentation
1 parent 8a33613 commit e47893d

File tree

6 files changed

+35
-12
lines changed

6 files changed

+35
-12
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "sysdig-lsp"
3-
version = "0.5.1"
3+
version = "0.6.0"
44
edition = "2024"
55
authors = [ "Sysdig Inc." ]
66
readme = "README.md"

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ helping you detect vulnerabilities and misconfigurations earlier in the developm
1515
1616
## Features
1717

18-
| Feature | **[VSCode Extension](https://github.com/sysdiglabs/vscode-extension)** | **[Sysdig LSP](./docs/features/README.md)** |
19-
|---------------------------------|------------------------------------------------------------------------|----------------------------------------------------------|
20-
| Scan base image in Dockerfile | Supported | [Supported](./docs/features/scan_base_image.md) (0.1.0+) |
21-
| Code lens support | Supported | [Supported](./docs/features/code_lens.md) (0.2.0+) |
22-
| Build and Scan Dockerfile | Supported | [Supported](./docs/features/build_and_scan.md) (0.4.0+) |
23-
| Layered image analysis | Supported | [Supported](./docs/features/layered_analysis.md) (0.5.0+)|
24-
| Docker-compose image analysis | Supported | In roadmap |
25-
| K8s Manifest image analysis | Supported | In roadmap |
26-
| Infrastructure-as-code analysis | Supported | In roadmap |
27-
| Vulnerability explanation | Supported | In roadmap |
18+
| Feature | **[VSCode Extension](https://github.com/sysdiglabs/vscode-extension)** | **[Sysdig LSP](./docs/features/README.md)** |
19+
|---------------------------------|------------------------------------------------------------------------|------------------------------------------------------------------------|
20+
| Scan base image in Dockerfile | Supported | [Supported](./docs/features/scan_base_image.md) (0.1.0+) |
21+
| Code lens support | Supported | [Supported](./docs/features/code_lens.md) (0.2.0+) |
22+
| Build and Scan Dockerfile | Supported | [Supported](./docs/features/build_and_scan.md) (0.4.0+) |
23+
| Layered image analysis | Supported | [Supported](./docs/features/layered_analysis.md) (0.5.0+) |
24+
| Docker-compose image analysis | Supported | [Supported](./docs/features/docker_compose_image_analysis.md) (0.6.0+) |
25+
| K8s Manifest image analysis | Supported | In roadmap |
26+
| Infrastructure-as-code analysis | Supported | In roadmap |
27+
| Vulnerability explanation | Supported | In roadmap |
2828

2929
## Build
3030

docs/features/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,7 @@ Sysdig LSP provides tools to integrate container security checks into your devel
1818
- Scans each Dockerfile layer individually for precise vulnerability identification.
1919
- Supports detailed analysis in single-stage and multi-stage Dockerfiles.
2020

21+
## [Docker-compose Image Analysis](./docker_compose_image_analysis.md)
22+
- Scans the images defined in your `docker-compose.yml` files for vulnerabilities.
23+
2124
See the linked documents for more details.
1.57 MB
Loading
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Docker-compose Image Analysis
2+
3+
Sysdig LSP scans the images defined in your `docker-compose.yml` files to identify vulnerabilities.
4+
5+
> [!IMPORTANT]
6+
> Sysdig LSP analyzes each service's image in your compose file.
7+
8+
![Sysdig LSP executing docker-compose image scan](./docker_compose_image_analysis.gif)
9+
10+
## Example
11+
12+
```yaml
13+
services:
14+
web:
15+
image: nginx:latest
16+
db:
17+
image: postgres:13
18+
```
19+
20+
In this example, Sysdig LSP will provide actions to scan both `nginx:latest` and `postgres:13` images.

0 commit comments

Comments
 (0)