Skip to content

Commit b361cdc

Browse files
authored
Update deployment documentation. (#342)
* Update deployment documentation. * Fix typo. * Minor fixes. * Minor fixes. * Minor fixes.
1 parent 02f8ca2 commit b361cdc

File tree

1 file changed

+50
-26
lines changed

1 file changed

+50
-26
lines changed

doc/deployment.md

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ and how to deploy it to the cluster.
6060

6161
In order to build a specific version of the controller, you must check out the
6262
desired version. The following commands clone the repo and check out version
63-
`v1.1.0`:
63+
`v1.5.1`:
6464

6565
```shell
6666
git clone https://github.com/grpc/test-infra && cd test-infra
67-
git checkout --detach v1.1.0
67+
git checkout --detach v1.5.1
6868
```
6969

7070
### Environment variables
@@ -78,6 +78,9 @@ The following environment variables must be set before starting the build:
7878
- `RUN_IMAGE_PREFIX`
7979
- `KILL_AFTER`
8080

81+
`GOCMD` may be set to build with a [specific version of Go][goversion]. This
82+
variable defaults to `go`.
83+
8184
`TEST_INFRA_VERSION` is used to tag the images created by the controller build,
8285
and defaults to `latest`.
8386

@@ -95,10 +98,11 @@ timeout is set in the LoadTest configuration. `KILL_AFTER` is set in the
9598
[controller configuration](#controller-configuration), as a safeguard for
9699
components that may hang and consume resources after test timeout.
97100

98-
The variables used to build the `v1.1.0` release are as follows:
101+
The variables used to build the `v1.5.1` release are as follows:
99102

100103
```shell
101-
export TEST_INFRA_VERSION=v1.1.0
104+
export GOCMD=go1.19.5
105+
export TEST_INFRA_VERSION=v1.5.1
102106
export INIT_IMAGE_PREFIX=gcr.io/grpc-testing/e2etest/init/
103107
export BUILD_IMAGE_PREFIX=gcr.io/grpc-testing/e2etest/init/build/
104108
export RUN_IMAGE_PREFIX=gcr.io/grpc-testing/e2etest/init/runtime/
@@ -112,14 +116,15 @@ You can change `TEST_INFRA_VERSION` to any label you would like to apply to your
112116
images.
113117

114118
[grpccore]: https://github.com/grpc/grpc
119+
[goversion]: https://go.dev/doc/manage-install
115120

116121
### Controller configuration
117122

118123
The controller requires a configuration file to be included in the controller
119124
image. This configuration file can be generated from a template as follows:
120125

121126
```shell
122-
go run config/cmd/configure.go \
127+
${GOCMD:-go} run config/cmd/configure.go \
123128
-version="${TEST_INFRA_VERSION}" \
124129
-init-image-prefix="${INIT_IMAGE_PREFIX}" \
125130
-build-image-prefix="${BUILD_IMAGE_PREFIX}" \
@@ -168,24 +173,26 @@ language, plus a language-agnostic clone container image. These images are
168173
necessary to run any tests that do not use [pre-built images][], such as the
169174
[examples][].
170175

171-
The complete set of images built for `v1.1.0` is as follows:
176+
The complete set of images built for `v1.5.1` is as follows:
172177

173178
```shell
174-
gcr.io/grpc-testing/e2etest/init/build/csharp:v1.1.0
175-
gcr.io/grpc-testing/e2etest/init/build/node:v1.1.0
176-
gcr.io/grpc-testing/e2etest/init/build/php7:v1.1.0
177-
gcr.io/grpc-testing/e2etest/init/build/ruby:v1.1.0
178-
gcr.io/grpc-testing/e2etest/init/clone:v1.1.0
179-
gcr.io/grpc-testing/e2etest/init/ready:v1.1.0
180-
gcr.io/grpc-testing/e2etest/runtime/controller:v1.1.0
181-
gcr.io/grpc-testing/e2etest/runtime/cxx:v1.1.0
182-
gcr.io/grpc-testing/e2etest/runtime/driver:v1.1.0
183-
gcr.io/grpc-testing/e2etest/runtime/go:v1.1.0
184-
gcr.io/grpc-testing/e2etest/runtime/java:v1.1.0
185-
gcr.io/grpc-testing/e2etest/runtime/node:v1.1.0
186-
gcr.io/grpc-testing/e2etest/runtime/php7:v1.1.0
187-
gcr.io/grpc-testing/e2etest/runtime/python:v1.1.0
188-
gcr.io/grpc-testing/e2etest/runtime/ruby:v1.1.0
179+
gcr.io/grpc-testing/e2etest/init/build/csharp:v1.5.1
180+
gcr.io/grpc-testing/e2etest/init/build/dotnet:v1.5.1
181+
gcr.io/grpc-testing/e2etest/init/build/node:v1.5.1
182+
gcr.io/grpc-testing/e2etest/init/build/php7:v1.5.1
183+
gcr.io/grpc-testing/e2etest/init/build/ruby:v1.5.1
184+
gcr.io/grpc-testing/e2etest/init/clone:v1.5.1
185+
gcr.io/grpc-testing/e2etest/init/ready:v1.5.1
186+
gcr.io/grpc-testing/e2etest/runtime/controller:v1.5.1
187+
gcr.io/grpc-testing/e2etest/runtime/cxx:v1.5.1
188+
gcr.io/grpc-testing/e2etest/runtime/dotnet:v1.5.1
189+
gcr.io/grpc-testing/e2etest/runtime/driver:v1.5.1
190+
gcr.io/grpc-testing/e2etest/runtime/go:v1.5.1
191+
gcr.io/grpc-testing/e2etest/runtime/java:v1.5.1
192+
gcr.io/grpc-testing/e2etest/runtime/node:v1.5.1
193+
gcr.io/grpc-testing/e2etest/runtime/php7:v1.5.1
194+
gcr.io/grpc-testing/e2etest/runtime/python:v1.5.1
195+
gcr.io/grpc-testing/e2etest/runtime/ruby:v1.5.1
189196
```
190197

191198
This should match what is included in the
@@ -205,11 +212,11 @@ Images can be built and pushed with the following command:
205212
make all-psm-images push-all-psm-images
206213
```
207214

208-
The complete set of PSM images built for `v1.1.0` is as follows:
215+
The complete set of PSM images built for `v1.5.1` is as follows:
209216

210217
```shell
211-
gcr.io/grpc-testing/e2etest/runtime/sidecar:v1.1.0
212-
gcr.io/grpc-testing/e2etest/runtime/xds-server:v1.1.0
218+
gcr.io/grpc-testing/e2etest/runtime/sidecar:v1.5.1
219+
gcr.io/grpc-testing/e2etest/runtime/xds-server:v1.5.1
213220
```
214221

215222
> Note: PSM images are pushed by default to the location specified by
@@ -221,7 +228,7 @@ gcr.io/grpc-testing/e2etest/runtime/xds-server:v1.1.0
221228
The following command deletes all previous deployments from the cluster:
222229

223230
```shell
224-
kubectl -n test-infra-system delete deployments --all
231+
kubectl -n test-infra-system delete deployments,prometheus --all
225232
```
226233

227234
This is an optional step, but may be advisable, so we can start from a clean
@@ -332,7 +339,23 @@ metrics endpoint: http://localhost:9090/graph.
332339

333340
## Running an example test
334341

335-
Verify that the deployment is able to run a test by running the example Go test:
342+
Verify that the deployment is able to run a test by running the example Go test.
343+
344+
The easiest way to run the test is with the [test runner][]:
345+
346+
1. Build the test runner binary:
347+
348+
```shell
349+
make runner
350+
```
351+
352+
1. Run the example test:
353+
354+
```shell
355+
./bin/runner -i config/samples/ruby_example_loadtest.yaml -c :1 --delete-successful-tests -o sponge_log.xml
356+
```
357+
358+
Alternatively, you can apply the test to the cluster and monitor for completion:
336359

337360
1. Start the test:
338361

@@ -358,3 +381,4 @@ Verify that the deployment is able to run a test by running the example Go test:
358381

359382
[examples]: ../config/samples/README.md
360383
[prometheusoperator]: ../config/prometheus/README.md
384+
[test runner]: ../tools/README.md#test-runner

0 commit comments

Comments
 (0)