-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f7e2073
commit d485a35
Showing
1 changed file
with
66 additions
and
0 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 |
---|---|---|
@@ -1,3 +1,69 @@ | ||
# Terraform Provider for Tigris Buckets | ||
|
||
This repository contains a Terraform provider that allows you to create and manage Tigris buckets. This provider supports creating, reading, updating, deleting, and importing Tigris buckets with additional customization options like specifying access keys. | ||
|
||
## Usage | ||
|
||
Below is an example of how to use the Tigris provider in your Terraform configuration: | ||
|
||
```hcl | ||
terraform { | ||
required_providers { | ||
tigris = { | ||
source = "https://github.com/tigrisdata/terraform-provider-tigris" | ||
} | ||
} | ||
} | ||
provider "tigris" { | ||
access_key = "your-access-key" | ||
secret_key = "your-secret-key" | ||
} | ||
resource "tigris_bucket" "example" { | ||
bucket_name = "my-custom-bucket" | ||
} | ||
``` | ||
|
||
### Applying the Configuration | ||
|
||
1. Initialize Terraform: | ||
|
||
```shell | ||
terraform init | ||
``` | ||
|
||
2. Apply the configuration: | ||
|
||
```shell | ||
terraform apply | ||
``` | ||
|
||
## Configuration | ||
|
||
### Provider Configuration | ||
|
||
The provider can be configured with the following parameters: | ||
|
||
- access_key: (Optional) The access key. Can also be sourced from the AWS_ACCESS_KEY_ID environment variable. | ||
- secret_key: (Optional) The secret key. Can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable. | ||
|
||
### Resource Configuration | ||
|
||
- bucket_name: (Required) The name of the Tigris bucket. | ||
|
||
## Resources | ||
|
||
### tigris_bucket | ||
|
||
The tigris_bucket resource creates and manages a Tigris bucket. This resource supports the following actions: | ||
|
||
- Create: Creates a new Tigris bucket. | ||
- Read: Retrieves information about the existing Tigris bucket. | ||
- Update: Updates the bucket configuration. | ||
- Delete: Deletes the Tigris bucket. | ||
- Import: Imports an existing Tigris bucket into Terraform’s state. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Please feel free to submit a Pull Request. |