Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(develop): Add Docker image for development environment #128

Merged
merged 1 commit into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/build.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM golang:1.23-bookworm
RUN apt update && apt install -y clang gcc flex bison make \
libelf-dev gcc-aarch64-linux-gnu libc6-dev-arm64-cross git && \
git config --global --add safe.directory /app
WORKDIR /app
107 changes: 107 additions & 0 deletions .github/workflows/docker-dev-image.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: docker-dev-image

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

on:
workflow_dispatch:
push:
branches:
- 'dev-docker'

env:
# Use docker.io for Docker Hub if empty
REGISTRY: quay.io
# github.repository as <account>/<repo>
IMAGE_NAME: 'ptcpdump/develop'


jobs:
build:

runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v4

# Set up BuildKit Docker container builder to be able to build
# multi-platform images and export cache
# https://github.com/docker/setup-buildx-action
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
with:
platforms: linux/amd64,linux/arm64

# Login against a Docker registry except on PR
# https://github.com/docker/login-action
- name: Log into registry ${{ env.REGISTRY }}
if: github.event_name != 'pull_request'
uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
with:
registry: ${{ env.REGISTRY }}
username: ${{ secrets.QUAY_USER }}
password: ${{ secrets.QUAY_PASSWD }}

# Extract metadata (tags, labels) for Docker
# https://github.com/docker/metadata-action
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

- name: generate tag name
run: |
echo "TAG_NAME=$(date +'%Y%m%d.%H%M%S')" >> $GITHUB_ENV

# Build and push Docker image with Buildx (don't push on PR)
# https://github.com/docker/build-push-action
- name: Build and push Docker image (no latest tag)
id: build-and-push
uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
with:
context: .
file: .github/build.Dockerfile
# platforms: linux/amd64,linux/arm64
platforms: linux/amd64
push: ${{ github.event_name != 'pull_request' }}
tags: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG_NAME }}'
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max

- name: test image
run: |
set -xe

IMAGE='${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG_NAME }}'

docker run --rm -v `pwd`:/app "${IMAGE}" make build-bpf
docker run --rm -v `pwd`:/app "${IMAGE}" make build

./ptcpdump --version

git status


# Build and push Docker image with Buildx (don't push on PR)
# https://github.com/docker/build-push-action
- name: Build and push Docker image (latest tag)
id: build-and-push-latest
uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
with:
context: .
file: .github/build.Dockerfile
# platforms: linux/amd64,linux/arm64
platforms: linux/amd64
push: ${{ github.event_name != 'pull_request' }}
tags: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest'
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max

13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,6 @@ Flags:
* Lex/Flex >= 2.6
* GCC
* GNU make
* Kernel headers are expected to be installed in `/lib/modules/$(uname -r)`.


### Building
Expand All @@ -340,10 +339,22 @@ Flags:
make build-bpf
```

Or:

```
docker run --rm -v `pwd`:/app quay.io/ptcpdump/develop:latest make build-bpf
```

2. Build ptcpdump:

```
make build
```

Or:

```
docker run --rm -v `pwd`:/app quay.io/ptcpdump/develop:latest make build
```

<p align="right"><a href="#top">🔝</a></p>
14 changes: 13 additions & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,6 @@ Flags:
* Lex/Flex >= 2.6
* GCC
* GNU make
* Kernel headers are expected to be installed in `/lib/modules/$(uname -r)`.


### Building
Expand All @@ -360,10 +359,23 @@ Flags:
make build-bpf
```

Or:

```
docker run --rm -v `pwd`:/app quay.io/ptcpdump/develop:latest make build-bpf
```


2. Build ptcpdump:

```
make build
```

Or:

```
docker run --rm -v `pwd`:/app quay.io/ptcpdump/develop:latest make build
```

<p align="right"><a href="#top">🔝</a></p>
Loading