grpc/examples/cpp/xds

gRPC C++ xDS Hello World Example

This xDS example builds on the Hello World Example and changes the gRPC client and server to accept configuration from an xDS control plane.

Configuration

The client takes two command-line arguments -

• target - By default, the client tries to connect to the xDS "xds:///helloworld:50051" and gRPC would use xDS to resolve this target and connect to the server backend. This can be overridden to change the target.
• xds-creds - Bool value, defaults to true. When this is set, XdsCredentials will be used with a fallback on InsecureChannelCredentials. If unset, InsecureChannelCredentials will be used.

The server takes three command-line arguments -

• port - Port on which the Hello World service is run. Defaults to 50051.
• maintenance_port - If secure mode is used (see below), the Admin service is exposed on this port. If secure mode is not used, maintenance_port is unused, and the Admin service is just exposed on port. Defaults to 50052.
• secure - Bool value, defaults to true. When this is set, XdsServerCredentials will be used with a fallback on InsecureServerCredentials. If unset, InsecureServerCredentials will be used.

Running the example

Currently, this example and some of the gRPC xDS libraries that it depends on only builds with bazel. CMake support will be introduced in the future.

To use XDS, you should first deploy the XDS management server in your deployment environment and know its name. You need to set the GRPC_XDS_BOOTSTRAP environment variable to point to the gRPC XDS bootstrap file (see gRFC A27 for the bootstrap format). This is needed by both client and server.

Please view GCP instructions as an example.

To run the server -

$ export GRPC_XDS_BOOTSTRAP=/path/to/bootstrap.json
$ tools/bazel run examples/cpp/xds:greeter_server

To run the client -

$ export GRPC_XDS_BOOTSTRAP=/path/to/bootstrap.json
$ tools/bazel run examples/cpp/xds:greeter_client

Building Docker

From the gRPC workspace folder:

Client:

docker build -f examples/cpp/xds/Dockerfile.client examples/cpp/xds

Server:

docker build -f examples/cpp/xds/Dockerfile.server examples/cpp/xds

To push to a registry, add a tag to the image either by adding a -t flag to docker build command above or run:

docker image tag ${sha from build command above} ${tag}

And then push the tagged image using docker push