rename for consistency

launchdarkly · Jun 7, 2024 · c7fbdbb · c7fbdbb
1 parent bb416bf
commit c7fbdbb
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 58 deletions.
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -125,42 +125,42 @@ dockers:
 
   # AMD64
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-amd64"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-amd64"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-amd64"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-amd64"
     use: buildx
     goos: linux
     goarch: amd64
-    dockerfile: Dockerfile-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
       - "--platform=linux/amd64"
 
   # ARMv7
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-armv7"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-armv7"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-armv7"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-armv7"
     use: buildx
     goos: linux
     goarch: arm
     goarm: 7
-    dockerfile: Dockerfile-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
       - "--platform=linux/arm/v7"
 
   # ARM64v8
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-arm64v8"
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-arm64v8"
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-arm64v8"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-arm64v8"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-arm64v8"
     use: buildx
     goos: linux
     goarch: arm64
-    dockerfile: Dockerfile-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
@@ -171,42 +171,42 @@ dockers:
 
   # AMD64
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-amd64"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-amd64"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-amd64"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-amd64"
     use: buildx
     goos: linux
     goarch: amd64
-    dockerfile: Dockerfile-debug-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-debug-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
       - "--platform=linux/amd64"
 
   # ARMv7
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-armv7"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-armv7"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-armv7"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-armv7"
     use: buildx
     goos: linux
     goarch: arm
     goarm: 7
-    dockerfile: Dockerfile-debug-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-debug-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
       - "--platform=linux/arm/v7"
 
   # ARM64v8
   - image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-arm64v8"
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-arm64v8"
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-arm64v8"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-arm64v8"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-arm64v8"
     use: buildx
     goos: linux
     goarch: arm64
-    dockerfile: Dockerfile-debug-nonroot-static-debian12.goreleaser
+    dockerfile: Dockerfile-static-debian12-debug-nonroot.goreleaser
     skip_push: false
     build_flag_templates:
       - "--pull"
@@ -239,45 +239,45 @@ docker_manifests:
       - "launchdarkly/ld-relay:latest-i386"
 
   # For the static debian12 image
-  - name_template: "launchdarkly/ld-relay:latest-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:latest-static-debian12-nonroot"
     skip_push: false
     image_templates:
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:latest-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-amd64"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-armv7"
+      - "launchdarkly/ld-relay:latest-static-debian12-nonroot-arm64v8"
 
-  - name_template: "launchdarkly/ld-relay:{{ .Version}}-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:{{ .Version}}-static-debian12-nonroot"
     skip_push: false
     image_templates:
-       - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-amd64"
-       - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-armv7"
-       - "launchdarkly/ld-relay:{{ .Version }}-nonroot-static-debian12-arm64v8"
+       - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-amd64"
+       - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-armv7"
+       - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-nonroot-arm64v8"
 
-  - name_template: "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot"
     skip_push: false
     image_templates:
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:v{{ .Major }}-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-amd64"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-armv7"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-nonroot-arm64v8"
 
   # For the debug static debian12 image
-  - name_template: "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot"
     skip_push: false
     image_templates:
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:latest-debug-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-amd64"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-armv7"
+      - "launchdarkly/ld-relay:latest-static-debian12-debug-nonroot-arm64v8"
 
-  - name_template: "launchdarkly/ld-relay:{{ .Version}}-debug-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:{{ .Version}}-static-debian12-debug-nonroot"
     skip_push: false
     image_templates:
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:{{ .Version }}-debug-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-amd64"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-armv7"
+      - "launchdarkly/ld-relay:{{ .Version }}-static-debian12-debug-nonroot-arm64v8"
 
-  - name_template: "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12"
+  - name_template: "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot"
     skip_push: false
     image_templates:
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-amd64"
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-armv7"
-      - "launchdarkly/ld-relay:v{{ .Major }}-debug-nonroot-static-debian12-arm64v8"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-amd64"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-armv7"
+      - "launchdarkly/ld-relay:v{{ .Major }}-static-debian12-debug-nonroot-arm64v8"
diff --git a/...-debug-nonroot-static-debian12.goreleaser → ...-static-debian12-debug-nonroot.goreleaser b/...-debug-nonroot-static-debian12.goreleaser → ...-static-debian12-debug-nonroot.goreleaser
diff --git a/...erfile-nonroot-static-debian12.goreleaser → ...erfile-static-debian12-nonroot.goreleaser b/...erfile-nonroot-static-debian12.goreleaser → ...erfile-static-debian12-nonroot.goreleaser
diff --git a/docs/docker.md b/docs/docker.md
@@ -15,10 +15,11 @@ When developing locally, you can build the `ld-relay` Alpine container with the
 $ docker build -t ld-relay .
 ```
 
-Please note that this [Dockerfile](../Dockerfile) is **not** the same on that is published to [DockerHub](https://hub.docker.com/r/launchdarkly/ld-relay).
+Please note that this Alpine [Dockerfile](../Dockerfile) is **not** the same one that is published to [DockerHub]
+(https://hub.docker.com/r/launchdarkly/ld-relay).
 
-It is a convenience for local development, whereas the image published to DockerHub is built during our release process 
-and is based on [Dockerfile.goreleaser](../Dockerfile.goreleaser).
+It is a convenience for local development, whereas the Alpine image published to DockerHub is built during our release 
+process and is based on [Dockerfile.goreleaser](../Dockerfile.goreleaser).
 
 In Docker, the config file is expected to be found at `/ldr/ld-relay.conf`, unless you are using environment variables 
 to configure the Relay Proxy. To learn more, read [Configuration](./configuration.md).
@@ -50,9 +51,7 @@ $ docker run --name ld-relay --link redis:redis -e USE_REDIS=1 -e LD_ENV_test="s
 ## Production Deployment
 
 In production, you may choose between our Distroless or Alpine Linux images. We recommend using the Distroless
-images, as they present a smaller attack surface and will be less likely to require continual patching.
-
-Additionally, the Distroless images are even smaller than Alpine.
+images, as they present less of an attack surface, are smaller, and should require less continual patching.
 
 Please note that the default Distroless image does not contain a debug shell. 
 
@@ -61,10 +60,10 @@ Please note that the default Distroless image does not contain a debug shell.
 Relay's Distroless images are distributed in two variants. The first is intended for regular usage, while the 
 second is for debugging and contains a shell.
 
-| Docker image tag suffix          | Based on [Distroless](https://github.com/GoogleContainerTools/distroless) tag.. | Purpose                  |
-|----------------------------------|---------------------------------------------------------------------------------|--------------------------|
-| `-nonroot-static-debian12`       | `static-debian12:nonroot`                                                       | Normal usage             |
-| `-debug-nonroot-static-debian12` | `static-debian12:debug-nonroot`                                                 | Contains a busybox shell |
+| Docker image tag suffix           | Based on [Distroless](https://github.com/GoogleContainerTools/distroless) tag.. | Purpose                  |
+|-----------------------------------|---------------------------------------------------------------------------------|--------------------------|
+| `-static-debian12-nonroot`        | `static-debian12:nonroot`                                                       | Normal usage             |
+| `-static-debian12-debug-nonroot-` | `static-debian12:debug-nonroot`                                                 | Contains a busybox shell |