-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fixing readme and contrib Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fix installation of iter8 Signed-off-by: Srinivasan Parthasarathy <[email protected]> * install fixes Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing tests.yaml Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing loglevel Signed-off-by: Srinivasan Parthasarathy <[email protected]> * indent new lines Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing multi-line runs Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing tests Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing install Signed-off-by: Srinivasan Parthasarathy <[email protected]> * updated concepts and home Signed-off-by: Srinivasan Parthasarathy <[email protected]> * Iter8 CLI documentation Signed-off-by: Srinivasan Parthasarathy <[email protected]> * updated docs Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing usage docs Signed-off-by: Srinivasan Parthasarathy <[email protected]> * updated iter8 commands Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing readme and contrib Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing various v0.10 docs Signed-off-by: Srinivasan Parthasarathy <[email protected]> * update roadmap Signed-off-by: Srinivasan Parthasarathy <[email protected]> * roadmap with devsecops Signed-off-by: Srinivasan Parthasarathy <[email protected]> * updating iter8 CLI docs Signed-off-by: Srinivasan Parthasarathy <[email protected]> * fixing your first experiment doc Signed-off-by: Srinivasan Parthasarathy <[email protected]>
- Loading branch information
Showing
33 changed files
with
742 additions
and
528 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,49 @@ | ||
| # :zap: Iter8: Kubernetes Release Optimizer | ||
| # Iter8: Kubernetes Release Optimizer | ||
|
|
||
| [](https://github.com/iter8-tools/iter8/releases) | ||
| [](https://pkg.go.dev/github.com/iter8-tools/iter8) | ||
| [](https://codecov.io/gh/iter8-tools/iter8) | ||
|  | ||
|  | ||
|
|
||
| > - Safely rollout apps | ||
| > - Maximize business value | ||
| > - Use with any app/serverless/ML framework | ||
| > - Simplify CI/CD/GitOps | ||
| > - Get started in seconds | ||
| > - Benchmark and validate HTTP and gRPC services | ||
| > - Compare app/ML model versions using metrics | ||
| > - Safely promote winning version | ||
| > - Maximize business value in each release | ||
| <p align='center'> | ||
| <img alt-text="Iter8 experiment" src="https://iter8-tools.github.io/docs/0.9/images/iter8-intro-dark.png" width="70%" /> | ||
| </p> | ||
|
|
||
| ## :rocket: Getting started | ||
|
|
||
| ### Install Iter8 CLI | ||
| ```shell | ||
| brew tap iter8-tools/iter8 | ||
| brew install [email protected] | ||
| ``` | ||
| [See here](https://iter8.tools/latest/getting-started/install) for more ways to install. | ||
|
|
||
| ### Benchmark an HTTP service | ||
| Launch Iter8 experiment and view report. | ||
| ```shell | ||
| iter8 launch -c load-test-http --set url=https://httpbin.org/get | ||
| iter8 report | ||
| ``` | ||
|
|
||
| ### Benchmark a gRPC service | ||
| Start a sample gRPC service in a separate terminal. | ||
|
|
||
| ```shell | ||
| docker run -p 50051:50051 docker.io/grpc/java-example-hostname:latest | ||
| ``` | ||
|
|
||
| Launch Iter8 experiment and view report. | ||
| ```shell | ||
| iter8 launch -c load-test-grpc \ | ||
| --set host="127.0.0.1:50051" \ | ||
| --set call="helloworld.Greeter.SayHello" \ | ||
| --set protoURL="https://raw.githubusercontent.com/grpc/grpc-go/master/examples/helloworld/helloworld/helloworld.proto" | ||
| iter8 report | ||
| ``` | ||
|
|
||
| ## :dart: Usage examples | ||
| ## :dart: Features at a glance | ||
|
|
||
| **Load testing with SLOs** | ||
|
|
||
| > Iter8 experiments can generate requests for HTTP and gRPC services, collect built-in latency and error-related metrics, and validate SLOs. | ||
| **A/B(/n) testing** | ||
|
|
||
| > Grow your business with every release. Iter8 experiments can compare multiple versions based on business value and identify a winner. | ||
| **Simple to use** | ||
|
|
||
| > Get started with Iter8 in seconds using pre-packaged experiment charts. Run Iter8 experiments locally, inside Kubernetes, or inside your CI/CD/GitOps pipelines. | ||
| **App frameworks** | ||
|
|
||
| > Use with any app, serverless, or ML framework. Iter8 works with Kubernetes deployments, statefulSets, Knative services, KServe/Seldon ML deployments, or other custom Kubernetes resource types. | ||
| ## :rocket: Usage examples | ||
| 1. [Load test, benchmark and validate HTTP services with SLOs](https://iter8.tools/0.9/tutorials/load-test-http/usage/). | ||
| 2. [Load test, benchmark and validate gRPC services with SLOs](https://iter8.tools/0.9/tutorials/load-test-grpc/usage/). | ||
| 3. Load test, benchmark and validate Knative services with SLOs: [HTTP](https://iter8.tools/0.9/tutorials/integrations/knative/load-test-http/) and [gRPC](https://iter8.tools/0.9/tutorials/integrations/knative/load-test-grpc/). | ||
| 3. Performance testing and SLO validation using Iter8 GitHub Action: [HTTP](https://iter8.tools/0.9/tutorials/load-test-http/ghaction/) and [gRPC](https://iter8.tools/0.9/tutorials/load-test-grpc/ghaction/). | ||
| 4. Performance testing and SLO validation for Knative services: [HTTP](https://iter8.tools/0.9/tutorials/integrations/knative/load-test-http/) and [gRPC](https://iter8.tools/0.9/tutorials/integrations/knative/load-test-grpc/). | ||
|
|
||
| Please see [https://iter8.tools](https://iter8.tools) for the complete documentation. | ||
|
|
||
| ## :maple_leaf: Issues | ||
|
|
||
| ### Documentation | ||
| Iter8 documentation is available at https://iter8.tools. | ||
| Iter8 issues are tracked [here](https://github.com/iter8-tools/iter8/issues). | ||
|
|
||
| ## :wrench: Developing Iter8 | ||
| ## :tada: Contributing | ||
| We welcome PRs! | ||
|
|
||
| See [here](CONTRIBUTING.md) for information about ways to contribute, Iter8 community meetings, finding an issue, asking for help, pull-request lifecycle, and more. | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,61 +3,36 @@ | |
|
|
||
| ```shell | ||
| brew tap iter8-tools/iter8 | ||
| brew install iter8 | ||
| brew install iter8@0.10 | ||
| ``` | ||
|
|
||
| ??? note "Install a specific version" | ||
| You can install the Iter8 CLI with specific major and minor version numbers. For example, the following command installs the release of the Iter8 CLI with major `0` and minor `9`. | ||
| ```shell | ||
| brew tap iter8-tools/iter8 | ||
| brew install [email protected] | ||
| ``` | ||
|
|
||
| === "Binaries" | ||
| You can replace `v0.9.0` with [any desired Iter8 release tag](https://github.com/iter8-tools/iter8/releases). | ||
| Replace `${TAG}` below with [any Iter8 release tag](https://github.com/iter8-tools/iter8/releases) (example, `v0.10.5`). | ||
|
|
||
| === "darwin-amd64 (MacOS)" | ||
| ```shell | ||
| wget https://github.com/iter8-tools/iter8/releases/download/v0.9.0/iter8-darwin-amd64.tar.gz | ||
| wget https://github.com/iter8-tools/iter8/releases/download/${TAG}/iter8-darwin-amd64.tar.gz | ||
| tar -xvf iter8-darwin-amd64.tar.gz | ||
| ``` | ||
| Move `darwin-amd64/iter8` to any directory in your `PATH`. | ||
|
|
||
| === "linux-amd64" | ||
| ```shell | ||
| wget https://github.com/iter8-tools/iter8/releases/download/v0.9.0/iter8-linux-amd64.tar.gz | ||
| wget https://github.com/iter8-tools/iter8/releases/download/${TAG}/iter8-linux-amd64.tar.gz | ||
| tar -xvf iter8-linux-amd64.tar.gz | ||
| ``` | ||
| Move `linux-amd64/iter8` to any directory in your `PATH`. | ||
|
|
||
| === "linux-386" | ||
| ```shell | ||
| wget https://github.com/iter8-tools/iter8/releases/download/v0.9.0/iter8-linux-386.tar.gz | ||
| wget https://github.com/iter8-tools/iter8/releases/download/${TAG}/iter8-linux-386.tar.gz | ||
| tar -xvf iter8-linux-386.tar.gz | ||
| ``` | ||
| Move `linux-386/iter8` to any directory in your `PATH`. | ||
|
|
||
| === "windows-amd64" | ||
| ```shell | ||
| wget https://github.com/iter8-tools/iter8/releases/download/v0.9.0/iter8-windows-amd64.tar.gz | ||
| wget https://github.com/iter8-tools/iter8/releases/download/${TAG}/iter8-windows-amd64.tar.gz | ||
| tar -xvf iter8-windows-amd64.tar.gz | ||
| ``` | ||
| Move `windows-amd64/iter8.exe` to any directory in your `PATH`. | ||
|
|
||
|
|
||
| === "Source" | ||
| Go `1.17+` is a pre-requisite. Replace `v0.9.0` with [any desired Iter8 release tag](https://github.com/iter8-tools/iter8/releases). | ||
|
|
||
| ```shell | ||
| export TAG=v0.9.0 | ||
| https://github.com/iter8-tools/iter8.git?ref=${TAG} | ||
| cd iter8 | ||
| make install | ||
| ``` | ||
|
|
||
| === "Go 1.17+" | ||
| You can replace `v0.9.0` with [any desired Iter8 release tag](https://github.com/iter8-tools/iter8/releases). | ||
| ```shell | ||
| go install github.com/iter8-tools/[email protected] | ||
| ``` | ||
| You can now run `iter8` (from your gopath bin/ directory) | ||
Oops, something went wrong.