Skip to content

Commit

Permalink
Update cli docs (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
ramanan-ravi authored Apr 25, 2024
1 parent 8982f86 commit 71a7ec9
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 28 deletions.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ WORKDIR /go/package-scanner/
COPY . .

ARG TARGETPLATFORM
ARG MAKE_CMD=package-scanner
# TODO(tjonak): not sure whether I need to expose TARGETPLATFORM to make or is ARG automatically available
# test that
RUN TARGETPLATFORM=$TARGETPLATFORM make tools
RUN CGO_ENABLED=0 make package-scanner
RUN CGO_ENABLED=0 make $MAKE_CMD

FROM debian:bullseye-slim
LABEL MAINTAINER="Deepfence Inc"
Expand Down
15 changes: 13 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
export IMAGE_REPOSITORY?=quay.io/deepfenceio
export DF_IMG_TAG?=2.2.0

all: package-scanner

.PHONY: bootstrap
Expand Down Expand Up @@ -28,11 +31,19 @@ package-scanner: vendor $(PWD)/**/*.go $(PWD)/agent-plugins-grpc/**/*.go

.PHONY: docker
docker:
docker build -t quay.io/deepfenceio/deepfence_package_scanner:2.2.0 .
docker build -t $(IMAGE_REPOSITORY)/deepfence_package_scanner:$(DF_IMG_TAG) .

.PHONY: docker-cli
docker-cli:
docker build --build-arg MAKE_CMD="cli" -t $(IMAGE_REPOSITORY)/deepfence_package_scanner_cli:$(DF_IMG_TAG) .

.PHONY: docker-cli-multi-arch-push
docker-cli-multi-arch-push: buildx
docker buildx build --build-arg MAKE_CMD="cli" --platform linux/arm64,linux/amd64 --tag $(IMAGE_REPOSITORY)/deepfence_package_scanner_cli:$(DF_IMG_TAG) . --push

.PHONY: docker-multi-arch
docker-multi-arch:
docker buildx build --platform linux/arm64,linux/amd64 --tag quay.io/deepfenceio/deepfence_package_scanner:2.2.0 .
docker buildx build --platform linux/arm64,linux/amd64 --tag $(IMAGE_REPOSITORY)/deepfence_package_scanner:$(DF_IMG_TAG) .

.PHONY: buildx
buildx:
Expand Down
34 changes: 9 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,37 +30,21 @@ docker pull nginx:latest

## Build
1. make tools
2. make release
3. dist directory contains tar.gz packages for linux and macos as shown below
```
$ ls -lh dist/
total 256M
-rw-r--r-- 1 root root 3.6K Dec 29 09:40 artifacts.json
-rw-r--r-- 1 root root 408 Dec 29 09:40 checksums.txt
-rw-r--r-- 1 root root 3.4K Dec 29 09:40 config.yaml
-rw-r--r-- 1 root root 232 Dec 29 09:40 metadata.json
-rw-r--r-- 1 root root 65M Dec 29 09:40 package-scanner_Darwin_arm64.tar.gz
-rw-r--r-- 1 root root 67M Dec 29 09:40 package-scanner_Darwin_x86_64.tar.gz
-rw-r--r-- 1 root root 61M Dec 29 09:40 package-scanner_Linux_arm64.tar.gz
-rw-r--r-- 1 root root 65M Dec 29 09:40 package-scanner_Linux_x86_64.tar.gz
drwxr-xr-x 2 root root 4.0K Dec 29 09:40 package-scanner_darwin_amd64_v1
drwxr-xr-x 2 root root 4.0K Dec 29 09:40 package-scanner_darwin_arm64
drwxr-xr-x 2 root root 4.0K Dec 29 09:40 package-scanner_linux_amd64_v1
drwxr-xr-x 2 root root 4.0K Dec 29 09:40 package-scanner_linux_arm64
```
2. make cli
3. This will generate `package-scanner` binary in the current directory

## Build docker image
1. make tools
2. make docker
3. docker images should show new image with name quay.io/deepfenceio/deepfence_package_scanner_ce:2.2.0
1. make docker-cli
2. docker images should show new image with name quay.io/deepfenceio/deepfence_package_scanner_cli:2.2.0
```
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
quay.io/deepfenceio/deepfence_package_scanner 2.2.0 e06fb1cd3868 About an hour ago 569MB
nginx latest 1403e55ab369 8 days ago 142MB
REPOSITORY TAG IMAGE ID CREATED SIZE
quay.io/deepfenceio/deepfence_package_scanner_cli 2.2.0 e06fb1cd3868 About an hour ago 569MB
nginx latest 1403e55ab369 8 days ago 142MB
```
## Docker image standalone usage example
```
docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock quay.io/deepfenceio/deepfence_package_scanner_ce:2.2.0 package-scanner -source nginx:latest
docker pull nginx:latest
docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock --name package-scanner quay.io/deepfenceio/deepfence_package_scanner_cli:2.2.0 -source nginx:latest
```

0 comments on commit 71a7ec9

Please sign in to comment.