Breaking: Remove Cmake gRPC install when not found (googleforgames#3621)

Breaking: Remove Cmake gRPC install when not found

gRPC upgrades with gRPC where very brittle, and attempts to upgrade
dependencies and/or switch to a `FetchContent_Declare` type workflow
were becoming increasingly time-consuming - and not resulting with a
working solution.

Speaking with the gRPC team, they recommended not installing
dependencies within CMake (and how they do it admittedly an
antipattern). So this change removes the ability for the CMakeLists.txt
to install gRPC and makes finding the gRPC dependency a hard
requirement, and updates the documentation accordingly.

This change isn't onerous to the end user, as our SDK has only the one
dependency - gRPC (which does install all its dependencies). At some
point gRPC will have official support for vcpkg, at which point we
should probably move with them - but in the meantime, the cpp-simple
example has been updated with this change, and it's an extra ~4 lines.

This update also include a lot of other fixes:
* Upgrade from Debian Bullseye to Bookworm for all cpp related
containers
* Builds now actually happen in parallel, reducing build time to minutes
 not hours.
* Bump to gRPC 1.57.1
* Fix bug with gRPC dependency utf8_range.
* Move to C++17, because it's required for gRPC.

Work on googleforgames#3570

Author: markmandel

.github/ISSUE_TEMPLATE/kubernetes_update.md

@@ -39,10 +39,14 @@ List of items to do for upgrading to {version_1} {version_2} {version_3}
         - [ ] `dev_minikube_example_cluster_version`, which is {version_2} with the supported patch version
 - [ ] If client-go pulled in a new version of gRPC, then also
     - [ ] Update the `grpc_release_tag` in the SDK [base image grpc version](https://github.com/googleforgames/agones/blob/main/build/includes/sdk.mk).
-    - [ ] Update the gRPC version number in C++ CMake scripts, `AGONES_GRPC_VERSION` [here](https://github.com/googleforgames/agones/blob/main/sdks/cpp/CMakeLists.txt)
-          and `gRPC_GIT_TAG` [here](https://github.com/googleforgames/agones/blob/main/sdks/cpp/cmake/prerequisites.cmake)
+    - [ ] Update the gRPC version number in C++ gRPC Dependency documentation [here](https://github.com/googleforgames/agones/blob/main/site/content/en/docs/Guides/Client%20SDKs/cpp.md).
+    - [ ] Update the gRPC version
+      ([Dockerfile](https://github.com/googleforgames/agones/blob/main/examples/cpp-simple/Dockerfile)) and 
+      increment the image tag
+      ([Makefile](https://github.com/googleforgames/agones/blob/main/examples/cpp-simple/Makefile)) in the C++
+      `cpp-simple` example.
     - [ ] Regenerate all client sdks: [make gen-all-sdk-grpc](https://github.com/googleforgames/agones/blob/main/build/README.md#make-gen-all-sdk-grpc) 
-          This can take an hour or so, as the above changes force a rebuild. Plan your day accordingly 😃.
+          This can take 20 minutes or so, as the above changes force a rebuild. Plan your day accordingly 😃.
     - [ ] Regenerate allocated API endpoints: [make gen-allocation-grpc](https://github.com/googleforgames/agones/blob/main/build/README.md#make-gen-allocation-grpc)
 - [ ] Confirm the update works as expected by running e2e tests
     - [ ] Add the new supported Kubernetes versions to the e2e clusters creation

build/build-sdk-images/cpp/build-sdk-test.sh

@@ -25,7 +25,8 @@ then
     mkdir -p "$DIR"/sdk/.build
     cp -r /go/src/agones.dev/agones/sdks/cpp/* $DIR/sdk
     cd $DIR/sdk/.build
-    cmake .. -DCMAKE_BUILD_TYPE=Release -DAGONES_SILENT_OUTPUT=OFF -DCMAKE_INSTALL_PREFIX=$DIR/sdk/.build -DAGONES_THIRDPARTY_INSTALL_PATH=$DIR/sdk/.build -G "Unix Makefiles" -Wno-dev
+    cmake .. -DCMAKE_BUILD_TYPE=Release -DAGONES_SILENT_OUTPUT=OFF \
+      -DCMAKE_INSTALL_PREFIX=$DIR/sdk/.build -G "Unix Makefiles" -Wno-dev
 else
     echo "Directory with cpp SDK third party dependencies \
 has already built - using cached version. \

build/build-sdk-images/restapi/Dockerfile

@@ -28,7 +28,7 @@ RUN wget -q https://dl.google.com/go/go${GO_VERSION}.linux-amd64.tar.gz && \
 
 RUN echo '§' && apt-get -qy update
 
-RUN apt-get install -qq -y openjdk-11-jre > /dev/null
+RUN apt-get install -qq -y openjdk-17-jre > /dev/null
 
 ENV PATH /usr/local/go/bin:/go/bin:$PATH
 

build/build-sdk-images/tool/base/Dockerfile

@@ -17,19 +17,20 @@
 # Base images for SDKs Bump: 3
 #
 
-FROM debian:bullseye
+FROM debian:bookworm
 
 RUN apt-get update && apt-get install -y \
   build-essential autoconf libtool git pkg-config curl \
   automake libtool curl make g++ unzip moreutils cmake \
   && apt-get clean
 
 ARG GRPC_RELEASE_TAG
-# install protobuf first, then grpc
+# Install grpc locally for reuse across builds.
 RUN git clone --recurse-submodules -b $GRPC_RELEASE_TAG --depth 1 --shallow-submodules https://github.com/grpc/grpc /var/local/git/grpc && \
     cd /var/local/git/grpc && \
     mkdir -p cmake/build && \
     cd cmake/build && \
+    export CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) && \
     cmake -DCMAKE_BUILD_TYPE=Release -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF ../.. && \
     make -j$(nproc) && make install
 

build/includes/sdk.mk

@@ -20,7 +20,7 @@
 #   \__, |_| \_\_|    \____|   |_|\___/ \___/|_|_|_| |_|\__, |
 #   |___/                                               |___/
 
-grpc_release_tag = v1.57.0
+grpc_release_tag = v1.57.1
 
 build_sdk_base_version = $(call sha,$(build_path)/build-sdk-images/tool/base/Dockerfile)_$(grpc_release_tag)
 build_sdk_base_tag = agones-build-sdk-base:$(build_sdk_base_version)

build/release/post_cloudbuild.yaml

@@ -39,14 +39,12 @@ steps:
     id: cpp-sdk-build-restore-cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/CMakeLists.txt )
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
     id: cpp-sdk-conformance-restore-cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/CMakeLists.txt )
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
     id: rust-sdk-build-restore-cache
     args:

cloudbuild.yaml

@@ -42,15 +42,13 @@ steps:
     id: cpp-sdk-build-restore-cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/CMakeLists.txt )
     waitFor: ['-']
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
     id: cpp-sdk-conformance-restore-cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/CMakeLists.txt )
     waitFor: ['-']
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
     id: rust-sdk-build-restore-cache
@@ -187,8 +185,7 @@ steps:
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/save_cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/CMakeLists.txt )
       - --path=sdks/cpp/.build
     id: cpp-sdk-build-save-cache
     waitFor:
@@ -350,8 +347,7 @@ steps:
   - name: us-docker.pkg.dev/$PROJECT_ID/ci/save_cache
     args:
       - --bucket=gs://$_CACHE_BUCKET
-      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake
-        )
+      - --key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( sdks/cpp/CMakeLists.txt )
       - --path=test/sdk/cpp/sdk
     id: cpp-sdk-conformance-save-cache
     waitFor:

examples/cpp-simple/CMakeLists.txt

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-cmake_minimum_required (VERSION 3.13.0)
+cmake_minimum_required(VERSION 3.15)
 
 project(cpp-simple CXX)
 
 # Settings
-set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
@@ -38,7 +38,6 @@ elseif(UNIX AND NOT APPLE)
   # Linux
 endif()
 
-
 include_directories(${agones_INCLUDE_DIRS})
 set(SRC_FILES "server.cc")
 

examples/cpp-simple/Dockerfile

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM debian:bullseye as builder
+FROM debian:bookworm as builder
 
 RUN apt-get update && apt-get install -y \
   build-essential autoconf libtool git pkg-config \
@@ -21,24 +21,39 @@ RUN apt-get update && apt-get install -y \
 
 WORKDIR /project
 
+# Install gRPC and dependencies
+RUN git clone --recurse-submodules -b v1.57.1 --depth 1 --shallow-submodules https://github.com/grpc/grpc /var/local/git/grpc && \
+    cd /var/local/git/grpc && \
+    mkdir -p cmake/build && \
+    cd cmake/build && \
+    export CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) && \
+    cmake -DCMAKE_BUILD_TYPE=Release \
+      -DgRPC_INSTALL=ON \
+      -DgRPC_BUILD_TESTS=OFF ../.. && \
+    make -j$(nproc) && make install
+
+# Install Agones SDK
 COPY ./sdks/cpp sdk
 RUN cd sdk &&  \
     mkdir -p .build && \
     cd .build && \
+    export CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) && \
     cmake .. -DCMAKE_BUILD_TYPE=Release -DAGONES_SILENT_OUTPUT=OFF -DCMAKE_INSTALL_PREFIX=/project/sdk/.build \
-             -DAGONES_THIRDPARTY_INSTALL_PATH=/project/sdk/.build -G "Unix Makefiles" -Wno-dev && \
+      -G "Unix Makefiles" -Wno-dev && \
     cmake --build . --target install -j$(nproc)
 
+# Build sample application
 COPY ./examples/cpp-simple cpp-simple
 RUN cd cpp-simple && mkdir -p .build && cd .build && \
+    export CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) && \
     cmake .. -G "Unix Makefiles" \
        -DCMAKE_BUILD_TYPE=Release \
        -DCMAKE_PREFIX_PATH=/project/sdk/.build \
        -Dagones_DIR=/project/sdk/.build/agones/cmake \
        -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=.bin && \
     cmake --build . --target install -j$(nproc)
 
-FROM debian:bullseye
+FROM debian:bookworm
 RUN useradd -u 1000 -m server
 
 COPY --from=builder --chown=server:server /project/cpp-simple/.build/.bin/cpp-simple /home/server/cpp-simple

examples/cpp-simple/Makefile

@@ -30,10 +30,11 @@ PROD_REPO ?= us-docker.pkg.dev/agones-images/examples
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 project_path := $(dir $(mkfile_path))
 root_path = $(realpath $(project_path)/../..)
+version := 0.17
 ifeq ($(REPOSITORY),)
-	server_tag := cpp-simple-server:0.16
+	server_tag := cpp-simple-server:$(version)
 else
-	server_tag := $(REPOSITORY)/cpp-simple-server:0.16
+	server_tag := $(REPOSITORY)/cpp-simple-server:$(version)
 endif
 
 #   _____                    _

sdks/cpp/CMakeLists.txt

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-cmake_minimum_required (VERSION 3.5.0)
+cmake_minimum_required(VERSION 3.15)
 
 # Silent cmake/build output (internal option)
 # Extra command line options
@@ -62,45 +62,36 @@ project(agones VERSION ${AGONES_VERSION} HOMEPAGE_URL https://github.com/googlef
 
 # Options
 option(AGONES_FORCE_GRPC_VERSION "Build Agones C++ SDK only with supported gRPC version" ON)
-option(AGONES_BUILD_ONLY_PREREQUISITIES "Build only prerequisites of Agones" OFF)
-option(AGONES_ZLIB_STATIC "Use static version of ZLIB" ON)
-option(AGONES_BUILD_THIRDPARTY_DEBUG "Build debug version of thirdparty libraries (MSVC only)" OFF)
 option(AGONES_CLANG_FORMAT "Apply clang-format (if found) as a pre-build step" OFF)
-set(AGONES_THIRDPARTY_INSTALL_PATH "${CMAKE_INSTALL_PREFIX}" CACHE STRING "Path for installing third-party OpenSSL and gRPC, if they are not found with find_package")
-set(AGONES_OPENSSL_CONFIG_STRING "VC-WIN64A" CACHE STRING "See https://github.com/openssl/openssl/blob/OpenSSL_1_1_1-stable/INSTALL for details")
 
 # Prerequisities
 # [markmandel] - not 100% sure what include(CMakeFindDependencyMacro) does, but it solves the building issue.
 # https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#creating-a-package-configuration-file
 include(CMakeFindDependencyMacro)
-include(./cmake/prerequisites.cmake)
-find_package(Threads REQUIRED)
-find_package(ZLIB REQUIRED)
-find_package(Protobuf REQUIRED CONFIG)
-find_package(gRPC ${AGONES_GRPC_VERSION} ${AGONES_GRPC_VERSION_MATCH} REQUIRED CONFIG)
+include(ProcessorCount)
 
-if (AGONES_BUILD_ONLY_PREREQUISITIES)
-    return()
+ProcessorCount(CPU_COUNT)
+if (CPU_COUNT GREATER 0 AND NOT DEFINED CMAKE_BUILD_PARALLEL_LEVEL)
+    set(ENV{CMAKE_BUILD_PARALLEL_LEVEL} "${CPU_COUNT}")
+    message(STATUS "Setting CMAKE_BUILD_PARALLEL_LEVEL to $ENV{CMAKE_BUILD_PARALLEL_LEVEL}")
 endif()
 
-# Currently we doesn't support build time generation of proto/gRPC files,
-# so gRPC version should be strict
-set(AGONES_FORCE_GRPC_VERSION ON)
-set(AGONES_GRPC_VERSION_MATCH "")
-if (AGONES_FORCE_GRPC_VERSION)
-    set(AGONES_GRPC_VERSION_MATCH EXACT)
-endif()
+# gRPC
+find_package(Protobuf REQUIRED)
+find_package(gRPC CONFIG REQUIRED)
+find_package(Threads REQUIRED)
+
+message(STATUS "gRPC version found: ${gRPC_VERSION}")
 
 # Settings
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE ON)
 set(CMAKE_DEBUG_POSTFIX "d")
-set(AGONES_GRPC_VERSION "1.57.0")
 
 # Platform specific stuff
 if (WIN32)

sdks/cpp/cmake/clang-verify.in

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-cmake_minimum_required (VERSION 3.5.0)
+cmake_minimum_required(VERSION 3.15)
 
 option(AGONES_SILENT_OUTPUT "Show only warnings/error messages" OFF)
 if (AGONES_SILENT_OUTPUT)