Skip to content

Commit db6862c

Browse files
committed
cmd/coordinator: update documentation
Update documentation to reflect changes from the dashboard unification. For golang/go#34744. Change-Id: Ifb61207dd61496df0e8e9c96fd05730399e3a4b8 Reviewed-on: https://go-review.googlesource.com/c/build/+/340434 Trust: Dmitri Shuralyov <[email protected]> Reviewed-by: Carlos Amedee <[email protected]>
1 parent 6b1a97d commit db6862c

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,13 @@ https://github.com/golang/go/issues. Prefix your issue with
1818

1919
The main components of the Go build system are:
2020

21-
* The **dashboard**, in [app/](https://dev.golang.org/dir/build/app), serves
22-
https://build.golang.org/. It runs on App Engine and holds the state for
23-
which builds passed or failed, and stores the build failure logs for
24-
post-submit failures. (Trybot build failure logs are stored elsewhere).
25-
The dashboard does not execute any builds on its own.
26-
27-
2821
* The **coordinator**, in
2922
[cmd/coordinator/](https://dev.golang.org/dir/build/cmd/coordinator/),
30-
serves https://farmer.golang.org/. It runs on GKE and coordinates the
31-
whole build system. It finds work to do (both pre-submit "TryBot" work,
32-
and post-submit work) and executes builds, allocating machines to run the
33-
builds. It is the owner of all machines.
23+
serves https://farmer.golang.org/ and https://build.golang.org/.
24+
It runs on GKE and coordinates the whole build system. It finds work
25+
to do (both pre-submit "TryBot" work, and post-submit work) and executes
26+
builds, allocating machines to run the builds. It is the owner of all machines.
27+
It holds the state for which builds passed or failed, and the build logs.
3428

3529
* The Go package in [buildenv/](https://dev.golang.org/dir/build/buildenv/)
3630
contains constants for where the dashboard and coordinator run, for prod,
@@ -67,7 +61,7 @@ The main components of the Go build system are:
6761
over the already-open TCP connection.
6862

6963
These three pools can be viewed at the coordinator's
70-
http://farmer.golang.org/#pools
64+
https://farmer.golang.org/#pools.
7165

7266

7367
* The [env/](https://dev.golang.org/dir/build/env/) directory describes

cmd/coordinator/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,23 @@ Building, running tests, running locally is supported on Linux and macOS only.
66

77
Run
88

9-
go run golang.org/x/build/cmd/coordinator --mode=dev --env=dev
9+
```sh
10+
go run golang.org/x/build/cmd/coordinator -mode=dev -env=dev
11+
```
1012

1113
to start a server on https://localhost:8119. Proceed past the TLS warning and
1214
you should get the homepage. Some features won't work when running locally,
13-
but you should be able to view the homepage and the builders page and do basic
14-
sanity checks.
15+
but you should be able to navigate between the homepage, the dashboard,
16+
the builders page, and do limited local development and testing.
1517

1618
#### Render the "Trybot Status" page locally
1719

1820
To view/modify the "Trybot Status" page locally, you can run the coordinator
1921
with the `-dev` tag.
2022

21-
go run -tags=dev golang.org/x/build/cmd/coordinator --mode=dev --env=dev
23+
```sh
24+
go run -tags=dev golang.org/x/build/cmd/coordinator -mode=dev -env=dev
25+
```
2226

2327
Then visit https://localhost:8119/try-dev in your browser.
2428
You should see a trybot status page with some example data.

cmd/coordinator/coordinator.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
// The coordinator runs the majority of the Go build system.
1010
//
11-
// It is responsible for finding build work and executing it,
12-
// reporting the results to build.golang.org for public display.
11+
// It is responsible for finding build work, executing it,
12+
// and displaying the results.
1313
//
1414
// For an overview of the Go build system, see the README at
1515
// the root of the x/build repo.

0 commit comments

Comments
 (0)