Update HTTP and gRPC tutorials #65
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alan Cha <[email protected]>
Signed-off-by: Alan Cha <[email protected]>
Alan-Cha
force-pushed
the
update_http_grpc
branch
from
3a1bf08 to
a70e39c
Compare
Alan-Cha
commented
Feb 14, 2023
kalantar
previously approved these changes
Feb 14, 2023
|
|
||
| The [ready](../user-guide/tasks/ready.md) task checks if the `httpbin` deployment exists and is available, and the `httpbin` service exists. | ||
|
|
||
| The [http](../user-guide/tasks/http.md) task sends requests to the cluster-local HTTP service whose URL is `http://httpbin.default/post` with a string payload, and collects [Iter8's built-in HTTP load test metrics](../user-guide/tasks/http.md#metrics). |
There was a problem hiding this comment.
Perhaps include the value of the string (hello) in the description just to be explicit.
docs/tutorials/load-test-grpc.md
Outdated
|
|
||
| The [ready](../user-guide/tasks/ready.md) task checks if the `routeguide` deployment exists and is available, and the `routeguide` service exists. | ||
|
|
||
| The [grpc](../user-guide/tasks/grpc.md) task sends call requests to the `routeguide.RouteGuide.ListFeatures` method of the cluster-local gRPC service with host address `routeguide.default:50051`, and collects [Iter8's built-in gRPC load test metrics](../user-guide/tasks/grpc.md#metrics). |
There was a problem hiding this comment.
Perhaps restate here that this is a server streaming example. "sends call requests to ... which streams results in response."
Same comment in all examples.
Signed-off-by: Alan Cha <[email protected]>
sriumcp
requested changes
Feb 14, 2023
| --set assess.SLOs.upper.http/error-count=0 \ | ||
| --set runner=job | ||
| ``` | ||
| === "Get example" |
|
|
||
| This is a [single-loop](concepts.md#iter8-experiment) [Kubernetes experiment](concepts.md#kubernetes-experiments) where all the previously mentioned tasks will run once and the experiment will finish. Hence, its [runner](concepts.md#runners) value is set to `job`. | ||
|
|
||
| === "Post example" |
docs/tutorials/load-test-grpc.md
Outdated
| --set runner=job | ||
| ``` | ||
|
|
||
| ??? note "About this experiment" |
There was a problem hiding this comment.
Let us combine the "About this experiment" notes across the 4 tabs for gRPC and 2 tabs for HTTP.
docs/tutorials/load-test-grpc.md
Outdated
| @@ -16,44 +16,129 @@ Load test a Kubernetes gRPC service and validate its [service-level objectives ( | |||
| 1. Try [your first experiment](../getting-started/your-first-experiment.md). Understand the main [concepts](../getting-started/concepts.md) behind Iter8 experiments. | |||
| 2. Deploy the sample gRPC service in the Kubernetes cluster. | |||
| ```shell | |||
| kubectl create deploy hello --image=docker.io/grpc/java-example-hostname:latest --port=50051 | |||
| kubectl expose deploy hello --port=50051 | |||
| kubectl create deployment routeguide --image=golang --port=50051 -- bash -c "git clone -b v1.52.0 --depth 1 https://github.com/grpc/grpc-go; cd grpc-go/examples/route_guide; go run server/server.go" | |||
There was a problem hiding this comment.
Perhaps \ new line break before -- bash?
Signed-off-by: Alan Cha <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.