Expand list of system capabilities in README and add known issues

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=131074174
This commit is contained in:
mcilwain 2016-08-23 10:59:29 -07:00 committed by Ben McIlwain
parent 87314c4469
commit 5dc1f716bd
3 changed files with 163 additions and 52 deletions

View file

@ -64,6 +64,24 @@ computer too badly.
--local_resources=1000,3,1.0
Executed 360 out of 360 tests: 360 tests pass.
## Running a development instance locally
`RegistryTestServer` is a lightweight test server for the registry that is
suitable for running locally for development. It uses local versions of all
Google Cloud Platform dependencies, when available. Correspondingly, its
functionality is limited compared to a Domain Registry instance running on an
actual App Engine instance. To see its command-line parameters, run:
$ bazel run //javatests/google/registry/server -- --help
Then to fire up an instance of the server, run:
$ bazel run //javatests/google/registry/server {your params}
Once it is running, you can interact with it via normal `registry_tool`
commands, or view the registrar console in a web browser by navigating to
http://localhost:8080/registrar .
## Deploying the code
You are going to need to configure a variety of things before a working

View file

@ -9,6 +9,15 @@ if the most recent export failed. Its code lives inside the tools package
(`java/google/registry/tools`), and is compiled by building the `registry_tool`
target in the Bazel BUILD file in that package.
To build the tool and display its command-line help, execute this command:
$ bazel run //java/google/registry/tool:registry_tool -- --help
For future invocations you should alias the compiled binary in the
`bazel-genfiles/java/google/registry` directory or add it to your path so that
you can run it more easily. The rest of this guide assumes that it has been
aliased to `registry_tool`.
The registry tool is always called with a specific environment to run in using
the -e parameter. This looks like: