Release notes for v0.2 + doc update (#100)

Signed-off-by: Otto van der Schaaf <oschaaf@we-amp.com>
envoyproxy · Jul 18, 2019 · 50c096e · 50c096e
1 parent e15477b
commit 50c096e
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 2 deletions.
diff --git a/BUILD b/BUILD
@@ -8,6 +8,15 @@ load(
 
 envoy_package()
 
+filegroup(
+    name = "nighthawk",
+    srcs = [
+        ":nighthawk_client",
+        ":nighthawk_service",
+        ":nighthawk_test_server",
+    ],
+)
+
 envoy_cc_binary(
     name = "nighthawk_client",
     repository = "@envoy",

diff --git a/README.md b/README.md
@@ -25,13 +25,13 @@ For building the Nighthawk test server, see [here](source/server/README.md).
 ### Test it
 
 ```bash
-bazel test -c dbg //test:nighthawk_test
+bazel test -c dbg //test/... //integration/...
 ```
 
 ### Build it
 
 ```bash
-bazel build -c opt //:nighthawk_client
+bazel build -c opt //:nighthawk
 ```
 
 ### Using the CLI
@@ -155,6 +155,40 @@ Where:
 
 ```
 
+### Nighthawk gRPC service
+
+The gRPC service can be used to start a server which is able to perform back-to-back benchmark runs upon request. The service interface definition [can be found here.](https://github.com/envoyproxy/nighthawk/blob/59a37568783272a6438b5697277d4e56aa16ebbe/api/client/service.proto) 
+
+
+```bash
+➜ bazel-bin/nighthawk_service --help
+
+USAGE: 
+
+   bazel-bin/nighthawk_service  [--listen <address:port>] [--] [--version]
+                                [-h]
+
+
+Where: 
+
+   --listen <address:port>
+     The address:port on which the Nighthawk gRPC service should listen.
+     Default: 0.0.0.0:8443.
+
+   --,  --ignore_rest
+     Ignores the rest of the labeled arguments following this flag.
+
+   --version
+     Displays version information and exits.
+
+   -h,  --help
+     Displays usage information and exits.
+
+
+   L7 (HTTP/HTTPS/HTTP2) performance characterization tool.
+
+```
+
 ## A sample benchmark run
 
 ```bash

diff --git a/docs/root/version_history.md b/docs/root/version_history.md
@@ -1,5 +1,17 @@
 Version history
 ---------------
+
+0.2 (July 16, 2019)
+=========================
+
+- Nighthawk as a service: (https://github.com/envoyproxy/nighthawk/issues/22)
+- Add option to control how request pacing is maintained (https://github.com/envoyproxy/nighthawk/issues/80)
+- Add python orchestration for integration testing: https://github.com/envoyproxy/nighthawk/issues/50
+- Benchmark client configuration options: 
+  - Connection-pool configuration https://github.com/envoyproxy/nighthawk/issues/45
+  - Allow control of TLS ciphers and settings https://github.com/envoyproxy/nighthawk/issues/32
+  - Measure time spend waiting on a full connection queue: https://github.com/envoyproxy/nighthawk/pull/97
+
 0.1 (May 6, 2019)
 =========================