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

0.4.0 PR - Docs update to match Fabric gateway configuration changes #854

Merged
merged 1 commit into from
Jun 16, 2020
Merged
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions docs/vNext/Fabric_Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ or from various [other sources](./Runtime_Configuration.md).
### Binding with Fabric SDK 2.0.x
> Note that when using the binding target for the Fabric SDK 2.0.x there are capability restrictions:
> * The 2.0 SDK does not facilitate administration actions. It it not possible to create/join channels, nor install/instantiate chaincode. Consequently the 2.0 binding only facilitates operation with a `--caliper-flow-only-test` flag
> * The 2.0 SDK currently only supports operation using a `gateway`. Consequently the 2.0.0 binding requires a `--caliper-fabric-gateway-usegateway` flag
> * The 2.0 SDK currently only supports operation using a `gateway`. Consequently the 2.0.0 binding requires a `--caliper-fabric-gateway-enabled` flag
>
> When testing with the 2.0 SDK, it is recommended to configure the system in advance with a network tool of your choice, or using Caliper bound to a 1.4 SDK. The 2.0 SDK may then be bound to Caliper and used for testing.
> Caliper does not support the Fabric v2.0 chaincode lifecycle, however the legacy commands of install/instantiate are still valid, and so Caliper can perform basic network configuration using 1.4 SDK bindings.
Expand All @@ -69,11 +69,11 @@ The above settings are processed when starting Caliper. Modifying them during te
> caliper:
> fabric:
> gateway:
> usegateway: true
> enabled: true
> discovery: true
> ```
> After naming the [project settings](./Runtime_Configuration.md#project-level) file `caliper.yaml` and placing it in the root of your workspace directory, it will override the following two setting keys with the following values:
> * Setting `caliper-fabric-gateway-usegateway` is set to `true`
> * Setting `caliper-fabric-gateway-enabled` is set to `true`
> * Setting `caliper-fabric-gateway-discovery` is set to `true`
>
> __The other settings remain unchanged.__
Expand Down
4 changes: 2 additions & 2 deletions docs/vNext/Runtime_Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,9 @@ A default/fallback configuration file is shipped with the Caliper-related packag
| caliper-fabric-countqueryasload | Indicates whether to count queries as workload, i.e., whether the generated report should include them. |
| caliper-fabric-gateway-discovery | Indicates whether to use the Fabric discovery mechanism (via Gateway API). |
| caliper-fabric-gateway-eventstrategy | Sets the event strategy to use. |
| caliper-fabric-gateway-gatewaylocalhost | Indicates whether to use the localhost default within the Fabric Gateway API. |
| caliper-fabric-gateway-localhost | Indicates whether to use the localhost default within the Fabric Gateway API. |
| caliper-fabric-gateway-querystrategy | Sets the query strategy to use. |
| caliper-fabric-gateway-usegateway | Indicates whether to use the gateway-based SDK API. |
| caliper-fabric-gateway-enabled | Indicates whether to use the Fabric gateway-based SDK API. |
| caliper-fabric-latencythreshold | Determines the reported commit time of a transaction based on the given percentage of event sources. |
| caliper-fabric-loadbalancing | Determines how automatic load balancing is applied. |
| caliper-fabric-overwritegopath | Indicates whether to temporarily set the GOPATH environment variable to the workspace directory. |
Expand Down