13996: Documentation for config migration
[arvados.git] / doc / admin / config-migration.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: Migrating Configuration
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 Arvados is migrating to a centralized configuration file for all components.  The centralized Arvados configuration is @/etc/arvados/config.yml@.  Components that support the new centralized configuration are listed below.
14
15 h2. API server
16
17 The legacy API server configuration is stored in @config/application.yml@ and @config/database.yml@.  After migration to @/etc/arvados/config.yml@, both of these files should be moved out of the way and/or deleted.
18
19 Change to the API server directory and use the following commands:
20
21 <pre>
22 $ bundle exec rake config:migrate > config.yml
23 $ cp config.yml /etc/arvados/config.yml
24 </pre>
25
26 This will print the contents of @config.yml@ after merging with legacy @application.yml@.  It may then be redirected to a file and copied to @/etc/arvados/config.yml@.
27
28 If you wish to update @config.yml@ configuration by hand, or check that everything has been migrated, use @config:diff@ to print configuration items that differ between @application.yml@ and the system @config.yml@.
29
30 <pre>
31 $ bundle exec rake config:diff
32 </pre>
33
34 This command will also report if no migrations are required.
35
36 h2. arvados-controller
37
38 Only supports centralized config file.  No migration needed.
39
40 h2. arvados-dispatch-cloud
41
42 Only supports centralized config file.  No migration needed.