docs(examples): improve consistency in naming
[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     manage_gems_deps: true
30     # pkg: ruby
31     # gems_deps:
32     #     - curl
33     #     - g++
34     #     - gcc
35     #     - git
36     #     - libcurl4
37     #     - libcurl4-gnutls-dev
38     #     - libpq-dev
39     #     - libxml2
40     #     - libxml2-dev
41     #     - make
42     #     - python3-dev
43     #     - ruby-dev
44     #     - zlib1g-dev
45
46   # config:
47   #   file: /etc/arvados/config.yml
48   #   user: root
49   ## IMPORTANT!!!!!
50   ## If you're intalling any of the rails apps (api, workbench), the group
51   ## should be set to that of the web server, usually `www-data`
52   #   group: root
53   #   mode: 640
54
55   ### ARVADOS CLUSTER CONFIG
56   cluster:
57     name: fixme
58     domain: example.net
59
60     database:
61       # max concurrent connections per arvados server daemon
62       # connection_pool_max: 32
63       name: arvados
64       host: 127.0.0.1
65       password: changeme_arvados
66       user: arvados
67       encoding: en_US.utf8
68       client_encoding: UTF8
69
70     tls:
71       # certificate: ''
72       # key: ''
73       # required to test with snakeoil certs
74       insecure: true
75
76     ### TOKENS
77     tokens:
78       system_root: changeme_system_root_token
79       management: changeme_management_token
80       rails_secret: changeme_rails_secret_token
81       anonymous_user: changeme_anonymous_user_token
82
83     ### KEYS
84     secrets:
85       blob_signing_key: changeme_blob_signing_key
86       workbench_secret_key: changeme_workbench_secret_key
87       dispatcher_access_key: changeme_dispatcher_access_key
88       dispatcher_secret_key: changeme_dispatcher_secret_key
89       keep_access_key: changeme_keep_access_key
90       keep_secret_key: changeme_keep_secret_key
91
92     AuditLogs:
93       Section_to_ignore:
94         - some_random_value
95
96     ### VOLUMES
97     ## This should usually match all your `keepstore` instances
98     Volumes:
99       # the volume name will be composed with
100       # <cluster>-nyw5e-<volume>
101       fixme-nyw5e-000000000000000:
102         AccessViaHosts:
103           http://keep0.fixme.example.net:25107:
104             ReadOnly: false
105         Replication: 2
106         Driver: Directory
107         DriverParameters:
108           Root: /tmp
109
110     Users:
111       NewUsersAreActive: true
112       AutoAdminFirstUser: true
113       AutoSetupNewUsers: true
114       AutoSetupNewUsersWithRepository: true
115
116     Services:
117       Controller:
118         ExternalURL: https://fixme.example.net
119         InternalURLs:
120           http://localhost:8003: {}
121       DispatchCloud:
122         InternalURLs:
123           http://fixme.example.net:9006: {}
124       Keepbalance:
125         InternalURLs:
126           http://fixme.example.net:9005: {}
127       Keepproxy:
128         ExternalURL: https://keep.fixme.example.net
129         InternalURLs:
130           http://localhost:25100: {}
131       Keepstore:
132         InternalURLs:
133           http://keep0.fixme.example.net:25107: {}
134       RailsAPI:
135         InternalURLs:
136           http://localhost:8004: {}
137       WebDAV:
138         ExternalURL: https://collections.fixme.example.net
139         InternalURLs:
140           http://localhost:9002: {}
141       WebDAVDownload:
142         ExternalURL: https://download.fixme.example.net
143       WebShell:
144         ExternalURL: https://webshell.fixme.example.net
145       Websocket:
146         ExternalURL: wss://ws.fixme.example.net/websocket
147         InternalURLs:
148           http://localhost:8005: {}
149       Workbench1:
150         ExternalURL: https://workbench.fixme.example.net
151       Workbench2:
152         ExternalURL: https://workbench2.fixme.example.net
153
154 #  ### THESE ARE THE PACKAGES AND DAEMONS BASIC CONFIGS
155 #  #### API
156 #   api:
157 #     pkg:
158 #       name:
159 #         - arvados-api-server
160 #         - arvados-dispatch-cloud
161 #     gem:
162 #       name:
163 #         - arvados-cli
164 #     service:
165 #       name:
166 #         - nginx
167 #       port: 8004
168 #  #### CONTROLLER
169 #   controller:
170 #     pkg:
171 #       name: arvados-controller
172 #     service:
173 #       name: arvados-controller
174 #       port: 8003
175 #  #### DISPATCHER
176 #   dispatcher:
177 #     pkg:
178 #       name:
179 #         - crunch-dispatch-local
180 #       #   - arvados-dispatch-cloud
181 #       #   - crunch-dispatch-slurm
182 #     service:
183 #       name: crunch-dispatch-local
184 #       port: 9006
185 #  #### KEEPPROXY
186 #   keepproxy:
187 #     pkg:
188 #       name: keepproxy
189 #     service:
190 #       name: keepproxy
191 #       port: 25107
192 #  #### KEEPWEB
193 #   keepweb:
194 #     pkg:
195 #       name: keep-web
196 #     service:
197 #       name: keep-web
198 #     #   webdav
199 #       port: 9002
200 #  #### KEEPSTORE
201 #   keepstore:
202 #     pkg:
203 #       name: keepstore
204 #     service:
205 #       name: keepstore
206 #       port: 25107
207 #  #### GIT-HTTPD
208 #   githttpd:
209 #     pkg:
210 #       name: arvados-git-httpd
211 #     service:
212 #       name: arvados-git-httpd
213 #       port: 9001
214 #  #### SHELL
215 #   shell:
216 #     pkg:
217 #       name:
218 #         - arvados-client
219 #         - arvados-src
220 #         - libpam-arvados-go
221 #         - python3-arvados-fuse
222 #         - python3-arvados-python-client
223 #         - python3-arvados-cwl-runner
224 #     gem:
225 #       name:
226 #         - arvados-cli
227 #         - arvados-login-sync
228 #     shellinabox:
229 #       config: /etc/default/shellinabox
230 #       service:
231 #         name: shellinabox
232 #         port: 4200
233 #     libpam_arvados:
234 #       config: /etc/pam.d/arvados
235 #  #### WORKBENCH
236 #   workbench:
237 #     pkg:
238 #       name: arvados-workbench
239 #     service:
240 #       name: nginx
241 #  #### WORKBENCH2
242 #   workbench2:
243 #     pkg:
244 #       name: arvados-workbench2
245 #     service:
246 #       name: nginx
247 #  ####  WEBSOCKET
248 #   websocket:
249 #     pkg:
250 #       name: arvados-ws
251 #     service:
252 #       name: arvados-ws
253 #       port: 8005
254 #  #### SSO
255 #   sso:
256 #     pkg:
257 #       name: arvados-sso
258 #     service:
259 #       name: arvados-sso
260 #       port: 8900
261
262 #  ## SALTSTACK FORMULAS TOFS configuration
263 #   https://template-formula.readthedocs.io/en/latest/TOFS_pattern.html
264 #   tofs:
265 #   #    The files_switch key serves as a selector for alternative
266 #   #    directories under the formula files directory. See TOFS pattern
267 #   #    doc for more info.
268 #   #    Note: Any value not evaluated by `config.get` will be used literally.
269 #   #    This can be used to set custom paths, as many levels deep as required.
270 #     files_switch:
271 #       - any/path/can/be/used/here
272 #       - id
273 #       - roles
274 #       - osfinger
275 #       - os
276 #       - os_family
277 #   #    All aspects of path/file resolution are customisable using the options below.
278 #   #    This is unnecessary in most cases; there are sensible defaults.
279 #   #    Default path: salt://< path_prefix >/< dirs.files >/< dirs.default >
280 #   #            I.e.: salt://arvados/files/default
281 #   #    path_prefix: template_alt
282 #   #    dirs:
283 #   #      files: files_alt
284 #   #      default: default_alt
285 #   #    The entries under `source_files` are prepended to the default source files
286 #   #    given for the state
287 #   #    source_files:
288 #   #      arvados-config-file-file-managed:
289 #   #        - 'example_alt.tmpl'
290 #   #        - 'example_alt.tmpl.jinja'