From ab652f8a0c4d73f8d20497b448f547881ff57312 Mon Sep 17 00:00:00 2001 From: Jason Lynch Date: Wed, 4 Mar 2026 18:19:58 -0500 Subject: [PATCH] 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 --- .gitignore | 1 + .goreleaser.yaml | 4 ++-- Makefile | 16 ++++++++-------- docker/control-plane-ci/Dockerfile | 4 ++-- docker/control-plane-dev/Dockerfile | 2 +- docker/control-plane-dev/docker-compose.yaml | 4 ++-- docker/control-plane-dev/entrypoint.sh | 4 ++-- docker/control-plane/Dockerfile | 4 ++-- docs/development/running-locally.md | 14 +++++++++----- e2e/fixtures/roles/build_image/vars/main.yaml | 2 +- 10 files changed, 30 insertions(+), 25 deletions(-) diff --git a/.gitignore b/.gitignore index 3051ef7a..eb997f88 100644 --- a/.gitignore +++ b/.gitignore @@ -21,5 +21,6 @@ docs/plans *-results.xml dist control-plane +pgedge-control-plane !docker/control-plane e2e/debug diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 8ed317b2..76c421ea 100644 --- a/.goreleaser.yaml +++ b/.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: diff --git a/Makefile b/Makefile index 22d9fe90..a5812da4 100644 --- a/Makefile +++ b/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 diff --git a/docker/control-plane-ci/Dockerfile b/docker/control-plane-ci/Dockerfile index 73e51909..e8e551b6 100644 --- a/docker/control-plane-ci/Dockerfile +++ b/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"] diff --git a/docker/control-plane-dev/Dockerfile b/docker/control-plane-dev/Dockerfile index ed894e14..a49df879 100644 --- a/docker/control-plane-dev/Dockerfile +++ b/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" ] diff --git a/docker/control-plane-dev/docker-compose.yaml b/docker/control-plane-dev/docker-compose.yaml index 62790c0c..2d3071f9 100644 --- a/docker/control-plane-dev/docker-compose.yaml +++ b/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} diff --git a/docker/control-plane-dev/entrypoint.sh b/docker/control-plane-dev/entrypoint.sh index f5bfa049..fa9fefec 100755 --- a/docker/control-plane-dev/entrypoint.sh +++ b/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 diff --git a/docker/control-plane/Dockerfile b/docker/control-plane/Dockerfile index 5cda49dc..f34534fb 100644 --- a/docker/control-plane/Dockerfile +++ b/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 / diff --git a/docs/development/running-locally.md b/docs/development/running-locally.md index 1144ba22..c6bae399 100644 --- a/docs/development/running-locally.md +++ b/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 diff --git a/e2e/fixtures/roles/build_image/vars/main.yaml b/e2e/fixtures/roles/build_image/vars/main.yaml index 8a223795..b642c8e5 100644 --- a/e2e/fixtures/roles/build_image/vars/main.yaml +++ b/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