Skip to content

Commit

Permalink
Merge pull request #42 from kaleido-io/kaleido-docs
Browse files Browse the repository at this point in the history
Used tfplugindocs to Generate Initial Documentation
  • Loading branch information
peterbroadhurst authored Aug 26, 2022
2 parents 7bed0f1 + b4c975b commit ece5c10
Show file tree
Hide file tree
Showing 13 changed files with 498 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/data-sources/privatestack_bridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_privatestack_bridge Data Source - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_privatestack_bridge (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `environment_id` (String)
- `service_id` (String)

### Optional

- `appcred_id` (String) Optionally provide an application credential to inject into the downloaded config, making it ready for use
- `appcred_secret` (String) Optionally provide an application credential to inject into the downloaded config, making it ready for use

### Read-Only

- `config_json` (String)
- `id` (String) The ID of this resource.


21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido Provider"
subcategory: ""
description: |-
---

# kaleido Provider





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `api` (String)
- `api_key` (String)
32 changes: 32 additions & 0 deletions docs/resources/app_creds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_app_creds Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_app_creds (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `environment_id` (String)
- `membership_id` (String)
- `name` (String)

### Read-Only

- `auth_type` (String)
- `id` (String) The ID of this resource.
- `password` (String)
- `username` (String)


46 changes: 46 additions & 0 deletions docs/resources/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_configuration Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_configuration (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `environment_id` (String)
- `membership_id` (String)
- `name` (String)
- `type` (String)

### Optional

- `details` (Map of String)
- `details_json` (String)
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `last_updated` (Number)

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)


31 changes: 31 additions & 0 deletions docs/resources/consortium.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_consortium Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_consortium (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `description` (String)
- `name` (String)

### Optional

- `shared_deployment` (Boolean) The decentralized nature of Kaleido means a consortium might be shared with other accounts. When true only create if name does not exist, and delete becomes a no-op.

### Read-Only

- `id` (String) The ID of this resource.


42 changes: 42 additions & 0 deletions docs/resources/czone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_czone Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_czone (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `cloud` (String)
- `consortium_id` (String)
- `region` (String)

### Optional

- `name` (String)
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)


36 changes: 36 additions & 0 deletions docs/resources/destination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_destination Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_destination (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `membership_id` (String)
- `name` (String)
- `service_id` (String)
- `service_type` (String)

### Optional

- `auto_verify_membership` (Boolean)
- `idregistry_id` (String)
- `kaleido_managed` (Boolean)

### Read-Only

- `id` (String) The ID of this resource.


40 changes: 40 additions & 0 deletions docs/resources/environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_environment Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_environment (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consensus_type` (String)
- `consortium_id` (String)
- `env_type` (String)
- `name` (String)

### Optional

- `block_period` (Number)
- `chain_id` (Number)
- `description` (String)
- `multi_region` (Boolean)
- `prefunded_accounts` (Map of String)
- `release_id` (String)
- `shared_deployment` (Boolean) The decentralized nature of Kaleido means an environment might be shared with other accounts. When true only create if name does not exist, and delete becomes a no-op.
- `test_features_json` (String)

### Read-Only

- `id` (String) The ID of this resource.


45 changes: 45 additions & 0 deletions docs/resources/ezone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_ezone Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_ezone (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `cloud` (String)
- `consortium_id` (String)
- `environment_id` (String)
- `region` (String)

### Optional

- `bridge_id` (String)
- `name` (String)
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `type` (String)

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)


28 changes: 28 additions & 0 deletions docs/resources/invitation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_invitation Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_invitation (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `email` (String)
- `org_name` (String)

### Read-Only

- `id` (String) The ID of this resource.


31 changes: 31 additions & 0 deletions docs/resources/membership.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kaleido_membership Resource - terraform-provider-kaleido"
subcategory: ""
description: |-
---

# kaleido_membership (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `consortium_id` (String)
- `org_name` (String)

### Optional

- `pre_existing` (Boolean) In a decentalized consortium memberships are driven by invitation, and will be pre-existing at the point of deploying infrastructure.

### Read-Only

- `id` (String) The ID of this resource.


Loading

0 comments on commit ece5c10

Please sign in to comment.