This is an automated email from the ASF dual-hosted git repository.
xiangfu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new b43d4adc9c docs: add macOS gRPC Java plugin build workaround and
instructions (#16329)
b43d4adc9c is described below
commit b43d4adc9c417f962fcb967ee45a89395583206b
Author: Xiang Fu <[email protected]>
AuthorDate: Thu Jul 10 19:29:42 2025 -0700
docs: add macOS gRPC Java plugin build workaround and instructions (#16329)
---
README.md | 26 ++++++++++++++++++++++++++
pom.xml | 8 ++++++++
2 files changed, 34 insertions(+)
diff --git a/README.md b/README.md
index b87b6643c5..0a6352ccdf 100644
--- a/README.md
+++ b/README.md
@@ -141,6 +141,32 @@ For faster builds it is recommended to use `./mvnw verify
-Ppinot-fastdev`, whic
More detailed instructions can be found at [Quick
Demo](https://docs.pinot.apache.org/basics/getting-started/quick-start) section
in the documentation.
+### macOS Build Requirements
+
+If you're building Pinot on macOS and encounter issues with the gRPC Java
plugin during the build process, you may need to configure the protobuf Maven
plugin to use a specific executable path. This is a known issue on macOS ARM
(Apple Silicon) systems.
+
+To resolve this, you can install the protobuf compiler and gRPC Java plugin
globally:
+
+```bash
+# Install protobuf compiler
+brew install protobuf
+brew install protoc-gen-grpc-java
+sudo cp /opt/homebrew/bin/protoc-gen-grpc-java
/usr/local/bin/protoc-gen-grpc-java
+```
+
+Then add the following configuration to the `protobuf-maven-plugin` in the
`pom.xml` file:
+
+```xml
+<plugin>
+ <groupId>org.xolstice.maven.plugins</groupId>
+ <artifactId>protobuf-maven-plugin</artifactId>
+ <configuration>
+ ...
+ <pluginExecutable>/usr/local/bin/protoc-gen-grpc-java</pluginExecutable>
+ </configuration>
+</plugin>
+```
+
## Deploying Pinot to Kubernetes
Please refer to [Running Pinot on
Kubernetes](https://docs.pinot.apache.org/basics/getting-started/kubernetes-quickstart)
in our project documentation. Pinot also provides Kubernetes integrations with
the interactive query engine,
[Trino](https://docs.pinot.apache.org/integrations/trino)
[Presto](https://docs.pinot.apache.org/integrations/presto), and the data
visualization tool, [Apache Superset](helm/superset.yaml).
diff --git a/pom.xml b/pom.xml
index 7803b9a675..65286a867f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2323,6 +2323,14 @@
<protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
<pluginId>grpc-java</pluginId>
<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
+ <!-- For macOS users: If you encounter gRPC Java plugin issues
during build, install protobuf and gRPC Java plugin globally, then uncomment
the line below:
+ ```bash
+ brew install protobuf
+ brew install protoc-gen-grpc-java
+ sudo cp /opt/homebrew/bin/protoc-gen-grpc-java
/usr/local/bin/protoc-gen-grpc-java
+ ```
+ -->
+ <!--
<pluginExecutable>/usr/local/bin/protoc-gen-grpc-java</pluginExecutable> -->
</configuration>
<executions>
<execution>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
