allocatord: Update README for how to run locally
Add some extra prerequisites. Also add Markdown formatting.
Change-Id: I7e331373963ad11c18380358c644cb680cface32
diff --git a/services/allocator/allocatord/README.md b/services/allocator/allocatord/README.md
index d8b1609..10c8f78 100644
--- a/services/allocator/allocatord/README.md
+++ b/services/allocator/allocatord/README.md
@@ -1,19 +1,39 @@
# Run allocatord locally
-```
-# Get oauth credentials file.
+## Prerequisites
+
+1. [Jiri][1] set up and `JIRI_ROOT` environment variable set.
+2. [Google Cloud SDK][2] installed, so that `gcloud` and `gsutil`
+ commands are on the `PATH`
+3. Kubernates control installed with
+
+ ```sh
+ gcloud components install kubectl
+ ```
+4. You are added as an editor on the [vanadium-staging][3] project.
+
+## Get oauth credentials file.
+
+```sh
gsutil cp gs://vanadium-backup/allocatord_oauth.json /tmp/oauth.json
+```
-# Prepare.
+## Prepare.
+
+```sh
source ${JIRI_ROOT}/infrastructure/scripts/util/vanadium-oncall.sh
-jiri go install v.io/x/ref/services/allocator/allocatord v.io/x/ref/services/agent/vbecome
+jiri go install \
+ v.io/x/ref/services/allocator/allocatord \
+ v.io/x/ref/services/agent/vbecome \
+ v.io/x/ref/services/cluster/vkube \
+ v.io/x/ref/services/agent \
+ v.io/x/ref/services/agent/v23agentd
agent -s on
+```
-# Run allocatord.
-# And then visit http://localhost:8166 to browse the UI.
-#
-# To update UI, edit template/CSS/JavaScript files in the "assets" directory and
-# refresh the page to see the changes. No need to restart allocatord.
+## Run allocatord
+
+```sh
as_service ${JIRI_ROOT}/release/go/bin/vbecome --name=allocatord \
${JIRI_ROOT}/release/go/bin/allocatord \
--http-addr=:8166 \
@@ -28,8 +48,23 @@
--dashboard-gcm-project=vanadium-staging \
--assets=${JIRI_ROOT}/release/go/src/v.io/x/ref/services/allocator/allocatord/assets \
--static-assets-prefix=https://static.staging.v.io
+```
-# Re-generate "assets/assets.go" file when UI changes are ready to be reviewed.
+and then visit http://localhost:8166 to browse the UI.
+
+## Edit UI
+
+To update UI, edit template/CSS/JavaScript files in the "assets"
+directory and refresh the page to see the changes. No need to restart
+allocatord.
+
+Re-generate "assets/assets.go" file when UI changes are ready to be reviewed.
+
+```sh
jiri go generate v.io/x/ref/services/allocator/allocatord
```
+
+[1]: https://github.com/vanadium/go.jiri
+[2]: https://cloud.google.com/sdk/downloads
+[3]: https://pantheon.corp.google.com/iam-admin/iam/project?project=vanadium-staging
