From 28486d7d7f6bb43af22ac8b2de517c77f2dbb6f2 Mon Sep 17 00:00:00 2001 From: Garrett Jones Date: Mon, 7 Aug 2017 16:04:12 -0700 Subject: [PATCH 1/2] Updating and expanding explanation of supported platforms --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cee27d83bad7..f491671039ed 100644 --- a/README.md +++ b/README.md @@ -876,12 +876,28 @@ Java 7 or above is required for using the clients in this repository. Supported Platforms ------------------- -This client is supported on Mac OS X, Windows and Linux (excluding Android and Alpine). -Google Cloud Platform environments currently supported include GCE, GKE and GAE Flex. -GAE Standard is not currently supported. +Clients in this repository use either HTTP or gRPC for the transport layer. All +HTTP-based clients should work in all environments (theoretically). -Spring Boot users : Native Tomcat is not currently supported. Please use [embedded Jetty](https://docs.spring.io/spring-boot/docs/current/reference/html/howto-embedded-servlet-containers.html#howto-use-jetty-instead-of-tomcat) -to get your application working with this client. +For clients that use gRPC, the supported platforms are constrained by the platforms +that [Forked Tomcat Native](http://netty.io/wiki/forked-tomcat-native.html) supports, +which for architectures means only x86_64, and for operating systems means Mac OS X, +Windows, and Linux. Additionally, gRPC constrains the use of platforms with +threading restrictions. + +Thus, the following are not supported: + +- Android +- Alpine Linux (due to netty-tcnative requiring glibc, which is not present on Alpine) +- Raspberry Pi (since it runs on the ARM architecture) +- Google App Engine Standard Java 7 + +The following environments should work (among others): + +- Google Compute Engine (GCE) +- Google Container Engine (GKE) +- Google App Engine Standard Java 8 (GAE Std J8) +- Google App Engine Flex (GAE Flex) Testing ------- From 4c9586505203aad0fd89bfcdbf567f8bb418512a Mon Sep 17 00:00:00 2001 From: Garrett Jones Date: Mon, 7 Aug 2017 16:41:50 -0700 Subject: [PATCH 2/2] PR feedback --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f491671039ed..9257552ce41c 100644 --- a/README.md +++ b/README.md @@ -877,7 +877,7 @@ Supported Platforms ------------------- Clients in this repository use either HTTP or gRPC for the transport layer. All -HTTP-based clients should work in all environments (theoretically). +HTTP-based clients should work in all environments. For clients that use gRPC, the supported platforms are constrained by the platforms that [Forked Tomcat Native](http://netty.io/wiki/forked-tomcat-native.html) supports, @@ -894,6 +894,9 @@ Thus, the following are not supported: The following environments should work (among others): +- standalone Windows on x86_64 +- standalone Mac OS X on x86_64 +- standalone Linux on x86_64 - Google Compute Engine (GCE) - Google Container Engine (GKE) - Google App Engine Standard Java 8 (GAE Std J8)