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

feat: publish -alpine suffixed Docker images #396

Merged
merged 7 commits into from
Jun 17, 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
2 changes: 1 addition & 1 deletion .github/workflows/daily-security-scan-alpine.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
scan-relay:
strategy:
matrix:
tag: ['latest', 'v7', 'v8']
tag: ['latest', 'latest-alpine', 'v7', 'v8', 'v8-alpine']
fail-fast: false
runs-on: ubuntu-latest
steps:
Expand Down
30 changes: 29 additions & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,9 @@ dockers:
- "--platform=linux/arm64/v8"

docker_manifests:
# For the Alpine image
# For backwards compatibility, we publish the :latest, :vX, and :x.y.z tags for Alpine without any suffix
# indicating that the image is Alpine based (unlike the debian12 images). This is because it's what was done historically,
# and we cannot change it yet without breaking existing users.
- name_template: "launchdarkly/ld-relay:{{ .Version}}"
skip_push: false
image_templates:
Expand All @@ -238,6 +240,32 @@ docker_manifests:
- "launchdarkly/ld-relay:latest-arm64v8"
- "launchdarkly/ld-relay:latest-i386"

# We'll also create aliases for the Alpine-based image with the suffix "-alpine" to make it easier to distinguish
# from the debian12 image. This will also allow us to eventually deprecate the non-suffixed tags in a future major version.
- name_template: "launchdarkly/ld-relay:{{ .Version}}-alpine"
skip_push: false
image_templates:
- "launchdarkly/ld-relay:{{ .Version }}-amd64"
- "launchdarkly/ld-relay:{{ .Version }}-armv7"
- "launchdarkly/ld-relay:{{ .Version }}-arm64v8"
- "launchdarkly/ld-relay:{{ .Version }}-i386"

- name_template: "launchdarkly/ld-relay:v{{ .Major }}-alpine"
skip_push: false
image_templates:
- "launchdarkly/ld-relay:v{{ .Major }}-amd64"
- "launchdarkly/ld-relay:v{{ .Major }}-armv7"
- "launchdarkly/ld-relay:v{{ .Major }}-arm64v8"
- "launchdarkly/ld-relay:v{{ .Major }}-i386"

- name_template: "launchdarkly/ld-relay:latest-alpine"
skip_push: false
image_templates:
- "launchdarkly/ld-relay:latest-amd64"
- "launchdarkly/ld-relay:latest-armv7"
- "launchdarkly/ld-relay:latest-arm64v8"
- "launchdarkly/ld-relay:latest-i386"

# For the static debian12 image
- name_template: "launchdarkly/ld-relay:latest-static-debian12-nonroot"
skip_push: false
Expand Down
15 changes: 9 additions & 6 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Using Docker is not required, but if you prefer using a Docker container we prov
We provide images based on Alpine Linux and Google's
["distroless"](https://github.com/GoogleContainerTools/distroless) Debian12 images.

| Image | Version | Size | amd64 | armv7 | arm64v8 | i386 |
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|-------|-------|---------|------|
| Distroless | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest-static-debian12-nonroot) ][dockerhub] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest-static-debian12-nonroot)][dockerhub] | ✅ | ✅ | ✅ | ❌ | |
| Distroless (debug) | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest-static-debian12-debug-nonroot) ][dockerhub] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest-static-debian12-debug-nonroot)][dockerhub] | ✅ | ✅ | ✅ | ❌ |
| Alpine | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest) ][dockerhub] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest)][dockerhub] | ✅ | ✅ | ✅ | ✅ |
| Image | Version | Size | amd64 | armv7 | arm64v8 | i386 |
|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------|---------|------|
| Distroless | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest-static-debian12-nonroot) ][dockerhub-distroless] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest-static-debian12-nonroot)][dockerhub-distroless] | ✅ | ✅ | ✅ | ❌ | |
| Distroless (debug) | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest-static-debian12-debug-nonroot) ][dockerhub-distroless-debug] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest-static-debian12-debug-nonroot)][dockerhub-distroless-debug] | ✅ | ✅ | ✅ | ❌ |
| Alpine | [![Docker Image Version](https://img.shields.io/docker/v/launchdarkly/ld-relay/latest-alpine) ][dockerhub-alpine] | [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/launchdarkly/ld-relay/latest-alpine)][dockerhub-alpine] | ✅ | ✅ | ✅ | ✅ |

We recommend using the Distroless images, as automated security scanners regularly flag issues in Alpine even though
the Relay Proxy itself is unaffected.
Expand Down Expand Up @@ -81,4 +81,7 @@ variant):
docker exec -it [container name] /busybox/sh
```

[dockerhub]: https://hub.docker.com/r/launchdarkly/ld-relay
[dockerhub-distroless]: https://hub.docker.com/r/launchdarkly/ld-relay/tags?page=&page_size=&ordering=&name=static-debian12-nonroot
[dockerhub-distroless-debug]: https://hub.docker.com/r/launchdarkly/ld-relay/tags?page=&page_size=&ordering=&name=static-debian12-debug-nonroot
[dockerhub-alpine]: https://hub.docker.com/r/launchdarkly/ld-relay/tags?page=&page_size=&ordering=&name=alpine

Loading