zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-07-21 10:16:07 +02:00
Code Issues Projects Releases Packages Wiki Activity

Move the environment configuration YAML files into the main JAR

Browse source 
This allows configuration to work properly from the nomulus tool.

TESTED=I built and ran it against several environments, and all worked
properly.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=146697124
This commit is contained in:
mcilwain 2017-02-06 12:36:27 -08:00 • committed by Ben McIlwain
parent a904f2c6ee
commit bf068e61d9
14 changed files with 51 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/configuration.md
View file

@ -58,21 +58,16 @@ queues, and thus edit those associated XML files.
Global configuration is managed through YAML files that are built with and
deployed in the app. The full list of config options and their default values
can be found in the `[default-config.yaml][default-config]` file. If you wish to
change any of these values, do not change make changes to this file. Instead,
write a custom configuration file named `nomulus-config.yaml` that overrides
only the options you wish to change, and include it in the `WEB-INF` directory
in each service.
The existing environments that Nomulus ships with (alpha, sandbox, etc.) come
with placeholder configuration files that are included in the default deployment
build, so if you are using one of these environments, simply make your changes
to that file. For example, to configure the alpha environment, edit
`[env/alpha/common/WEB-INF/nomulus-config.yaml][nomulus-config-alpha]`.
can be found in the [`default-config.yaml`][default-config] file. If you wish to
change any of these values, do not edit this file. Instead, edit the environment
configuration file named
`google/registry/config/files/nomulus-config-ENVIRONMENT.yaml`, overriding only
the options you wish to change. Nomulus ships with blank placeholders for all
standard environments.
You will not need to change most of the default settings. Here is the subset of
settings that you will need to change for all deployed environments, including
development environments. See `[default-config.yaml][default-config]` for a full
development environments. See [`default-config.yaml`][default-config] for a full
description of each option:
```yaml
@ -93,7 +88,7 @@ need to specify more settings. The `nomulus-config-production-sample.yaml` file
contains an exhaustive list of all settings to override.
From a code perspective, all configuration settings ultimately come through the
`[RegistryConfig][registry-config]` class. This includes a Dagger module called
[`RegistryConfig`][registry-config] class. This includes a Dagger module called
`ConfigModule` that provides injectable configuration options. Some legacy
configuration options that can be changed in this class include timeout lengths
and buffer sizes for various tasks, email addresses and URLs to use for various
@ -145,6 +140,5 @@ above, per-TLD configuration options are stored as data in the running system,
and thus do not require code pushes to update.
[app-engine-config]: https://cloud.google.com/appengine/docs/java/configuration-files
[default-config]: https://github.com/google/nomulus/blob/master/java/google/registry/config/default-config.yaml
[nomulus-config-alpha]: https://github.com/google/nomulus/blob/master/java/google/registry/env/alpha/common/WEB-INF/nomulus-config.yaml
[default-config]: https://github.com/google/nomulus/blob/master/java/google/registry/config/files/default-config.yaml
[registry-config]: https://github.com/google/nomulus/blob/master/java/google/registry/config/RegistryConfig.java