4 title: Migrating Configuration
8 Copyright (C) The Arvados Authors. All rights reserved.
10 SPDX-License-Identifier: CC-BY-SA-3.0
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. Components not listed here do not yet support centralized configuration. During the migration period, legacy configuration files will continue to be loaded and take precedence over the centralized configuration file.
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.
19 Change to the API server directory and use the following commands:
22 $ RAILS_ENV=production bundle exec rake config:migrate > config.yml
23 $ cp config.yml /etc/arvados/config.yml
26 This will print the contents of @config.yml@ after merging the legacy @application.yml@ and @database.yml@ into the existing systemwide @config.yml@. It may be redirected to a file and copied to @/etc/arvados/config.yml@ (it is safe to copy over, all configuration items from the existing @/etc/arvados/config.yml@ will be included in the migrated output).
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@.
31 $ RAILS_ENV=production bundle exec rake config:diff
34 This command will also report if no migrations are required.
38 The legacy workbench configuration is stored in @config/application.yml@. After migration to @/etc/arvados/config.yml@, this file should be moved out of the way and/or deleted.
40 Change to the workbench server directory and use the following commands:
43 $ RAILS_ENV=production bundle exec rake config:migrate > config.yml
44 $ cp config.yml /etc/arvados/config.yml
47 This will print the contents of @config.yml@ after merging the legacy @application.yml@ into the existing systemwide @config.yml@. It may be redirected to a file and copied to @/etc/arvados/config.yml@ (it is safe to copy over, all configuration items from the existing @/etc/arvados/config.yml@ will be included in the migrated output).
49 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@.
52 $ RAILS_ENV=production bundle exec rake config:diff
55 This command will also report if no migrations are required.
57 h2. crunch-dispatch-slurm
59 Currently only reads @InstanceTypes@ from centralized configuration. Still requires component-specific configuration file.
63 Currently only reads @RemoteClusters@ from centralized configuration. Still requires component-specific configuration file.
65 h2(#keepproxy). keepproxy
67 The legacy keepproxy config (loaded from @/etc/arvados/keepproxy/keepproxy.yml@ or a different location specified via -legacy-keepproxy-config command line argument) takes precedence over the centralized config. After you migrate everything from the legacy config to the centralized config, you should delete @/etc/arvados/keepproxy/keepproxy.yml@ and stop using the -legacy-keepproxy-config argument.
69 Also, configuration via individual command line arguments is no longer available and the @DisableGet@, @DisablePut@, and @PIDFile@ configuration options are no longer supported. If you are still using the legacy config at @/etc/arvados/keepproxy/keepproxy.yml@ and @DisableGet@ or @DisablePut@ are set to true or @PIDFile@ has a value, keepproxy will produce an error and fail to start.
71 h2. arvados-controller
73 Already uses centralized config exclusively. No migration needed.
75 h2. arvados-dispatch-cloud
77 Already uses centralized config exclusively. No migration needed.