233b492cb0b52ee20d112d1ab184ef55913ab556
[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       # You can pass extra database connections parameters here,
69       # which will be rendered as yaml.
70       # extra_conn_params:
71       #  sslmode: prefer
72       #  verify-ca: false
73       #  client_encoding: UTF8
74
75
76     tls:
77       # certificate: ''
78       # key: ''
79       # required to test with snakeoil certs
80       insecure: true
81
82     ### TOKENS
83     tokens:
84       # Secrets and tokens have to be +32 alphanumeric,
85       # it does not accept underscores or special characters.
86       # See https://dev.arvados.org/issues/17150
87       system_root: changemesystemroottoken
88       management: changememanagementtoken
89       anonymous_user: changemeanonymoususertoken
90
91     ### KEYS
92     secrets:
93       blob_signing_key: changemeblobsigningkey
94       workbench_secret_key: changemeworkbenchsecretkey
95       dispatcher_access_key: changemedispatcheraccesskey
96       dispatcher_secret_key: changemedispatchersecretkey
97       keep_access_key: changemekeepaccesskey
98       keep_secret_key: changemekeepsecretkey
99
100     AuditLogs:
101       Section_to_ignore:
102         - some_random_value
103
104     ### VOLUMES
105     ## This should usually match all your `keepstore` instances
106     Volumes:
107       # the volume name will be composed with
108       # <cluster>-nyw5e-<volume>
109       fixme-nyw5e-000000000000000:
110         AccessViaHosts:
111           http://keep0.fixme.example.net:25107:
112             ReadOnly: false
113         Replication: 2
114         Driver: Directory
115         DriverParameters:
116           Root: /tmp
117
118     Users:
119       NewUsersAreActive: true
120       AutoAdminFirstUser: true
121       AutoSetupNewUsers: true
122       AutoSetupNewUsersWithRepository: true
123
124     Services:
125       Controller:
126         ExternalURL: https://fixme.example.net
127         InternalURLs:
128           http://localhost:8003: {}
129       DispatchCloud:
130         InternalURLs:
131           http://fixme.example.net:9006: {}
132       Keepbalance:
133         InternalURLs:
134           http://fixme.example.net:9005: {}
135       Keepproxy:
136         ExternalURL: https://keep.fixme.example.net
137         InternalURLs:
138           http://localhost:25100: {}
139       Keepstore:
140         InternalURLs:
141           http://keep0.fixme.example.net:25107: {}
142       RailsAPI:
143         InternalURLs:
144           http://localhost:8004: {}
145       WebDAV:
146         ExternalURL: https://collections.fixme.example.net
147         InternalURLs:
148           http://localhost:9002: {}
149       WebDAVDownload:
150         ExternalURL: https://download.fixme.example.net
151       WebShell:
152         ExternalURL: https://webshell.fixme.example.net
153       Websocket:
154         ExternalURL: wss://ws.fixme.example.net/websocket
155         InternalURLs:
156           http://localhost:8005: {}
157       Workbench1:
158         ExternalURL: https://workbench.fixme.example.net
159       Workbench2:
160         ExternalURL: https://workbench2.fixme.example.net
161
162 #  ### THESE ARE THE PACKAGES AND DAEMONS BASIC CONFIGS
163 #  #### API
164 #   api:
165 #     pkg:
166 #       name:
167 #         - arvados-api-server
168 #         - arvados-dispatch-cloud
169 #     gem:
170 #       name:
171 #         - arvados-cli
172 #     service:
173 #       name:
174 #         - nginx
175 #       port: 8004
176 #  #### CONTROLLER
177 #   controller:
178 #     pkg:
179 #       name: arvados-controller
180 #     service:
181 #       name: arvados-controller
182 #       port: 8003
183 #  #### DISPATCHER
184 #   dispatcher:
185 #     pkg:
186 #       name:
187 #         - crunch-dispatch-local
188 #       #   - arvados-dispatch-cloud
189 #       #   - crunch-dispatch-slurm
190 #     service:
191 #       name: crunch-dispatch-local
192 #       port: 9006
193 #  #### KEEPPROXY
194 #   keepproxy:
195 #     pkg:
196 #       name: keepproxy
197 #     service:
198 #       name: keepproxy
199 #       port: 25107
200 #  #### KEEPWEB
201 #   keepweb:
202 #     pkg:
203 #       name: keep-web
204 #     service:
205 #       name: keep-web
206 #     #   webdav
207 #       port: 9002
208 #  #### KEEPSTORE
209 #   keepstore:
210 #     pkg:
211 #       name: keepstore
212 #     service:
213 #       name: keepstore
214 #       port: 25107
215 #  #### GIT-HTTPD
216 #   githttpd:
217 #     pkg:
218 #       name: arvados-git-httpd
219 #     service:
220 #       name: arvados-git-httpd
221 #       port: 9001
222 #  #### SHELL
223 #   shell:
224 #     pkg:
225 #       name:
226 #         - arvados-client
227 #         - arvados-src
228 #         - libpam-arvados-go
229 #         - python3-arvados-fuse
230 #         - python3-arvados-python-client
231 #         - python3-arvados-cwl-runner
232 #     gem:
233 #       name:
234 #         - arvados-cli
235 #         - arvados-login-sync
236 #     shellinabox:
237 #       config: /etc/default/shellinabox
238 #       service:
239 #         name: shellinabox
240 #         port: 4200
241 #     libpam_arvados:
242 #       config: /etc/pam.d/arvados
243 #  #### WORKBENCH
244 #   workbench:
245 #     pkg:
246 #       name: arvados-workbench
247 #     service:
248 #       name: nginx
249 #  #### WORKBENCH2
250 #   workbench2:
251 #     pkg:
252 #       name: arvados-workbench2
253 #     service:
254 #       name: nginx
255 #  ####  WEBSOCKET
256 #   websocket:
257 #     pkg:
258 #       name: arvados-ws
259 #     service:
260 #       name: arvados-ws
261 #       port: 8005
262 #  #### SSO
263 #   sso:
264 #     pkg:
265 #       name: arvados-sso
266 #     service:
267 #       name: arvados-sso
268 #       port: 8900
269
270 #  ## SALTSTACK FORMULAS TOFS configuration
271 #   https://template-formula.readthedocs.io/en/latest/TOFS_pattern.html
272 #   tofs:
273 #   #    The files_switch key serves as a selector for alternative
274 #   #    directories under the formula files directory. See TOFS pattern
275 #   #    doc for more info.
276 #   #    Note: Any value not evaluated by `config.get` will be used literally.
277 #   #    This can be used to set custom paths, as many levels deep as required.
278 #     files_switch:
279 #       - any/path/can/be/used/here
280 #       - id
281 #       - roles
282 #       - osfinger
283 #       - os
284 #       - os_family
285 #   #    All aspects of path/file resolution are customisable using the options below.
286 #   #    This is unnecessary in most cases; there are sensible defaults.
287 #   #    Default path: salt://< path_prefix >/< dirs.files >/< dirs.default >
288 #   #            I.e.: salt://arvados/files/default
289 #   #    path_prefix: template_alt
290 #   #    dirs:
291 #   #      files: files_alt
292 #   #      default: default_alt
293 #   #    The entries under `source_files` are prepended to the default source files
294 #   #    given for the state
295 #   #    source_files:
296 #   #      arvados-config-file-file-managed:
297 #   #        - 'example_alt.tmpl'
298 #   #        - 'example_alt.tmpl.jinja'