Add install documentation for Workbench2.

[arvados.git] / doc / install / install-controller.html.textile.liquid

diff --git a/doc/install/install-controller.html.textile.liquid b/doc/install/install-controller.html.textile.liquid
index ccb8d980aebc1f3f658a5ed603459ca15878736d..f78467f5bebf60604e3aeba78c7a36d700ef94ce 100644 (file)
--- a/doc/install/install-controller.html.textile.liquid
+++ b/doc/install/install-controller.html.textile.liquid
@@ -85,19 +85,20 @@ Restart Nginx to apply the new configuration.
 </code></pre>
 </notextile>
 
-h3. Configure arvados-controller
+h3(#configuration). Configure arvados-controller
 
 Create the cluster configuration file @/etc/arvados/config.yml@ using the following template.
 
 <notextile>
 <pre><code>Clusters:
   <span class="userinput">uuid_prefix</span>:
-    NodeProfiles:
-      apiserver:
-        arvados-controller:
-          Listen: ":<span class="userinput">9004</span>" # must match the "upstream controller" section of your Nginx config
+    Services:
+      Controller:
+        InternalURLs:
+          "http://localhost:<span class="userinput">9004</span>": {} # must match the "upstream controller" section of your Nginx config
+      RailsAPI:
         arvados-api-server:
-          Listen: ":<span class="userinput">8000</span>" # must match the "upstream api" section of your Nginx config
+          "http://localhost:<span class="userinput">8000</span>": {} # must match the "upstream api" section of your Nginx config
     PostgreSQL:
       ConnectionPool: 128
       Connection:
@@ -178,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>