tools/ansible/examples/simple-cluster-config.yml

   1 ### Example single-node cluster configuration ###
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: Apache-2.0
   5 #
   6 # You can use this file as a baseline for a simple single-node Arvados
   7 # cluster like you would install with `simple-cluster-inventory.yml`.
   8 # To use this configuration, you MUST:
   9 #  * Change the cluster ID `xurid` to your own ID.
  10 #    Choose a cluster ID with exactly five lowercase alphanumerics.
  11 #    Make sure you update the references under `PostgreSQL` and `Volumes` too.
  12 #  * Change each of `ManagementToken`, `SystemRootToken`, `BlobSigningKey`,
  13 #    and `PostgreSQL.Connection.password` to a unique, strong password.
  14 #    Tokens can only contain alphanumerics. You can generate one by running:
  15 #          tr -dc A-Za-z0-9 </dev/urandom | head -c 64
  16 #  * In every `ExternalURL` setting, change `hostname.example` to the name
  17 #    or address of your cluster host.
  18 # You MAY change other settings as noted in comments below.
  19
  20 Clusters:
  21   xurid:
  22     # These settings are appropriate if you are installing a PostgreSQL
  23     # server on the Arvados cluster node (the default). To use an external
  24     # database, make sure all parameters match what the database administrator
  25     # provides.
  26     PostgreSQL:
  27       Connection:
  28         user: arvados
  29         password: FIXMEDefaultPostgreSQLPassword
  30         host: localhost
  31         port: "5432"
  32         dbname: "arvados_xurid"
  33
  34     ManagementToken: FIXMEDefaultManagementToken
  35     SystemRootToken: FIXMEDefaultSystemRootToken
  36
  37     Collections:
  38       BlobSigningKey: FIXMEDefaultBlobSigningKey
  39       DefaultReplication: 1
  40
  41     # This configuration lets users log in to Arvados using the same Unix
  42     # username and password they use on the cluster host.
  43     Login:
  44       PAM:
  45         Enable: true
  46
  47     Users:
  48       AutoAdminFirstUser: true
  49
  50     TLS:
  51       Certificate: /etc/ssl/certs/ssl-cert-snakeoil.pem
  52       Key: /etc/ssl/private/ssl-cert-snakeoil.key
  53
  54     Volumes:
  55       xurid-nyw5e-000000000000000:
  56         Driver: Directory
  57         Replication: 1
  58         DriverParameters:
  59           Root: /var/lib/arvados/keep-data
  60
  61     # Port ranges used by services:
  62     #  8040-8079: Internal service behind nginx
  63     #  8440-8479: nginx front-end for corresponding service
  64     #  8080-8099: Internal-only service
  65     #  8900-8999: Service container ports
  66     Services:
  67       RailsAPI:
  68         InternalURLs:
  69           "http://localhost:8080": {}
  70
  71       Keepstore:
  72         InternalURLs:
  73           "http://localhost:8088": {}
  74
  75       Keepbalance:
  76         InternalURLs:
  77           "http://localhost:8089": {}
  78
  79       Websocket:
  80         InternalURLs:
  81           "http://localhost:8040": {}
  82         ExternalURL: "wss://hostname.example:8440/websocket"
  83
  84       Controller:
  85         InternalURLs:
  86           "http://localhost:8043": {}
  87         ExternalURL: "https://hostname.example:8443"
  88
  89       ContainerWebServices:
  90         # This ExternalURL should match Controller's.
  91         ExternalURL: "https://hostname.example:8443"
  92         ExternalPortMin: 8900
  93         ExternalPortMax: 8999
  94
  95       Keepproxy:
  96         InternalURLs:
  97           "http://localhost:8044": {}
  98         ExternalURL: "https://hostname.example:8444"
  99
 100       WebDAV:
 101         InternalURLs:
 102           "http://localhost:8048": {}
 103         ExternalURL: "https://hostname.example:8448"
 104
 105       WebDAVDownload:
 106         # These URLs should match WebDAV's.
 107         InternalURLs:
 108           "http://localhost:8048": {}
 109         ExternalURL: "https://hostname.example:8448"
 110
 111       Workbench2:
 112         ExternalURL: "https://hostname.example"
 113
 114       Workbench1:
 115         # These URLs should match Workbench2's.
 116         ExternalURL: "https://hostname.example"