Skip to content
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.

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

Update examples in the README #24

Merged
merged 1 commit into from
Nov 16, 2021
Merged
Changes from all commits
Commits
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
49 changes: 31 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,27 +117,40 @@ See [Performance Management with Meshery](https://docs.meshery.io/guides/perform
## SMP Compatible Test Configuration File

```yaml
smp_version: v0.0.1
id:
name: Istio Performance Test
labels: {}
clients:
- internal: false
load_generator: fortio
protocol: 1
connections: 2
rps: 10
headers: {}
cookies: {}
body: ""
content_type: ""
endpoint_urls:
- http://localhost:2323/productpage
duration: "30m"
# Test configuration file for running performance benchmarks
# See: https://docs.meshery.io/guides/performance-management#running-performance-benchmarks-through-mesheryctl
test:
smp_version: v0.0.1

# The name of the test
name: Load Test
labels: {}

# Test configuration to be defined here
clients:
- internal: false
load_generator: fortio
protocol: 1
connections: 2
rps: 10
headers: {}
cookies: {}
body: ''
content_type: ''
endpoint_urls:
- 'https://smp-spec.io'
duration: 60s

# Service mesh under test in Service Mesh Performance Spec format
# See: https://github.com/service-mesh-performance/service-mesh-performance/blob/master/protos/service_mesh.proto
mesh:
type: 3
```

## Sample configuration

See [scheduled-benchmarks.yml](.github/workflows/scheduled-benchmarks.yml) and [configurable-benchmark-test.yml](.github/workflows/configurable-benchmark-test.yaml) for more sample configurations.

```yaml
name: Meshery SMP Action
on:
Expand Down Expand Up @@ -167,7 +180,7 @@ jobs:
with:
provider_token: ${{ secrets.PROVIDER_TOKEN }}
platform: docker
profile_name: istio-soak-test
profile_name: soak-test
```

## Join the service mesh community!
Expand Down