1
0
mirror of https://github.com/google/nomulus synced 2026-03-27 12:55:28 +00:00
Files
nomulus/docs/operational-procedures/modifying-tlds.md
gbrodman c52983fb61 Update some Nomulus documentation (#2970)
This doesn't update everything -- it leaves out some of the more
complicated changes (architecture, code-structure, configuration,
install, and proxy-setup). Those will require more complete rewrites, so
I'm punting them to a future PR.
2026-02-26 19:05:22 +00:00

1.3 KiB

Creating or Modifying TLDs

Nomulus stores YAML representations of TLDs, in an effort to make sure that any (potentially significant) modifications to TLDs go through source control and code review. We recommend storing these TLD YAML representations in a separate private repository so that changes can be verified by multiple people before being merged (here is an example TLD)

Creating and updating a TLD use the same process -- the only difference is whether you're creating a TLD YAML file from scratch or modifying an existing one.

Similar to premium lists and reserved lists, we recommend modifying TLDs as a part of an automated build process after the desired changes have been merged into the TLD YAML files. The automated process should run:

nomulus -e {ENVIRONMENT} configure_tld --build_environment --input=path/to/my/file/tld.yaml

The build_environment flag signals that this is being run as part of an automated build process and should ideally not be used manually. There is an additional --break_glass argument that can be used in emergencies to modify TLDs outside a normal build process.