chore(shellcheck): switch hook for `shellcheck` [skip ci]
[arvados-formula.git] / pillar.example
1 # -*- coding: utf-8 -*-
2 # vim: ft=yaml
3 ---
4 # The variables commented out are the default values that the formula uses.
5 # The uncommented values are REQUIRED values. If you don't set them, running
6 # this formula will fail.
7 arvados:
8   ### GENERAL CONFIG
9   # version: '2.1.0'
10   # release: production
11   ## It makes little sense to disable this flag, but you can, if you want :)
12   # use_upstream_repo: true
13
14   ## Repo URL is built with grains values. If desired, it can be completely
15   ## overwritten with the pillar parameter 'repo_url'
16   # repo:
17   #   humanname: Arvados Official Repository
18
19   ## IMPORTANT!!!!!
20   ## api, workbench and shell require some gems, so you need to make sure ruby
21   ## and deps are installed in order to install and compile the gems.
22   ## We default to `false` in these two variables as it's expected you already
23   ## manage OS packages with some other tool and you don't want us messing up
24   ## with your setup.
25   ruby:
26     ## We set these to `true` here for testing purposes.
27     ## They both default to `false`.
28     manage_ruby: true
29     use_rvm: false     # If you want to use rvm. Defaults to true for centos-7
30     # pkg: ruby        # Can specify a version like ruby-2.5.7 for rvm
31     manage_gems_deps: true
32     # gems_deps:
33     #     - curl
34     #     - g++
35     #     - gcc
36     #     - git
37     #     - libcurl4
38     #     - libcurl4-gnutls-dev
39     #     - libpq-dev
40     #     - libxml2
41     #     - libxml2-dev
42     #     - make
43     #     - python3-dev
44     #     - ruby-dev
45     #     - zlib1g-dev
46
47   # config:
48   #   file: /etc/arvados/config.yml
49   #   user: root
50   ## IMPORTANT!!!!!
51   ## If you're intalling any of the rails apps (api, workbench), the group
52   ## should be set to that of the web server, usually `www-data`
53   #   group: root
54   #   mode: 640
55
56   ### ARVADOS CLUSTER CONFIG
57   cluster:
58     name: fixme
59     domain: example.net
60
61     database:
62       # max concurrent connections per arvados server daemon
63       # connection_pool_max: 32
64       name: arvados
65       host: 127.0.0.1
66       password: changeme_arvados
67       user: arvados
68       encoding: en_US.utf8
69       client_encoding: UTF8
70       # You can pass extra database connections parameters here,
71       # which will be rendered as yaml.
72       # extra_conn_params:
73       #  sslmode: prefer
74       #  verify-ca: false
75
76
77     tls:
78       # certificate: ''
79       # key: ''
80       # required to test with snakeoil certs
81       insecure: true
82
83     ### TOKENS
84     tokens:
85       # SystemRootToken has to be alphanumeric, it does not accept underscores
86       # or special characters. See
87       # https://dev.arvados.org/issues/17150
88       system_root: changemesystemroottoken
89       management: changememanagementtoken
90       rails_secret: changemerailssecrettoken
91       anonymous_user: changemeanonymoususertoken
92
93     ### KEYS
94     secrets:
95       blob_signing_key: changemeblobsigningkey
96       workbench_secret_key: changemeworkbenchsecretkey
97       dispatcher_access_key: changemedispatcheraccesskey
98       dispatcher_secret_key: changemedispatchersecretkey
99       keep_access_key: changemekeepaccesskey
100       keep_secret_key: changemekeepsecretkey
101
102     AuditLogs:
103       Section_to_ignore:
104         - some_random_value
105
106     ### VOLUMES
107     ## This should usually match all your `keepstore` instances
108     Volumes:
109       # the volume name will be composed with
110       # <cluster>-nyw5e-<volume>
111       fixme-nyw5e-000000000000000:
112         AccessViaHosts:
113           http://keep0.fixme.example.net:25107:
114             ReadOnly: false
115         Replication: 2
116         Driver: Directory
117         DriverParameters:
118           Root: /tmp
119
120     Users:
121       NewUsersAreActive: true
122       AutoAdminFirstUser: true
123       AutoSetupNewUsers: true
124       AutoSetupNewUsersWithRepository: true
125
126     Services:
127       Controller:
128         ExternalURL: https://fixme.example.net
129         InternalURLs:
130           http://localhost:8003: {}
131       DispatchCloud:
132         InternalURLs:
133           http://fixme.example.net:9006: {}
134       Keepbalance:
135         InternalURLs:
136           http://fixme.example.net:9005: {}
137       Keepproxy:
138         ExternalURL: https://keep.fixme.example.net
139         InternalURLs:
140           http://localhost:25100: {}
141       Keepstore:
142         InternalURLs:
143           http://keep0.fixme.example.net:25107: {}
144       RailsAPI:
145         InternalURLs:
146           http://localhost:8004: {}
147       WebDAV:
148         ExternalURL: https://collections.fixme.example.net
149         InternalURLs:
150           http://localhost:9002: {}
151       WebDAVDownload:
152         ExternalURL: https://download.fixme.example.net
153       WebShell:
154         ExternalURL: https://webshell.fixme.example.net
155       Websocket:
156         ExternalURL: wss://ws.fixme.example.net/websocket
157         InternalURLs:
158           http://localhost:8005: {}
159       Workbench1:
160         ExternalURL: https://workbench.fixme.example.net
161       Workbench2:
162         ExternalURL: https://workbench2.fixme.example.net
163
164 #  ### THESE ARE THE PACKAGES AND DAEMONS BASIC CONFIGS
165 #  #### API
166 #   api:
167 #     pkg:
168 #       name:
169 #         - arvados-api-server
170 #         - arvados-dispatch-cloud
171 #     gem:
172 #       name:
173 #         - arvados-cli
174 #     service:
175 #       name:
176 #         - nginx
177 #       port: 8004
178 #  #### CONTROLLER
179 #   controller:
180 #     pkg:
181 #       name: arvados-controller
182 #     service:
183 #       name: arvados-controller
184 #       port: 8003
185 #  #### DISPATCHER
186 #   dispatcher:
187 #     pkg:
188 #       name:
189 #         - crunch-dispatch-local
190 #       #   - arvados-dispatch-cloud
191 #       #   - crunch-dispatch-slurm
192 #     service:
193 #       name: crunch-dispatch-local
194 #       port: 9006
195 #  #### KEEPPROXY
196 #   keepproxy:
197 #     pkg:
198 #       name: keepproxy
199 #     service:
200 #       name: keepproxy
201 #       port: 25107
202 #  #### KEEPWEB
203 #   keepweb:
204 #     pkg:
205 #       name: keep-web
206 #     service:
207 #       name: keep-web
208 #     #   webdav
209 #       port: 9002
210 #  #### KEEPSTORE
211 #   keepstore:
212 #     pkg:
213 #       name: keepstore
214 #     service:
215 #       name: keepstore
216 #       port: 25107
217 #  #### GIT-HTTPD
218 #   githttpd:
219 #     pkg:
220 #       name: arvados-git-httpd
221 #     service:
222 #       name: arvados-git-httpd
223 #       port: 9001
224 #  #### SHELL
225 #   shell:
226 #     pkg:
227 #       name:
228 #         - arvados-client
229 #         - arvados-src
230 #         - libpam-arvados-go
231 #         - python3-arvados-fuse
232 #         - python3-arvados-python-client
233 #         - python3-arvados-cwl-runner
234 #     gem:
235 #       name:
236 #         - arvados-cli
237 #         - arvados-login-sync
238 #     shellinabox:
239 #       config: /etc/default/shellinabox
240 #       service:
241 #         name: shellinabox
242 #         port: 4200
243 #     libpam_arvados:
244 #       config: /etc/pam.d/arvados
245 #  #### WORKBENCH
246 #   workbench:
247 #     pkg:
248 #       name: arvados-workbench
249 #     service:
250 #       name: nginx
251 #  #### WORKBENCH2
252 #   workbench2:
253 #     pkg:
254 #       name: arvados-workbench2
255 #     service:
256 #       name: nginx
257 #  ####  WEBSOCKET
258 #   websocket:
259 #     pkg:
260 #       name: arvados-ws
261 #     service:
262 #       name: arvados-ws
263 #       port: 8005
264 #  #### SSO
265 #   sso:
266 #     pkg:
267 #       name: arvados-sso
268 #     service:
269 #       name: arvados-sso
270 #       port: 8900
271
272 #  ## SALTSTACK FORMULAS TOFS configuration
273 #   https://template-formula.readthedocs.io/en/latest/TOFS_pattern.html
274 #   tofs:
275 #   #    The files_switch key serves as a selector for alternative
276 #   #    directories under the formula files directory. See TOFS pattern
277 #   #    doc for more info.
278 #   #    Note: Any value not evaluated by `config.get` will be used literally.
279 #   #    This can be used to set custom paths, as many levels deep as required.
280 #     files_switch:
281 #       - any/path/can/be/used/here
282 #       - id
283 #       - roles
284 #       - osfinger
285 #       - os
286 #       - os_family
287 #   #    All aspects of path/file resolution are customisable using the options below.
288 #   #    This is unnecessary in most cases; there are sensible defaults.
289 #   #    Default path: salt://< path_prefix >/< dirs.files >/< dirs.default >
290 #   #            I.e.: salt://arvados/files/default
291 #   #    path_prefix: template_alt
292 #   #    dirs:
293 #   #      files: files_alt
294 #   #      default: default_alt
295 #   #    The entries under `source_files` are prepended to the default source files
296 #   #    given for the state
297 #   #    source_files:
298 #   #      arvados-config-file-file-managed:
299 #   #        - 'example_alt.tmpl'
300 #   #        - 'example_alt.tmpl.jinja'