feat: rename binary to pgedge-control-plane

Renames the binary and archives from `control-plane` to
`pgedge-control-plane` to reduce the chance of conflicts with other
packages.

PLAT-417

Author: jason-lynch

.gitignore

@@ -21,5 +21,6 @@ docs/plans
 *-results.xml
 dist
 control-plane
+pgedge-control-plane
 !docker/control-plane
 e2e/debug

.goreleaser.yaml

@@ -1,8 +1,8 @@
 version: 2
-project_name: control-plane
+project_name: pgedge-control-plane
 builds:
   - main: ./server
-    binary: control-plane
+    binary: pgedge-control-plane
     env:
       - CGO_ENABLED=0
     goos:

Makefile

@@ -258,12 +258,12 @@ control-plane-images:
 goreleaser-build:
 	GORELEASER_CURRENT_TAG=$(CONTROL_PLANE_VERSION) \
 	$(goreleaser) build --snapshot --clean
-	tar -C dist/control-plane_linux_amd64_v1 -c -z \
-		-f dist/control-plane_$(CONTROL_PLANE_VERSION:v%=%)_linux_amd64.tar.gz \
-		control-plane
-	tar -C dist/control-plane_linux_arm64_v8.0 -c -z \
-		-f dist/control-plane_$(CONTROL_PLANE_VERSION:v%=%)_linux_arm64.tar.gz \
-		control-plane
+	tar -C dist/pgedge-control-plane_linux_amd64_v1 -c -z \
+		-f dist/pgedge-control-plane_$(CONTROL_PLANE_VERSION:v%=%)_linux_amd64.tar.gz \
+		pgedge-control-plane
+	tar -C dist/pgedge-control-plane_linux_arm64_v8.0 -c -z \
+		-f dist/pgedge-control-plane_$(CONTROL_PLANE_VERSION:v%=%)_linux_arm64.tar.gz \
+		pgedge-control-plane
 
 goreleaser-test-release:
 	GORELEASER_CURRENT_TAG=$(CONTROL_PLANE_VERSION) \
@@ -332,7 +332,7 @@ build: dev-build
 dev-build: 
 	GOOS=linux go build \
 		-gcflags "all=-N -l" \
-		-o docker/control-plane-dev/control-plane \
+		-o docker/control-plane-dev/pgedge-control-plane \
 		$(shell pwd)/server
 
 .PHONY: docker-swarm-init
@@ -397,7 +397,7 @@ api-docs:
 ci-compose-build: 
 	GOOS=linux go build \
 		-gcflags "all=-N -l" \
-		-o docker/control-plane-ci/control-plane \
+		-o docker/control-plane-ci/pgedge-control-plane \
 		$(shell pwd)/server
 
 .PHONY: ci-compose-detached

docker/control-plane-ci/Dockerfile

@@ -4,6 +4,6 @@ RUN apt-get update && \
     apt-get install -y curl && \
     rm -rf /var/lib/apt/lists/*
 
-COPY ./control-plane /control-plane
+COPY ./pgedge-control-plane /pgedge-control-plane
 
-ENTRYPOINT ["/control-plane"]
+ENTRYPOINT ["/pgedge-control-plane"]

docker/control-plane-dev/Dockerfile

@@ -5,6 +5,6 @@ ENV CGO_ENABLED=0
 RUN go install github.com/go-delve/delve/cmd/dlv@latest
 
 COPY ./entrypoint.sh /entrypoint.sh
-COPY ./control-plane /control-plane
+COPY ./pgedge-control-plane /pgedge-control-plane
 
 ENTRYPOINT [ "/entrypoint.sh" ]

docker/control-plane-dev/docker-compose.yaml

@@ -6,9 +6,9 @@ services:
       watch:
         - path: ./Dockerfile
           action: rebuild
-        - path: ./control-plane
+        - path: ./pgedge-control-plane
           action: sync+restart
-          target: /control-plane
+          target: /pgedge-control-plane
     working_dir: ${WORKSPACE_DIR}
     environment:
       - DEBUG=${DEBUG:-0}

docker/control-plane-dev/entrypoint.sh

@@ -13,13 +13,13 @@ if [[ "${DEBUG}" == 1 ]]; then
         --log-output=debugger,debuglineerr,gdbwire,lldbout,rpc \
         --accept-multiclient \
         --api-version=2 \
-        exec /control-plane \
+        exec /pgedge-control-plane \
         -- \
         run \
         --config-path /config.json \
         --logging.pretty
 else
-    exec /control-plane run \
+    exec /pgedge-control-plane run \
         --config-path /config.json \
         --logging.pretty
 fi

docker/control-plane/Dockerfile

@@ -4,6 +4,6 @@ ARG TARGETOS
 ARG TARGETARCH
 ARG ARCHIVE_VERSION
 
-ENTRYPOINT ["/control-plane"]
+ENTRYPOINT ["/pgedge-control-plane"]
 
-ADD control-plane_${ARCHIVE_VERSION}_${TARGETOS}_${TARGETARCH}.tar.gz /
+ADD pgedge-control-plane_${ARCHIVE_VERSION}_${TARGETOS}_${TARGETARCH}.tar.gz /

docs/development/running-locally.md

@@ -120,13 +120,17 @@ On MacOS, the full path to the Restish configuration file is `~/Library/Applicat
 
 ## Running the Control Plane
 
-To start the Control Plane instances, navigate into the `control-plane` repository root and run:
+To start the Control Plane instances, navigate into the `control-plane`
+repository root and run:
 
 ```sh
 make dev-watch
 ```
 
-This will build a `control-plane` binary, build the Docker image in `docker/control-plane-dev`, and run the Docker Compose configuration in `watch` mode. See the [Development workflow](#development-workflow) section to learn how to use this setup for development.
+This will build a `pgedge-control-plane` binary, build the Docker image in
+`docker/control-plane-dev`, and run the Docker Compose configuration in `watch`
+mode. See the [Development workflow](#development-workflow) section to learn how
+to use this setup for development.
 
 ## Interact with the Control Plane API
 
@@ -199,11 +203,11 @@ section to reinitialize your cluster.
 
 The following sections detail the steps in the development process.
 
-### Rebuilding the `control-plane` binary
+### Rebuilding the `pgedge-control-plane` binary
 
 The Docker Compose file is configured to watch for changes to the
-`control-plane` binary. You can update the binary in the running containers by
-running:
+`pgedge-control-plane` binary. You can update the binary in the running
+containers by running:
 
 ```sh
 make dev-build

e2e/fixtures/roles/build_image/vars/main.yaml

@@ -4,4 +4,4 @@ _arch_transform:
   x86_64: amd64
   aarch64: arm64
   arm64: arm64
-_archive_name: control-plane_{{ version }}_linux_{{ _arch_transform[architecture] }}.tar.gz
+_archive_name: pgedge-control-plane_{{ version }}_linux_{{ _arch_transform[architecture] }}.tar.gz