Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
Signed-off-by: Cari Albritton <cari.albritton@kaleido.io>
  • Loading branch information
calbritt committed Oct 3, 2023
1 parent 448eb09 commit 467a08f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions examples/env_with_dxe/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Summary

Create an environment with:

* Nodes and IPFS and Data Exchange Services

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| kaleido_api_key | Kaleido API Key | string | - | yes |
| kaleido_region | Can be '-ap' for Sydney, or '-eu' for Frankfurt. Defaults to US | string | `` | no |
| provider | Blockchain Provider for the environment. | string | `pantheon` | no |
| consensus | Consensus methods supported by pantheon. | list | `ibft` | no |
| multi_region | Multi region env | string | `false` | no |
| node_size | Size of the nodes to be created | string | `small` | no |
| node_count | Number of nodes to create | string | 4 | no |
| service_count | Number of services to create | string | 1 | no |
2 changes: 1 addition & 1 deletion examples/env_with_dxe/input.tfvars
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kaleido_api_key = ""
env_name = "test-environment"
provider = "pantheon"
consensus = "ibft"
multi_region = "true"
multi_region = "false"
node_count = 1
block_period = 2
gc_mode = "archive"
Expand Down

0 comments on commit 467a08f

Please sign in to comment.