Update comments/help text about config for crunch-dispatch-slurm and websockets

Link to updated config.yml docs

fixes #15541
fixes #15542

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

diff --git a/services/crunch-dispatch-slurm/usage.go b/services/crunch-dispatch-slurm/usage.go
index bcfa5b8a39ed7c8680a5ec1ffed6b583193f1caf..b2d157cbdb897c055f30f8f22a632976d859060c 100644 (file)
--- a/services/crunch-dispatch-slurm/usage.go
+++ b/services/crunch-dispatch-slurm/usage.go
@@ -10,21 +10,6 @@ import (
        "os"
 )
 
-var exampleConfigFile = []byte(`
-    {
-       "Client": {
-           "APIHost": "zzzzz.arvadosapi.com",
-           "AuthToken": "xyzzy",
-           "Insecure": false
-           "KeepServiceURIs": [],
-       },
-       "CrunchRunCommand": ["crunch-run"],
-       "PollPeriod": "10s",
-       "SbatchArguments": ["--partition=foo", "--exclude=node13"],
-       "ReserveExtraRAM": 268435456,
-       "BatchSize": 10000
-    }`)
-
 func usage(fs *flag.FlagSet) {
        fmt.Fprintf(os.Stderr, `
 crunch-dispatch-slurm runs queued Arvados containers by submitting
@@ -34,7 +19,7 @@ Options:
 `)
        fs.PrintDefaults()
        fmt.Fprintf(os.Stderr, `
-Example config file:
-%s
-`, exampleConfigFile)
+
+For configuration instructions see https://doc.arvados.org/install/crunch2-slurm/install-dispatch.html
+`)
 }

diff --git a/services/ws/doc.go b/services/ws/doc.go
index 092539747e29aceb94f58fa46bbf9024aca6e09c..806c3355da6c693350493a7471bc59e270bfb1e3 100644 (file)
--- a/services/ws/doc.go
+++ b/services/ws/doc.go
@@ -6,7 +6,7 @@
 // cache-invalidation event feed at "ws://.../websocket") to
 // websocket clients.
 //
-// Installation
+// Installation and configuration
 //
 // See https://doc.arvados.org/install/install-ws.html.
 //
@@ -16,25 +16,14 @@
 //
 // Usage
 //
-//     arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
-//
-// Minimal configuration
-//
-//     Client:
-//       APIHost: localhost:443
-//     Listen: ":1234"
-//     Postgres:
-//       dbname: arvados_production
-//       host: localhost
-//       password: xyzzy
-//       user: arvados
+//     arvados-ws [-legacy-ws-config /etc/arvados/ws/ws.yml] [-dump-config]
 //
 // Options
 //
-// -config path
+// -legacy-ws-config path
 //
-// Load configuration from the given file instead of the default
-// /etc/arvados/ws/ws.yml
+// Load legacy configuration from the given file instead of the default
+// /etc/arvados/ws/ws.yml, legacy config overrides the clusterwide config.yml.
 //
 // -dump-config
 //