Skip to content

examples: update xds example readme #7017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
creamsoup merged 2 commits into from
May 7, 2020
Merged

examples: update xds example readme #7017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1be23f
examples: update xds example readme
creamsoup May 7, 2020
123456e
apply review comments
creamsoup May 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ Tagging the Release
$ ${EDITOR:-nano -w} README.md
$ ${EDITOR:-nano -w} documentation/android-channel-builder.md
$ ${EDITOR:-nano -w} cronet/README.md
$ ${EDITOR:-nano -w} examples/example-xds/README.md
$ git commit -a -m "Update README etc to reference $MAJOR.$MINOR.$PATCH"
```
3. Change root build files to remove "-SNAPSHOT" for the next release version
Expand Down
34 changes: 3 additions & 31 deletions examples/example-xds/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,15 @@ will be very hard to produce a working enviornment just by this example. Please
refer to documentation specific for your XDS management server and
environment.__

The example requires grpc-xds, but grpc-xds is not currently being published.
You will thus need to build it yourself. This should guide you, but if you
encounter issues please consult [COMPILING.md](../../COMPILING.md).

### Build the example

1. The server does not use XDS, so recent releases work fine. Building using
recent releases is much easier, so check out the most recent release tag:
```
$ git checkout v1.29.0
```

2. Build the hello-world example server or the hostname example server. See
1. Build the hello-world example server or the hostname example server. See
[the examples README](../README.md) or the
[hostname example README](../example-hostname/README.md).

3. Since XDS is still developing rapidly, XDS-using code should be built from
master:
```
$ git checkout master
```

4. Building protoc-gen-grpc-java (the protoc plugin) requires a bit of work and
isn't necessary. So change the hello-world example to use the last released
version of the plugin. In `grpc-java/examples/build.gradle`, change:
```
grpc { artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}" }
```
To:
```
grpc { artifact = "io.grpc:protoc-gen-grpc-java:1.29.0" }
```


5. Build this client. From the `grpc-java/examples/examples-xds` directory:
2. Build the xds hello-world example client. From the `grpc-java/examples/examples-xds` directory:
```
$ ../gradlew -PskipCodegen=true -PskipAndroid=true --include-build ../.. installDist
$ ../gradlew installDist
```

This creates the script `build/install/example-xds/bin/xds-hello-world-client`
Expand Down