updated documentation to clarify TLS support

updated documentation to clarify TLS support for --remote_cache, --remote_executor and --bes_backend Follow-up of #8061 Closes #9331. PiperOrigin-RevId: 268866260
bazelbuild · Sep 13, 2019 · 9ff02a9 · 9ff02a9
1 parent 6470bb7
commit 9ff02a9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 12 deletions.
diff --git a/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java b/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java
@@ -27,14 +27,15 @@
 public class BuildEventServiceOptions extends OptionsBase {
 
   @Option(
-    name = "bes_backend",
-    defaultValue = "",
-    documentationCategory = OptionDocumentationCategory.LOGGING,
-    effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
-    help =
-        "Specifies the build event service (BES) backend endpoint as HOST or HOST:PORT. "
-            + "Disabled by default."
-  )
+      name = "bes_backend",
+      defaultValue = "",
+      documentationCategory = OptionDocumentationCategory.LOGGING,
+      effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
+      help =
+          "Specifies the build event service (BES) backend endpoint as HOST or HOST:PORT. Disabled"
+              + " by default.The supported schemas are grpc and grpcs (grpc with TLS enabled). If"
+              + " no schema is provided bazel'll default to grpcs. Specify grpc:// schema to"
+              + " disable TLS.")
   public String besBackend;
 
   @Option(

diff --git a/src/main/java/com/google/devtools/build/lib/remote/options/RemoteOptions.java b/src/main/java/com/google/devtools/build/lib/remote/options/RemoteOptions.java
@@ -66,7 +66,10 @@ public final class RemoteOptions extends OptionsBase {
       defaultValue = "null",
       documentationCategory = OptionDocumentationCategory.REMOTE,
       effectTags = {OptionEffectTag.UNKNOWN},
-      help = "HOST or HOST:PORT of a remote execution endpoint.")
+      help =
+          "HOST or HOST:PORT of a remote execution endpoint.The supported schemas are grpc and"
+              + " grpcs (grpc with TLS enabled). If no schema is provided bazel'll default to"
+              + " grpcs. Specify grpc:// schema to disable TLS.")
   public String remoteExecutor;
 
   @Option(
@@ -76,9 +79,10 @@ public final class RemoteOptions extends OptionsBase {
       documentationCategory = OptionDocumentationCategory.REMOTE,
       effectTags = {OptionEffectTag.UNKNOWN},
       help =
-          "A URI of a caching endpoint. The supported schemas are http(s) and grpc. "
-              + "If no schema is provided we'll default to grpc. "
-              + "See https://docs.bazel.build/versions/master/remote-caching.html")
+          "A URI of a caching endpoint. The supported schemas are http, https, grpc and grpcs"
+              + " (grpc with TLS enabled). If no schema is provided bazel will default to grpcs."
+              + " Specify grpc:// or http:// schema to disable TLS.See"
+              + " https://docs.bazel.build/versions/master/remote-caching.html")
   public String remoteCache;
 
   @Option(