-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add update documentation and example
- Loading branch information
Showing
4 changed files
with
73 additions
and
34 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "solana_keypair Resource - terraform-provider-solana" | ||
subcategory: "" | ||
description: |- | ||
Genereate a random or grinded keypair compatible with the solana-keygen CLI. | ||
--- | ||
|
||
# solana_keypair (Resource) | ||
|
||
Genereate a random or grinded keypair compatible with the `solana-keygen` CLI. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Random Keypair | ||
resource "solana_keypair" "key" { | ||
output_path = "${path.module}/id.json" | ||
random = true | ||
} | ||
# Grind Keypair | ||
resource "solana_keypair" "key" { | ||
output_path = "${path.module}/id.json" | ||
grind { | ||
prefix = "abc" | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- **output_path** (String) The file path to output the keypair into. | ||
|
||
### Optional | ||
|
||
- **grind** (Block Set, Max: 1) The grind options for the new keypair. (see [below for nested schema](#nestedblock--grind)) | ||
- **id** (String) The ID of this resource. | ||
- **random** (Boolean) Whether to generate a random new keypair. | ||
|
||
### Read-Only | ||
|
||
- **private_key** (String, Sensitive) The randomly generated private key. | ||
- **public_key** (String) The randomly generated public key. | ||
|
||
<a id="nestedblock--grind"></a> | ||
### Nested Schema for `grind` | ||
|
||
Optional: | ||
|
||
- **prefix** (String) The desired prefix of the public key. | ||
- **suffix** (String) The desired suffix of the public key. | ||
- **threads** (Number) The number of threads to grind for the keypair (between 1-15). | ||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Random Keypair | ||
resource "solana_keypair" "key" { | ||
output_path = "${path.module}/id.json" | ||
random = true | ||
} | ||
|
||
# Grind Keypair | ||
resource "solana_keypair" "key" { | ||
output_path = "${path.module}/id.json" | ||
|
||
grind { | ||
prefix = "abc" | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.