15000: Recommend checking config publication errors during install.
authorTom Clegg <tclegg@veritasgenetics.com>
Fri, 14 Jun 2019 18:21:18 +0000 (14:21 -0400)
committerTom Clegg <tclegg@veritasgenetics.com>
Fri, 14 Jun 2019 18:21:18 +0000 (14:21 -0400)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tclegg@veritasgenetics.com>

doc/install/install-controller.html.textile.liquid

index 394aa0fdf7801c074874cbbd500c07b6f5870f5b..f78467f5bebf60604e3aeba78c7a36d700ef94ce 100644 (file)
@@ -179,3 +179,19 @@ Confirm the service is listening on its assigned port and responding to requests
 {"errors":["Forbidden"],"error_token":"1533044555+684b532c"}
 </code></pre>
 </notextile>
+
+h3(#confirm-config). Confirm the public configuration is OK
+
+Confirm the publicly accessible configuration endpoint does not reveal any sensitive information (e.g., a secret that was mistakenly entered under the wrong configuration key). Use the jq program, if you have installed it, to make the JSON document easier to read.
+
+<notextile>
+<pre><code>~$ <span class="userinput">curl http://0.0.0.0:<b>9004</b>/arvados/v1/config | jq .</span>
+{
+  "API": {
+    "MaxItemsPerResponse": 1000,
+    "MaxRequestAmplification": 4,
+    "RequestTimeout": "5m"
+  },
+  ...
+</code></pre>
+</notextile>