zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-08-14 05:29:38 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add temporary extra steps to "first steps tutorial" in docs

Browse source 
These are needed for now to get all nomulus tool commands working.  Also some other minor doc cleanup.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=136471375
This commit is contained in:
nickfelt 2016-10-18 07:42:02 -07:00 • committed by Ben McIlwain
parent 9b233b0171
commit 8c1021f8cb
2 changed files with 31 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/first-steps-tutorial.md
View file

@ -12,7 +12,29 @@ running registry system. We'll assume that all commands below are running in the
`alpha` environment; if you named your environment differently, then use that `alpha` environment; if you named your environment differently, then use that
everywhere that `alpha` appears. everywhere that `alpha` appears.
### Create a TLD ## Temporary extra steps
Using the `nomulus` admin tool currently requires two additional steps to enable
full functionality. These steps should _not_ be done for a production
deployment - a suitable solution for production is in progress.
1. Modify the `tools` module `web.xml` file to remove admin-only restrictions.
Look for the `<auth-constraint>admin</auth-constraint>` element. Comment
out this element, and redeploy the tools module to your live app.
2. Set up [application default credentials][app-default-creds] in `gcloud` by
running the following command:
```shell
$ gcloud beta auth application-default login
Your browser has been opened to visit:
[ ... snip logging in via browser ... ]
You are now logged in as [user@email.tld].
```
[app-default-creds]: https://developers.google.com/identity/protocols/application-default-credentials
## Create a TLD
Pick the name of a TLD to create. For the purposes of this example we'll use Pick the name of a TLD to create. For the purposes of this example we'll use
"example", which conveniently happens to be an ICANN reserved string, meaning "example", which conveniently happens to be an ICANN reserved string, meaning
@ -43,7 +65,7 @@ Updated 1 entities.
upper-case TLD name down to 8 characters. Refer to the [gTLD Registry upper-case TLD name down to 8 characters. Refer to the [gTLD Registry
Advisory: Correction of non-compliant ROIDs][roids] for further information. Advisory: Correction of non-compliant ROIDs][roids] for further information.
### Create a registrar ## Create a registrar
Now we need to create a registrar and give it access to operate on the example Now we need to create a registrar and give it access to operate on the example
TLD. For the purposes of our example we'll name the registrar "Acme". TLD. For the purposes of our example we'll name the registrar "Acme".
@ -78,7 +100,7 @@ Where:
* `--allowed_tlds` is a comma-delimited list of top level domains where this * `--allowed_tlds` is a comma-delimited list of top level domains where this
registrar has access. registrar has access.
### Create a contact ## Create a contact
Now we want to create a contact, as a contact is required before a domain can be Now we want to create a contact, as a contact is required before a domain can be
created. Contacts can be used on any number of domains across any number of created. Contacts can be used on any number of domains across any number of
@ -108,7 +130,7 @@ Where:
The address and `email` fields are required to create a contact. The address and `email` fields are required to create a contact.
### Create a host ## Create a host
Hosts are used to specify the IP addresses (either v4 or v6) that are associated Hosts are used to specify the IP addresses (either v4 or v6) that are associated
with a given nameserver. Note that hosts may either be in-bailiwick (on a TLD with a given nameserver. Note that hosts may either be in-bailiwick (on a TLD
@ -132,7 +154,7 @@ Where:
Note that hosts are required to have IP addresses if they are subordinate, and Note that hosts are required to have IP addresses if they are subordinate, and
must not have IP addresses if they are not subordinate. must not have IP addresses if they are not subordinate.
### Create a domain ## Create a domain
To tie it all together, let's create a domain name that uses the above contact To tie it all together, let's create a domain name that uses the above contact
and host. and host.
@ -158,7 +180,7 @@ Note how the same contact id is used for the administrative, technical, and
registrant contact. It is common for domain names to use the same details for registrant contact. It is common for domain names to use the same details for
all contacts on a domain name. all contacts on a domain name.
### Verify test entities using WHOIS ## Verify test entities using WHOIS
To verify that everything worked, let's query the WHOIS information for To verify that everything worked, let's query the WHOIS information for
fake.example: fake.example:

6
docs/install.md
View file

@ -166,7 +166,7 @@ upload just that one using the `-M` flag to specify the service to update.
To verify successful deployment, visit To verify successful deployment, visit
https://acme-registry-alpha.appspot.com/registrar in your browser (adjusting https://acme-registry-alpha.appspot.com/registrar in your browser (adjusting
approrpriately for the project ID that you actually used). If the project appropriately for the project ID that you actually used). If the project
deployed successfully, you'll see a "You need permission" page indicating that deployed successfully, you'll see a "You need permission" page indicating that
you need to configure the system and grant access to your Google account. It's you need to configure the system and grant access to your Google account. It's
time to go to the next step, configuration. time to go to the next step, configuration.
@ -175,8 +175,8 @@ Configuration is handled by editing code, rebuilding the project, and deploying
again. See the [configuration guide](./configuration.md) for more details. Once again. See the [configuration guide](./configuration.md) for more details. Once
you have completed basic configuration (including most critically the project ID you have completed basic configuration (including most critically the project ID
in your copy of `ProductionRegistryConfigExample`), you can rebuild and start in your copy of `ProductionRegistryConfigExample`), you can rebuild and start
using `registry_tool` to create test entities in your newly deployed system. See using the `nomulus` tool to create test entities in your newly deployed system.
the [first steps tutorial](./first-steps-tutorial.md) for more information. See the [first steps tutorial](./first-steps-tutorial.md) for more information.
[app-engine-sdk]: https://cloud.google.com/appengine/docs/java/download [app-engine-sdk]: https://cloud.google.com/appengine/docs/java/download
[java-jdk7]: http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html [java-jdk7]: http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html